| Field Name | Field Type | Notes | |||||||||||||||||||||
| BehaviourPackInfos length | li16 | ||||||||||||||||||||||
| BehaviourPackInfos array |
| ||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||
| TexturePackInfos length | li16 | |||||||||||||||||||||||||
| TexturePackInfos array |
| |||||||||||||||||||||||||
| Field Name | Field Type | Notes | |||||||||
| ResourcePackIdVersions length | varint | ||||||||||
| ResourcePackIdVersions array |
| ||||||||||
| Field Name | Field Type | Notes |
| name | string | |
| enabled | bool |
| Field Name | Field Type | Notes | ||||||||||||||||||
| GameMode | zigzag32 enum
| |||||||||||||||||||
| Field Name | Field Type | Notes | |||||||||
| name | string | ||||||||||
| type | varint enum
| ||||||||||
| value if type |
| ||||||||||
| Field Name | Field Type | Notes |
| hash | lu64 | |
| payload | ByteArray |
| Field Name | Field Type | Notes | ||||||
| BlockPalette length | varint | |||||||
| BlockPalette array |
| |||||||
| Field Name | Field Type | Notes | |||||||||
| Itemstates length | varint | ||||||||||
| Itemstates array |
| ||||||||||
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||
| network id | zigzag32 | ||||||||||||||||||||||||||||||||||||||||||||||
| 🔁 if network id |
| ||||||||||||||||||||||||||||||||||||||||||||||
| 🔁 if network id |
| ||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| x | zigzag32 | |
| y | zigzag32 | |
| z | zigzag32 |
| Field Name | Field Type | Notes |
| x | varint | |
| y | varint | |
| z | varint |
| Field Name | Field Type | Notes |
| x | lf32 | |
| y | lf32 | |
| z | lf32 |
| Field Name | Field Type | Notes |
| x | lf32 | |
| z | lf32 |
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MetadataDictionary length | varint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MetadataDictionary array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| ridden entity id | zigzag64 | |
| rider entity id | zigzag64 | |
| type | u8 | |
| immediate | bool | |
| rider initiated | bool |
| Field Name | Field Type | Notes | ||||||||||||
| EntityAttributes length | varint | |||||||||||||
| EntityAttributes array |
| |||||||||||||
| Field Name | Field Type | Notes |
| yaw | byterot | |
| pitch | byterot | |
| head yaw | byterot |
| Field Name | Field Type | Notes |
| x | zigzag32 | |
| y | varint | |
| z | zigzag32 |
| Field Name | Field Type | Notes | |||||||||||||||
| PlayerAttributes length | varint | ||||||||||||||||
| PlayerAttributes array |
| ||||||||||||||||
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| legacy request id | zigzag32 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| legacy transactions if legacy request id |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction type | varint enum
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| network ids | bool | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| inventory actions length | varint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| inventory actions array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| transaction data if transaction type |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| runtime id | zigzag32 | |
| item | Item |
| Field Name | Field Type | Notes | ||||||||||||
| network id | zigzag32 | |||||||||||||
| 🔁 if network id |
| |||||||||||||
| Field Name | Field Type | Notes | ||||||||||||||||||
| PotionTypeRecipes length | varint | |||||||||||||||||||
| PotionTypeRecipes array |
| |||||||||||||||||||
| Field Name | Field Type | Notes | |||||||||
| PotionContainerChangeRecipes length | varint | ||||||||||
| PotionContainerChangeRecipes array |
| ||||||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Recipes length | varint | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Recipes array |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| width | li32 | |
| height | li32 | |
| data | string |
| Field Name | Field Type | Notes | |||||||||||||||
| skin id | string | ||||||||||||||||
| skin resource pack | string | ||||||||||||||||
| skin data | SkinImage | ||||||||||||||||
| animations length | li32 | ||||||||||||||||
| animations array |
| ||||||||||||||||
| cape data | SkinImage | ||||||||||||||||
| geometry data | string | ||||||||||||||||
| animation data | string | ||||||||||||||||
| premium | string | ||||||||||||||||
| persona | bool | ||||||||||||||||
| cape on classic | bool | ||||||||||||||||
| cape id | string | ||||||||||||||||
| full skin id | string | ||||||||||||||||
| arm size | string | ||||||||||||||||
| skin color | string | ||||||||||||||||
| personal pieces length | li32 | ||||||||||||||||
| personal pieces array |
| ||||||||||||||||
| piece tint colors length | li32 | ||||||||||||||||
| piece tint colors array |
| ||||||||||||||||
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||
| type | u8 enum
| ||||||||||||||||||||||||||||||||||||||||
| records count | varint | ||||||||||||||||||||||||||||||||||||||||
| Length for records below is records count from above | |||||||||||||||||||||||||||||||||||||||||
| records array |
| ||||||||||||||||||||||||||||||||||||||||
| Length for verified below is records count from above | |||||||||||||||||||||||||||||||||||||||||
| verified array | bool | ||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||
| type | u8 enum
| ||||||||||||||||||||||||||||||||||||||||
| entries length | varint | ||||||||||||||||||||||||||||||||||||||||
| entries array |
| ||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||||||||
| type | i8 enum
| |||||||||||||
| entries length | varint | |||||||||||||
| entries array |
| |||||||||||||
| Field Name | Field Type | Notes |
| id | u8 | |
| level | u8 |
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||
| EnchantOptions length | varint | |||||||||||||||||||||||||||||||
| EnchantOptions array |
| |||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| container id | u8 | |
| slot id | u8 | |
| stack id | zigzag32 |
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ItemStackRequests length | varint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ItemStackRequests array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||
| ItemStackResponses length | varint | |||||||||||||||||||||||||||||||||||||
| ItemStackResponses array |
| |||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||
| ItemComponentList length | varint | |||||||
| ItemComponentList array |
| |||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||
| type | varint enum
| |||||||||||||||||||||||||||||||||||||
| uuid | uuid | |||||||||||||||||||||||||||||||||||||
| request id | string | |||||||||||||||||||||||||||||||||||||
| player entity id if type |
| |||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WindowID | i8 enum
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WindowIDVarint | varint enum
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WindowType | u8 enum
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LegacyEntityType | li32 enum
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The login process is as follows: C→S: Login S→C: Server To Client Handshake C→S: Client To Server Handshake S→C: Play Status (Login success) To spawn, the following packets should be sent, in order, after the ones above: S→C: Resource Packs Info C→S: Resource Pack Client Response S→C: Resource Pack Stack C→S: Resource Pack Client Response S→C: Start Game S→C: Creative Content S→C: Biome Definition List S→C: Chunks S→C: Play Status (Player spawn) If there are no resource packs being sent, a Resource Pack Stack can be sent directly after Resource Packs Info to avoid the client responses.
| Field Name | Field Type | Notes |
| protocol version | i32 | Protocol version (Big Endian!) |
| tokens | ["encapsulated", { "lengthType": "varint", "type": "LoginTokens" }] |
| Field Name | Field Type | Notes |
| identity | LittleString | JSON array of JWT data: contains the display name, UUID and XUID It should be signed by the Mojang public key |
| client | LittleString | Skin related data |
| Field Name | Field Type | Notes | ||||||||||||||||||||||||
| status | i32 enum
| |||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| token | string | Contains the salt to complete the Diffie-Hellman key exchange |
Sent by the client in response to a Server To Client Handshake packet sent by the server. It is the first encrypted packet in the login handshake and serves as a confirmation that encryption is correctly initialized client side. It has no fields.
| Field Name | Field Type | Notes |
Sent by the server to disconnect a client.
| Field Name | Field Type | Notes |
| hide disconnect reason | bool | Specifies if the disconnection screen should be hidden when the client is disconnected, meaning it will be sent directly to the main menu. |
| message | string | An optional message to show when disconnected. |
| Field Name | Field Type | Notes |
| must accept | bool | If the resource pack requires the client accept it. |
| has scripts | bool | If scripting is enabled. |
| behaviour packs | BehaviourPackInfos | A list of behaviour packs that the client needs to download before joining the server. All of these behaviour packs will be applied together. |
| texture packs | TexturePackInfos | A list of resource packs that the client needs to download before joining the server. The order of these resource packs is not relevant in this packet. It is however important in the Resource Pack Stack packet. |
| Field Name | Field Type | Notes |
| must accept | bool | If the resource pack must be accepted for the player to join the server. |
| behavior packs | ResourcePackIdVersions | [inline] |
| resource packs | ResourcePackIdVersions | [inline] |
| game version | string | |
| experiments | Experiments | |
| experiments previously used | bool |
| Field Name | Field Type | Notes | |||||||||||||||
| response status | u8 enum
| ||||||||||||||||
| resourcepackids | ResourcePackIds | All of the pack IDs. | |||||||||||||||
Sent by the client to the server to send chat messages, and by the server to the client to forward or send messages, which may be chat, popups, tips etc.
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||
| type | u8 enum
| ||||||||||||||||||||||||||||||||||
| needs translation | bool | NeedsTranslation specifies if any of the messages need to be translated. It seems that where % is found in translatable text types, these are translated regardless of this bool. Translatable text types include TextTypeTip, TextTypePopup and TextTypeJukeboxPopup. | |||||||||||||||||||||||||||||||||
| 🔁 if type |
| ||||||||||||||||||||||||||||||||||
| xuid | string | The XUID of the player who sent this message. | |||||||||||||||||||||||||||||||||
| platform chat id | string | PlatformChatID is an identifier only set for particular platforms when chatting (presumably only for Nintendo Switch). It is otherwise an empty string, and is used to decide which players are able to chat with each other. | |||||||||||||||||||||||||||||||||
For additional information and examples of all the chat types above, see here: https://imgur.com/a/KhcFscg Sent by the server to update the current time client-side. The client actually advances time client-side by itself, so this packet does not need to be sent each tick. It is merely a means of synchronizing time between server and client.
| Field Name | Field Type | Notes |
| time | zigzag32 | Time is the current time. The time is not limited to 24000 (time of day), but continues progressing after that. |
Sent by the server to send information about the world the player will be spawned in.
| Field Name | Field Type | Notes | |||||||||
| entity id | zigzag64 | The unique ID of the player. The unique ID is a value that remains consistent across different sessions of the same world, but most unofficial servers simply fill the runtime ID of the entity out for this field. | |||||||||
| runtime entity id | varint64 | The runtime ID of the player. The runtime ID is unique for each world session, and entities are generally identified in packets using this runtime ID. | |||||||||
| player gamemode | GameMode | PlayerGameMode is the game mode the player currently has. It is a value from 0-4, with 0 being survival mode, 1 being creative mode, 2 being adventure mode, 3 being survival spectator and 4 being creative spectator. This field may be set to 5 to make the client fall back to the game mode set in the WorldGameMode field. | |||||||||
| spawn | vec3f | The spawn position of the player in the world. In servers this is often the same as the world's spawn position found below. | |||||||||
| rotation | vec2f | The pitch and yaw of the player | |||||||||
| seed | zigzag32 | The seed used to generate the world. Unlike in Java edition, the seed is a 32bit Integer here. | |||||||||
| biome type | li16 | ||||||||||
| biome name | string | ||||||||||
| dimension | zigzag32 | Dimension is the ID of the dimension that the player spawns in. It is a value from 0-2, with 0 being the overworld, 1 being the nether and 2 being the end. | |||||||||
| generator | zigzag32 | Generator is the generator used for the world. It is a value from 0-4, with 0 being old limited worlds, 1 being infinite worlds, 2 being flat worlds, 3 being nether worlds and 4 being end worlds. A value of 0 will actually make the client stop rendering chunks you send beyond the world limit. | |||||||||
| world gamemode | GameMode | The world game mode that a player gets when it first spawns in the world. It is shown in the settings and is used if the Player Gamemode is set to 5. | |||||||||
| difficulty | zigzag32 | Difficulty is the difficulty of the world. It is a value from 0-3, with 0 being peaceful, 1 being easy, 2 being normal and 3 being hard. | |||||||||
| spawn position | BlockCoordinates | The block on which the world spawn of the world. This coordinate has no effect on the place that the client spawns, but it does have an effect on the direction that a compass poInts. | |||||||||
| achievements disabled | bool | Defines if achievements are disabled in the world. The client crashes if this value is set to true while the player's or the world's game mode is creative, and it's recommended to simply always set this to false as a server. | |||||||||
| day cycle stop time | zigzag32 | The time at which the day cycle was locked if the day cycle is disabled using the respective game rule. The client will maIntain this time as Boolean as the day cycle is disabled. | |||||||||
| edu offer | zigzag32 | Some Minecraft: Education Edition field that specifies what 'region' the world was from, with 0 being None, 1 being RestOfWorld, and 2 being China. The actual use of this field is unknown. | |||||||||
| edu features enabled | bool | Specifies if the world has education edition features enabled, such as the blocks or entities specific to education edition. | |||||||||
| edu product uuid | string | ||||||||||
| rain level | lf32 | The level specifying the Intensity of the rain falling. When set to 0, no rain falls at all. | |||||||||
| lightning level | lf32 | ||||||||||
| has confirmed platform locked content | bool | The level specifying the Intensity of the thunder. This may actually be set independently from the rain level, meaning dark clouds can be produced without rain. | |||||||||
| is multiplayer | bool | Specifies if the world is a multi-player game. This should always be set to true for servers. | |||||||||
| broadcast to lan | bool | Specifies if LAN broadcast was Intended to be enabled for the world. | |||||||||
| xbox live broadcast mode | varint | The mode used to broadcast the joined game across XBOX Live. | |||||||||
| platform broadcast mode | varint | The mode used to broadcast the joined game across the platform. | |||||||||
| enable commands | bool | If commands are enabled for the player. It is recommended to always set this to true on the server, as setting it to false means the player cannot, under any circumstance, use a command. | |||||||||
| is texturepacks required | bool | Specifies if the texture pack the world might hold is required, meaning the client was forced to download it before joining. | |||||||||
| gamerules | GameRules | Defines game rules currently active with their respective values. The value of these game rules may be either 'bool', 'Int32' or 'Float32'. Some game rules are server side only, and don't necessarily need to be sent to the client. | |||||||||
| experiments | Experiments | ||||||||||
| experiments previously used | bool | ||||||||||
| bonus chest | bool | Specifies if the world had the bonus map setting enabled when generating it. It does not have any effect client-side. | |||||||||
| map enabled | bool | Specifies if the world has the start with map setting enabled, meaning each joining player obtains a map. This should always be set to false, because the client obtains a map all on its own accord if this is set to true. | |||||||||
| permission level | zigzag32 | The permission level of the player. It is a value from 0-3, with 0 being visitor, 1 being member, 2 being operator and 3 being custom. | |||||||||
| server chunk tick range | li32 | The radius around the player in which chunks are ticked. Most servers set this value to a fixed number, as it does not necessarily affect anything client-side. | |||||||||
| has locked behavior pack | bool | Specifies if the texture pack of the world is locked, meaning it cannot be disabled from the world. This is typically set for worlds on the marketplace that have a dedicated texture pack. | |||||||||
| has locked resource pack | bool | Specifies if the texture pack of the world is locked, meaning it cannot be disabled from the world. This is typically set for worlds on the marketplace that have a dedicated texture pack. | |||||||||
| is from locked world template | bool | Specifies if the world from the server was from a locked world template. For servers this should always be set to false. | |||||||||
| msa gamertags only | bool | ||||||||||
| is from world template | bool | Specifies if the world from the server was from a locked world template. For servers this should always be set to false. | |||||||||
| is world template option locked | bool | Specifies if the world was a template that locks all settings that change properties above in the settings GUI. It is recommended to set this to true for servers that do not allow things such as setting game rules through the GUI. | |||||||||
| only spawn v1 villagers | bool | A hack that Mojang put in place to preserve backwards compatibility with old villagers. The his never actually read though, so it has no functionality. | |||||||||
| game version | string | The version of the game from which Vanilla features will be used. The exact function of this field isn't clear. | |||||||||
| limited world width | li32 | ||||||||||
| limited world length | li32 | ||||||||||
| is new nether | bool | ||||||||||
| experimental gameplay override | bool | ||||||||||
| level id | string | A base64 encoded world ID that is used to identify the world. | |||||||||
| world name | string | The name of the world that the player is joining. Note that this field shows up above the player list for the rest of the game session, and cannot be changed. Setting the server name to this field is recommended. | |||||||||
| premium world template id | string | A UUID specific to the premium world template that might have been used to generate the world. Servers should always fill out an empty String for this. | |||||||||
| is trial | bool | Specifies if the world was a trial world, meaning features are limited and there is a time limit on the world. | |||||||||
| movement authority | zigzag32 enum
| ||||||||||
| current tick | li64 | The total time in ticks that has elapsed since the start of the world. | |||||||||
| enchantment seed | zigzag32 | The seed used to seed the random used to produce enchantments in the enchantment table. Note that the exact correct random implementation must be used to produce the correct results both client- and server-side. | |||||||||
| block palette | BlockPalette | ||||||||||
| itemstates | Itemstates | A list of all items with their legacy IDs which are available in the game. Failing to send any of the items that are in the game will crash mobile clients. | |||||||||
| multiplayer correlation id | string | A unique ID specifying the multi-player session of the player. A random UUID should be filled out for this field. | |||||||||
| server authoritative inventory | bool | ||||||||||
| Field Name | Field Type | Notes |
| uuid | uuid | UUID is the UUID of the player. It is the same UUID that the client sent in the Login packet at the start of the session. A player with this UUID must exist in the player list (built up using the Player List packet) for it to show up in-game. |
| username | string | Username is the name of the player. This username is the username that will be set as the initial name tag of the player. |
| entity id self | zigzag64 | The unique ID of the player. The unique ID is a value that remains consistent across different sessions of the same world, but most unoffical servers simply fill the runtime ID of the player out for this field. |
| runtime entity id | varint | The runtime ID of the player. The runtime ID is unique for each world session, and entities are generally identified in packets using this runtime ID. |
| platform chat id | string | An identifier only set for particular platforms when chatting (presumably only for Nintendo Switch). It is otherwise an empty string, and is used to decide which players are able to chat with each other. |
| x | lf32 | |
| y | lf32 | |
| z | lf32 | |
| speed x | lf32 | |
| speed y | lf32 | |
| speed z | lf32 | |
| pitch | lf32 | |
| yaw | lf32 | |
| head yaw | lf32 | |
| held item | Item | |
| metadata | MetadataDictionary | |
| flags | varint | |
| command permission | varint | |
| action permissions | varint | |
| permission level | varint | |
| custom stored permissions | varint | |
| user id | li64 | |
| links | Links | |
| device id | string | |
| device os | li32 |
| Field Name | Field Type | Notes |
| entity id self | zigzag64 | |
| runtime entity id | varint | |
| entity type | string | |
| x | lf32 | |
| y | lf32 | |
| z | lf32 | |
| speed x | lf32 | |
| speed y | lf32 | |
| speed z | lf32 | |
| pitch | lf32 | |
| yaw | lf32 | |
| head yaw | lf32 | |
| attributes | EntityAttributes | |
| metadata | MetadataDictionary | |
| links | Links |
| Field Name | Field Type | Notes |
| entity id self | zigzag64 |
| Field Name | Field Type | Notes |
| entity id self | zigzag64 | |
| runtime entity id | varint | |
| item | Item | |
| x | lf32 | |
| y | lf32 | |
| z | lf32 | |
| speed x | lf32 | |
| speed y | lf32 | |
| speed z | lf32 | |
| metadata | MetadataDictionary | |
| is from fishing | bool |
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| target | varint |
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| flags | u8 | |
| position | vec3f | |
| rotation | Rotation |
MovePlayer is sent by players to send their movement to the server, and by the server to update the movement of player entities to other players.
| Field Name | Field Type | Notes | ||||||||||||||||||||||||
| runtime id | varint | EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and entities are generally identified in packets using this runtime ID. | ||||||||||||||||||||||||
| position | vec3f | Position is the position to spawn the player on. If the player is on a distance that the viewer cannot see it, the player will still show up if the viewer moves closer. | ||||||||||||||||||||||||
| pitch | lf32 | Pitch is the vertical rotation of the player. Facing straight forward yields a pitch of 0. Pitch is measured in degrees. | ||||||||||||||||||||||||
| yaw | lf32 | Yaw is the horizontal rotation of the player. Yaw is also measured in degrees | ||||||||||||||||||||||||
| head yaw | lf32 | HeadYaw is the same as Yaw, except that it applies specifically to the head of the player. A different value for HeadYaw than Yaw means that the player will have its head turned | ||||||||||||||||||||||||
| mode | u8 enum
| |||||||||||||||||||||||||
| on ground | bool | OnGround specifies if the player is considered on the ground. Note that proxies or hacked clients could fake this to always be true, so it should not be taken for granted. | ||||||||||||||||||||||||
| ridden runtime id | varint | RiddenEntityRuntimeID is the runtime ID of the entity that the player might currently be riding. If not riding, this should be left 0. | ||||||||||||||||||||||||
| teleport if mode |
| |||||||||||||||||||||||||
| tick | varint64 | |||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| jump strength | zigzag32 |
| Field Name | Field Type | Notes |
| coordinates | BlockCoordinates | |
| block runtime id | varint | |
| block priority | varint | |
| storage | varint |
| Field Name | Field Type | Notes |
| entity id self | zigzag64 | |
| runtime entity id | varint | |
| coordinates | BlockCoordinates | |
| direction | zigzag32 | |
| title | string |
TickSync is sent by the client and the server to maintain a synchronized, server-authoritative tick between the client and the server. The client sends this packet first, and the server should reply with another one of these packets, including the response time.
| Field Name | Field Type | Notes |
| request time | li64 | ClientRequestTimestamp is the timestamp on which the client sent this packet to the server. The server should fill out that same value when replying. The ClientRequestTimestamp is always 0 |
| response time | li64 | ServerReceptionTimestamp is the timestamp on which the server received the packet sent by the client. When the packet is sent by the client, this value is 0. ServerReceptionTimestamp is generally the current tick of the server. It isn't an actual timestamp, as the field implies |
| Field Name | Field Type | Notes |
| sound id | u8 | |
| position | vec3f | |
| block id | zigzag32 | |
| entity type | zigzag32 | |
| is baby mob | bool | |
| is global | bool |
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| event | zigzag32 enum
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| position | vec3f | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | zigzag32 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||
| position | BlockCoordinates | Position is the position of the block that an event occurred at. | ||||||
| type | zigzag32 enum
| |||||||
| data | zigzag32 | EventData holds event type specific data. For chests for example, opening the chest means the data must be 1 | ||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| runtime entity id | varint | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| event id | u8 enum
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | zigzag32 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| event id | u8 | |
| effect id | zigzag32 | |
| amplifier | zigzag32 | |
| particles | bool | |
| duration | zigzag32 |
| Field Name | Field Type | Notes |
| runtime entity id | varint64 | |
| attributes | PlayerAttributes | |
| tick | varint64 |
| Field Name | Field Type | Notes |
| transaction | Transaction |
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| item | Item | |
| slot | u8 | |
| selected slot | u8 | |
| windows id | WindowID |
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| helmet | Item | |
| chestplate | Item | |
| leggings | Item | |
| boots | Item |
Interact is sent by the client when it interacts with another entity in some way. It used to be used for normal entity and block interaction, but this is no longer the case now.
| Field Name | Field Type | Notes | |||||||||
| action id | u8 enum
| ||||||||||
| target runtime entity id | varint | TargetEntityRuntimeID is the runtime ID of the entity that the player interacted with. This is empty for the InteractActionOpenInventory action type. | |||||||||
| position if action id |
| ||||||||||
| Field Name | Field Type | Notes |
| x | zigzag32 | |
| y | zigzag32 | |
| z | zigzag32 | |
| add user data | bool | |
| selected slot | u8 |
| Field Name | Field Type | Notes |
| runtime entity id | lu64 | |
| selected slot | u8 |
PlayerAction is sent by the client when it executes any action, for example starting to sprint, swim, starting the breaking of a block, dropping an item, etc.
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| runtime entity id | varint | EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and entities are generally identified in packets using this runtime ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| action | zigzag32 enum
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| position | BlockCoordinates | BlockPosition is the position of the target block, if the action with the ActionType set concerned a block. If that is not the case, the block position will be zero. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| face | zigzag32 | BlockFace is the face of the target block that was touched. If the action with the ActionType set concerned a block. If not, the face is always 0. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| health | zigzag32 |
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| metadata | MetadataDictionary | |
| tick | varint64 |
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| velocity | vec3f |
SetActorLink is sent by the server to initiate an entity link client-side, meaning one entity will start riding another.
| Field Name | Field Type | Notes |
| link | Link |
| Field Name | Field Type | Notes |
| health | zigzag32 |
| Field Name | Field Type | Notes | ||||||
| spawn type | zigzag32 enum
| |||||||
| player position | BlockCoordinates | |||||||
| dimension | zigzag32 | |||||||
| world position | BlockCoordinates | |||||||
| Field Name | Field Type | Notes | ||||||||||||||||||||||||
| action id | zigzag32 enum
| |||||||||||||||||||||||||
| runtime entity id | varint64 | |||||||||||||||||||||||||
| 🔁 if action id |
| |||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| x | lf32 | |
| y | lf32 | |
| z | lf32 | |
| state | u8 | |
| runtime entity id | varint |
ContainerOpen is sent by the server to open a container client-side. This container must be physically present in the world, for the packet to have any effect. Unlike Java Edition, Bedrock Edition requires that chests for example must be present and in range to open its inventory.
| Field Name | Field Type | Notes |
| window id | WindowID | WindowID is the ID representing the window that is being opened. It may be used later to close the container using a ContainerClose packet. |
| window type | WindowType | ContainerType is the type ID of the container that is being opened when opening the container at the position of the packet. It depends on the block/entity, and could, for example, be the window type of a chest or a hopper, but also a horse inventory. |
| coordinates | BlockCoordinates | ContainerPosition is the position of the container opened. The position must point to a block entity that actually has a container. If that is not the case, the window will not be opened and the packet will be ignored, if a valid ContainerEntityUniqueID has not also been provided. |
| runtime entity id | zigzag64 | ContainerEntityUniqueID is the unique ID of the entity container that was opened. It is only used if the ContainerType is one that points to an entity, for example a horse. |
ContainerClose is sent by the server to close a container the player currently has opened, which was opened using the ContainerOpen packet, or by the client to tell the server it closed a particular container, such as the crafting grid.
| Field Name | Field Type | Notes |
| window id | WindowID | WindowID is the ID representing the window of the container that should be closed. It must be equal to the one sent in the ContainerOpen packet to close the designated window. |
| server | bool | ServerSide determines whether or not the container was force-closed by the server. If this value is not set correctly, the client may ignore the packet and respond with a PacketViolationWarning. |
PlayerHotBar is sent by the server to the client. It used to be used to link hot bar slots of the player to actual slots in the inventory, but as of 1.2, this was changed and hot bar slots are no longer a free floating part of the inventory. Since 1.2, the packet has been re-purposed, but its new functionality is not clear.
| Field Name | Field Type | Notes |
| selected slot | varint | |
| window id | WindowID | |
| select slot | bool |
InventoryContent is sent by the server to update the full content of a particular inventory. It is usually sent for the main inventory of the player, but also works for other inventories that are currently opened by the player.
| Field Name | Field Type | Notes |
| inventory id | WindowIDVarint | WindowID is the ID that identifies one of the windows that the client currently has opened, or one of the consistent windows such as the main inventory. |
| input | ItemStacks | Content is the new content of the inventory. The length of this slice must be equal to the full size of the inventory window updated. |
InventorySlot is sent by the server to update a single slot in one of the inventory windows that the client currently has opened. Usually this is the main inventory, but it may also be the off hand or, for example, a chest inventory.
| Field Name | Field Type | Notes |
| window id | WindowIDVarint | WindowID is the ID of the window that the packet modifies. It must point to one of the windows that the client currently has opened. |
| slot | varint | Slot is the index of the slot that the packet modifies. The new item will be set to the slot at this index. |
| item | ItemStack | NewItem is the item to be put in the slot at Slot. It will overwrite any item that may currently be present in that slot. |
ContainerSetData is sent by the server to update specific data of a single container, meaning a block such as a furnace or a brewing stand. This data is usually used by the client to display certain features client-side.
| Field Name | Field Type | Notes |
| window id | WindowID | WindowID is the ID of the window that should have its data set. The player must have a window open with the window ID passed, or nothing will happen. |
| property | zigzag32 | Key is the key of the property. It is one of the constants that can be found above. Multiple properties share the same key, but the functionality depends on the type of the container that the data is set to. |
| value | zigzag32 | Value is the value of the property. Its use differs per property. |
| Field Name | Field Type | Notes |
| recipes | Recipes | |
| potion type recipes | PotionTypeRecipes | |
| potion container recipes | PotionContainerChangeRecipes | |
| is clean | bool |
CraftingEvent is sent by the client when it crafts a particular item. Note that this packet may be fully ignored, as the InventoryTransaction packet provides all the information required.
| Field Name | Field Type | Notes | |||||||||
| window id | WindowID | WindowID is the ID representing the window that the player crafted in. | |||||||||
| recipe type | zigzag32 enum
| ||||||||||
| recipe id | uuid | RecipeUUID is the UUID of the recipe that was crafted. It points to the UUID of the recipe that was sent earlier in the CraftingData packet. | |||||||||
| input length | varint | Input is a list of items that the player put into the recipe so that it could create the Output items. These items are consumed in the process. | |||||||||
| input array | Item | ||||||||||
| result length | varint | Output is a list of items that were obtained as a result of crafting the recipe. | |||||||||
| result array | Item | ||||||||||
| Field Name | Field Type | Notes |
AdventureSettings is sent by the server to update game-play related features, in particular permissions to access these features for the client. It includes allowing the player to fly, build and mine, and attack entities. Most of these flags should be checked server-side instead of using this packet only. The client may also send this packet to the server when it updates one of these settings through the in-game settings interface. The server should verify if the player actually has permission to update those settings.
| Field Name | Field Type | Notes | |||||||||||||||
| flags | AdventureFlags | Flags is a set of flags that specify certain properties of the player, such as whether or not it can fly and/or move through blocks. It is one of the AdventureFlag constants above. | |||||||||||||||
| command permission | varint enum
| ||||||||||||||||
| action permissions | ActionPermissions | ActionPermissions is, much like Flags, a set of flags that specify actions that the player is allowed to undertake, such as whether it is allowed to edit blocks, open doors etc. It is a combination of the ActionPermission constants above. | |||||||||||||||
| permission level | varint enum
| ||||||||||||||||
| custom stored permissions | varint | Custom permissions | |||||||||||||||
| user id | li64 | PlayerUniqueID is a unique identifier of the player. It appears it is not required to fill this field out with a correct value. Simply writing 0 seems to work. | |||||||||||||||
| Field Name | Field Type | Notes |
| position | BlockCoordinates | |
| nbt | nbt |
| Field Name | Field Type | Notes |
| motion x | lf32 | |
| motion z | lf32 | |
| jumping | bool | |
| sneaking | bool |
LevelChunk is sent by the server to provide the client with a chunk of a world data (16xYx16 blocks). Typically a certain amount of chunks is sent to the client before sending it the spawn PlayStatus packet, so that the client spawns in a loaded world.
| Field Name | Field Type | Notes | |||||||||
| x | zigzag32 | ChunkX is the X coordinate of the chunk sent. (To translate a block's X to a chunk's X: x >> 4) | |||||||||
| z | zigzag32 | ChunkZ is the Z coordinate of the chunk sent. (To translate a block's Z to a chunk's Z: z >> 4) | |||||||||
| sub chunk count | varint | SubChunkCount is the amount of sub chunks that are part of the chunk sent. Depending on if the cache is enabled, a list of blob hashes will be sent, or, if disabled, the sub chunk data. | |||||||||
| cache enabled | bool | CacheEnabled specifies if the client blob cache should be enabled. This system is based on hashes of blobs which are consistent and saved by the client in combination with that blob, so that the server does not have to send the same chunk multiple times. If the client does not yet have a blob with the hash sent, it will send a ClientCacheBlobStatus packet containing the hashes is does not have the data of. | |||||||||
| blobs if cache enabled |
| ||||||||||
| payload | ByteArray | RawPayload is a serialised string of chunk data. The data held depends on if CacheEnabled is set to true. If set to false, the payload is composed of multiple sub-chunks, each of which carry a version which indicates the way they are serialised, followed by biomes, border blocks and tile entities. If CacheEnabled is true, the payload consists out of the border blocks and tile entities only. | |||||||||
| Field Name | Field Type | Notes |
| enabled | bool |
| Field Name | Field Type | Notes |
| difficulty | varint |
| Field Name | Field Type | Notes |
| dimension | zigzag32 | |
| position | vec3f | |
| respawn | bool |
SetPlayerGameType is sent by the server to update the game type (game mode) of the player
| Field Name | Field Type | Notes |
| gamemode | GameMode | The new gamemode for the player. Some of these game types require additional flags to be set in an AdventureSettings packet for the game mode to obtain its full functionality. |
| Field Name | Field Type | Notes |
| records | PlayerRecords |
| Field Name | Field Type | Notes |
| event type | lu16 |
Event is sent by the server to send an event with additional data. It is typically sent to the client for telemetry reasons, much like the SimpleEvent packet.
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| runtime id | varint64 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| event type | zigzag32 enum
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| use player id | u8 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| event data | restBuffer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| position | vec3f | |
| count | zigzag32 |
| Field Name | Field Type | Notes |
| mapinfo | MapInfo |
| Field Name | Field Type | Notes |
| map id | zigzag64 |
| Field Name | Field Type | Notes |
| chunk radius | zigzag32 |
| Field Name | Field Type | Notes |
| chunk radius | zigzag32 |
| Field Name | Field Type | Notes |
| coordinates | BlockCoordinates |
| Field Name | Field Type | Notes |
| rules | GameRules |
Camera is sent by the server to use an Education Edition camera on a player. It produces an image client-side.
| Field Name | Field Type | Notes |
| camera entity unique id | zigzag64 | CameraEntityUniqueID is the unique ID of the camera entity from which the picture was taken. |
| target player unique id | zigzag64 | TargetPlayerUniqueID is the unique ID of the target player. The unique ID is a value that remains consistent across different sessions of the same world, but most servers simply fill the runtime ID of the player out for this field. |
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||||||||||||||
| boss entity id | zigzag64 | |||||||||||||||||||||||||||||||||||||||||||
| type | varint enum
| |||||||||||||||||||||||||||||||||||||||||||
| 🔁 if type |
| |||||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| status | zigzag32 |
This packet sends a list of commands to the client. Commands can have arguments, and some of those arguments can have 'enum' values, which are a list of possible values for the argument. The serialization is rather complex and involves palettes like chunks.
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| values len | varint | The length of the enums for all the command parameters in this packet | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| _enum_type | ["enum_size_based_on_values_len"] | Not read from stream: instead calculated from the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Length for enum values below is values len from above | Here all the enum values for all of the possible commands are stored to one array palette | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enum values array | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| suffixes length | varint | Integer parameters may sometimes have a prefix, such as the XP command:
/xp | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| suffixes array | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enums length | varint | The list of enum objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enums array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| command data length | varint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| command data array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dynamic enums length | varint | There are two types of enums: static enums which cannot be changed after sending AvaliableCommands, (unless you resend the whole packet) and 'soft' or 'dynamic' enums like below which is an array that can be updated with the UpdateSoftEnum packet | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dynamic enums array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enum constraints length | varint | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enum constraints array |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ParamOptionCollapseEnum specifies if the enum (only if the Type is actually an enum type. If not,
setting this to true has no effect) should be collapsed. This means that the options of the enum are
never shown in the actual usage of the command, but only as auto-completion, like it automatically does
with enums that have a big amount of options. To illustrate, it can make
| Field Name | Field Type | Notes |
| command | string | CommandLine is the raw entered command line. The client does no parsing of the command line by itself (unlike it did in the early stages), but lets the server do that. |
| origin | CommandOrigin | Origin holds information about the command sender that will be returnd back in the command response |
| internal | bool | Internal specifies if the command request internal. Setting it to false seems to work and the usage of this field is not known. |
CommandBlockUpdate is sent by the client to update a command block at a specific position. The command block may be either a physical block or an entity.
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||
| is block | bool | Block specifies if the command block updated was an actual physical block. If false, the command block is in a minecart and has an entity runtime ID instead. | ||||||||||||||||||||||||||||||
| 🔁 if is block |
| |||||||||||||||||||||||||||||||
| command | string | Command is the command currently entered in the command block. This is the command that is executed when the command block is activated. | ||||||||||||||||||||||||||||||
| last output | string | LastOutput is the output of the last command executed by the command block. It may be left empty to show simply no output at all, in combination with setting ShouldTrackOutput to false. | ||||||||||||||||||||||||||||||
| name | string | Name is the name of the command block updated. If not empty, it will show this name hovering above the command block when hovering over the block with the cursor. | ||||||||||||||||||||||||||||||
| should track output | bool | ShouldTrackOutput specifies if the command block tracks output. If set to false, the output box won't be shown within the command block. | ||||||||||||||||||||||||||||||
| tick delay | li32 | TickDelay is the delay in ticks between executions of a command block, if it is a repeating command block. | ||||||||||||||||||||||||||||||
| execute on first tick | bool | ExecuteOnFirstTick specifies if the command block should execute on the first tick, AKA as soon as the command block is enabled. | ||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes | ||||||||||||
| origin | CommandOrigin | CommandOrigin is the data specifying the origin of the command. In other words, the source that the command request was from, such as the player itself or a websocket server. The client forwards the messages in this packet to the right origin, depending on what is sent here. | ||||||||||||
| output type | i8 | OutputType specifies the type of output that is sent. The OutputType sent by vanilla games appears to be 3, which seems to work. | ||||||||||||
| success count | varint | SuccessCount is the amount of times that a command was executed successfully as a result of the command that was requested. For servers, this is usually a rather meaningless fields, but for vanilla, this is applicable for commands created with Functions. | ||||||||||||
| output length | varint | OutputMessages is a list of all output messages that should be sent to the player. Whether they are shown or not, depends on the type of the messages. | ||||||||||||
| output array |
| |||||||||||||
UpdateTrade is sent by the server to update the trades offered by a villager to a player. It is sent at the moment that a player interacts with a villager.
| Field Name | Field Type | Notes |
| window id | WindowID | WindowID is the ID that identifies the trading window that the client currently has opened. |
| window type | WindowType | WindowType is an identifier specifying the type of the window opened. In vanilla, it appears this is always filled out with 15. |
| size | varint | Size is the amount of trading options that the villager has. |
| trade tier | varint | TradeTier is the tier of the villager that the player is trading with. The tier starts at 0 with a first two offers being available, after which two additional offers are unlocked each time the tier becomes one higher. |
| villager unique id | varint64 | VillagerUniqueID is the unique ID of the villager entity that the player is trading with. The TradeTier sent above applies to this villager. |
| entity unique id | varint64 | EntityUniqueID is the unique ID of the entity (usually a player) for which the trades are updated. The updated trades may apply only to this entity. |
| display name | string | DisplayName is the name displayed at the top of the trading UI. It is usually used to represent the profession of the villager in the UI. |
| new trading ui | bool | NewTradeUI specifies if the villager should be using the new trade UI (The one added in 1.11.) rather than the old one. This should usually be set to true. |
| economic trades | bool | Trading based on Minecraft economy - specifies if the prices of the villager's offers are modified by an increase in demand for the item. (A mechanic added in 1.11.) Buying more of the same item will increase the price of that particular item. https://minecraft.gamepedia.com/Trading#Economics |
| offers | nbt | NBT serialised compound of offers that the villager has. |
UpdateEquip is sent by the server to the client upon opening a horse inventory. It is used to set the content of the inventory and specify additional properties, such as the items that are allowed to be put in slots of the inventory.
| Field Name | Field Type | Notes |
| window id | WindowID | WindowID is the identifier associated with the window that the UpdateEquip packet concerns. It is the ID sent for the horse inventory that was opened before this packet was sent. |
| window type | WindowType | WindowType is the type of the window that was opened. Generally, this is the type of a horse inventory, as the packet is specifically made for that. |
| size | u8 | Size is the size of the horse inventory that should be opened. A bigger size does, in fact, change the amount of slots displayed. |
| entity id | zigzag64 | EntityUniqueID is the unique ID of the entity whose equipment was 'updated' to the player. It is typically the horse entity that had its inventory opened. |
| inventory | nbt |
|
| Field Name | Field Type | Notes |
| package id | string | |
| max chunk size | lu32 | |
| chunk count | lu32 | |
| compressed package size | lu64 | |
| hash | ByteArray | |
| is premium | bool | |
| pack type | u8 |
| Field Name | Field Type | Notes |
| package id | string | |
| chunk index | lu32 | |
| progress | lu64 | |
| payload | ByteArray |
| Field Name | Field Type | Notes |
| package id | string | |
| chunk index | lu32 |
| Field Name | Field Type | Notes |
| server address | string | |
| port | lu16 |
| Field Name | Field Type | Notes |
| name | string | |
| coordinates | BlockCoordinates | |
| volume | lf32 | |
| pitch | lf32 |
| Field Name | Field Type | Notes |
| name | string | |
| stop all | bool |
| Field Name | Field Type | Notes |
| type | zigzag32 | |
| text | string | |
| fade in time | zigzag32 | |
| stay time | zigzag32 | |
| fade out time | zigzag32 |
| Field Name | Field Type | Notes |
| behaviortree | string |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| unknown0 | string | |
| unknown1 | bool |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| uuid | uuid | |
| skin | Skin | |
| skin name | string | |
| old skin name | string | |
| is verified | bool |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| server | string |
| Field Name | Field Type | Notes |
| unknown | varint |
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||
| type | u8 enum
| ||||||||||||||||||||||||||||||||||||||||
| slot | u8 | ||||||||||||||||||||||||||||||||||||||||
| 🔁 if type |
| ||||||||||||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| runtime entity id | varint | |
| unknown0 | u8 | |
| unknown1 | string | |
| unknown2 | u8 |
| Field Name | Field Type | Notes |
| file name | string | |
| image data | string | |
| unknown2 | string |
| Field Name | Field Type | Notes |
| form id | varint | |
| data | string |
| Field Name | Field Type | Notes |
| form id | varint | |
| data | string |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| form id | varint | |
| data | string |
| Field Name | Field Type | Notes |
| xuid | string |
SetDefaultGameType is sent by the client when it toggles the default game type in the settings UI, and is sent by the server when it actually changes the default game type, resulting in the toggle being changed in the settings UI.
| Field Name | Field Type | Notes |
| gamemode | GameMode | GameType is the new game type that is set. When sent by the client, this is the requested new default game type. |
| Field Name | Field Type | Notes |
| objective name | string |
| Field Name | Field Type | Notes |
| display slot | string | |
| objective name | string | |
| display name | string | |
| criteria name | string | |
| sort order | zigzag32 |
| Field Name | Field Type | Notes |
| entries | ScoreEntries |
LabTable is sent by the client to let the server know it started a chemical reaction in Education Edition, and is sent by the server to other clients to show the effects. The packet is only functional if Education features are enabled.
| Field Name | Field Type | Notes | ||||||
| action type | u8 enum
| |||||||
| position | vec3i | Position is the position at which the lab table used was located. | ||||||
| reaction type | u8 | ReactionType is the type of the reaction that took place as a result of the items put into the lab table. The reaction type can be either that of an item or a particle, depending on whatever the result was of the reaction. | ||||||
| Field Name | Field Type | Notes |
| coordinates | BlockCoordinates | |
| block runtime id | varint | |
| block priority | varint | |
| data layer id | varint | |
| unknown0 | varint | |
| unknown1 | varint |
MoveActorDelta is sent by the server to move an entity. The packet is specifically optimised to save as much space as possible, by only writing non-zero fields. As of 1.16.100, this packet no longer actually contains any deltas.
| Field Name | Field Type | Notes | |||
| runtime entity id | varint64 | EntityRuntimeID is the runtime ID of the entity that is being moved. The packet works provided a non-player entity with this runtime ID is present. | |||
| flags | DeltaMoveFlags | Flags is a list of flags that specify what data is in the packet. | |||
| x if flags.has x |
| ||||
| y if flags.has y |
| ||||
| z if flags.has z |
| ||||
| rot x if flags.has rot x |
| ||||
| rot y if flags.has rot y |
| ||||
| rot z if flags.has rot z |
| ||||
| Field Name | Field Type | Notes |
| entries | ScoreboardIdentityEntries |
SetLocalPlayerAsInitialised is sent by the client in response to a PlayStatus packet with the status set to spawn. The packet marks the moment at which the client is fully initialised and can receive any packet without discarding it.
| Field Name | Field Type | Notes |
| runtime entity id | varint64 | EntityRuntimeID is the entity runtime ID the player was assigned earlier in the login sequence in the StartGame packet. |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| timestamp | lu64 | |
| unknown flag | u8 |
| Field Name | Field Type | Notes |
| event name | string | |
| event data | string |
| Field Name | Field Type | Notes |
| dimension id | u8 | |
| entity id | zigzag64 | |
| position | vec3f | |
| particle name | string |
| Field Name | Field Type | Notes |
| nbt | nbt |
| Field Name | Field Type | Notes |
| sound id | u8 | |
| position | vec3f | |
| block id | zigzag32 | |
| entity type | string | |
| is baby mob | bool | |
| is global | bool |
| Field Name | Field Type | Notes |
| coordinates | BlockCoordinates | |
| radius | varint |
| Field Name | Field Type | Notes |
| nbt | nbt |
| Field Name | Field Type | Notes |
| sound id | varint | |
| position | vec3f | |
| block id | zigzag32 | |
| entity type | string | |
| is baby mob | bool | |
| is global | bool |
LevelEventGeneric is sent by the server to send a 'generic' level event to the client. This packet sends an NBT serialised object and may for that reason be used for any event holding additional data.
| Field Name | Field Type | Notes |
| event id | varint | EventID is a unique identifier that identifies the event called. The data that follows has fields in the NBT depending on what event it is. |
| nbt | nbtLoop | SerialisedEventData is a network little endian serialised object of event data, with fields that vary depending on EventID. Unlike many other NBT structures, this data is not actually in a compound but just loosely floating NBT tags. To decode using the nbt package, you would need to append 0x0a00 at the start (compound id and name length) and add 0x00 at the end, to manually wrap it in a compound. Likewise, you would have to remove these bytes when encoding. |
LecternUpdate is sent by the client to update the server on which page was opened in a book on a lectern, or if the book should be removed from it.
| Field Name | Field Type | Notes |
| page | u8 | Page is the page number in the book that was opened by the player on the lectern. |
| page count | u8 | PageCount is the number of pages that the book opened in the lectern has. |
| position | vec3i | Position is the position of the lectern that was updated. If no lectern is at the block position, the packet should be ignored. |
| drop book | bool | DropBook specifies if the book currently set on display in the lectern should be dropped server-side. |
| Field Name | Field Type | Notes |
| server uri | string | |
| frame send frequency | lf32 | |
| action | u8 | |
| resolution x | li32 | |
| resolution y | li32 |
This is NOT a Minecraft entity, but an entity in the Entity Component System (ECS) for the game engine Minecrat Bedrock uses. Internally, all 'Minecraft entities' are known as Actors including in packet names and fields. However, these are irrelevant internal details so we don't do the renames in these protocol definitions, for simplicity we just use Entity. AddEntity is sent by the server to the client. Its function is not entirely clear: It does not add an entity in the sense of an in-game entity, but has to do with the ECS that Minecraft uses.
| Field Name | Field Type | Notes |
| network id | varint64 | EntityNetworkID is the network ID of the entity that should be added. |
RemoveEntity is sent by the server to the client. Its function is not entirely clear: It does not remove an entity in the sense of an in-game entity, but has to do with the ECS that Minecraft uses
| Field Name | Field Type | Notes |
| network id | varint64 | EntityNetworkID is the network ID of the entity that should be removed. |
| Field Name | Field Type | Notes |
| enabled | bool |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| Field Name | Field Type | Notes |
| nbt | nbt |
ClientCacheBlobStatus is part of the blob cache protocol. It is sent by the client to let the server know what blobs it needs and which blobs it already has, in an ACK type system.
| Field Name | Field Type | Notes |
| misses | varint | The number of MISSes in this packet |
| haves | varint | The number of HITs in this packet |
| Length for missing below is misses from above | A list of blob hashes that the client does not have a blob available for. The server should send the blobs matching these hashes as soon as possible. | |
| missing array | lu64 | |
| Length for have below is haves from above | A list of hashes that the client does have a cached blob for. Server doesn't need to send. | |
| have array | lu64 | |
ClientCacheMissResponse is part of the blob cache protocol. It is sent by the server in response to a ClientCacheBlobStatus packet and contains the blob data of all blobs that the client acknowledged not to have yet.
| Field Name | Field Type | Notes |
| blobs length | varint | |
| blobs array | Blob |
EducationSettings is a packet sent by the server to update Minecraft: Education Edition related settings. It is unused by the normal base game.
| Field Name | Field Type | Notes | |||
| CodeBuilderDefaultURI | string | CodeBuilderDefaultURI is the default URI that the code builder is ran on. Using this, a Code Builder program can make code directly affect the server. | |||
| CodeBuilderTitle | string | CodeBuilderTitle is the title of the code builder shown when connected to the CodeBuilderDefaultURI. | |||
| CanResizeCodeBuilder | bool | CanResizeCodeBuilder specifies if clients connected to the world should be able to resize the code builder when it is opened. | |||
| HasOverrideURI | bool | ||||
| OverrideURI if HasOverrideURI |
| ||||
| HasQuiz | bool | HasQuiz specifies if the world has a quiz connected to it. | |||
Emote is sent by both the server and the client. When the client sends an emote, it sends this packet to the server, after which the server will broadcast the packet to other players online.
| Field Name | Field Type | Notes |
| entity id | varint64 | EntityRuntimeID is the entity that sent the emote. When a player sends this packet, it has this field set as its own entity runtime ID. |
| emote id | string | EmoteID is the ID of the emote to send. |
| flags | u8 | Flags is a combination of flags that change the way the Emote packet operates. When the server sends this packet to other players, EmoteFlagServerSide must be present. |
MultiPlayerSettings is sent by the client to update multi-player related settings server-side and sent back to online players by the server. The MultiPlayerSettings packet is a Minecraft: Education Edition packet. It has no functionality for the base game.
| Field Name | Field Type | Notes | |||||||||
| action type | zigzag32 enum
| ||||||||||
SettingsCommand is sent by the client when it changes a setting in the settings that results in the issuing of a command to the server, such as when Show Coordinates is enabled.
| Field Name | Field Type | Notes |
| command line | string | CommandLine is the full command line that was sent to the server as a result of the setting that the client changed. |
| suppress output | bool | SuppressOutput specifies if the client requests the suppressing of the output of the command that was executed. Generally this is set to true, as the client won't need a message to confirm the output of the change. |
AnvilDamage is sent by the client to request the dealing damage to an anvil. This packet is completely pointless and the server should never listen to it.
| Field Name | Field Type | Notes |
| damage | u8 | Damage is the damage that the client requests to be dealt to the anvil. |
| position | BlockCoordinates | AnvilPosition is the position in the world that the anvil can be found at. |
CompletedUsingItem is sent by the server to tell the client that it should be done using the item it is currently using.
| Field Name | Field Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||
| used item id | li16 | UsedItemID is the item ID of the item that the client completed using. This should typically be the ID of the item held in the hand. | |||||||||||||||||||||||||||||||||||||||||||||
| use method | li32 enum
| ||||||||||||||||||||||||||||||||||||||||||||||
NetworkSettings is sent by the server to update a variety of network settings. These settings modify the way packets are sent over the network stack.
| Field Name | Field Type | Notes |
| compression threshold | u16 | CompressionThreshold is the minimum size of a packet that is compressed when sent. If the size of a packet is under this value, it is not compressed. When set to 0, all packets will be left uncompressed. |
PlayerAuthInput is sent by the client to allow for server authoritative movement. It is used to synchronise the player input with the position server-side. The client sends this packet when the ServerAuthoritativeMovementMode field in the StartGame packet is set to true, instead of the MovePlayer packet. The client will send this packet once every tick.
| Field Name | Field Type | Notes | ||||||||||||||||||||||||||||||
| pitch | lf32 | Pitch that the player reports it has. | ||||||||||||||||||||||||||||||
| yaw | lf32 | Yaw that player reports it has. | ||||||||||||||||||||||||||||||
| position | vec3f | Position holds the position that the player reports it has. | ||||||||||||||||||||||||||||||
| move vector | vec2f | MoveVector is a Vec2 that specifies the direction in which the player moved, as a combination of X/Z values which are created using the WASD/controller stick state. | ||||||||||||||||||||||||||||||
| head yaw | lf32 | HeadYaw is the horizontal rotation of the head that the player reports it has. | ||||||||||||||||||||||||||||||
| input data | InputFlag | InputData is a combination of bit flags that together specify the way the player moved last tick. It is a combination of the flags above. | ||||||||||||||||||||||||||||||
| input mode | varint enum
| |||||||||||||||||||||||||||||||
| play mode | varint enum
| |||||||||||||||||||||||||||||||
| gaze direction if play mode |
| |||||||||||||||||||||||||||||||
| tick | varint64 | Tick is the server tick at which the packet was sent. It is used in relation to CorrectPlayerMovePrediction. | ||||||||||||||||||||||||||||||
| delta | vec3f | Delta was the delta between the old and the new position. There isn't any practical use for this field as it can be calculated by the server itself. | ||||||||||||||||||||||||||||||
| Field Name | Field Type | Notes |
| items | ItemStacks |
| Field Name | Field Type | Notes |
| enchant options | EnchantOptions |
| Field Name | Field Type | Notes |
| requests | ItemStackRequests |
| Field Name | Field Type | Notes |
| responses | ItemStackResponses |
PlayerArmourDamage is sent by the server to damage the armour of a player. It is a very efficient packet, but generally it's much easier to just send a slot update for the damaged armour.
| Field Name | Field Type | Notes | |||
| type | ArmorDamageType | Bitset holds a bitset of 4 bits that indicate which pieces of armour need to have damage dealt to them. The first bit, when toggled, is for a helmet, the second for the chestplate, the third for the leggings and the fourth for boots. | |||
| helmet damage if type.head |
| ||||
| chestplate damage if type.chest |
| ||||
| leggings damage if type.legs |
| ||||
| boots damage if types.feet |
| ||||
UpdatePlayerGameType is sent by the server to change the game mode of a player. It is functionally identical to the SetPlayerGameType packet.
| Field Name | Field Type | Notes |
| gamemode | GameMode | GameType is the new game type of the player. It is one of the constants that can be found in setplayergame_type.go. Some of these game types require additional flags to be set in an AdventureSettings packet for the game mode to obtain its full functionality. |
| player unique id | zigzag64 | PlayerUniqueID is the entity unique ID of the player that should have its game mode updated. If this packet is sent to other clients with the player unique ID of another player, nothing happens. |
EmoteList is sent by the client every time it joins the server and when it equips new emotes. It may be used by the server to find out which emotes the client has available. If the player has no emotes equipped, this packet is not sent. Under certain circumstances, this packet is also sent from the server to the client, but I was unable to find when this is done.
| Field Name | Field Type | Notes |
| player id | varint64 | PlayerRuntimeID is the runtime ID of the player that owns the emote pieces below. If sent by the client, this player runtime ID is always that of the player itself. |
| emote pieces length | varint | EmotePieces is a list of emote pieces that the player with the runtime ID above has. |
| emote pieces array | uuid |
PositionTrackingDBClientRequest is a packet sent by the client to request the position and dimension of a 'tracking ID'. These IDs are tracked in a database by the server. In 1.16, this is used for lodestones. The client will send this request to find the position a lodestone compass needs to point to. If found, it will point to the lodestone. If not, it will start spinning around. A PositionTrackingDBServerBroadcast packet should be sent in response to this packet.
| Field Name | Field Type | Notes | |||
| action | u8 enum
| ||||
| tracking id | zigzag32 | TrackingID is a unique ID used to identify the request. The server responds with a PositionTrackingDBServerBroadcast packet holding the same ID, so that the client can find out what that packet was in response to. | |||
PositionTrackingDBServerBroadcast is sent by the server in response to the PositionTrackingDBClientRequest packet. This packet is, as of 1.16, currently only used for lodestones. The server maintains a database with tracking IDs and their position and dimension. The client will request these tracking IDs, (NBT tag set on the lodestone compass with the tracking ID?) and the server will respond with the status of those tracking IDs. What is actually done with the data sent depends on what the client chooses to do with it. For the lodestone compass, it is used to make the compass point towards lodestones and to make it spin if the lodestone at a position is no longer there.
| Field Name | Field Type | Notes | |||||||||
| broadcast action | u8 enum
| ||||||||||
| tracking id | zigzag32 | TrackingID is the ID of the PositionTrackingDBClientRequest packet that this packet was in response to. The tracking ID is also present as the 'id' field in the SerialisedData field. | |||||||||
| nbt | nbt | ||||||||||
PacketViolationWarning is sent by the client when it receives an invalid packet from the server. It holds some information on the error that occurred.
| Field Name | Field Type | Notes | |||||||||
| violation type | zigzag32 enum
| ||||||||||
| severity | zigzag32 enum
| ||||||||||
| packet id | zigzag32 | PacketID is the ID of the invalid packet that was received. | |||||||||
| reason | string | ViolationContext holds a description on the violation of the packet. | |||||||||
MotionPredictionHints is sent by the server to the client. There is a predictive movement component for entities. This packet fills the "history" of that component and entity movement is computed based on the points. Vanilla sends this packet instead of the SetActorMotion packet when 'spatial optimisations' are enabled.
| Field Name | Field Type | Notes |
| entity runtime id | varint64 | EntityRuntimeID is the runtime ID of the entity whose velocity is sent to the client. |
| velocity | vec3f | Velocity is the server-calculated velocity of the entity at the point of sending the packet. |
| on ground | bool | OnGround specifies if the server currently thinks the entity is on the ground. |
AnimateEntity is sent by the server to animate an entity client-side. It may be used to play a single animation, or to activate a controller which can start a sequence of animations based on different conditions specified in an animation controller. Much of the documentation of this packet can be found at https://minecraft.gamepedia.com/BedrockEditionbetaanimationdocumentation.
| Field Name | Field Type | Notes |
| animation | string | Animation is the name of a single animation to start playing. |
| next state | string | NextState is the first state to start with. These states are declared in animation controllers (which, in themselves, are animations too). These states in turn may have animations and transitions to move to a next state. |
| stop condition | string | StopCondition is a MoLang expression that specifies when the animation should be stopped. |
| controller | string | Controller is the animation controller that is used to manage animations. These controllers decide when to play which animation. |
| blend out time | lf32 | BlendOutTime does not currently seem to be used. |
| runtime entity ids length | varint | EntityRuntimeIDs is list of runtime IDs of entities that the animation should be applied to. |
| runtime entity ids array | varint64 |
CameraShake is sent by the server to make the camera shake client-side. This feature was added for map- making partners.
| Field Name | Field Type | Notes |
| intensity | lf32 | Intensity is the intensity of the shaking. The client limits this value to 4, so anything higher may not work. |
| duration | lf32 | Duration is the number of seconds the camera will shake for. |
| type | u8 | Type is the type of shake, and is one of the constants listed above. The different type affects how the shake looks in game. |
PlayerFog is sent by the server to render the different fogs in the Stack. The types of fog are controlled by resource packs to change how they are rendered, and the ability to create custom fog.
| Field Name | Field Type | Notes |
| stack length | varint | Stack is a list of fog identifiers to be sent to the client. Examples of fog identifiers are "minecraft:fogocean" and "minecraft:foghell". |
| stack array | string |
CorrectPlayerMovePrediction is sent by the server if and only if StartGame.ServerAuthoritativeMovementMode is set to AuthoritativeMovementModeServerWithRewind. The packet is used to correct movement at a specific point in time.
| Field Name | Field Type | Notes |
| position | vec3f | Position is the position that the player is supposed to be at at the tick written in the field below. The client will change its current position based on movement after that tick starting from the Position. |
| delta | vec3f | Delta is the change in position compared to what the client sent as its position at that specific tick. |
| on ground | bool | OnGround specifies if the player was on the ground at the time of the tick below. |
| tick | varint64 | Tick is the tick of the movement which was corrected by this packet. |
ItemComponent is sent by the server to attach client-side components to a custom item.
| Field Name | Field Type | Notes |
| entries | ItemComponentList |
|
FilterText is sent by the both the client and the server. The client sends the packet to the server to allow the server to filter the text server-side. The server then responds with the same packet and the safer version of the text.
| Field Name | Field Type | Notes |
| text | string | Text is either the text from the client or the safer version of the text sent by the server. |
| from server | bool | FromServer indicates if the packet was sent by the server or not. |