minecraft-data 3.26.0 → 3.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/data.js +43 -1
  2. package/doc/history.md +8 -0
  3. package/minecraft-data/README.md +1 -1
  4. package/minecraft-data/data/bedrock/1.16.201/proto.yml +1 -1
  5. package/minecraft-data/data/bedrock/1.16.201/protocol.json +1 -1
  6. package/minecraft-data/data/bedrock/1.16.210/proto.yml +1 -1
  7. package/minecraft-data/data/bedrock/1.16.210/protocol.json +1 -1
  8. package/minecraft-data/data/bedrock/1.16.220/proto.yml +1 -1
  9. package/minecraft-data/data/bedrock/1.16.220/protocol.json +1 -1
  10. package/minecraft-data/data/bedrock/1.17.0/proto.yml +1 -1
  11. package/minecraft-data/data/bedrock/1.17.0/protocol.json +1 -1
  12. package/minecraft-data/data/bedrock/1.17.10/proto.yml +1 -1
  13. package/minecraft-data/data/bedrock/1.17.10/protocol.json +1 -1
  14. package/minecraft-data/data/bedrock/1.17.30/proto.yml +1 -1
  15. package/minecraft-data/data/bedrock/1.17.30/protocol.json +1 -1
  16. package/minecraft-data/data/bedrock/1.17.40/proto.yml +1 -1
  17. package/minecraft-data/data/bedrock/1.17.40/protocol.json +1 -1
  18. package/minecraft-data/data/bedrock/1.18.0/proto.yml +1 -1
  19. package/minecraft-data/data/bedrock/1.18.0/protocol.json +1 -1
  20. package/minecraft-data/data/bedrock/1.18.11/proto.yml +1 -1
  21. package/minecraft-data/data/bedrock/1.18.11/protocol.json +1 -1
  22. package/minecraft-data/data/bedrock/1.18.30/proto.yml +1 -1
  23. package/minecraft-data/data/bedrock/1.18.30/protocol.json +1 -1
  24. package/minecraft-data/data/bedrock/1.19.1/proto.yml +1 -1
  25. package/minecraft-data/data/bedrock/1.19.1/protocol.json +1 -1
  26. package/minecraft-data/data/bedrock/1.19.10/proto.yml +1 -1
  27. package/minecraft-data/data/bedrock/1.19.10/protocol.json +1 -1
  28. package/minecraft-data/data/bedrock/1.19.20/proto.yml +1 -1
  29. package/minecraft-data/data/bedrock/1.19.20/protocol.json +1 -1
  30. package/minecraft-data/data/bedrock/1.19.21/proto.yml +1 -1
  31. package/minecraft-data/data/bedrock/1.19.21/protocol.json +1 -1
  32. package/minecraft-data/data/bedrock/1.19.30/proto.yml +1 -1
  33. package/minecraft-data/data/bedrock/1.19.30/protocol.json +1 -1
  34. package/minecraft-data/data/bedrock/1.19.40/proto.yml +1 -1
  35. package/minecraft-data/data/bedrock/1.19.40/protocol.json +1 -1
  36. package/minecraft-data/data/bedrock/1.19.50/proto.yml +3826 -0
  37. package/minecraft-data/data/bedrock/1.19.50/protocol.json +1 -1
  38. package/minecraft-data/data/bedrock/1.19.50/types.yml +2038 -0
  39. package/minecraft-data/data/bedrock/1.19.60/proto.yml +3850 -0
  40. package/minecraft-data/data/bedrock/1.19.60/protocol.json +11061 -0
  41. package/minecraft-data/data/bedrock/1.19.60/types.yml +2062 -0
  42. package/minecraft-data/data/bedrock/1.19.60/version.json +6 -0
  43. package/minecraft-data/data/bedrock/1.19.62/protocol.json +11065 -0
  44. package/minecraft-data/data/bedrock/1.19.62/version.json +6 -0
  45. package/minecraft-data/data/bedrock/common/protocolVersions.json +12 -0
  46. package/minecraft-data/data/bedrock/common/versions.json +3 -1
  47. package/minecraft-data/data/bedrock/latest/proto.yml +29 -5
  48. package/minecraft-data/data/bedrock/latest/types.yml +25 -0
  49. package/minecraft-data/data/dataPaths.json +43 -1
  50. package/minecraft-data/data/pc/1.19.3/protocol.json +21 -25
  51. package/minecraft-data/doc/history.md +7 -0
  52. package/package.json +1 -1
@@ -0,0 +1,3826 @@
1
+ # Created from MiNET and gophertunnel docs
2
+ # The version below is the latest version this protocol schema was updated for.
3
+ # The output protocol.json will be in the folder for the version
4
+ !version: 1.19.50
5
+
6
+ # Some ProtoDef aliases
7
+ string: ["pstring",{"countType":"varint"}] # String / array types
8
+ ByteArray: ["buffer",{"countType":"varint"}]
9
+ SignedByteArray: ["buffer",{"countType":"zigzag32"}]
10
+ LittleString: ["pstring",{"countType":"li32"}]
11
+ ShortArray: ["buffer",{"countType":"li16"}]
12
+ varint64: native # Some primitives
13
+ zigzag32: native
14
+ zigzag64: native
15
+ uuid: native # Data types & special handling
16
+ byterot: native
17
+ bitflags: native
18
+ restBuffer: native
19
+ encapsulated: native
20
+ nbt: native # NBT
21
+ lnbt: native
22
+ nbtLoop: native
23
+ enum_size_based_on_values_len: native # Packet-specific custom logic
24
+ MapInfo: native
25
+
26
+ # load the packet map file (auto-generated)
27
+ !import: packet_map.yml
28
+
29
+ !StartDocs: Packets
30
+
31
+ # # Login Sequence
32
+ # The login process is as follows:
33
+ #
34
+ # * C→S: [Login](#packet_login)
35
+ # * S→C: [Server To Client Handshake](#packet_server_to_client_handshake)
36
+ # * C→S: [Client To Server Handshake](#packet_client_to_server_handshake)
37
+ # * S→C: [Play Status (Login success)](#packet_play_status)
38
+ # * To spawn, the following packets should be sent, in order, after the ones above:
39
+ # * S→C: [Resource Packs Info](#packet_resource_packs_info)
40
+ # * C→S: [Resource Pack Client Response](#packet_resource_pack_client_response)
41
+ # * S→C: [Resource Pack Stack](#packet_resource_pack_stack)
42
+ # * C→S: [Resource Pack Client Response](#packet_resource_pack_client_response)
43
+ # * S→C: [Start Game](#packet_start_game)
44
+ # * S→C: [Creative Content](#packet_creative_content)
45
+ # * S→C: [Biome Definition List](#packet_biome_definition_list)
46
+ # * S→C: [Chunks](#packet_level_chunk)
47
+ # * S→C: [Play Status (Player spawn)](#packet_play_status)
48
+ #
49
+ # If there are no resource packs being sent, a Resource Pack Stack can be sent directly
50
+ # after Resource Packs Info to avoid the client responses.
51
+ #
52
+ # ===
53
+
54
+ packet_login:
55
+ !id: 0x01
56
+ !bound: server
57
+ # Protocol version (Big Endian!)
58
+ protocol_version: i32
59
+ tokens: '["encapsulated", { "lengthType": "varint", "type": "LoginTokens" }]'
60
+
61
+ LoginTokens:
62
+ # JSON array of JWT data: contains the display name, UUID and XUID
63
+ # It should be signed by the Mojang public key
64
+ identity: LittleString
65
+ # Skin related data
66
+ client: LittleString
67
+
68
+ packet_play_status:
69
+ !id: 0x02
70
+ !bound: client
71
+ status: i32 =>
72
+ # Sent after Login has been successfully decoded and the player has logged in
73
+ 0: login_success
74
+ # Displays "Could not connect: Outdated client!"
75
+ 1: failed_client
76
+ # Displays "Could not connect: Outdated server!"
77
+ 2: failed_spawn
78
+ # Sent after world data to spawn the player
79
+ 3: player_spawn
80
+ # Displays "Unable to connect to world. Your school does not have access to this server."
81
+ 4: failed_invalid_tenant
82
+ # Displays "The server is not running Minecraft: Education Edition. Failed to connect."
83
+ 5: failed_vanilla_edu
84
+ # Displays "The server is running an incompatible edition of Minecraft. Failed to connect."
85
+ 6: failed_edu_vanilla
86
+ # Displays "Wow this server is popular! Check back later to see if space opens up. Server Full"
87
+ 7: failed_server_full
88
+ # Cannot join a vanilla game on editor
89
+ 8: failed_editor_vanilla_mismatch
90
+ # Cannot join an editor game on vanilla
91
+ 9: failed_vanilla_editor_mismatch
92
+
93
+
94
+ packet_server_to_client_handshake:
95
+ !id: 0x03
96
+ !bound: client
97
+ # Contains the salt to complete the Diffie-Hellman key exchange
98
+ token: string
99
+
100
+
101
+ # Sent by the client in response to a Server To Client Handshake packet
102
+ # sent by the server. It is the first encrypted packet in the login handshake
103
+ # and serves as a confirmation that encryption is correctly initialized client side.
104
+ # It has no fields.
105
+ packet_client_to_server_handshake:
106
+ !id: 0x04
107
+ !bound: server
108
+
109
+ # Sent by the server to disconnect a client.
110
+ packet_disconnect:
111
+ !id: 0x05
112
+ !bound: client
113
+ # Specifies if the disconnection screen should be hidden when the client is disconnected,
114
+ # meaning it will be sent directly to the main menu.
115
+ hide_disconnect_reason: bool
116
+ # An optional message to show when disconnected.
117
+ message: string
118
+
119
+
120
+ packet_resource_packs_info:
121
+ !id: 0x06
122
+ !bound: client
123
+ # If the resource pack requires the client accept it.
124
+ must_accept: bool
125
+ # If scripting is enabled.
126
+ has_scripts: bool
127
+ # ForcingServerPacks is currently an unclear field.
128
+ force_server_packs: bool
129
+ # A list of behaviour packs that the client needs to download before joining the server.
130
+ # All of these behaviour packs will be applied together.
131
+ behaviour_packs: BehaviourPackInfos
132
+ # A list of resource packs that the client needs to download before joining the server.
133
+ # The order of these resource packs is not relevant in this packet. It is however important in the Resource Pack Stack packet.
134
+ texture_packs: TexturePackInfos
135
+
136
+ packet_resource_pack_stack:
137
+ !id: 0x07
138
+ !bound: client
139
+ # If the resource pack must be accepted for the player to join the server.
140
+ must_accept: bool
141
+ # [inline]
142
+ behavior_packs: ResourcePackIdVersions
143
+ # [inline]
144
+ resource_packs: ResourcePackIdVersions
145
+ game_version: string
146
+ experiments: Experiments # ??? such random fields
147
+ experiments_previously_used: bool
148
+
149
+ packet_resource_pack_client_response:
150
+ !id: 0x08
151
+ !bound: server
152
+ response_status: u8 =>
153
+ 0: none
154
+ 1: refused
155
+ 2: send_packs
156
+ 3: have_all_packs
157
+ 4: completed
158
+ # All of the pack IDs.
159
+ resourcepackids: ResourcePackIds
160
+
161
+ # Sent by the client to the server to send chat messages, and by the server to the client
162
+ # to forward or send messages, which may be chat, popups, tips etc.
163
+ ## https://github.com/pmmp/PocketMine-MP/blob/a43b46a93cb127f037c879b5d8c29cda251dd60c/src/pocketmine/network/mcpe/protocol/TextPacket.php
164
+ ## https://github.com/Sandertv/gophertunnel/blob/05ac3f843dd60d48b9ca0ab275cda8d9e85d8c43/minecraft/protocol/packet/text.go
165
+ packet_text:
166
+ !id: 0x09
167
+ !bound: both
168
+ # TextType is the type of the text sent. When a client sends this to the server, it should always be
169
+ # TextTypeChat. If the server sends it, it may be one of the other text types above.
170
+ type: u8 =>
171
+ 0: raw
172
+ 1: chat
173
+ 2: translation
174
+ 3: popup
175
+ 4: jukebox_popup
176
+ 5: tip
177
+ 6: system
178
+ 7: whisper
179
+ 8: announcement
180
+ 9: json_whisper
181
+ 10: json
182
+ 11: json_announcement
183
+ # NeedsTranslation specifies if any of the messages need to be translated. It seems that where % is found
184
+ # in translatable text types, these are translated regardless of this bool. Translatable text types
185
+ # include TextTypeTip, TextTypePopup and TextTypeJukeboxPopup.
186
+ needs_translation: bool
187
+ _: type?
188
+ if chat or whisper or announcement:
189
+ source_name: string
190
+ message: string
191
+ if raw or tip or system or json_whisper or json or json_announcement:
192
+ message: string
193
+ if translation or popup or jukebox_popup:
194
+ message: string
195
+ parameters: string[]varint
196
+ # The XUID of the player who sent this message.
197
+ xuid: string
198
+ # PlatformChatID is an identifier only set for particular platforms when chatting (presumably only for
199
+ # Nintendo Switch). It is otherwise an empty string, and is used to decide which players are able to
200
+ # chat with each other.
201
+ platform_chat_id: string
202
+ # For additional information and examples of all the chat types above, see here: https://imgur.com/a/KhcFscg
203
+
204
+
205
+ # Sent by the server to update the current time client-side. The client actually advances time
206
+ # client-side by itself, so this packet does not need to be sent each tick. It is merely a means
207
+ # of synchronizing time between server and client.
208
+ packet_set_time:
209
+ !id: 0x0a
210
+ !bound: client
211
+ # Time is the current time. The time is not limited to 24000 (time of day), but continues
212
+ # progressing after that.
213
+ time: zigzag32
214
+
215
+ # Sent by the server to send information about the world the player will be spawned in.
216
+ packet_start_game:
217
+ !id: 0x0b
218
+ !bound: client
219
+ # The unique ID of the player. The unique ID is a value that remains consistent across
220
+ # different sessions of the same world, but most unofficial servers simply fill the
221
+ # runtime ID of the entity out for this field.
222
+ entity_id: zigzag64
223
+ # The runtime ID of the player. The runtime ID is unique for each world session,
224
+ # and entities are generally identified in packets using this runtime ID.
225
+ runtime_entity_id: varint64
226
+ # PlayerGameMode is the game mode the player currently has. It is a value from 0-4, with 0 being
227
+ # survival mode, 1 being creative mode, 2 being adventure mode, 3 being survival spectator and 4 being
228
+ # creative spectator.
229
+ # This field may be set to 5 to make the client fall back to the game mode set in the WorldGameMode
230
+ # field.
231
+ player_gamemode: GameMode
232
+ # The spawn position of the player in the world. In servers this is often the same as the
233
+ # world's spawn position found below.
234
+ player_position: vec3f
235
+ # The pitch and yaw of the player
236
+ rotation: vec2f
237
+ # The seed used to generate the world.
238
+ seed: lu64
239
+ biome_type: li16
240
+ biome_name: string
241
+ # Dimension is the ID of the dimension that the player spawns in. It is a value from 0-2,
242
+ # with 0 being the overworld, 1 being the nether and 2 being the end.
243
+ dimension: zigzag32 =>
244
+ 0: overworld
245
+ 1: nether
246
+ 2: end
247
+ # Generator is the generator used for the world. It is a value from 0-4, with 0 being old
248
+ # limited worlds, 1 being infinite worlds, 2 being flat worlds, 3 being nether worlds and
249
+ # 4 being end worlds. A value of 0 will actually make the client stop rendering chunks you
250
+ # send beyond the world limit.
251
+ generator: zigzag32
252
+ # The world game mode that a player gets when it first spawns in the world. It is shown in the
253
+ # settings and is used if the Player Gamemode is set to 5.
254
+ world_gamemode: GameMode
255
+ # Difficulty is the difficulty of the world. It is a value from 0-3, with 0 being peaceful,
256
+ # 1 being easy, 2 being normal and 3 being hard.
257
+ difficulty: zigzag32
258
+ # The block on which the world spawn of the world. This coordinate has no effect on the place
259
+ # that the client spawns, but it does have an effect on the direction that a compass poInts.
260
+ spawn_position: BlockCoordinates
261
+ # Defines if achievements are disabled in the world. The client crashes if this value is set
262
+ # to true while the player's or the world's game mode is creative, and it's recommended to simply
263
+ # always set this to false as a server.
264
+ achievements_disabled: bool
265
+ # EditorWorld is a value to dictate if the world is in editor mode, a special mode recently introduced adding
266
+ # "powerful tools for editing worlds, intended for experienced creators."
267
+ editor_world: bool
268
+ # The time at which the day cycle was locked if the day cycle is disabled using the respective
269
+ # game rule. The client will maIntain this time as Boolean as the day cycle is disabled.
270
+ day_cycle_stop_time: zigzag32
271
+ # Some Minecraft: Education Edition field that specifies what 'region' the world was from,
272
+ # with 0 being None, 1 being RestOfWorld, and 2 being China. The actual use of this field is unknown.
273
+ edu_offer: zigzag32
274
+ # Specifies if the world has education edition features enabled, such as the blocks or entities
275
+ # specific to education edition.
276
+ edu_features_enabled: bool
277
+ edu_product_uuid: string
278
+ # The level specifying the Intensity of the rain falling. When set to 0, no rain falls at all.
279
+ rain_level: lf32
280
+ lightning_level: lf32
281
+ # The level specifying the Intensity of the thunder. This may actually be set independently
282
+ # from the rain level, meaning dark clouds can be produced without rain.
283
+ has_confirmed_platform_locked_content: bool
284
+ # Specifies if the world is a multi-player game. This should always be set to true for servers.
285
+ is_multiplayer: bool
286
+ # Specifies if LAN broadcast was Intended to be enabled for the world.
287
+ broadcast_to_lan: bool
288
+ # The mode used to broadcast the joined game across XBOX Live.
289
+ xbox_live_broadcast_mode: varint
290
+ # The mode used to broadcast the joined game across the platform.
291
+ platform_broadcast_mode: varint
292
+ # If commands are enabled for the player. It is recommended to always set this to true on the
293
+ # server, as setting it to false means the player cannot, under any circumstance, use a command.
294
+ enable_commands: bool
295
+ # Specifies if the texture pack the world might hold is required, meaning the client was
296
+ # forced to download it before joining.
297
+ is_texturepacks_required: bool
298
+ # Defines game rules currently active with their respective values. The value of these game
299
+ # rules may be either 'bool', 'Int32' or 'Float32'. Some game rules are server side only,
300
+ # and don't necessarily need to be sent to the client.
301
+ gamerules: GameRules
302
+ experiments: Experiments
303
+ experiments_previously_used: bool
304
+ # Specifies if the world had the bonus map setting enabled when generating it.
305
+ # It does not have any effect client-side.
306
+ bonus_chest: bool
307
+ # Specifies if the world has the start with map setting enabled, meaning each
308
+ # joining player obtains a map. This should always be set to false, because the
309
+ # client obtains a map all on its own accord if this is set to true.
310
+ map_enabled: bool
311
+ # The permission level of the player. It is a value from 0-3, with 0 being visitor,
312
+ # 1 being member, 2 being operator and 3 being custom.
313
+ permission_level: PermissionLevel
314
+ # The radius around the player in which chunks are ticked. Most servers set this value
315
+ # to a fixed number, as it does not necessarily affect anything client-side.
316
+ server_chunk_tick_range: li32
317
+ # Specifies if the texture pack of the world is locked, meaning it cannot be disabled
318
+ # from the world. This is typically set for worlds on the marketplace that have a dedicated
319
+ # texture pack.
320
+ has_locked_behavior_pack: bool
321
+ # Specifies if the texture pack of the world is locked, meaning it cannot be disabled from the
322
+ # world. This is typically set for worlds on the marketplace that have a dedicated texture pack.
323
+ has_locked_resource_pack: bool
324
+ # Specifies if the world from the server was from a locked world template.
325
+ # For servers this should always be set to false.
326
+ is_from_locked_world_template: bool
327
+ msa_gamertags_only: bool
328
+ # Specifies if the world from the server was from a locked world template.
329
+ # For servers this should always be set to false.
330
+ is_from_world_template: bool
331
+ # Specifies if the world was a template that locks all settings that change properties
332
+ # above in the settings GUI. It is recommended to set this to true for servers that
333
+ # do not allow things such as setting game rules through the GUI.
334
+ is_world_template_option_locked: bool
335
+ # A hack that Mojang put in place to preserve backwards compatibility with old villagers.
336
+ # The his never actually read though, so it has no functionality.
337
+ only_spawn_v1_villagers: bool
338
+ # PersonaDisabled is true if persona skins are disabled for the current game session.
339
+ persona_disabled: bool
340
+ # CustomSkinsDisabled is true if custom skins are disabled for the current game session.
341
+ custom_skins_disabled: bool
342
+ # The version of the game from which Vanilla features will be used.
343
+ # The exact function of this field isn't clear.
344
+ game_version: string
345
+ limited_world_width: li32
346
+ limited_world_length: li32
347
+ is_new_nether: bool
348
+ edu_resource_uri: EducationSharedResourceURI
349
+ experimental_gameplay_override: bool
350
+ # ChatRestrictionLevel specifies the level of restriction on in-game chat.
351
+ chat_restriction_level: u8 =>
352
+ 0: none
353
+ 1: dropped
354
+ 2: disabled
355
+ # DisablePlayerInteractions is true if the client should ignore other players when interacting with the world.
356
+ disable_player_interactions: bool
357
+ # A base64 encoded world ID that is used to identify the world.
358
+ level_id: string
359
+ # The name of the world that the player is joining. Note that this field shows up
360
+ # above the player list for the rest of the game session, and cannot be changed.
361
+ # Setting the server name to this field is recommended.
362
+ world_name: string
363
+ # A UUID specific to the premium world template that might have been used to
364
+ # generate the world. Servers should always fill out an empty String for this.
365
+ premium_world_template_id: string
366
+ # Specifies if the world was a trial world, meaning features are limited and there
367
+ # is a time limit on the world.
368
+ is_trial: bool
369
+
370
+ # MovementType specifies the way the server handles player movement. Available options are
371
+ # packet.AuthoritativeMovementModeClient, packet.AuthoritativeMovementModeServer and
372
+ # packet.AuthoritativeMovementModeServerWithRewind, where server the server authoritative types result
373
+ # in the client sending PlayerAuthInput packets instead of MovePlayer packets and the rewind mode
374
+ # requires sending the tick of movement and several actions.
375
+ #
376
+ # Specifies if the client or server is authoritative over the movement of the player,
377
+ # meaning it controls the movement of it.
378
+ ## https://github.com/pmmp/PocketMine-MP/blob/a43b46a93cb127f037c879b5d8c29cda251dd60c/src/pocketmine/network/mcpe/protocol/types/PlayerMovementType.php#L26
379
+ movement_authority: zigzag32 =>
380
+ 0: client
381
+ 1: server
382
+ # PlayerAuthInputPacket + a bunch of junk that solves a nonexisting problem
383
+ 2: server_with_rewind
384
+ # RewindHistorySize is the amount of history to keep at maximum if MovementType is
385
+ # packet.AuthoritativeMovementModeServerWithRewind.
386
+ rewind_history_size: zigzag32
387
+ # ServerAuthoritativeBlockBreaking specifies if block breaking should be sent through
388
+ # packet.PlayerAuthInput or not. This field is somewhat redundant as it is always enabled if
389
+ # MovementType is packet.AuthoritativeMovementModeServer or
390
+ # packet.AuthoritativeMovementModeServerWithRewind
391
+ server_authoritative_block_breaking: bool
392
+
393
+ # The total time in ticks that has elapsed since the start of the world.
394
+ current_tick: li64
395
+ # The seed used to seed the random used to produce enchantments in the enchantment table.
396
+ # Note that the exact correct random implementation must be used to produce the correct
397
+ # results both client- and server-side.
398
+ enchantment_seed: zigzag32
399
+
400
+ # BlockProperties is a list of all the custom blocks registered on the server.
401
+ block_properties: BlockProperties
402
+ # A list of all items with their legacy IDs which are available in the game.
403
+ # Failing to send any of the items that are in the game will crash mobile clients.
404
+ itemstates: Itemstates
405
+ # A unique ID specifying the multi-player session of the player.
406
+ # A random UUID should be filled out for this field.
407
+ multiplayer_correlation_id: string
408
+ # ServerAuthoritativeInventory specifies if the server authoritative inventory system is enabled. This
409
+ # is a new system introduced in 1.16. Backwards compatibility with the inventory transactions has to
410
+ # some extent been preserved, but will eventually be removed.
411
+ server_authoritative_inventory: bool
412
+ # The server's engine version, used for telemetry
413
+ engine: string
414
+ # PropertyData contains properties that should be applied on the player. These properties are the same as the
415
+ # ones that are sent in the SyncActorProperty packet.
416
+ property_data: nbt
417
+ # A checksum to ensure block types between the server and client match
418
+ block_pallette_checksum: lu64
419
+ # WorldTemplateID is a UUID that identifies the template that was used to generate the world. Servers that do not
420
+ # use a world based off of a template can set this to an empty UUID.
421
+ world_template_id: uuid
422
+ # ClientSideGeneration is true if the client should use the features registered in the FeatureRegistry packet to
423
+ # generate terrain client-side to save on bandwidth.
424
+ client_side_generation: bool
425
+
426
+ packet_add_player:
427
+ !id: 0x0c
428
+ !bound: client
429
+ # UUID is the UUID of the player. It is the same UUID that the client sent in the
430
+ # Login packet at the start of the session. A player with this UUID must exist
431
+ # in the player list (built up using the Player List packet) for it to show up in-game.
432
+ uuid: uuid
433
+ # Username is the name of the player. This username is the username that will be
434
+ # set as the initial name tag of the player.
435
+ username: string
436
+ # The runtime ID of the player. The runtime ID is unique for each world session,
437
+ # and entities are generally identified in packets using this runtime ID.
438
+ runtime_id: varint64
439
+ # An identifier only set for particular platforms when chatting (presumably only for
440
+ # Nintendo Switch). It is otherwise an empty string, and is used to decide which players
441
+ # are able to chat with each other.
442
+ platform_chat_id: string
443
+ # Position is the position to spawn the player on. If the player is on a distance that the viewer cannot
444
+ # see it, the player will still show up if the viewer moves closer.
445
+ position: vec3f
446
+ # Velocity is the initial velocity the player spawns with. This velocity will initiate client side
447
+ # movement of the player.
448
+ velocity: vec3f
449
+ # Pitch is the vertical rotation of the player. Facing straight forward yields a pitch of 0. Pitch is
450
+ # measured in degrees.
451
+ pitch: lf32
452
+ # Yaw is the horizontal rotation of the player. Yaw is also measured in degrees.
453
+ yaw: lf32
454
+ # HeadYaw is the same as Yaw, except that it applies specifically to the head of the player. A different
455
+ # value for HeadYaw than Yaw means that the player will have its head turned.
456
+ head_yaw: lf32
457
+ # HeldItem is the item that the player is holding. The item is shown to the viewer as soon as the player
458
+ # itself shows up. Needless to say that this field is rather pointless, as additional packets still must
459
+ # be sent for armour to show up.
460
+ held_item: Item
461
+ # GameType is the game type of the player. If set to GameTypeSpectator, the player will not be shown to viewers.
462
+ gamemode: GameMode
463
+ # EntityMetadata is a map of entity metadata, which includes flags and data properties that alter in
464
+ # particular the way the player looks. Flags include ones such as 'on fire' and 'sprinting'.
465
+ # The metadata values are indexed by their property key.
466
+ metadata: MetadataDictionary
467
+ # EntityProperties holds lists of entity properties that define specific attributes of an entity. As of v1.19.40, the
468
+ # vanilla server does not use these properties, however they are still supported by the protocol.
469
+ properties: EntityProperties
470
+ # The unique ID of the player. The unique ID is a value that remains consistent
471
+ # across different sessions of the same world, but most unoffical servers simply
472
+ # fill the runtime ID of the player out for this field.
473
+ unique_id: li64
474
+ permission_level: PermissionLevel
475
+ command_permission: CommandPermissionLevel
476
+ # AbilityLayer represents the abilities of a specific layer, such as the base layer or the spectator layer.
477
+ abilities: AbilityLayers[]u8
478
+ # EntityLinks is a list of entity links that are currently active on the player. These links alter the
479
+ # way the player shows up when first spawned in terms of it shown as riding an entity. Setting these
480
+ # links is important for new viewers to see the player is riding another entity.
481
+ links: Links
482
+ # DeviceID is the device ID set in one of the files found in the storage of the device of the player. It
483
+ # may be changed freely, so it should not be relied on for anything.
484
+ device_id: string
485
+ # BuildPlatform is the build platform/device OS of the player that is about to be added, as it sent in
486
+ # the Login packet when joining.
487
+ device_os: DeviceOS
488
+
489
+ packet_add_entity:
490
+ !id: 0x0d
491
+ !bound: client
492
+ # EntityUniqueID is the unique ID of the entity. The unique ID is a value that remains consistent across
493
+ # different sessions of the same world, but most servers simply fill the runtime ID of the entity out for
494
+ unique_id: zigzag64
495
+ # EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
496
+ # entities are generally identified in packets using this runtime ID.
497
+ runtime_id: varint64
498
+ # EntityType is the string entity type of the entity, for example 'minecraft:skeleton'. A list of these
499
+ # entities may be found online.
500
+ entity_type: string
501
+ # Position is the position to spawn the entity on. If the entity is on a distance that the player cannot
502
+ # see it, the entity will still show up if the player moves closer.
503
+ position: vec3f
504
+ # Velocity is the initial velocity the entity spawns with. This velocity will initiate client side
505
+ # movement of the entity.
506
+ velocity: vec3f
507
+ # Pitch is the vertical rotation of the entity. Facing straight forward yields a pitch of 0. Pitch is
508
+ # measured in degrees.
509
+ pitch: lf32
510
+ # Yaw is the horizontal rotation of the entity. Yaw is also measured in degrees.
511
+ yaw: lf32
512
+ # HeadYaw is the same as Yaw, except that it applies specifically to the head of the entity. A different value for
513
+ # HeadYaw than Yaw means that the entity will have its head turned.
514
+ head_yaw: lf32
515
+ # BodyYaw is the same as Yaw, except that it applies specifically to the body of the entity. A different value for
516
+ # BodyYaw than HeadYaw means that the entity will have its body turned, although it is unclear what the difference
517
+ # between BodyYaw and Yaw is.
518
+ body_yaw: lf32
519
+ # Attributes is a slice of attributes that the entity has. It includes attributes such as its health,
520
+ # movement speed, etc.
521
+ attributes: EntityAttributes
522
+ # EntityMetadata is a map of entity metadata, which includes flags and data properties that alter in
523
+ # particular the way the entity looks. Flags include ones such as 'on fire' and 'sprinting'.
524
+ # The metadata values are indexed by their property key.
525
+ metadata: MetadataDictionary
526
+ # EntityProperties holds lists of entity properties that define specific attributes of an entity. As of v1.19.40, the
527
+ # vanilla server does not use these properties, however they are still supported by the protocol.
528
+ properties: EntityProperties
529
+ # EntityLinks is a list of entity links that are currently active on the entity. These links alter the
530
+ # way the entity shows up when first spawned in terms of it shown as riding an entity. Setting these
531
+ # links is important for new viewers to see the entity is riding another entity.
532
+ links: Links
533
+
534
+ packet_remove_entity:
535
+ !id: 0x0e
536
+ !bound: client
537
+ entity_id_self: zigzag64
538
+
539
+ packet_add_item_entity:
540
+ !id: 0x0f
541
+ !bound: client
542
+ entity_id_self: zigzag64
543
+ runtime_entity_id: varint64
544
+ item: Item
545
+ position: vec3f
546
+ velocity: vec3f
547
+ metadata: MetadataDictionary
548
+ is_from_fishing: bool
549
+
550
+ packet_take_item_entity:
551
+ !id: 0x11
552
+ !bound: client
553
+ runtime_entity_id: varint64
554
+ target: varint
555
+
556
+ # MoveActorAbsolute is sent by the server to move an entity to an absolute position. It is typically used
557
+ # for movements where high accuracy isn't needed, such as for long range teleporting.
558
+ packet_move_entity:
559
+ !id: 0x12
560
+ !bound: both
561
+ # EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
562
+ # entities are generally identified in packets using this runtime ID.
563
+ runtime_entity_id: varint64
564
+ # Flags is a combination of flags that specify details of the movement. It is a combination of the flags
565
+ # above.
566
+ flags: u8
567
+ # Position is the position to spawn the entity on. If the entity is on a distance that the player cannot
568
+ # see it, the entity will still show up if the player moves closer.
569
+ position: vec3f
570
+ # Rotation is a Vec3 holding the X, Y and Z rotation of the entity after the movement. This is a Vec3 for
571
+ # the reason that projectiles like arrows don't have yaw/pitch, but do have roll.
572
+ rotation: Rotation
573
+
574
+ # MovePlayer is sent by players to send their movement to the server, and by the server to update the
575
+ # movement of player entities to other players.
576
+ packet_move_player:
577
+ !id: 0x13
578
+ !bound: both
579
+ # EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and
580
+ # entities are generally identified in packets using this runtime ID.
581
+ runtime_id: varint
582
+ # Position is the position to spawn the player on. If the player is on a distance that the viewer cannot
583
+ # see it, the player will still show up if the viewer moves closer.
584
+ position: vec3f
585
+ # Pitch is the vertical rotation of the player. Facing straight forward yields a pitch of 0. Pitch is
586
+ # measured in degrees.
587
+ pitch: lf32
588
+ # Yaw is the horizontal rotation of the player. Yaw is also measured in degrees
589
+ yaw: lf32
590
+ # HeadYaw is the same as Yaw, except that it applies specifically to the head of the player. A different
591
+ # value for HeadYaw than Yaw means that the player will have its head turned
592
+ head_yaw: lf32
593
+ # Mode is the mode of the movement. It specifies the way the player's movement should be shown to other
594
+ # players. It is one of the constants below.
595
+ mode: u8 =>
596
+ 0: normal
597
+ 1: reset
598
+ 2: teleport
599
+ 3: rotation
600
+ # OnGround specifies if the player is considered on the ground. Note that proxies or hacked clients could
601
+ # fake this to always be true, so it should not be taken for granted.
602
+ on_ground: bool
603
+ # RiddenEntityRuntimeID is the runtime ID of the entity that the player might currently be riding. If not
604
+ # riding, this should be left 0.
605
+ ridden_runtime_id: varint
606
+ teleport: mode ?
607
+ if teleport:
608
+ # TeleportCause is written only if Mode is MoveModeTeleport. It specifies the cause of the teleportation,
609
+ # which is one of the constants above.
610
+ cause: li32 =>
611
+ 0: unknown
612
+ 1: projectile
613
+ 2: chorus_fruit
614
+ 3: command
615
+ 4: behavior
616
+ # TeleportSourceEntityType is the entity type that caused the teleportation, for example an ender pearl.
617
+ # TODO: is this still a integer and not a string?
618
+ source_entity_type: LegacyEntityType
619
+ tick: varint64
620
+
621
+ packet_rider_jump:
622
+ !id: 0x14
623
+ !bound: both
624
+ jump_strength: zigzag32
625
+
626
+ # UpdateBlock is sent by the server to update a block client-side, without resending the entire chunk that
627
+ # the block is located in. It is particularly useful for small modifications like block breaking/placing.
628
+ packet_update_block:
629
+ !id: 0x15
630
+ !bound: client
631
+ # Position is the block position at which a block is updated.
632
+ position: BlockCoordinates
633
+ # NewBlockRuntimeID is the runtime ID of the block that is placed at Position after sending the packet
634
+ # to the client.
635
+ block_runtime_id: varint
636
+ # Flags is a combination of flags that specify the way the block is updated client-side. It is a
637
+ # combination of the flags above, but typically sending only the BlockUpdateNetwork flag is sufficient.
638
+ flags: UpdateBlockFlags
639
+ # Layer is the world layer on which the block is updated. For most blocks, this is the first layer, as
640
+ # that layer is the default layer to place blocks on, but for blocks inside of each other, this differs.
641
+ layer: varint
642
+
643
+
644
+ UpdateBlockFlags: [ "bitflags",
645
+ {
646
+ "type": "varint",
647
+ "flags": {
648
+ "neighbors": 1,
649
+ "network": 2,
650
+ "no_graphic": 0b100,
651
+ "unused": 0b1000,
652
+ "priority": 0b10000,
653
+ }
654
+ }
655
+ ]
656
+
657
+ packet_add_painting:
658
+ !id: 0x16
659
+ !bound: client
660
+ entity_id_self: zigzag64
661
+ runtime_entity_id: varint64
662
+ coordinates: vec3f
663
+ direction: zigzag32
664
+ title: string
665
+
666
+ # TickSync is sent by the client and the server to maintain a synchronized, server-authoritative tick between
667
+ # the client and the server. The client sends this packet first, and the server should reply with another one
668
+ # of these packets, including the response time.
669
+ packet_tick_sync:
670
+ !id: 0x17
671
+ !bound: both
672
+ # ClientRequestTimestamp is the timestamp on which the client sent this packet to the server. The server
673
+ # should fill out that same value when replying.
674
+ # The ClientRequestTimestamp is always 0
675
+ request_time: li64
676
+ # ServerReceptionTimestamp is the timestamp on which the server received the packet sent by the client.
677
+ # When the packet is sent by the client, this value is 0.
678
+ # ServerReceptionTimestamp is generally the current tick of the server. It isn't an actual timestamp, as
679
+ # the field implies
680
+ response_time: li64
681
+
682
+ packet_level_sound_event_old:
683
+ !id: 0x18
684
+ !bound: both
685
+ sound_id: u8
686
+ position: vec3f
687
+ block_id: zigzag32
688
+ entity_type: zigzag32
689
+ is_baby_mob: bool
690
+ is_global: bool
691
+
692
+ packet_level_event:
693
+ !id: 0x19
694
+ !bound: client
695
+ event: zigzag32 =>
696
+ 1000: sound_click
697
+ 1001: sound_click_fail
698
+ 1002: sound_shoot
699
+ 1003: sound_door
700
+ 1004: sound_fizz
701
+ 1005: sound_ignite
702
+ 1007: sound_ghast
703
+ 1008: sound_ghast_shoot
704
+ 1009: sound_blaze_shoot
705
+ 1010: sound_door_bump
706
+ 1012: sound_door_crash
707
+ 1018: sound_enderman_teleport
708
+ 1020: sound_anvil_break
709
+ 1021: sound_anvil_use
710
+ 1022: sound_anvil_fall
711
+ 1030: sound_pop
712
+ 1032: sound_portal
713
+ 1040: sound_itemframe_add_item
714
+ 1041: sound_itemframe_remove
715
+ 1042: sound_itemframe_place
716
+ 1043: sound_itemframe_remove_item
717
+ 1044: sound_itemframe_rotate_item
718
+ 1050: sound_camera
719
+ 1051: sound_orb
720
+ 1052: sound_totem
721
+ 1060: sound_armor_stand_break
722
+ 1061: sound_armor_stand_hit
723
+ 1062: sound_armor_stand_fall
724
+ 1063: sound_armor_stand_place
725
+ 1064: pointed_dripstone_land
726
+ 1065: dye_used
727
+ 1066: ink_sack_used
728
+ 2000: particle_shoot #TODO: check 2000-2017
729
+ 2001: particle_destroy
730
+ 2002: particle_splash
731
+ 2003: particle_eye_despawn
732
+ 2004: particle_spawn
733
+ 2005: particle_crop_growth
734
+ 2006: particle_guardian_curse
735
+ 2007: particle_death_smoke
736
+ 2008: particle_block_force_field
737
+ 2009: particle_projectile_hit
738
+ 2010: particle_dragon_egg_teleport
739
+ 2011: particle_crop_eaten
740
+ 2012: particle_critical
741
+ 2013: particle_enderman_teleport
742
+ 2014: particle_punch_block
743
+ 2015: particle_bubble
744
+ 2016: particle_evaporate
745
+ 2017: particle_destroy_armor_stand
746
+ 2018: particle_breaking_egg
747
+ 2019: particle_destroy_egg
748
+ 2020: particle_evaporate_water
749
+ 2021: particle_destroy_block_no_sound
750
+ 2022: particle_knockback_roar
751
+ 2023: particle_teleport_trail
752
+ 2024: particle_point_cloud
753
+ 2025: particle_explosion
754
+ 2026: particle_block_explosion
755
+ 2027: particle_vibration_signal
756
+ 2028: particle_dripstone_drip
757
+ 2029: particle_fizz_effect
758
+ 2030: particle_wax_on
759
+ 2031: particle_wax_off
760
+ 2032: particle_scrape
761
+ 2033: particle_electric_spark
762
+ 2034: particle_turtle_egg
763
+ 2035: particle_sculk_shriek
764
+ 2036: sculk_catalyst_bloom
765
+ 2037: sculk_charge
766
+ 2038: sculk_charge_pop
767
+ 2039: sonic_explosion
768
+
769
+ 3001: start_rain
770
+ 3002: start_thunder
771
+ 3003: stop_rain
772
+ 3004: stop_thunder
773
+ 3005: pause_game #data: 1 to pause, 0 to resume
774
+ 3006: pause_game_no_screen #data: 1 to pause, 0 to resume - same effect as normal pause but without screen
775
+ 3007: set_game_speed #x coordinate of pos = scale factor (default 1.0)
776
+ 3500: redstone_trigger
777
+ 3501: cauldron_explode
778
+ 3502: cauldron_dye_armor
779
+ 3503: cauldron_clean_armor
780
+ 3504: cauldron_fill_potion
781
+ 3505: cauldron_take_potion
782
+ 3506: cauldron_fill_water
783
+ 3507: cauldron_take_water
784
+ 3508: cauldron_add_dye
785
+ 3509: cauldron_clean_banner
786
+ 3600: block_start_break
787
+ 3601: block_stop_break
788
+ 4000: set_data
789
+ 9800: players_sleeping
790
+ 9801: sleeping_players
791
+ 0x4000: add_particle_mask
792
+ # 0x4000 | + particle ID
793
+ 16385: add_particle_bubble # 1
794
+ 16386: add_particle_bubble_manual # 2
795
+ 16387: add_particle_critical # 3
796
+ 16388: add_particle_block_force_field # 4
797
+ 16389: add_particle_smoke # 5
798
+ 16390: add_particle_explode # 6
799
+ 16391: add_particle_evaporation # 7
800
+ 16392: add_particle_flame # 8
801
+ 16393: add_particle_candle_flame # 9
802
+ 16394: add_particle_lava # 10
803
+ 16395: add_particle_large_smoke # 11
804
+ 16396: add_particle_redstone # 12
805
+ 16397: add_particle_rising_red_dust # 13
806
+ 16398: add_particle_item_break # 14
807
+ 16399: add_particle_snowball_poof # 15
808
+ 16400: add_particle_huge_explode # 16
809
+ 16401: add_particle_huge_explode_seed # 17
810
+ 16402: add_particle_mob_flame # 18
811
+ 16403: add_particle_heart # 19
812
+ 16404: add_particle_terrain # 20
813
+ 16405: add_particle_town_aura # 21
814
+ 16406: add_particle_portal # 22
815
+ 16408: add_particle_water_splash # 24
816
+ 16409: add_particle_water_splash_manual # 25
817
+ 16410: add_particle_water_wake # 26
818
+ 16411: add_particle_drip_water # 27
819
+ 16412: add_particle_drip_lava # 28
820
+ 16413: add_particle_drip_honey # 29
821
+ 16414: add_particle_stalactite_drip_water # 30
822
+ 16415: add_particle_stalactite_drip_lava # 31
823
+ 16416: add_particle_falling_dust # 32
824
+ 16417: add_particle_mob_spell # 33
825
+ 16418: add_particle_mob_spell_ambient # 34
826
+ 16419: add_particle_mob_spell_instantaneous # 35
827
+ 16420: add_particle_ink # 36
828
+ 16421: add_particle_slime # 37
829
+ 16422: add_particle_rain_splash # 38
830
+ 16423: add_particle_villager_angry # 39
831
+ 16424: add_particle_villager_happy # 40
832
+ 16425: add_particle_enchantment_table # 41
833
+ 16426: add_particle_tracking_emitter # 42
834
+ 16427: add_particle_note # 43
835
+ 16428: add_particle_witch_spell # 44
836
+ 16429: add_particle_carrot # 45
837
+ 16430: add_particle_mob_appearance # 46
838
+ 16431: add_particle_end_rod # 47
839
+ 16432: add_particle_dragons_breath # 48
840
+ 16433: add_particle_spit # 49
841
+ 16434: add_particle_totem # 50
842
+ 16435: add_particle_food # 51
843
+ 16436: add_particle_fireworks_starter # 52
844
+ 16437: add_particle_fireworks_spark # 53
845
+ 16438: add_particle_fireworks_overlay # 54
846
+ 16439: add_particle_balloon_gas # 55
847
+ 16440: add_particle_colored_flame # 56
848
+ 16441: add_particle_sparkler # 57
849
+ 16442: add_particle_conduit # 58
850
+ 16443: add_particle_bubble_column_up # 59
851
+ 16444: add_particle_bubble_column_down # 60
852
+ 16445: add_particle_sneeze # 61
853
+ 16446: add_particle_shulker_bullet # 62
854
+ 16447: add_particle_bleach # 63
855
+ 16448: add_particle_dragon_destroy_block # 64
856
+ 16449: add_particle_mycelium_dust # 65
857
+ 16450: add_particle_falling_red_dust # 66
858
+ 16451: add_particle_campfire_smoke # 67
859
+ 16452: add_particle_tall_campfire_smoke # 68
860
+ 16453: add_particle_dragon_breath_fire # 69
861
+ 16454: add_particle_dragon_breath_trail # 70
862
+ 16455: add_particle_blue_flame # 71
863
+ 16456: add_particle_soul # 72
864
+ 16457: add_particle_obsidian_tear # 73
865
+ 16458: add_particle_portal_reverse # 74
866
+ 16459: add_particle_snowflake # 75
867
+ 16460: add_particle_vibration_signal # 76
868
+ 16461: add_particle_sculk_sensor_redstone # 77
869
+ 16462: add_particle_spore_blossom_shower # 78
870
+ 16463: add_particle_spore_blossom_ambient # 79
871
+ 16464: add_particle_wax # 80
872
+ 16465: add_particle_electric_spark # 81
873
+ position: vec3f
874
+ data: zigzag32
875
+
876
+ packet_block_event:
877
+ !id: 0x1a
878
+ !bound: client
879
+ # Position is the position of the block that an event occurred at.
880
+ position: BlockCoordinates
881
+ # EventType is the type of the block event.
882
+ # The event type decides the way the event data that follows is used
883
+ type: zigzag32 =>
884
+ 0: sound
885
+ 1: change_state
886
+ # EventData holds event type specific data. For chests for example,
887
+ # opening the chest means the data must be 1
888
+ data: zigzag32
889
+
890
+ packet_entity_event:
891
+ !id: 0x1b
892
+ !bound: both
893
+ runtime_entity_id: varint64
894
+ event_id: u8 =>
895
+ 1: jump
896
+ 2: hurt_animation
897
+ 3: death_animation
898
+ 4: arm_swing
899
+ 5: stop_attack
900
+ 6: tame_fail
901
+ 7: tame_success
902
+ 8: shake_wet
903
+ 9: use_item
904
+ 10: eat_grass_animation
905
+ 11: fish_hook_bubble
906
+ 12: fish_hook_position
907
+ 13: fish_hook_hook
908
+ 14: fish_hook_tease
909
+ 15: squid_ink_cloud
910
+ 16: zombie_villager_cure
911
+ 18: respawn
912
+ 19: iron_golem_offer_flower
913
+ 20: iron_golem_withdraw_flower
914
+ 21: love_particles #breeding
915
+ 22: villager_angry
916
+ 23: villager_happy
917
+ 24: witch_spell_particles
918
+ 25: firework_particles
919
+ 26: in_love_particles
920
+ 27: silverfish_spawn_animation
921
+ 28: guardian_attack
922
+ 29: witch_drink_potion
923
+ 30: witch_throw_potion
924
+ 31: minecart_tnt_prime_fuse
925
+ 32: creeper_prime_fuse
926
+ 33: air_supply_expired
927
+ 34: player_add_xp_levels
928
+ 35: elder_guardian_curse
929
+ 36: agent_arm_swing
930
+ 37: ender_dragon_death
931
+ 38: dust_particles #not sure what this is
932
+ 39: arrow_shake
933
+
934
+ 57: eating_item
935
+
936
+ 60: baby_animal_feed #green particles, like bonemeal on crops
937
+ 61: death_smoke_cloud
938
+ 62: complete_trade
939
+ 63: remove_leash #data 1 = cut leash
940
+ 64: caravan
941
+ 65: consume_totem
942
+ 66: player_check_treasure_hunter_achievement #mojang...
943
+ 67: entity_spawn #used for MinecraftEventing stuff, not needed
944
+ 68: dragon_puke #they call this puke particles
945
+ 69: item_entity_merge
946
+ 70: start_swim
947
+ 71: balloon_pop
948
+ 72: treasure_hunt
949
+ 73: agent_summon
950
+ 74: charged_crossbow
951
+ 75: fall
952
+ 76: grow_up
953
+ 77: vibration_detected
954
+ 78: drink_milk
955
+ data: zigzag32
956
+
957
+ packet_mob_effect:
958
+ !id: 0x1c
959
+ !bound: client
960
+ runtime_entity_id: varint64
961
+ event_id: u8
962
+ effect_id: zigzag32
963
+ amplifier: zigzag32
964
+ particles: bool
965
+ duration: zigzag32
966
+
967
+ packet_update_attributes:
968
+ !id: 0x1d
969
+ !bound: client
970
+ runtime_entity_id: varint64
971
+ attributes: PlayerAttributes
972
+ tick: varint64
973
+
974
+ # InventoryTransaction is a packet sent by the client. It essentially exists out of multiple sub-packets,
975
+ # each of which have something to do with the inventory in one way or another. Some of these sub-packets
976
+ # directly relate to the inventory, others relate to interaction with the world, that could potentially
977
+ # result in a change in the inventory.
978
+ packet_inventory_transaction:
979
+ !id: 0x1e
980
+ !bound: both
981
+ transaction: Transaction
982
+
983
+ packet_mob_equipment:
984
+ !id: 0x1f
985
+ !bound: both
986
+ runtime_entity_id: varint64
987
+ item: Item
988
+ slot: u8
989
+ selected_slot: u8
990
+ window_id: WindowID
991
+
992
+ packet_mob_armor_equipment:
993
+ !id: 0x20
994
+ !bound: both
995
+ runtime_entity_id: varint64
996
+ helmet: Item
997
+ chestplate: Item
998
+ leggings: Item
999
+ boots: Item
1000
+
1001
+ # Interact is sent by the client when it interacts with another entity in some way. It used to be used for
1002
+ # normal entity and block interaction, but this is no longer the case now.
1003
+ packet_interact:
1004
+ !id: 0x21
1005
+ !bound: both
1006
+ # Action type is the ID of the action that was executed by the player. It is one of the constants that
1007
+ # may be found above.
1008
+ action_id: u8 =>
1009
+ 3: leave_vehicle
1010
+ 4: mouse_over_entity
1011
+ 6: open_inventory
1012
+ # TargetEntityRuntimeID is the runtime ID of the entity that the player interacted with. This is empty
1013
+ # for the InteractActionOpenInventory action type.
1014
+ target_entity_id: varint64
1015
+ # Position associated with the ActionType above. For the InteractActionMouseOverEntity, this is the
1016
+ # position relative to the entity moused over over which the player hovered with its mouse/touch. For the
1017
+ # InteractActionLeaveVehicle, this is the position that the player spawns at after leaving the vehicle.
1018
+ position: action_id ?
1019
+ if mouse_over_entity or leave_vehicle: vec3f
1020
+
1021
+ packet_block_pick_request:
1022
+ !id: 0x22
1023
+ !bound: server
1024
+ x: zigzag32
1025
+ y: zigzag32
1026
+ z: zigzag32
1027
+ add_user_data: bool
1028
+ selected_slot: u8
1029
+
1030
+ packet_entity_pick_request:
1031
+ !id: 0x23
1032
+ !bound: server
1033
+ runtime_entity_id: lu64
1034
+ selected_slot: u8
1035
+ # WithData is true if the pick request requests the entity metadata.
1036
+ with_data: bool
1037
+
1038
+ # PlayerAction is sent by the client when it executes any action, for example starting to sprint, swim,
1039
+ # starting the breaking of a block, dropping an item, etc.
1040
+ packet_player_action:
1041
+ !id: 0x24
1042
+ !bound: server
1043
+ # EntityRuntimeID is the runtime ID of the player. The runtime ID is unique for each world session, and
1044
+ # entities are generally identified in packets using this runtime ID.
1045
+ runtime_entity_id: varint64
1046
+ # ActionType is the ID of the action that was executed by the player. It is one of the constants that may
1047
+ # be found above.
1048
+ action: Action
1049
+ # BlockPosition is the position of the target block, if the action with the ActionType set concerned a
1050
+ # block. If that is not the case, the block position will be zero.
1051
+ position: BlockCoordinates
1052
+ # ResultPosition is the position of the action's result. When a UseItemOn action is sent, this is the position of
1053
+ # the block clicked, but when a block is placed, this is the position at which the block will be placed.
1054
+ result_position: BlockCoordinates
1055
+ # BlockFace is the face of the target block that was touched. If the action with the ActionType set
1056
+ # concerned a block. If not, the face is always 0.
1057
+ face: zigzag32
1058
+
1059
+ packet_hurt_armor:
1060
+ !id: 0x26
1061
+ !bound: client
1062
+ cause: zigzag32
1063
+ damage: zigzag32
1064
+ armor_slots: zigzag64
1065
+
1066
+ packet_set_entity_data:
1067
+ !id: 0x27
1068
+ !bound: both
1069
+ runtime_entity_id: varint64
1070
+ metadata: MetadataDictionary
1071
+ # EntityProperties holds lists of entity properties that define specific attributes of an entity. As of v1.19.40, the
1072
+ # vanilla server does not use these properties, however they are still supported by the protocol.
1073
+ properties: EntityProperties
1074
+ tick: varint64
1075
+
1076
+ # SetActorMotion is sent by the server to change the client-side velocity of an entity. It is usually used
1077
+ # in combination with server-side movement calculation.
1078
+ packet_set_entity_motion:
1079
+ !id: 0x28
1080
+ !bound: both
1081
+ # EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
1082
+ # entities are generally identified in packets using this runtime ID.
1083
+ runtime_entity_id: varint64
1084
+ # Velocity is the new velocity the entity gets. This velocity will initiate the client-side movement of
1085
+ # the entity.
1086
+ velocity: vec3f
1087
+
1088
+ # SetActorLink is sent by the server to initiate an entity link client-side, meaning one entity will start
1089
+ # riding another.
1090
+ packet_set_entity_link:
1091
+ !id: 0x29
1092
+ !bound: client
1093
+ link: Link
1094
+
1095
+ packet_set_health:
1096
+ !id: 0x2a
1097
+ !bound: client
1098
+ health: zigzag32
1099
+
1100
+ packet_set_spawn_position:
1101
+ !id: 0x2b
1102
+ !bound: client
1103
+ spawn_type: zigzag32 =>
1104
+ 0: player
1105
+ 1: world
1106
+ player_position: BlockCoordinates
1107
+ dimension: zigzag32
1108
+ world_position: BlockCoordinates
1109
+
1110
+ packet_animate:
1111
+ !id: 0x2c
1112
+ !bound: both
1113
+ action_id: zigzag32 =>
1114
+ 0: none
1115
+ 1: swing_arm
1116
+ 2: unknown
1117
+ 3: wake_up
1118
+ 4: critical_hit
1119
+ 5: magic_critical_hit
1120
+ 128: row_right
1121
+ 129: row_left
1122
+ runtime_entity_id: varint64
1123
+ _: action_id ?
1124
+ if row_right or row_left:
1125
+ boat_rowing_time: lf32
1126
+
1127
+ packet_respawn:
1128
+ !id: 0x2d
1129
+ !bound: both
1130
+ position: vec3f
1131
+ state: u8
1132
+ runtime_entity_id: varint64
1133
+
1134
+ # ContainerOpen is sent by the server to open a container client-side. This container must be physically
1135
+ # present in the world, for the packet to have any effect. Unlike Java Edition, Bedrock Edition requires that
1136
+ # chests for example must be present and in range to open its inventory.
1137
+ packet_container_open:
1138
+ !id: 0x2e
1139
+ !bound: client
1140
+ # WindowID is the ID representing the window that is being opened. It may be used later to close the
1141
+ # container using a ContainerClose packet.
1142
+ window_id: WindowID
1143
+ # ContainerType is the type ID of the container that is being opened when opening the container at the
1144
+ # position of the packet. It depends on the block/entity, and could, for example, be the window type of
1145
+ # a chest or a hopper, but also a horse inventory.
1146
+ window_type: WindowType
1147
+ # ContainerPosition is the position of the container opened. The position must point to a block entity
1148
+ # that actually has a container. If that is not the case, the window will not be opened and the packet
1149
+ # will be ignored, if a valid ContainerEntityUniqueID has not also been provided.
1150
+ coordinates: BlockCoordinates
1151
+ # ContainerEntityUniqueID is the unique ID of the entity container that was opened. It is only used if
1152
+ # the ContainerType is one that points to an entity, for example a horse.
1153
+ runtime_entity_id: zigzag64
1154
+
1155
+ # ContainerClose is sent by the server to close a container the player currently has opened, which was opened
1156
+ # using the ContainerOpen packet, or by the client to tell the server it closed a particular container, such
1157
+ # as the crafting grid.
1158
+ packet_container_close:
1159
+ !id: 0x2f
1160
+ !bound: both
1161
+ # WindowID is the ID representing the window of the container that should be closed. It must be equal to
1162
+ # the one sent in the ContainerOpen packet to close the designated window.
1163
+ window_id: WindowID
1164
+ # ServerSide determines whether or not the container was force-closed by the server. If this value is
1165
+ # not set correctly, the client may ignore the packet and respond with a PacketViolationWarning.
1166
+ server: bool
1167
+
1168
+ # PlayerHotBar is sent by the server to the client. It used to be used to link hot bar slots of the player to
1169
+ # actual slots in the inventory, but as of 1.2, this was changed and hot bar slots are no longer a free
1170
+ # floating part of the inventory.
1171
+ # Since 1.2, the packet has been re-purposed, but its new functionality is not clear.
1172
+ packet_player_hotbar:
1173
+ !id: 0x30
1174
+ !bound: both
1175
+ selected_slot: varint
1176
+ window_id: WindowID
1177
+ select_slot: bool
1178
+
1179
+ # InventoryContent is sent by the server to update the full content of a particular inventory. It is usually
1180
+ # sent for the main inventory of the player, but also works for other inventories that are currently opened
1181
+ # by the player.
1182
+ packet_inventory_content:
1183
+ !id: 0x31
1184
+ !bound: both
1185
+ # WindowID is the ID that identifies one of the windows that the client currently has opened, or one of
1186
+ # the consistent windows such as the main inventory.
1187
+ window_id: WindowIDVarint
1188
+ # Content is the new content of the inventory. The length of this slice must be equal to the full size of
1189
+ # the inventory window updated.
1190
+ input: ItemStacks
1191
+
1192
+ # InventorySlot is sent by the server to update a single slot in one of the inventory windows that the client
1193
+ # currently has opened. Usually this is the main inventory, but it may also be the off hand or, for example,
1194
+ # a chest inventory.
1195
+ packet_inventory_slot:
1196
+ !id: 0x32
1197
+ !bound: both
1198
+ # WindowID is the ID of the window that the packet modifies. It must point to one of the windows that the
1199
+ # client currently has opened.
1200
+ window_id: WindowIDVarint
1201
+ # Slot is the index of the slot that the packet modifies. The new item will be set to the slot at this
1202
+ # index.
1203
+ slot: varint
1204
+ # NewItem is the item to be put in the slot at Slot. It will overwrite any item that may currently
1205
+ # be present in that slot.
1206
+ item: Item
1207
+
1208
+ # ContainerSetData is sent by the server to update specific data of a single container, meaning a block such
1209
+ # as a furnace or a brewing stand. This data is usually used by the client to display certain features
1210
+ # client-side.
1211
+ packet_container_set_data:
1212
+ !id: 0x33
1213
+ !bound: client
1214
+ # WindowID is the ID of the window that should have its data set. The player must have a window open with
1215
+ # the window ID passed, or nothing will happen.
1216
+ window_id: WindowID
1217
+ # Key is the key of the property. It is one of the constants that can be found above. Multiple properties
1218
+ # share the same key, but the functionality depends on the type of the container that the data is set to.
1219
+ # IF FURNACE:
1220
+ # 0: furnace_tick_count
1221
+ # 1: furnace_lit_time
1222
+ # 2: furnace_lit_duration
1223
+ # 3: furnace_stored_xp
1224
+ # 4: furnace_fuel_aux
1225
+ # IF BREWING STAND:
1226
+ # 0: brew_time
1227
+ # 1: brew_fuel_amount
1228
+ # 2: brew_fuel_total
1229
+ property: zigzag32
1230
+ # Value is the value of the property. Its use differs per property.
1231
+ value: zigzag32
1232
+
1233
+ packet_crafting_data:
1234
+ !id: 0x34
1235
+ !bound: client
1236
+ recipes: Recipes
1237
+ # PotionContainerChangeRecipes is a list of all recipes to convert a potion from one type to another,
1238
+ # such as from a drinkable potion to a splash potion, or from a splash potion to a lingering potion.
1239
+ potion_type_recipes: PotionTypeRecipes
1240
+ potion_container_recipes: PotionContainerChangeRecipes
1241
+ # MaterialReducers is a list of all material reducers which is used in education edition chemistry.
1242
+ material_reducers: MaterialReducer[]varint
1243
+ # ClearRecipes indicates if all recipes currently active on the client should be cleaned. Doing this
1244
+ # means that the client will have no recipes active by itself: Any CraftingData packets previously sent
1245
+ # will also be discarded, and only the recipes in this CraftingData packet will be used.
1246
+ clear_recipes: bool
1247
+
1248
+ # CraftingEvent is sent by the client when it crafts a particular item. Note that this packet may be fully
1249
+ # ignored, as the InventoryTransaction packet provides all the information required.
1250
+ packet_crafting_event:
1251
+ !id: 0x35
1252
+ !bound: both
1253
+ # WindowID is the ID representing the window that the player crafted in.
1254
+ window_id: WindowID
1255
+ # CraftingType is a type that indicates the way the crafting was done, for example if a crafting table
1256
+ # was used.
1257
+ recipe_type: zigzag32 =>
1258
+ 0: inventory
1259
+ 1: crafting
1260
+ 2: workbench
1261
+ # RecipeUUID is the UUID of the recipe that was crafted. It points to the UUID of the recipe that was
1262
+ # sent earlier in the CraftingData packet.
1263
+ recipe_id: uuid
1264
+ # Input is a list of items that the player put into the recipe so that it could create the Output items.
1265
+ # These items are consumed in the process.
1266
+ input: Item[]varint
1267
+ # Output is a list of items that were obtained as a result of crafting the recipe.
1268
+ result: Item[]varint
1269
+
1270
+ # GUIDataPickItem is sent by the server to make the client 'select' a hot bar slot. It currently appears to
1271
+ # be broken however, and does not actually set the selected slot to the hot bar slot set in the packet.
1272
+ packet_gui_data_pick_item:
1273
+ !id: 0x36
1274
+ !bound: client
1275
+ # ItemName is the name of the item that shows up in the top part of the popup that shows up when
1276
+ # selecting an item. It is shown as if an item was selected by the player itself.
1277
+ item_name: string
1278
+ # ItemEffects is the line under the ItemName, where the effects of the item are usually situated.
1279
+ item_effects: string
1280
+ # HotBarSlot is the hot bar slot to be selected/picked. This does not currently work, so it does not
1281
+ # matter what number this is.
1282
+ hotbar_slot: li32
1283
+
1284
+ # AdventureSettings is sent by the server to update game-play related features, in particular permissions to
1285
+ # access these features for the client. It includes allowing the player to fly, build and mine, and attack
1286
+ # entities. Most of these flags should be checked server-side instead of using this packet only.
1287
+ # The client may also send this packet to the server when it updates one of these settings through the
1288
+ # in-game settings interface. The server should verify if the player actually has permission to update those
1289
+ # settings.
1290
+ packet_adventure_settings:
1291
+ !id: 0x37
1292
+ !bound: both
1293
+ # Flags is a set of flags that specify certain properties of the player, such as whether or not it can
1294
+ # fly and/or move through blocks. It is one of the AdventureFlag constants above.
1295
+ flags: AdventureFlags
1296
+ # CommandPermissionLevel is a permission level that specifies the kind of commands that the player is
1297
+ # allowed to use.
1298
+ command_permission: CommandPermissionLevelVarint
1299
+ # ActionPermissions is, much like Flags, a set of flags that specify actions that the player is allowed
1300
+ # to undertake, such as whether it is allowed to edit blocks, open doors etc. It is a combination of the
1301
+ # ActionPermission constants above.
1302
+ action_permissions: ActionPermissions
1303
+ # PermissionLevel is the permission level of the player as it shows up in the player list built up using
1304
+ # the PlayerList packet. It is one of the PermissionLevel constants above.
1305
+ permission_level: PermissionLevel
1306
+ # Custom permissions
1307
+ custom_stored_permissions: varint
1308
+ # PlayerUniqueID is a unique identifier of the player. It appears it is not required to fill this field
1309
+ # out with a correct value. Simply writing 0 seems to work.
1310
+ user_id: li64
1311
+
1312
+ AdventureFlags: [ "bitflags",
1313
+ {
1314
+ "type": "varint",
1315
+ "flags": {
1316
+ "world_immutable": 1,
1317
+ "no_pvp": 2,
1318
+ "auto_jump": 0x20,
1319
+ "allow_flight": 0x40,
1320
+ "no_clip": 0x80,
1321
+ "world_builder": 0x100,
1322
+ "flying": 0x200,
1323
+ "muted": 0x400
1324
+ }
1325
+ }
1326
+ ]
1327
+
1328
+ ActionPermissions: [ "bitflags",
1329
+ {
1330
+ "type": "varint",
1331
+ "flags": {
1332
+ "mine": 0x10001,
1333
+ "doors_and_switches": 0x10002,
1334
+ "open_containers": 0x10004,
1335
+ "attack_players": 0x10008,
1336
+ "attack_mobs": 0x10010,
1337
+ "operator": 0x10020,
1338
+ "teleport": 0x10080,
1339
+ "build": 0x10100,
1340
+ "default": 0x10200
1341
+ }
1342
+ }
1343
+ ]
1344
+
1345
+ packet_block_entity_data:
1346
+ !id: 0x38
1347
+ !bound: both
1348
+ position: BlockCoordinates
1349
+ nbt: nbt
1350
+
1351
+ packet_player_input:
1352
+ !id: 0x39
1353
+ !bound: server
1354
+ motion_x: lf32
1355
+ motion_z: lf32
1356
+ jumping: bool
1357
+ sneaking: bool
1358
+
1359
+ # LevelChunk is sent by the server to provide the client with a chunk of a world data (16xYx16 blocks).
1360
+ # Typically a certain amount of chunks is sent to the client before sending it the spawn PlayStatus packet,
1361
+ # so that the client spawns in a loaded world.
1362
+ packet_level_chunk:
1363
+ !id: 0x3a
1364
+ !bound: client
1365
+ # ChunkX is the X coordinate of the chunk sent. (To translate a block's X to a chunk's X: x >> 4)
1366
+ x: zigzag32
1367
+ # ChunkZ is the Z coordinate of the chunk sent. (To translate a block's Z to a chunk's Z: z >> 4)
1368
+ z: zigzag32
1369
+ # SubChunkCount is the amount of sub chunks that are part of the chunk sent. Depending on if the cache
1370
+ # is enabled, a list of blob hashes will be sent, or, if disabled, the sub chunk data.
1371
+ # On newer versions, if this is a negative value it indicates to use the Subchunk Polling mechanism
1372
+ sub_chunk_count: varint
1373
+ # HighestSubChunk is the highest sub-chunk at the position that is not all air. It is only set if the
1374
+ # RequestMode is set to protocol.SubChunkRequestModeLimited.
1375
+ highest_subchunk_count: sub_chunk_count ?
1376
+ if -2: lu16
1377
+ # CacheEnabled specifies if the client blob cache should be enabled. This system is based on hashes of
1378
+ # blobs which are consistent and saved by the client in combination with that blob, so that the server
1379
+ # does not have to send the same chunk multiple times. If the client does not yet have a blob with the hash sent,
1380
+ # it will send a ClientCacheBlobStatus packet containing the hashes is does not have the data of.
1381
+ cache_enabled: bool
1382
+ blobs: cache_enabled?
1383
+ if true:
1384
+ # BlobHashes is a list of all blob hashes used in the chunk. It is composed of SubChunkCount + 1 hashes,
1385
+ # with the first SubChunkCount hashes being those of the sub chunks and the last one that of the biome
1386
+ # of the chunk.
1387
+ # If CacheEnabled is set to false, BlobHashes can be left empty.
1388
+ hashes: lu64[]varint
1389
+ # RawPayload is a serialised string of chunk data. The data held depends on if CacheEnabled is set to
1390
+ # true. If set to false, the payload is composed of multiple sub-chunks, each of which carry a version
1391
+ # which indicates the way they are serialised, followed by biomes, border blocks and tile entities. If
1392
+ # CacheEnabled is true, the payload consists out of the border blocks and tile entities only.
1393
+ payload: ByteArray
1394
+
1395
+ packet_set_commands_enabled:
1396
+ !id: 0x3b
1397
+ !bound: client
1398
+ enabled: bool
1399
+
1400
+ packet_set_difficulty:
1401
+ !id: 0x3c
1402
+ !bound: client
1403
+ difficulty: varint
1404
+
1405
+ packet_change_dimension:
1406
+ !id: 0x3d
1407
+ !bound: client
1408
+ dimension: zigzag32
1409
+ position: vec3f
1410
+ respawn: bool
1411
+
1412
+ # SetPlayerGameType is sent by the server to update the game type (game mode) of the player
1413
+ packet_set_player_game_type:
1414
+ !id: 0x3e
1415
+ !bound: both
1416
+ # The new gamemode for the player.
1417
+ # Some of these game types require additional flags to be set in an AdventureSettings packet for
1418
+ # the game mode to obtain its full functionality.
1419
+ gamemode: GameMode
1420
+
1421
+ packet_player_list:
1422
+ !id: 0x3f
1423
+ !bound: client
1424
+ records: PlayerRecords
1425
+
1426
+ packet_simple_event:
1427
+ !id: 0x40
1428
+ !bound: client
1429
+ event_type: lu16
1430
+
1431
+ # Event is sent by the server to send an event with additional data. It is typically sent to the client for
1432
+ # telemetry reasons, much like the SimpleEvent packet.
1433
+ packet_event:
1434
+ !id: 0x41
1435
+ !bound: client
1436
+ runtime_id: varint64
1437
+ event_type: zigzag32 =>
1438
+ 0: achievement_awarded
1439
+ 1: entity_interact
1440
+ 2: portal_built
1441
+ 3: portal_used
1442
+ 4: mob_killed
1443
+ 5: cauldron_used
1444
+ 6: player_death
1445
+ 7: boss_killed
1446
+ 8: agent_command
1447
+ 9: agent_created
1448
+ 10: banner_pattern_removed
1449
+ 11: commaned_executed
1450
+ 12: fish_bucketed
1451
+ 13: mob_born
1452
+ 14: pet_died
1453
+ 15: cauldron_block_used
1454
+ 16: composter_block_used
1455
+ 17: bell_block_used
1456
+ 18: actor_definition
1457
+ 19: raid_update
1458
+ 20: player_movement_anomaly
1459
+ 21: player_moement_corrected
1460
+ 22: honey_harvested
1461
+ 23: target_block_hit
1462
+ 24: piglin_barter
1463
+ 25: waxed_or_unwaxed_copper
1464
+ use_player_id: u8
1465
+ event_data: restBuffer # Unknown data, TODO: add
1466
+
1467
+ packet_spawn_experience_orb:
1468
+ !id: 0x42
1469
+ !bound: client
1470
+ position: vec3f
1471
+ count: zigzag32
1472
+
1473
+ UpdateMapFlags: [ "bitflags", {
1474
+ "type": "varint",
1475
+ "flags": [
1476
+ "void",
1477
+ "texture",
1478
+ "decoration",
1479
+ "initialisation"
1480
+ ]
1481
+ }]
1482
+
1483
+ # ClientBoundMapItemData is sent by the server to the client to update the data of a map shown to the client.
1484
+ # It is sent with a combination of flags that specify what data is updated.
1485
+ # The ClientBoundMapItemData packet may be used to update specific parts of the map only. It is not required
1486
+ # to send the entire map each time when updating one part.
1487
+ packet_clientbound_map_item_data:
1488
+ !id: 0x43
1489
+ !bound: client
1490
+ # MapID is the unique identifier that represents the map that is updated over network. It remains
1491
+ # consistent across sessions.
1492
+ map_id: zigzag64
1493
+ # UpdateFlags is a combination of flags found above that indicate what parts of the map should be updated
1494
+ # client-side.
1495
+ update_flags: UpdateMapFlags
1496
+ # Dimension is the dimension of the map that should be updated, for example the overworld (0), the nether
1497
+ # (1) or the end (2).
1498
+ dimension: u8
1499
+ # LockedMap specifies if the map that was updated was a locked map, which may be done using a cartography
1500
+ # table.
1501
+ locked: bool
1502
+ # Origin is the center position of the map being updated.
1503
+ origin: BlockCoordinates
1504
+ # The following fields apply only for the MapUpdateFlagInitialisation.
1505
+ # MapsIncludedIn holds an array of map IDs that the map updated is included in. This has to do with the
1506
+ # scale of the map: Each map holds its own map ID and all map IDs of maps that include this map and have
1507
+ # a bigger scale. This means that a scale 0 map will have 5 map IDs in this slice, whereas a scale 4 map
1508
+ # will have only 1 (its own).
1509
+ # The actual use of this field remains unknown.
1510
+ included_in: update_flags.initialisation ?
1511
+ if true: zigzag64[]varint
1512
+ # Scale is the scale of the map as it is shown in-game. It is written when any of the MapUpdateFlags are
1513
+ # set to the UpdateFlags field.
1514
+ scale: update_flags.initialisation || update_flags.decoration || update_flags.texture ?
1515
+ if true: u8
1516
+ # The following fields apply only for the MapUpdateFlagDecoration.
1517
+ # TrackedObjects is a list of tracked objects on the map, which may either be entities or blocks. The
1518
+ # client makes sure these tracked objects are actually tracked. (position updated etc.)
1519
+ tracked: update_flags.decoration ?
1520
+ if true:
1521
+ objects: TrackedObject[]varint
1522
+ decorations: MapDecoration[]varint
1523
+ # Updates to the map contents itself (texture)
1524
+ texture: update_flags.texture ?
1525
+ if true:
1526
+ # Width is the width of the texture area that was updated. The width may be a subset of the total width
1527
+ # of the map.
1528
+ width: zigzag32
1529
+ # Height is the height of the texture area that was updated. The height may be a subset of the total
1530
+ # height of the map
1531
+ height: zigzag32
1532
+ # XOffset is the X offset in pixels at which the updated texture area starts. From this X, the updated
1533
+ # texture will extend exactly Width pixels to the right.
1534
+ x_offset: zigzag32
1535
+ # YOffset is the Y offset in pixels at which the updated texture area starts. From this Y, the updated
1536
+ # texture will extend exactly Height pixels up.
1537
+ y_offset: zigzag32
1538
+ # Pixels is a list of pixel colours for the new texture of the map. It is indexed as Pixels[y][x], with
1539
+ # the length of the outer slice having to be exactly Height long and the inner slices exactly Width long.
1540
+ # To access this array, use $width * y + x
1541
+ pixels: varint[]varint
1542
+
1543
+
1544
+ packet_map_info_request:
1545
+ !id: 0x44
1546
+ !bound: both
1547
+ map_id: zigzag64
1548
+ # ClientPixels is a map of pixels sent from the client to notify the server about the pixels that it isn't
1549
+ # aware of.
1550
+ client_pixels: []lu32
1551
+ rgba: li32
1552
+ index: lu16
1553
+
1554
+ # RequestChunkRadius is sent by the client to the server to update the server on the chunk view radius that
1555
+ # it has set in the settings. The server may respond with a ChunkRadiusUpdated packet with either the chunk
1556
+ # radius requested, or a different chunk radius if the server chooses so.
1557
+ packet_request_chunk_radius:
1558
+ !id: 0x45
1559
+ !bound: both
1560
+ # ChunkRadius is the requested chunk radius. This value is always the value set in the settings of the
1561
+ # player.
1562
+ chunk_radius: zigzag32
1563
+
1564
+ # ChunkRadiusUpdated is sent by the server in response to a RequestChunkRadius packet. It defines the chunk
1565
+ # radius that the server allows the client to have. This may be lower than the chunk radius requested by the
1566
+ # client in the RequestChunkRadius packet.
1567
+ packet_chunk_radius_update:
1568
+ !id: 0x46
1569
+ !bound: client
1570
+ # ChunkRadius is the final chunk radius that the client will adapt when it receives the packet. It does
1571
+ # not have to be the same as the requested chunk radius.
1572
+ chunk_radius: zigzag32
1573
+
1574
+ packet_item_frame_drop_item:
1575
+ !id: 0x47
1576
+ !bound: both
1577
+ coordinates: BlockCoordinates
1578
+
1579
+ packet_game_rules_changed:
1580
+ !id: 0x48
1581
+ !bound: client
1582
+ rules: GameRules
1583
+
1584
+ # Camera is sent by the server to use an Education Edition camera on a player. It produces an image
1585
+ # client-side.
1586
+ packet_camera:
1587
+ !id: 0x49
1588
+ !bound: client
1589
+ # CameraEntityUniqueID is the unique ID of the camera entity from which the picture was taken.
1590
+ camera_entity_unique_id: zigzag64
1591
+ # TargetPlayerUniqueID is the unique ID of the target player. The unique ID is a value that remains
1592
+ # consistent across different sessions of the same world, but most servers simply fill the runtime ID of
1593
+ # the player out for this field.
1594
+ target_player_unique_id: zigzag64
1595
+
1596
+ packet_boss_event:
1597
+ !id: 0x4a
1598
+ !bound: both
1599
+ boss_entity_id: zigzag64
1600
+ type: varint =>
1601
+ # S2C: Shows the boss-bar to the player.
1602
+ 0: show_bar
1603
+ # C2S: Registers a player to a boss fight.
1604
+ 1: register_player
1605
+ # S2C: Removes the boss-bar from the client.
1606
+ 2: hide_bar
1607
+ # C2S: Unregisters a player from a boss fight.
1608
+ 3: unregister_player
1609
+ # S2C: Sets the bar percentage.
1610
+ 4: set_bar_progress
1611
+ # S2C: Sets title of the bar.
1612
+ 5: set_bar_title
1613
+ # S2C: darkens the sky
1614
+ 6: update_properties
1615
+ # S2C: Not implemented :( Intended to alter bar appearance, but these currently produce no effect on client-side whatsoever.
1616
+ 7: texture
1617
+ # C2S: Client asking the server to resend all boss data.
1618
+ 8: query
1619
+ _: type?
1620
+ if show_bar:
1621
+ # BossBarTitle is the title shown above the boss bar. It currently does not function, and instead uses
1622
+ # the name tag of the boss entity at all times. It is only set if the EventType is BossEventShow or
1623
+ # BossEventTitle.
1624
+ title: string
1625
+ # HealthPercentage is the percentage of health that is shown in the boss bar. It currently does not
1626
+ # function, and instead uses the health percentage of the boss entity at all times. It is only set if the
1627
+ # EventType is BossEventShow or BossEventHealthPercentage.
1628
+ progress: lf32
1629
+ # ScreenDarkening currently seems not to do anything.
1630
+ screen_darkening: li16
1631
+ # Colour is the colour of the boss bar that is shown when a player is subscribed. It currently does not
1632
+ # function. It is only set if the EventType is BossEventShow, BossEventAppearanceProperties or
1633
+ # BossEventTexture.
1634
+ # Format is ARGB
1635
+ color: varint
1636
+ # Overlay is the overlay of the boss bar that is shown on top of the boss bar when a player is
1637
+ # subscribed. It currently does not function. It is only set if the EventType is BossEventShow,
1638
+ # BossEventAppearanceProperties or BossEventTexture.
1639
+ overlay: varint
1640
+ if register_player or unregister_player or query:
1641
+ # PlayerUniqueID is the unique ID of the player that is registered to or unregistered from the boss
1642
+ # fight. It is set if EventType is either BossEventRegisterPlayer or BossEventUnregisterPlayer.
1643
+ player_id: zigzag64
1644
+ if set_bar_progress:
1645
+ progress: lf32
1646
+ if set_bar_title:
1647
+ title: string
1648
+ if update_properties:
1649
+ screen_darkening: li16
1650
+ color: varint
1651
+ overlay: varint
1652
+ if texture:
1653
+ color: varint
1654
+ overlay: varint
1655
+
1656
+ packet_show_credits:
1657
+ !id: 0x4b
1658
+ !bound: client
1659
+ runtime_entity_id: varint64
1660
+ status: zigzag32
1661
+
1662
+ # This packet sends a list of commands to the client. Commands can have
1663
+ # arguments, and some of those arguments can have 'enum' values, which are a list of possible
1664
+ # values for the argument. The serialization is rather complex and involves palettes like chunks.
1665
+ ## In bedrock-protocol, listen to on('client.commands') for a simpler representation
1666
+ packet_available_commands:
1667
+ !id: 0x4c
1668
+ !bound: client
1669
+ # The length of the enums for all the command parameters in this packet
1670
+ values_len: varint
1671
+ # Not read from stream: instead calculated from the `values_len` field
1672
+ #
1673
+ # If the values_len < 0xff => byte,
1674
+ # If the values_len < 0xffff => short,
1675
+ # If the values_len < 0xffffff => int
1676
+ _enum_type: '["enum_size_based_on_values_len"]'
1677
+ # Here all the enum values for all of the possible commands are stored to one array palette
1678
+ enum_values: string[]$values_len
1679
+ # Integer parameters may sometimes have a prefix, such as the XP command:
1680
+ # /xp <amount: int> [player: target] <- here, the xp command gives experience points
1681
+ # /xp <amount: int>L [player: target] <- here, the xp command gives experience levels
1682
+ # This is the palette of suffixes
1683
+ suffixes: string[]varint
1684
+ # The list of enum objects
1685
+ enums: []varint
1686
+ # The name of the enum
1687
+ name: string
1688
+ # The values in the enum
1689
+ values: []varint
1690
+ # The indexes to value in the palette
1691
+ _: ../_enum_type?
1692
+ if byte: u8
1693
+ if short: lu16
1694
+ if int: lu32
1695
+ command_data: []varint
1696
+ name: string
1697
+ description: string
1698
+ flags: lu16
1699
+ permission_level: u8
1700
+ alias: li32
1701
+ # The list of overload parameters for this command
1702
+ overloads: []varint
1703
+ # Each of the parameters gets an array of posible overloads
1704
+ _: []varint
1705
+ # The name of the parameter shown to the user (the `amount` in `/xp <amount: int>`)
1706
+ parameter_name: string
1707
+ value_type: lu16 =>
1708
+ 1: int
1709
+ 3: float
1710
+ 4: value
1711
+ 5: wildcard_int
1712
+ 6: operator
1713
+ 7: command_operator
1714
+ 8: target
1715
+ 10: wildcard_target
1716
+ 17: file_path
1717
+ 23: integer_range
1718
+ 38: equipment_slots
1719
+ 39: string
1720
+ 47: block_position
1721
+ 48: position
1722
+ 51: message
1723
+ 53: raw_text
1724
+ 57: json
1725
+ 67: block_states
1726
+ 70: command
1727
+ # In MC, this + prior field are combined to one 32bit bitfield
1728
+ enum_type: lu16 =>
1729
+ 0x10: valid
1730
+ 0x20: enum
1731
+ 0x100: suffixed
1732
+ 0x400: soft_enum
1733
+ # Is this parameter required?
1734
+ optional: bool
1735
+ # Additinal options for this command (thanks macroshaft...)
1736
+ options: CommandFlags
1737
+ # There are two types of enums: static enums which cannot be changed after sending AvaliableCommands,
1738
+ # (unless you resend the whole packet) and 'soft' or 'dynamic' enums like below which is an array
1739
+ # that can be updated with the UpdateSoftEnum packet
1740
+ dynamic_enums: []varint
1741
+ name: string
1742
+ values: string[]varint
1743
+ enum_constraints: []varint
1744
+ value_index: li32
1745
+ enum_index: li32
1746
+ constraints: []varint
1747
+ constraint: u8 =>
1748
+ 0: cheats_enabled
1749
+ 1: operator_permissions
1750
+ 2: host_permissions
1751
+
1752
+ # ParamOptionCollapseEnum specifies if the enum (only if the Type is actually an enum type. If not,
1753
+ # setting this to true has no effect) should be collapsed. This means that the options of the enum are
1754
+ # never shown in the actual usage of the command, but only as auto-completion, like it automatically does
1755
+ # with enums that have a big amount of options. To illustrate, it can make
1756
+ # <false|true|yes|no> <$Name: bool>.
1757
+ CommandFlags: [ "bitfield", [
1758
+ { "name": "unused", "size": 1, "signed": false },
1759
+ { "name": "collapse_enum", "size": 1, "signed": false },
1760
+ { "name": "has_semantic_constraint", "size": 1, "signed": false },
1761
+ { "name": "as_chained_command", "size": 1, "signed": false },
1762
+ { "name": "unknown2", "size": 4, "signed": false }, # 4 unused upper bits
1763
+ ]]
1764
+
1765
+ # enum_size_based_on_values_len: native
1766
+
1767
+ # CommandRequest is sent by the client to request the execution of a server-side command. Although some
1768
+ # servers support sending commands using the Text packet, this packet is guaranteed to have the correct
1769
+ # result.
1770
+ packet_command_request:
1771
+ !id: 0x4d
1772
+ !bound: server
1773
+ # CommandLine is the raw entered command line. The client does no parsing of the command line by itself
1774
+ # (unlike it did in the early stages), but lets the server do that.
1775
+ command: string
1776
+ # Origin holds information about the command sender that will be returnd back in the command response
1777
+ origin: CommandOrigin
1778
+ # Internal specifies if the command request internal. Setting it to false seems to work and the usage of
1779
+ # this field is not known.
1780
+ internal: bool
1781
+
1782
+
1783
+ # CommandBlockUpdate is sent by the client to update a command block at a specific position. The command
1784
+ # block may be either a physical block or an entity.
1785
+ packet_command_block_update:
1786
+ !id: 0x4e
1787
+ !bound: server
1788
+ # Block specifies if the command block updated was an actual physical block. If false, the command block
1789
+ # is in a minecart and has an entity runtime ID instead.
1790
+ is_block: bool
1791
+ # Position is the position of the command block updated. It is only set if Block is set to true. Nothing
1792
+ # happens if no command block is set at this position.
1793
+ _: is_block ?
1794
+ if true:
1795
+ # Position is the position of the command block updated. It is only set if Block is set to true. Nothing
1796
+ # happens if no command block is set at this position.
1797
+ position: BlockCoordinates
1798
+ # Mode is the mode of the command block. It is either CommandBlockImpulse, CommandBlockChain or
1799
+ # CommandBlockRepeat. It is only set if Block is set to true.
1800
+ mode: varint =>
1801
+ 0: impulse
1802
+ 1: repeat
1803
+ 2: chain
1804
+ # NeedsRedstone specifies if the command block needs to be powered by redstone to be activated. If false,
1805
+ # the command block is always active. The field is only set if Block is set to true.
1806
+ needs_redstone: bool
1807
+ # Conditional specifies the behaviour of the command block if the command block before it (the opposite
1808
+ # side of the direction the arrow if facing) fails to execute. If set to false, it will activate at all
1809
+ # times, whereas if set to true, it will activate only if the previous command block executed
1810
+ # successfully. The field is only set if Block is set to true.
1811
+ conditional: bool
1812
+ if false:
1813
+ minecart_entity_runtime_id: varint64
1814
+ # Command is the command currently entered in the command block. This is the command that is executed
1815
+ # when the command block is activated.
1816
+ command: string
1817
+ # LastOutput is the output of the last command executed by the command block. It may be left empty to
1818
+ # show simply no output at all, in combination with setting ShouldTrackOutput to false.
1819
+ last_output: string
1820
+ # Name is the name of the command block updated. If not empty, it will show this name hovering above the
1821
+ # command block when hovering over the block with the cursor.
1822
+ name: string
1823
+ # ShouldTrackOutput specifies if the command block tracks output. If set to false, the output box won't
1824
+ # be shown within the command block.
1825
+ should_track_output: bool
1826
+ # TickDelay is the delay in ticks between executions of a command block, if it is a repeating command
1827
+ # block.
1828
+ tick_delay: li32
1829
+ # ExecuteOnFirstTick specifies if the command block should execute on the first tick, AKA as soon as the
1830
+ # command block is enabled.
1831
+ execute_on_first_tick: bool
1832
+
1833
+ packet_command_output:
1834
+ !id: 0x4f
1835
+ !bound: client
1836
+ # CommandOrigin is the data specifying the origin of the command. In other words, the source that the
1837
+ # command request was from, such as the player itself or a websocket server. The client forwards the
1838
+ # messages in this packet to the right origin, depending on what is sent here.
1839
+ origin: CommandOrigin
1840
+ # OutputType specifies the type of output that is sent.
1841
+ output_type: i8 =>
1842
+ 1: last
1843
+ 2: silent
1844
+ 3: all
1845
+ 4: data_set
1846
+ # SuccessCount is the amount of times that a command was executed successfully as a result of the command
1847
+ # that was requested. For servers, this is usually a rather meaningless fields, but for vanilla, this is
1848
+ # applicable for commands created with Functions.
1849
+ success_count: varint
1850
+ # OutputMessages is a list of all output messages that should be sent to the player. Whether they are
1851
+ # shown or not, depends on the type of the messages.
1852
+ output: []varint
1853
+ # Success indicates if the output message was one of a successful command execution. If set to true, the
1854
+ # output message is by default coloured white, whereas if set to false, the message is by default
1855
+ # coloured red.
1856
+ success: bool
1857
+ # Message is the message that is sent to the client in the chat window. It may either be simply a
1858
+ # message or a translated built-in string like 'commands.tp.success.coordinates', combined with specific
1859
+ # parameters below.
1860
+ message_id: string
1861
+ # Parameters is a list of parameters that serve to supply the message sent with additional information,
1862
+ # such as the position that a player was teleported to or the effect that was applied to an entity.
1863
+ # These parameters only apply for the Minecraft built-in command output.
1864
+ parameters: string[]varint
1865
+ data_set: output_type ?
1866
+ if data_set: string
1867
+ default: void
1868
+
1869
+
1870
+ # UpdateTrade is sent by the server to update the trades offered by a villager to a player. It is sent at the
1871
+ # moment that a player interacts with a villager.
1872
+ packet_update_trade:
1873
+ !id: 0x50
1874
+ !bound: client
1875
+ # WindowID is the ID that identifies the trading window that the client currently has opened.
1876
+ window_id: WindowID
1877
+ # WindowType is an identifier specifying the type of the window opened. In vanilla, it appears this is
1878
+ # always filled out with 15.
1879
+ window_type: WindowType
1880
+ # Size is the amount of trading options that the villager has.
1881
+ size: varint
1882
+ # TradeTier is the tier of the villager that the player is trading with. The tier starts at 0 with a
1883
+ # first two offers being available, after which two additional offers are unlocked each time the tier
1884
+ # becomes one higher.
1885
+ trade_tier: varint
1886
+ # VillagerUniqueID is the unique ID of the villager entity that the player is trading with. The
1887
+ # TradeTier sent above applies to this villager.
1888
+ villager_unique_id: varint64
1889
+ # EntityUniqueID is the unique ID of the entity (usually a player) for which the trades are updated. The
1890
+ # updated trades may apply only to this entity.
1891
+ entity_unique_id: varint64
1892
+ # DisplayName is the name displayed at the top of the trading UI. It is usually used to represent the
1893
+ # profession of the villager in the UI.
1894
+ display_name: string
1895
+ # NewTradeUI specifies if the villager should be using the new trade UI (The one added in 1.11.) rather
1896
+ # than the old one. This should usually be set to true.
1897
+ new_trading_ui: bool
1898
+ # Trading based on Minecraft economy - specifies if the prices of the villager's offers are modified by an increase in
1899
+ # demand for the item. (A mechanic added in 1.11.) Buying more of the same item will increase the price
1900
+ # of that particular item.
1901
+ # https://minecraft.gamepedia.com/Trading#Economics
1902
+ economic_trades: bool
1903
+ # NBT serialised compound of offers that the villager has.
1904
+ offers: nbt
1905
+
1906
+ # UpdateEquip is sent by the server to the client upon opening a horse inventory. It is used to set the
1907
+ # content of the inventory and specify additional properties, such as the items that are allowed to be put
1908
+ # in slots of the inventory.
1909
+ packet_update_equipment:
1910
+ !id: 0x51
1911
+ !bound: client
1912
+ # WindowID is the identifier associated with the window that the UpdateEquip packet concerns. It is the
1913
+ # ID sent for the horse inventory that was opened before this packet was sent.
1914
+ window_id: WindowID
1915
+ # WindowType is the type of the window that was opened. Generally, this is the type of a horse inventory,
1916
+ # as the packet is specifically made for that.
1917
+ window_type: WindowType
1918
+ # Size is the size of the horse inventory that should be opened. A bigger size does, in fact, change the
1919
+ # amount of slots displayed.
1920
+ size: u8
1921
+ # EntityUniqueID is the unique ID of the entity whose equipment was 'updated' to the player. It is
1922
+ # typically the horse entity that had its inventory opened.
1923
+ entity_id: zigzag64
1924
+ # `inventory` is a network NBT serialised compound holding the content of the inventory of
1925
+ # the entity (the equipment) and additional data such as the allowed items for a particular slot, used to
1926
+ # make sure only saddles can be put in the saddle slot etc.
1927
+ inventory: nbt
1928
+
1929
+
1930
+ # ResourcePackDataInfo is sent by the server to the client to inform the client about the data contained in
1931
+ # one of the resource packs that are about to be sent.
1932
+ packet_resource_pack_data_info:
1933
+ !id: 0x52
1934
+ !bound: client
1935
+ # UUID is the unique ID of the resource pack that the info concerns.
1936
+ pack_id: string
1937
+ # DataChunkSize is the maximum size in bytes of the chunks in which the total size of the resource pack
1938
+ # to be sent will be divided. A size of 1MB (1024*1024) means that a resource pack of 15.5MB will be
1939
+ # split into 16 data chunks.
1940
+ max_chunk_size: lu32
1941
+ # ChunkCount is the total amount of data chunks that the sent resource pack will exist out of. It is the
1942
+ # total size of the resource pack divided by the DataChunkSize field.
1943
+ # The client doesn't actually seem to use this field. Rather, it divides the size by the chunk size to
1944
+ # calculate it itself.
1945
+ chunk_count: lu32
1946
+ # Size is the total size in bytes that the resource pack occupies. This is the size of the compressed
1947
+ # archive (zip) of the resource pack.
1948
+ size: lu64
1949
+ # Hash is a SHA256 hash of the content of the resource pack.
1950
+ hash: ByteArray
1951
+ # Premium specifies if the resource pack was a premium resource pack, meaning it was bought from the
1952
+ # Minecraft store.
1953
+ is_premium: bool
1954
+ # PackType is the type of the resource pack. It is one of the resource pack types listed.
1955
+ pack_type: u8 =>
1956
+ 1: addon
1957
+ 2: cached
1958
+ 3: copy_protected
1959
+ 4: behavior
1960
+ 5: persona_piece
1961
+ 6: resources
1962
+ 7: skins
1963
+ 8: world_template
1964
+
1965
+ # ResourcePackChunkData is sent to the client so that the client can download the resource pack. Each packet
1966
+ # holds a chunk of the compressed resource pack, of which the size is defined in the ResourcePackDataInfo
1967
+ # packet sent before.
1968
+ packet_resource_pack_chunk_data:
1969
+ !id: 0x53
1970
+ !bound: client
1971
+ # UUID is the unique ID of the resource pack that the chunk of data is taken out of.
1972
+ pack_id: string
1973
+ # ChunkIndex is the current chunk index of the chunk. It is a number that starts at 0 and is incremented
1974
+ # for each resource pack data chunk sent to the client.
1975
+ chunk_index: lu32
1976
+ # DataOffset is the current progress in bytes or offset in the data that the resource pack data chunk is
1977
+ # taken from.
1978
+ progress: lu64
1979
+ # RawPayload is a byte slice containing a chunk of data from the resource pack. It must be of the same size or
1980
+ # less than the DataChunkSize set in the ResourcePackDataInfo packet.
1981
+ payload: ByteArray
1982
+
1983
+ # ResourcePackChunkRequest is sent by the client to request a chunk of data from a particular resource pack,
1984
+ # that it has obtained information about in a ResourcePackDataInfo packet.
1985
+ packet_resource_pack_chunk_request:
1986
+ !id: 0x54
1987
+ !bound: server
1988
+ # UUID is the unique ID of the resource pack that the chunk of data is requested from.
1989
+ pack_id: string
1990
+ # ChunkIndex is the requested chunk index of the chunk. It is a number that starts at 0 and is
1991
+ # incremented for each resource pack data chunk requested.
1992
+ chunk_index: lu32
1993
+
1994
+ packet_transfer:
1995
+ !id: 0x55
1996
+ !bound: client
1997
+ server_address: string
1998
+ port: lu16
1999
+
2000
+ packet_play_sound:
2001
+ !id: 0x56
2002
+ !bound: client
2003
+ name: string
2004
+ coordinates: BlockCoordinates
2005
+ volume: lf32
2006
+ pitch: lf32
2007
+
2008
+ packet_stop_sound:
2009
+ !id: 0x57
2010
+ !bound: client
2011
+ name: string
2012
+ stop_all: bool
2013
+
2014
+ # SetTitle is sent by the server to make a title, subtitle or action bar shown to a player. It has several
2015
+ # fields that allow setting the duration of the titles.
2016
+ packet_set_title:
2017
+ !id: 0x58
2018
+ !bound: client
2019
+ # ActionType is the type of the action that should be executed upon the title of a player. It is one of
2020
+ # the constants above and specifies the response of the client to the packet.
2021
+ type: zigzag32 =>
2022
+ 0: clear
2023
+ 1: reset
2024
+ 2: set_title
2025
+ 3: set_subtitle
2026
+ 4: action_bar_message
2027
+ 5: set_durations
2028
+ 6: set_title_json
2029
+ 7: set_subtitle_json
2030
+ 8: action_bar_message_json
2031
+ # Text is the text of the title, which has a different meaning depending on the ActionType that the
2032
+ # packet has. The text is the text of a title, subtitle or action bar, depending on the type set.
2033
+ text: string
2034
+ # FadeInDuration is the duration that the title takes to fade in on the screen of the player. It is
2035
+ # measured in 20ths of a second (AKA in ticks).
2036
+ fade_in_time: zigzag32
2037
+ # RemainDuration is the duration that the title remains on the screen of the player. It is measured in
2038
+ # 20ths of a second (AKA in ticks).
2039
+ stay_time: zigzag32
2040
+ # FadeOutDuration is the duration that the title takes to fade out of the screen of the player. It is
2041
+ # measured in 20ths of a second (AKA in ticks).
2042
+ fade_out_time: zigzag32
2043
+ # XUID is the XBOX Live user ID of the player, which will remain consistent as long as the player is
2044
+ # logged in with the XBOX Live account. It is empty if the user is not logged into its XBL account.
2045
+ xuid: string
2046
+ # PlatformOnlineID is either a uint64 or an empty string.
2047
+ platform_online_id: string
2048
+
2049
+ packet_add_behavior_tree:
2050
+ !id: 0x59
2051
+ !bound: client
2052
+ behaviortree: string
2053
+
2054
+ # StructureBlockUpdate is sent by the client when it updates a structure block using the in-game UI. The
2055
+ # data it contains depends on the type of structure block that it is. In Minecraft Bedrock Edition v1.11,
2056
+ # there is only the Export structure block type, but in v1.13 the ones present in Java Edition will,
2057
+ # according to the wiki, be added too.
2058
+ packet_structure_block_update:
2059
+ !id: 0x5a
2060
+ !bound: client
2061
+ # Position is the position of the structure block that is updated.
2062
+ position: BlockCoordinates
2063
+ # StructureName is the name of the structure that was set in the structure block's UI. This is the name
2064
+ # used to export the structure to a file.
2065
+ structure_name: string
2066
+ # DataField is the name of a function to run, usually used during natural generation. A description can
2067
+ # be found here: https://minecraft.gamepedia.com/Structure_Block#Data.
2068
+ data_field: string
2069
+ # IncludePlayers specifies if the 'Include Players' toggle has been enabled, meaning players are also
2070
+ # exported by the structure block.
2071
+ include_players: bool
2072
+ # ShowBoundingBox specifies if the structure block should have its bounds outlined. A thin line will
2073
+ # encapsulate the bounds of the structure if set to true.
2074
+ show_bounding_box: bool
2075
+ # StructureBlockType is the type of the structure block updated. A list of structure block types that
2076
+ # will be used can be found in the constants above.
2077
+ structure_block_type: zigzag32
2078
+ # Settings is a struct of settings that should be used for exporting the structure. These settings are
2079
+ # identical to the last sent in the StructureBlockUpdate packet by the client.
2080
+ settings: StructureBlockSettings
2081
+ # RedstoneSaveMode is the mode that should be used to save the structure when used with redstone. In
2082
+ # Java Edition, this is always stored in memory, but in Bedrock Edition it can be stored either to disk
2083
+ # or memory. See the constants above for the options.
2084
+ redstone_save_mode: zigzag32
2085
+ # ShouldTrigger specifies if the structure block should be triggered immediately after this packet
2086
+ # reaches the server.
2087
+ should_trigger: bool
2088
+ # Waterlogged specifies if the structure block is waterlogged at the time of the packet being sent.
2089
+ water_logged: bool
2090
+
2091
+ # ShowStoreOffer is sent by the server to show a Marketplace store offer to a player. It opens a window
2092
+ # client-side that displays the item.
2093
+ # The ShowStoreOffer packet only works on the partnered servers: Servers that are not partnered will not have
2094
+ # a store buttons show up in the in-game pause menu and will, as a result, not be able to open store offers
2095
+ # on the client side. Sending the packet does therefore not work when using a proxy that is not connected to
2096
+ # with the domain of one of the partnered servers.
2097
+ packet_show_store_offer:
2098
+ !id: 0x5b
2099
+ !bound: client
2100
+ # OfferID is a string that identifies the offer for which a window should be opened. While typically a
2101
+ # UUID, the ID could be anything.
2102
+ offer_id: string
2103
+ # ShowAll specifies if all other offers of the same 'author' as the one of the offer associated with the
2104
+ # OfferID should also be displayed, alongside the target offer.
2105
+ show_all: bool
2106
+
2107
+
2108
+ # PurchaseReceipt is sent by the client to the server to notify the server it purchased an item from the
2109
+ # Marketplace store that was offered by the server. The packet is only used for partnered servers.
2110
+ packet_purchase_receipt:
2111
+ !id: 0x5c
2112
+ !bound: server
2113
+ # Receipts is a list of receipts, or proofs of purchases, for the offers that have been purchased by the
2114
+ # player.
2115
+ receipts: string[]varint
2116
+
2117
+ packet_player_skin:
2118
+ !id: 0x5d
2119
+ !bound: both
2120
+ uuid: uuid
2121
+ skin: Skin
2122
+ skin_name: string
2123
+ old_skin_name: string
2124
+ is_verified: bool
2125
+
2126
+ # SubClientLogin is sent when a sub-client joins the server while another client is already connected to it.
2127
+ # The packet is sent as a result of split-screen game play, and allows up to four players to play using the
2128
+ # same network connection. After an initial Login packet from the 'main' client, each sub-client that
2129
+ # connects sends a SubClientLogin to request their own login.
2130
+ packet_sub_client_login:
2131
+ !id: 0x5e
2132
+ !bound: client
2133
+ # ConnectionRequest is a string containing information about the player and JWTs that may be used to
2134
+ # verify if the player is connected to XBOX Live. The connection request also contains the necessary
2135
+ # client public key to initiate encryption.
2136
+ # The ConnectionRequest in this packet is identical to the one found in the Login packet.
2137
+ tokens: '["encapsulated", { "lengthType": "varint", "type": "LoginTokens" }]'
2138
+
2139
+ # AutomationClientConnect is used to make the client connect to a websocket server. This websocket server has
2140
+ # the ability to execute commands on the behalf of the client and it can listen for certain events fired by
2141
+ # the client.
2142
+ packet_initiate_web_socket_connection:
2143
+ !id: 0x5f
2144
+ !bound: client
2145
+ # ServerURI is the URI to make the client connect to. It can be, for example, 'localhost:8000/ws' to
2146
+ # connect to a websocket server on the localhost at port 8000.
2147
+ server: string
2148
+
2149
+
2150
+ # SetLastHurtBy is sent by the server to let the client know what entity type it was last hurt by. At this
2151
+ # moment, the packet is useless and should not be used. There is no behaviour that depends on if this
2152
+ # packet is sent or not.
2153
+ packet_set_last_hurt_by:
2154
+ !id: 0x60
2155
+ !bound: client
2156
+ entity_type: varint
2157
+
2158
+ # BookEdit is sent by the client when it edits a book. It is sent each time a modification was made and the
2159
+ # player stops its typing 'session', rather than simply after closing the book.
2160
+ packet_book_edit:
2161
+ !id: 0x61
2162
+ !bound: client
2163
+ type: u8 =>
2164
+ 0: replace_page
2165
+ 1: add_page
2166
+ 2: delete_page
2167
+ 3: swap_pages
2168
+ 4: sign
2169
+ slot: u8
2170
+ _: type?
2171
+ if replace_page or add_page:
2172
+ page_number: u8
2173
+ text: string
2174
+ # Only available on Education Edition.
2175
+ photo_name: string
2176
+ if delete_page:
2177
+ page_number: u8
2178
+ if swap_pages:
2179
+ page1: u8
2180
+ page2: u8
2181
+ if sign:
2182
+ title: string
2183
+ author: string
2184
+ xuid: string
2185
+
2186
+
2187
+ # NPCRequest is sent by the client when it interacts with an NPC.
2188
+ # The packet is specifically made for Education Edition, where NPCs are available to use.
2189
+ packet_npc_request:
2190
+ !id: 0x62
2191
+ !bound: both
2192
+ # EntityRuntimeID is the runtime ID of the NPC entity that the player interacted with. It is the same
2193
+ # as sent by the server when spawning the entity.
2194
+ runtime_entity_id: varint64
2195
+ # RequestType is the type of the request, which depends on the permission that the player has. It will
2196
+ # be either a type that indicates that the NPC should show its dialog, or that it should open the
2197
+ # editing window.
2198
+ request_type: u8 =>
2199
+ 0: set_actions
2200
+ 1: execute_action
2201
+ 2: execute_closing_commands
2202
+ 3: set_name
2203
+ 4: set_skin
2204
+ 5: set_interaction_text
2205
+ # CommandString is the command string set in the NPC. It may consist of multiple commands, depending on
2206
+ # what the player set in it.
2207
+ command: string
2208
+ # ActionType is the type of the action to execute.
2209
+ action_type: u8 =>
2210
+ 0: set_actions
2211
+ 1: execute_action
2212
+ 2: execute_closing_commands
2213
+ 3: set_name
2214
+ 4: set_skin
2215
+ 5: set_interact_text
2216
+ 6: execute_openining_commands
2217
+ # SceneName is the name of the scene.
2218
+ scene_name: string
2219
+
2220
+ # PhotoTransfer is sent by the server to transfer a photo (image) file to the client. It is typically used
2221
+ # to transfer photos so that the client can display it in a portfolio in Education Edition.
2222
+ # While previously usable in the default Bedrock Edition, the displaying of photos in books was disabled and
2223
+ # the packet now has little use anymore.
2224
+ packet_photo_transfer:
2225
+ !id: 0x63
2226
+ !bound: server
2227
+ # PhotoName is the name of the photo to transfer. It is the exact file name that the client will download
2228
+ # the photo as, including the extension of the file.
2229
+ image_name: string
2230
+ # PhotoData is the raw data of the photo image. The format of this data may vary: Formats such as JPEG or
2231
+ # PNG work, as long as PhotoName has the correct extension.
2232
+ image_data: string
2233
+ # BookID is the ID of the book that the photo is associated with. If the PhotoName in a book with this ID
2234
+ # is set to PhotoName, it will display the photo (provided Education Edition is used).
2235
+ # The photo image is downloaded to a sub-folder with this book ID.
2236
+ book_id: string
2237
+ # PhotoType is one of the three photo types above.
2238
+ photo_type: u8
2239
+ # SourceType is the source photo type. It is one of the three photo types above.
2240
+ source_type: u8
2241
+ # OwnerEntityUniqueID is the entity unique ID of the photo's owner.
2242
+ owner_entity_unique_id: li64
2243
+ # NewPhotoName is the new name of the photo.
2244
+ new_photo_name: string
2245
+
2246
+ # ModalFormRequest is sent by the server to make the client open a form. This form may be either a modal form
2247
+ # which has two options, a menu form for a selection of options and a custom form for properties.
2248
+ packet_modal_form_request:
2249
+ !id: 0x64
2250
+ !bound: client
2251
+ # FormID is an ID used to identify the form. The ID is saved by the client and sent back when the player
2252
+ # submits the form, so that the server can identify which form was submitted.
2253
+ form_id: varint
2254
+ # FormData is a JSON encoded object of form data. The content of the object differs, depending on the
2255
+ # type of the form sent, which is also set in the JSON.
2256
+ data: string
2257
+
2258
+ # ModalFormResponse is sent by the client in response to a ModalFormRequest, after the player has submitted
2259
+ # the form sent. It contains the options/properties selected by the player, or a JSON encoded 'null' if
2260
+ # the form was closed by clicking the X at the top right corner of the form.
2261
+ packet_modal_form_response:
2262
+ !id: 0x65
2263
+ !bound: server
2264
+ # FormID is the form ID of the form the client has responded to. It is the same as the ID sent in the
2265
+ # ModalFormRequest, and may be used to identify which form was submitted.
2266
+ form_id: varint
2267
+ # HasResponseData is true if the client provided response data.
2268
+ has_response_data: bool
2269
+ # ResponseData is a JSON encoded value representing the response of the player. For a modal form, the response is
2270
+ # either true or false, for a menu form, the response is an integer specifying the index of the button clicked, and
2271
+ # for a custom form, the response is an array containing a value for each element.
2272
+ data: has_response_data ?
2273
+ if true: string
2274
+ # HasCancelReason is true if the client provided a reason for the form being cancelled.
2275
+ has_cancel_reason: bool
2276
+ # CancelReason represents the reason why the form was cancelled.
2277
+ _: has_cancel_reason ?
2278
+ if true:
2279
+ cancel_reason: u8 =>
2280
+ 0: closed
2281
+ 1: busy
2282
+
2283
+ # ServerSettingsRequest is sent by the client to request the settings specific to the server. These settings
2284
+ # are shown in a separate tab client-side, and have the same structure as a custom form.
2285
+ # ServerSettingsRequest has no fields.
2286
+ packet_server_settings_request:
2287
+ !id: 0x66
2288
+ !bound: server
2289
+
2290
+ # ServerSettingsResponse is optionally sent by the server in response to a ServerSettingsRequest from the
2291
+ # client. It is structured the same as a ModalFormRequest packet, and if filled out correctly, will show
2292
+ # a specific tab for the server in the settings of the client. A ModalFormResponse packet is sent by the
2293
+ # client in response to a ServerSettingsResponse, when the client fills out the settings and closes the
2294
+ # settings again.
2295
+ packet_server_settings_response:
2296
+ !id: 0x67
2297
+ !bound: client
2298
+ # FormID is an ID used to identify the form. The ID is saved by the client and sent back when the player
2299
+ # submits the form, so that the server can identify which form was submitted.
2300
+ form_id: varint
2301
+ # FormData is a JSON encoded object of form data. The content of the object differs, depending on the
2302
+ # type of the form sent, which is also set in the JSON.
2303
+ data: string
2304
+
2305
+ # ShowProfile is sent by the server to show the XBOX Live profile of one player to another.
2306
+ packet_show_profile:
2307
+ !id: 0x68
2308
+ !bound: client
2309
+ # XUID is the XBOX Live User ID of the player whose profile should be shown to the player. If it is not
2310
+ # a valid XUID, the client ignores the packet.
2311
+ xuid: string
2312
+
2313
+ # SetDefaultGameType is sent by the client when it toggles the default game type in the settings UI, and is
2314
+ # sent by the server when it actually changes the default game type, resulting in the toggle being changed
2315
+ # in the settings UI.
2316
+ packet_set_default_game_type:
2317
+ !id: 0x69
2318
+ !bound: client
2319
+ # GameType is the new game type that is set. When sent by the client, this is the requested new default
2320
+ # game type.
2321
+ gamemode: GameMode
2322
+
2323
+ # RemoveObjective is sent by the server to remove a scoreboard objective. It is used to stop showing a
2324
+ # scoreboard to a player.
2325
+ packet_remove_objective:
2326
+ !id: 0x6a
2327
+ !bound: client
2328
+ # ObjectiveName is the name of the objective that the scoreboard currently active has. This name must
2329
+ # be identical to the one sent in the SetDisplayObjective packet.
2330
+ objective_name: string
2331
+
2332
+ # SetDisplayObjective is sent by the server to display an object as a scoreboard to the player. Once sent,
2333
+ # it should be followed up by a SetScore packet to set the lines of the packet.
2334
+ packet_set_display_objective:
2335
+ !id: 0x6b
2336
+ !bound: client
2337
+ # DisplaySlot is the slot in which the scoreboard should be displayed. Available options can be found in
2338
+ # the constants above.
2339
+ display_slot: string
2340
+ # ObjectiveName is the name of the objective that the scoreboard displays. Filling out a random unique
2341
+ # value for this field works: It is not displayed in the scoreboard.
2342
+ objective_name: string
2343
+ # DisplayName is the name, or title, that is displayed at the top of the scoreboard.
2344
+ display_name: string
2345
+ # CriteriaName is the name of the criteria that need to be fulfilled in order for the score to be
2346
+ # increased. This can be any kind of string and does not show up client-side.
2347
+ criteria_name: string
2348
+ # SortOrder is the order in which entries on the scoreboard should be sorted. It is one of the constants
2349
+ # that may be found above.
2350
+ sort_order: zigzag32
2351
+
2352
+ # SetScore is sent by the server to send the contents of a scoreboard to the player. It may be used to either
2353
+ # add, remove or edit entries on the scoreboard.
2354
+ packet_set_score:
2355
+ !id: 0x6c
2356
+ !bound: client
2357
+ # ActionType is the type of the action to execute upon the scoreboard with the entries that the packet
2358
+ # has. If ActionType is ScoreboardActionModify, all entries will be added to the scoreboard if not yet
2359
+ # present, or modified if already present. If set to ScoreboardActionRemove, all scoreboard entries set
2360
+ # will be removed from the scoreboard.
2361
+ action: u8 =>
2362
+ 0: change
2363
+ 1: remove
2364
+ entries: []varint
2365
+ scoreboard_id: zigzag64
2366
+ objective_name: string
2367
+ score: li32
2368
+ _: ../action ?
2369
+ if change:
2370
+ entry_type: i8 =>
2371
+ 1: player
2372
+ 2: entity
2373
+ 3: fake_player
2374
+ entity_unique_id: entry_type ?
2375
+ if player or entity: zigzag64
2376
+ custom_name: entry_type ?
2377
+ if fake_player: string
2378
+
2379
+ # LabTable is sent by the client to let the server know it started a chemical reaction in Education Edition,
2380
+ # and is sent by the server to other clients to show the effects.
2381
+ # The packet is only functional if Education features are enabled.
2382
+ packet_lab_table:
2383
+ !id: 0x6d
2384
+ !bound: both
2385
+ # ActionType is the type of the action that was executed. It is one of the constants above. Typically,
2386
+ # only LabTableActionCombine is sent by the client, whereas LabTableActionReact is sent by the server.
2387
+ action_type: u8 =>
2388
+ 0: combine
2389
+ 1: react
2390
+ # Position is the position at which the lab table used was located.
2391
+ position: vec3u
2392
+ # ReactionType is the type of the reaction that took place as a result of the items put into the lab
2393
+ # table. The reaction type can be either that of an item or a particle, depending on whatever the result
2394
+ # was of the reaction.
2395
+ reaction_type: u8
2396
+
2397
+ # UpdateBlockSynced is sent by the server to synchronise the falling of a falling block entity with the
2398
+ # transitioning back and forth from and to a solid block. It is used to prevent the entity from flickering,
2399
+ # and is used in places such as the pushing of blocks with pistons.
2400
+ packet_update_block_synced:
2401
+ !id: 0x6e
2402
+ !bound: client
2403
+ # Position is the block position at which a block is updated.
2404
+ position: BlockCoordinates
2405
+ # NewBlockRuntimeID is the runtime ID of the block that is placed at Position after sending the packet
2406
+ # to the client.
2407
+ block_runtime_id: varint
2408
+ # Flags is a combination of flags that specify the way the block is updated client-side. It is a
2409
+ # combination of the flags above, but typically sending only the BlockUpdateNetwork flag is sufficient.
2410
+ flags: UpdateBlockFlags
2411
+ # Layer is the world layer on which the block is updated. For most blocks, this is the first layer, as
2412
+ # that layer is the default layer to place blocks on, but for blocks inside of each other, this differs.
2413
+ layer: varint
2414
+ # EntityUniqueID is the unique ID of the falling block entity that the block transitions to or that the
2415
+ # entity transitions from.
2416
+ # Note that for both possible values for TransitionType, the EntityUniqueID should point to the falling
2417
+ # block entity involved.
2418
+ entity_unique_id: zigzag64
2419
+ # TransitionType is the type of the transition that happened. It is either BlockToEntityTransition, when
2420
+ # a block placed becomes a falling entity, or EntityToBlockTransition, when a falling entity hits the
2421
+ # ground and becomes a solid block again.
2422
+ transition_type: varint => TransitionType
2423
+
2424
+
2425
+ # MoveActorDelta is sent by the server to move an entity. The packet is specifically optimised to save as
2426
+ # much space as possible, by only writing non-zero fields.
2427
+ # As of 1.16.100, this packet no longer actually contains any deltas.
2428
+ packet_move_entity_delta:
2429
+ !id: 0x6f
2430
+ !bound: client
2431
+ # EntityRuntimeID is the runtime ID of the entity that is being moved. The packet works provided a
2432
+ # non-player entity with this runtime ID is present.
2433
+ runtime_entity_id: varint64
2434
+ # Flags is a list of flags that specify what data is in the packet.
2435
+ flags: DeltaMoveFlags
2436
+ x: flags.has_x?
2437
+ if true: lf32
2438
+ y: flags.has_y?
2439
+ if true: lf32
2440
+ z: flags.has_z?
2441
+ if true: lf32
2442
+ rot_x: flags.has_rot_x?
2443
+ if true: u8 # TODO: * implement ByteFloat
2444
+ rot_y: flags.has_rot_y?
2445
+ if true: u8
2446
+ rot_z: flags.has_rot_z?
2447
+ if true: u8
2448
+
2449
+ DeltaMoveFlags: [ "bitflags",
2450
+ {
2451
+ "type": "lu16",
2452
+ "flags": {
2453
+ "has_x": 0x01,
2454
+ "has_y": 0x02,
2455
+ "has_z": 0x04,
2456
+ "has_rot_x": 0x08,
2457
+ "has_rot_y": 0x10,
2458
+ "has_rot_z": 0x20,
2459
+ "on_ground": 0x40,
2460
+ "teleport": 0x80,
2461
+ "force_move": 0x100
2462
+ }
2463
+ }
2464
+ ]
2465
+
2466
+ # SetScoreboardIdentity is sent by the server to change the identity type of one of the entries on a
2467
+ # scoreboard. This is used to change, for example, an entry pointing to a player, to a fake player when it
2468
+ # leaves the server, and to change it back to a real player when it joins again.
2469
+ # In non-vanilla situations, the packet is quite useless.
2470
+ packet_set_scoreboard_identity:
2471
+ !id: 0x70
2472
+ !bound: client
2473
+ # ActionType is the type of the action to execute. The action is either ScoreboardIdentityActionRegister
2474
+ # to associate an identity with the entry, or ScoreboardIdentityActionClear to remove associations with
2475
+ # an entity.
2476
+ action: i8 =>
2477
+ 0: register_identity
2478
+ 1: clear_identity
2479
+ # Entries is a list of all entries in the packet. Each of these entries points to one of the entries on
2480
+ # a scoreboard. Depending on ActionType, their identity will either be registered or cleared.
2481
+ entries: []varint
2482
+ scoreboard_id: zigzag64
2483
+ entity_unique_id: ../action ?
2484
+ if register_identity: zigzag64
2485
+ default: void
2486
+
2487
+
2488
+ # SetLocalPlayerAsInitialised is sent by the client in response to a PlayStatus packet with the status set
2489
+ # to spawn. The packet marks the moment at which the client is fully initialised and can receive any packet
2490
+ # without discarding it.
2491
+ packet_set_local_player_as_initialized:
2492
+ !id: 0x71
2493
+ !bound: server
2494
+ # EntityRuntimeID is the entity runtime ID the player was assigned earlier in the login sequence in the
2495
+ # StartGame packet.
2496
+ runtime_entity_id: varint64
2497
+
2498
+ packet_update_soft_enum:
2499
+ !id: 0x72
2500
+ !bound: client
2501
+
2502
+ # NetworkStackLatency is sent by the server (and the client, on development builds) to measure the latency
2503
+ # over the entire Minecraft stack, rather than the RakNet latency. It has other usages too, such as the
2504
+ # ability to be used as some kind of acknowledgement packet, to know when the client has received a certain
2505
+ # other packet.
2506
+ packet_network_stack_latency:
2507
+ !id: 0x73
2508
+ !bound: both
2509
+ # Timestamp is the timestamp of the network stack latency packet. The client will, if NeedsResponse is
2510
+ # set to true, send a NetworkStackLatency packet with this same timestamp packet in response.
2511
+ timestamp: lu64
2512
+ # NeedsResponse specifies if the sending side of this packet wants a response to the packet, meaning that
2513
+ # the other side should send a NetworkStackLatency packet back.
2514
+ needs_response: u8
2515
+
2516
+ # ScriptCustomEvent is sent by both the client and the server. It is a way to let scripts communicate with
2517
+ # the server, so that the client can let the server know it triggered an event, or the other way around.
2518
+ # It is essentially an RPC kind of system.
2519
+ packet_script_custom_event:
2520
+ !id: 0x75
2521
+ !bound: both
2522
+ # EventName is the name of the event. The script and the server will use this event name to identify the
2523
+ # data that is sent.
2524
+ event_name: string
2525
+ # EventData is the data of the event. This data is typically a JSON encoded string, that the script is
2526
+ # able to encode and decode too.
2527
+ event_data: string
2528
+
2529
+ # SpawnParticleEffect is sent by the server to spawn a particle effect client-side. Unlike other packets that
2530
+ # result in the appearing of particles, this packet can show particles that are not hardcoded in the client.
2531
+ # They can be added and changed through behaviour packs to implement custom particles.
2532
+ packet_spawn_particle_effect:
2533
+ !id: 0x76
2534
+ !bound: client
2535
+ # Dimension is the dimension that the particle is spawned in. Its exact usage is not clear, as the
2536
+ # dimension has no direct effect on the particle.
2537
+ dimension: u8
2538
+ # EntityUniqueID is the unique ID of the entity that the spawned particle may be attached to. If this ID
2539
+ # is not -1, the Position below will be interpreted as relative to the position of the entity associated
2540
+ # with this unique ID.
2541
+ entity_id: zigzag64
2542
+ # Position is the position that the particle should be spawned at. If the position is too far away from
2543
+ # the player, it will not show up.
2544
+ # If EntityUniqueID is not -1, the position will be relative to the position of the entity.
2545
+ position: vec3f
2546
+ # ParticleName is the name of the particle that should be shown. This name may point to a particle effect
2547
+ # that is built-in, or to one implemented by behaviour packs.
2548
+ particle_name: string
2549
+ # MoLangVariables is an encoded JSON map of MoLang variables that may be applicable to the particle spawn. This can
2550
+ # just be left empty in most cases.
2551
+ # TODO: Investigate, probably not a ByteArray...
2552
+ molang_variables: ByteArray
2553
+
2554
+ # AvailableActorIdentifiers is sent by the server at the start of the game to let the client know all
2555
+ # entities that are available on the server.
2556
+ packet_available_entity_identifiers:
2557
+ !id: 0x77
2558
+ !bound: client
2559
+ # SerialisedEntityIdentifiers is a network NBT serialised compound of all entity identifiers that are
2560
+ # available in the server.
2561
+ nbt: nbt
2562
+
2563
+ # Not used. Use `packet_level_sound_event`.
2564
+ packet_level_sound_event_v2:
2565
+ !id: 0x78
2566
+ !bound: both
2567
+ sound_id: u8
2568
+ position: vec3f
2569
+ block_id: zigzag32
2570
+ entity_type: string
2571
+ is_baby_mob: bool
2572
+ is_global: bool
2573
+
2574
+ # NetworkChunkPublisherUpdate is sent by the server to change the point around which chunks are and remain
2575
+ # loaded. This is useful for mini-game servers, where only one area is ever loaded, in which case the
2576
+ # NetworkChunkPublisherUpdate packet can be sent in the middle of it, so that no chunks ever need to be
2577
+ # additionally sent during the course of the game.
2578
+ # In reality, the packet is not extraordinarily useful, and most servers just send it constantly at the
2579
+ # position of the player.
2580
+ # If the packet is not sent at all, no chunks will be shown to the player, regardless of where they are sent.
2581
+ packet_network_chunk_publisher_update:
2582
+ !id: 0x79
2583
+ !bound: client
2584
+ # Position is the block position around which chunks loaded will remain shown to the client. Most servers
2585
+ # set this position to the position of the player itself.
2586
+ coordinates: BlockCoordinates
2587
+ # Radius is the radius in blocks around Position that chunks sent show up in and will remain loaded in.
2588
+ # Unlike the RequestChunkRadius and ChunkRadiusUpdated packets, this radius is in blocks rather than
2589
+ # chunks, so the chunk radius needs to be multiplied by 16. (Or shifted to the left by 4.)
2590
+ radius: varint
2591
+ saved_chunks: []lu32
2592
+ # ChunkX is the X coordinate of the chunk sent. (To translate a block's X to a chunk's X: x >> 4)
2593
+ x: zigzag32
2594
+ # ChunkZ is the Z coordinate of the chunk sent. (To translate a block's Z to a chunk's Z: z >> 4)
2595
+ z: zigzag32
2596
+
2597
+
2598
+ # BiomeDefinitionList is sent by the server to let the client know all biomes that are available and
2599
+ # implemented on the server side. It is much like the AvailableActorIdentifiers packet, but instead
2600
+ # functions for biomes.
2601
+ packet_biome_definition_list:
2602
+ !id: 0x7a
2603
+ !bound: client
2604
+ # SerialisedBiomeDefinitions is a network NBT serialised compound of all definitions of biomes that are
2605
+ # available on the server.
2606
+ nbt: nbt
2607
+
2608
+ # LevelSoundEvent is sent by the server to make any kind of built-in sound heard to a player. It is sent to,
2609
+ # for example, play a stepping sound or a shear sound. The packet is also sent by the client, in which case
2610
+ # it could be forwarded by the server to the other players online. If possible, the packets from the client
2611
+ # should be ignored however, and the server should play them on its own accord.
2612
+ packet_level_sound_event:
2613
+ !id: 0x7b
2614
+ !bound: both
2615
+ # SoundType is the type of the sound to play. Some of the sound types
2616
+ # require additional data, which is set in the EventData field.
2617
+ sound_id: SoundType
2618
+ # Position is the position of the sound event. The player will be able to hear the direction of the sound
2619
+ # based on what position is sent here.
2620
+ position: vec3f
2621
+ # ExtraData is a packed integer that some sound types use to provide extra data. An example of this is
2622
+ # the note sound, which is composed of a pitch and an instrument type.
2623
+ extra_data: zigzag32
2624
+ # EntityType is the string entity type of the entity that emitted the sound, for example
2625
+ # 'minecraft:skeleton'. Some sound types use this entity type for additional data.
2626
+ entity_type: string
2627
+ # BabyMob specifies if the sound should be that of a baby mob. It is most notably used for parrot
2628
+ # imitations, which will change based on if this field is set to true or not.
2629
+ is_baby_mob: bool
2630
+ # DisableRelativeVolume specifies if the sound should be played relatively or not. If set to true, the
2631
+ # sound will have full volume, regardless of where the Position is, whereas if set to false, the sound's
2632
+ # volume will be based on the distance to Position.
2633
+ is_global: bool
2634
+
2635
+ # LevelEventGeneric is sent by the server to send a 'generic' level event to the client. This packet sends an
2636
+ # NBT serialised object and may for that reason be used for any event holding additional data.
2637
+ packet_level_event_generic:
2638
+ !id: 0x7c
2639
+ !bound: client
2640
+ # EventID is a unique identifier that identifies the event called. The data that follows has fields in
2641
+ # the NBT depending on what event it is.
2642
+ event_id: varint
2643
+ # SerialisedEventData is a network little endian serialised object of event data, with fields that vary
2644
+ # depending on EventID.
2645
+ # Unlike many other NBT structures, this data is not actually in a compound but just loosely floating
2646
+ # NBT tags. To decode using the nbt package, you would need to append 0x0a00 at the start (compound id
2647
+ # and name length) and add 0x00 at the end, to manually wrap it in a compound. Likewise, you would have
2648
+ # to remove these bytes when encoding.
2649
+ nbt: nbtLoop
2650
+
2651
+ # LecternUpdate is sent by the client to update the server on which page was opened in a book on a lectern,
2652
+ # or if the book should be removed from it.
2653
+ packet_lectern_update:
2654
+ !id: 0x7d
2655
+ !bound: client
2656
+ # Page is the page number in the book that was opened by the player on the lectern.
2657
+ page: u8
2658
+ # PageCount is the number of pages that the book opened in the lectern has.
2659
+ page_count: u8
2660
+ # Position is the position of the lectern that was updated. If no lectern is at the block position,
2661
+ # the packet should be ignored.
2662
+ position: vec3i
2663
+ # DropBook specifies if the book currently set on display in the lectern should be dropped server-side.
2664
+ drop_book: bool
2665
+
2666
+ # This packet was removed.
2667
+ packet_video_stream_connect:
2668
+ !id: 0x7e
2669
+ !bound: client
2670
+ server_uri: string
2671
+ frame_send_frequency: lf32
2672
+ action: u8
2673
+ resolution_x: li32
2674
+ resolution_y: li32
2675
+
2676
+ # This is NOT a Minecraft entity, but an entity in the Entity Component System (ECS)
2677
+ # for the game engine Minecrat Bedrock uses. Internally, all 'Minecraft entities' are
2678
+ # known as Actors including in packet names and fields. However, these are irrelevant
2679
+ # internal details so we don't do the renames in these protocol definitions, for simplicity we just use Entity.
2680
+ #
2681
+ # AddEntity is sent by the server to the client. Its function is not entirely clear: It does not add an
2682
+ # entity in the sense of an in-game entity, but has to do with the ECS that Minecraft uses.
2683
+ packet_add_ecs_entity:
2684
+ !id: 0x7f
2685
+ !bound: client
2686
+ # EntityNetworkID is the network ID of the entity that should be added.
2687
+ network_id: varint64
2688
+
2689
+ # RemoveEntity is sent by the server to the client. Its function is not entirely clear: It does not remove an
2690
+ # entity in the sense of an in-game entity, but has to do with the ECS that Minecraft uses
2691
+ packet_remove_ecs_entity:
2692
+ !id: 0x80
2693
+ !bound: client
2694
+ # EntityNetworkID is the network ID of the entity that should be removed.
2695
+ network_id: varint64
2696
+
2697
+ # ClientCacheStatus is sent by the client to the server at the start of the game. It is sent to let the
2698
+ # server know if it supports the client-side blob cache. Clients such as Nintendo Switch do not support the
2699
+ # cache, and attempting to use it anyway will fail.
2700
+ packet_client_cache_status:
2701
+ !id: 0x81
2702
+ !bound: both
2703
+ # Enabled specifies if the blob cache is enabled. If false, the server should not attempt to use the
2704
+ # blob cache. If true, it may do so, but it may also choose not to use it.
2705
+ enabled: bool
2706
+
2707
+ # OnScreenTextureAnimation is sent by the server to show a certain animation on the screen of the player.
2708
+ # The packet is used, as an example, for when a raid is triggered and when a raid is defeated.
2709
+ packet_on_screen_texture_animation:
2710
+ !id: 0x82
2711
+ !bound: client
2712
+ # AnimationType is the type of the animation to show. The packet provides no further extra data to allow
2713
+ # modifying the duration or other properties of the animation.
2714
+ animation_type: lu32
2715
+
2716
+
2717
+ # MapCreateLockedCopy is sent by the server to create a locked copy of one map into another map. In vanilla,
2718
+ # it is used in the cartography table to create a map that is locked and cannot be modified.
2719
+ packet_map_create_locked_copy:
2720
+ !id: 0x83
2721
+ !bound: client
2722
+ # OriginalMapID is the ID of the map that is being copied. The locked copy will obtain all content that
2723
+ # is visible on this map, except the content will not change.
2724
+ original_map_id: zigzag64
2725
+ # NewMapID is the ID of the map that holds the locked copy of the map that OriginalMapID points to. Its
2726
+ # contents will be impossible to change.
2727
+ new_map_id: zigzag64
2728
+
2729
+
2730
+ # StructureTemplateDataRequest is sent by the client to request data of a structure.
2731
+ packet_structure_template_data_export_request:
2732
+ !id: 0x84
2733
+ !bound: client
2734
+ # StructureName is the name of the structure that was set in the structure block's UI. This is the name
2735
+ # used to export the structure to a file.
2736
+ name: string
2737
+ # Position is the position of the structure block that has its template data requested.
2738
+ position: BlockCoordinates
2739
+ # Settings is a struct of settings that should be used for exporting the structure. These settings are
2740
+ # identical to the last sent in the StructureBlockUpdate packet by the client.
2741
+ settings: StructureBlockSettings
2742
+ # RequestType specifies the type of template data request that the player sent.
2743
+ request_type: u8 =>
2744
+ 1: export_from_save
2745
+ 2: export_from_load
2746
+ 3: query_saved_structure
2747
+ 4: import_from_save
2748
+
2749
+ # StructureTemplateDataResponse is sent by the server to send data of a structure to the client in response
2750
+ # to a StructureTemplateDataRequest packet.
2751
+ packet_structure_template_data_export_response:
2752
+ !id: 0x85
2753
+ !bound: client
2754
+ name: string
2755
+ success: bool
2756
+ nbt: success ?
2757
+ if true: nbt
2758
+ # ResponseType specifies the response type of the packet. This depends on the RequestType field sent in
2759
+ # the StructureTemplateDataRequest packet and is one of the constants above.
2760
+ response_type: u8 =>
2761
+ 1: export
2762
+ 2: query
2763
+ 3: import
2764
+
2765
+ # No longer used.
2766
+ packet_update_block_properties:
2767
+ !id: 0x86
2768
+ !bound: client
2769
+ nbt: nbt
2770
+
2771
+ # ClientCacheBlobStatus is part of the blob cache protocol. It is sent by the client to let the server know
2772
+ # what blobs it needs and which blobs it already has, in an ACK type system.
2773
+ packet_client_cache_blob_status:
2774
+ !id: 0x87
2775
+ !bound: client
2776
+ # The number of MISSes in this packet
2777
+ misses: varint
2778
+ # The number of HITs in this packet
2779
+ haves: varint
2780
+ # A list of blob hashes that the client does not have a blob available for. The server
2781
+ # should send the blobs matching these hashes as soon as possible.
2782
+ missing: lu64[]$misses
2783
+ # A list of hashes that the client does have a cached blob for. Server doesn't need to send.
2784
+ have: lu64[]$haves
2785
+
2786
+ # ClientCacheMissResponse is part of the blob cache protocol. It is sent by the server in response to a
2787
+ # ClientCacheBlobStatus packet and contains the blob data of all blobs that the client acknowledged not to
2788
+ # have yet.
2789
+ packet_client_cache_miss_response:
2790
+ !id: 0x88
2791
+ !bound: client
2792
+ blobs: Blob[]varint
2793
+
2794
+ # EducationSettings is a packet sent by the server to update Minecraft: Education Edition related settings.
2795
+ # It is unused by the normal base game.
2796
+ packet_education_settings:
2797
+ !id: 0x89
2798
+ !bound: client
2799
+ # CodeBuilderDefaultURI is the default URI that the code builder is ran on. Using this, a Code Builder
2800
+ # program can make code directly affect the server.
2801
+ CodeBuilderDefaultURI: string
2802
+ # CodeBuilderTitle is the title of the code builder shown when connected to the CodeBuilderDefaultURI.
2803
+ CodeBuilderTitle: string
2804
+ # CanResizeCodeBuilder specifies if clients connected to the world should be able to resize the code
2805
+ # builder when it is opened.
2806
+ CanResizeCodeBuilder: bool
2807
+ disable_legacy_title_bar: bool
2808
+ post_process_filter: string
2809
+ screenshot_border_path: string
2810
+ has_agent_capabilities: bool
2811
+ agent_capabilities: has_agent_capabilities ?
2812
+ if true:
2813
+ has: bool
2814
+ can_modify_blocks: bool
2815
+ HasOverrideURI: bool
2816
+ OverrideURI: HasOverrideURI?
2817
+ if true: string
2818
+ # HasQuiz specifies if the world has a quiz connected to it.
2819
+ HasQuiz: bool
2820
+ has_external_link_settings: bool
2821
+ external_link_settings: has_external_link_settings ?
2822
+ has: bool
2823
+ url: string
2824
+ display_name: string
2825
+
2826
+ # Emote is sent by both the server and the client. When the client sends an emote, it sends this packet to
2827
+ # the server, after which the server will broadcast the packet to other players online.
2828
+ packet_emote:
2829
+ !id: 0x8a
2830
+ !bound: both
2831
+ # EntityRuntimeID is the entity that sent the emote. When a player sends this packet, it has this field
2832
+ # set as its own entity runtime ID.
2833
+ entity_id: varint64
2834
+ # EmoteID is the ID of the emote to send.
2835
+ emote_id: string
2836
+ # Flags is a combination of flags that change the way the Emote packet operates. When the server sends
2837
+ # this packet to other players, EmoteFlagServerSide must be present.
2838
+ flags: u8
2839
+
2840
+ # MultiPlayerSettings is sent by the client to update multi-player related settings server-side and sent back
2841
+ # to online players by the server.
2842
+ # The MultiPlayerSettings packet is a Minecraft: Education Edition packet. It has no functionality for the
2843
+ # base game.
2844
+ packet_multiplayer_settings:
2845
+ !id: 0x8b
2846
+ !bound: server
2847
+ # ActionType is the action that should be done when this packet is sent. It is one of the constants that
2848
+ # may be found above.
2849
+ action_type: zigzag32 =>
2850
+ 0: enable_multiplayer
2851
+ 1: disable_multiplayer
2852
+ 2: refresh_join_code
2853
+
2854
+ # SettingsCommand is sent by the client when it changes a setting in the settings that results in the issuing
2855
+ # of a command to the server, such as when Show Coordinates is enabled.
2856
+ packet_settings_command:
2857
+ !id: 0x8c
2858
+ !bound: server
2859
+ # CommandLine is the full command line that was sent to the server as a result of the setting that the
2860
+ # client changed.
2861
+ command_line: string
2862
+ # SuppressOutput specifies if the client requests the suppressing of the output of the command that was
2863
+ # executed. Generally this is set to true, as the client won't need a message to confirm the output of
2864
+ # the change.
2865
+ suppress_output: bool
2866
+
2867
+ # AnvilDamage is sent by the client to request the dealing damage to an anvil. This packet is completely
2868
+ # pointless and the server should never listen to it.
2869
+ packet_anvil_damage:
2870
+ !id: 0x8d
2871
+ !bound: server
2872
+ # Damage is the damage that the client requests to be dealt to the anvil.
2873
+ damage: u8
2874
+ # AnvilPosition is the position in the world that the anvil can be found at.
2875
+ position: BlockCoordinates
2876
+
2877
+ # CompletedUsingItem is sent by the server to tell the client that it should be done using the item it is
2878
+ # currently using.
2879
+ packet_completed_using_item:
2880
+ !id: 0x8e
2881
+ !bound: client
2882
+ # UsedItemID is the item ID of the item that the client completed using. This should typically be the
2883
+ # ID of the item held in the hand.
2884
+ used_item_id: li16
2885
+ # UseMethod is the method of the using of the item that was completed. It is one of the constants that
2886
+ # may be found above.
2887
+ use_method: li32 =>
2888
+ 0: equip_armor
2889
+ 1: eat
2890
+ 2: attack
2891
+ 3: consume
2892
+ 4: throw
2893
+ 5: shoot
2894
+ 6: place
2895
+ 7: fill_bottle
2896
+ 8: fill_bucket
2897
+ 9: pour_bucket
2898
+ 10: use_tool
2899
+ 11: interact
2900
+ 12: retrieved
2901
+ 13: dyed
2902
+ 14: traded
2903
+
2904
+ # NetworkSettings is sent by the server to update a variety of network settings. These settings modify the
2905
+ # way packets are sent over the network stack.
2906
+ packet_network_settings:
2907
+ !id: 0x8f
2908
+ !bound: client
2909
+ # CompressionThreshold is the minimum size of a packet that is compressed when sent. If the size of a
2910
+ # packet is under this value, it is not compressed.
2911
+ # When set to 0, all packets will be left uncompressed.
2912
+ compression_threshold: lu16
2913
+ # CompressionAlgorithm is the algorithm that is used to compress packets.
2914
+ compression_algorithm: lu16 =>
2915
+ 0: deflate
2916
+ 1: snappy
2917
+ # ClientThrottle regulates whether the client should throttle players when exceeding of the threshold. Players
2918
+ # outside threshold will not be ticked, improving performance on low-end devices.
2919
+ client_throttle: bool
2920
+ # ClientThrottleThreshold is the threshold for client throttling. If the number of players exceeds this value, the
2921
+ # client will throttle players.
2922
+ client_throttle_threshold: u8
2923
+ # ClientThrottleScalar is the scalar for client throttling. The scalar is the amount of players that are ticked
2924
+ # when throttling is enabled.
2925
+ client_throttle_scalar: lf32
2926
+
2927
+ # PlayerAuthInput is sent by the client to allow for server authoritative movement. It is used to synchronise
2928
+ # the player input with the position server-side.
2929
+ # The client sends this packet when the ServerAuthoritativeMovementMode field in the StartGame packet is set
2930
+ # to true, instead of the MovePlayer packet. The client will send this packet once every tick.
2931
+ packet_player_auth_input:
2932
+ !id: 0x90
2933
+ !bound: server
2934
+ # Pitch that the player reports it has.
2935
+ pitch: lf32
2936
+ # Yaw that player reports it has.
2937
+ yaw: lf32
2938
+ # Position holds the position that the player reports it has.
2939
+ position: vec3f
2940
+ # MoveVector is a Vec2 that specifies the direction in which the player moved, as a combination of X/Z
2941
+ # values which are created using the WASD/controller stick state.
2942
+ move_vector: vec2f
2943
+ # HeadYaw is the horizontal rotation of the head that the player reports it has.
2944
+ head_yaw: lf32
2945
+ # InputData is a combination of bit flags that together specify the way the player moved last tick. It
2946
+ # is a combination of the flags above.
2947
+ input_data: InputFlag
2948
+ # InputMode specifies the way that the client inputs data to the screen. It is one of the constants that
2949
+ # may be found above.
2950
+ input_mode: varint =>
2951
+ 0: unknown
2952
+ 1: mouse
2953
+ 2: touch
2954
+ 3: game_pad
2955
+ 4: motion_controller
2956
+ # PlayMode specifies the way that the player is playing. The values it holds, which are rather random,
2957
+ # may be found above.
2958
+ play_mode: varint =>
2959
+ 0: normal
2960
+ 1: teaser
2961
+ 2: screen
2962
+ 3: viewer
2963
+ 4: reality
2964
+ 5: placement
2965
+ 6: living_room
2966
+ 7: exit_level
2967
+ 8: exit_level_living_room
2968
+ 9: num_modes
2969
+ # InteractionModel is a constant representing the interaction model the player is using.
2970
+ interaction_model: zigzag32 =>
2971
+ - touch
2972
+ - crosshair
2973
+ - classic
2974
+ # GazeDirection is the direction in which the player is gazing, when the PlayMode is PlayModeReality: In
2975
+ # other words, when the player is playing in virtual reality.
2976
+ gaze_direction: play_mode ?
2977
+ if reality: vec3f
2978
+ # Tick is the server tick at which the packet was sent. It is used in relation to
2979
+ # CorrectPlayerMovePrediction.
2980
+ tick: varint64
2981
+ # Delta was the delta between the old and the new position. There isn't any practical use for this field
2982
+ # as it can be calculated by the server itself.
2983
+ delta: vec3f
2984
+ transaction: input_data.item_interact ?
2985
+ if true:
2986
+ legacy: TransactionLegacy
2987
+ actions: TransactionActions
2988
+ data: TransactionUseItem
2989
+ item_stack_request: input_data.item_stack_request ?
2990
+ if true: ItemStackRequest
2991
+ block_action: input_data.block_action ?
2992
+ if true: []zigzag32
2993
+ action: Action
2994
+ _: action?
2995
+ if start_break or abort_break or crack_break or predict_break or continue_break:
2996
+ # BlockPosition is the position of the target block, if the action with the ActionType set concerned a
2997
+ # block. If that is not the case, the block position will be zero.
2998
+ position: BlockCoordinates
2999
+ # BlockFace is the face of the target block that was touched. If the action with the ActionType set
3000
+ # concerned a block. If not, the face is always 0.
3001
+ face: zigzag32
3002
+
3003
+ #TODO: update to use the new `shift` option in bitflags
3004
+ InputFlag: [ "bitflags", {
3005
+ "type": "varint64", "big": true,
3006
+ "flags": [
3007
+ "ascend",
3008
+ "descend",
3009
+ "north_jump",
3010
+ "jump_down",
3011
+ "sprint_down",
3012
+ "change_height",
3013
+ "jumping",
3014
+ "auto_jumping_in_water",
3015
+ "sneaking",
3016
+ "sneak_down",
3017
+ "up",
3018
+ "down",
3019
+ "left",
3020
+ "right",
3021
+ "up_left",
3022
+ "up_right",
3023
+ "want_up",
3024
+ "want_down",
3025
+ "want_down_slow",
3026
+ "want_up_slow",
3027
+ "sprinting",
3028
+ "ascend_block",
3029
+ "descend_block",
3030
+ "sneak_toggle_down",
3031
+ "persist_sneak",
3032
+ "start_sprinting",
3033
+ "stop_sprinting",
3034
+ "start_sneaking",
3035
+ "stop_sneaking",
3036
+ "start_swimming",
3037
+ "stop_swimming",
3038
+ "start_jumping",
3039
+ "start_gliding",
3040
+ "stop_gliding",
3041
+ "item_interact",
3042
+ "block_action",
3043
+ "item_stack_request"
3044
+ ]
3045
+ }]
3046
+
3047
+ # CreativeContent is a packet sent by the server to set the creative inventory's content for a player.
3048
+ # Introduced in 1.16, this packet replaces the previous method - sending an InventoryContent packet with
3049
+ # creative inventory window ID.
3050
+ # As of v1.16.100, this packet must be sent during the login sequence. Not sending it will stop the client
3051
+ # from joining the server.
3052
+ packet_creative_content:
3053
+ !id: 0x91
3054
+ !bound: client
3055
+ # Items is a list of the items that should be added to the creative inventory.
3056
+ items: []varint
3057
+ entry_id: varint
3058
+ item: ItemLegacy
3059
+
3060
+ # PlayerEnchantOptions is sent by the server to update the enchantment options displayed when the user opens
3061
+ # the enchantment table and puts an item in. This packet was added in 1.16 and allows the server to decide on
3062
+ # the enchantments that can be selected by the player.
3063
+ # The PlayerEnchantOptions packet should be sent once for every slot update of the enchantment table. The
3064
+ # vanilla server sends an empty PlayerEnchantOptions packet when the player opens the enchantment table
3065
+ # (air is present in the enchantment table slot) and sends the packet with actual enchantments in it when
3066
+ # items are put in that can have enchantments.
3067
+ packet_player_enchant_options:
3068
+ !id: 0x92
3069
+ !bound: client
3070
+ # Options is a list of possible enchantment options for the item that was put into the enchantment table.
3071
+ options: EnchantOption[]varint
3072
+
3073
+ # ItemStackRequest is sent by the client to change item stacks in an inventory. It is essentially a
3074
+ # replacement of the InventoryTransaction packet added in 1.16 for inventory specific actions, such as moving
3075
+ # items around or crafting. The InventoryTransaction packet is still used for actions such as placing blocks
3076
+ # and interacting with entities.
3077
+ packet_item_stack_request:
3078
+ !id: 0x93
3079
+ !bound: server
3080
+ requests: ItemStackRequest[]varint
3081
+
3082
+ # ItemStackResponse is sent by the server in response to an ItemStackRequest packet from the client. This
3083
+ # packet is used to either approve or reject ItemStackRequests from the client. If a request is approved, the
3084
+ # client will simply continue as normal. If rejected, the client will undo the actions so that the inventory
3085
+ # should be in sync with the server again.
3086
+ packet_item_stack_response:
3087
+ !id: 0x94
3088
+ !bound: client
3089
+ # Responses is a list of responses to ItemStackRequests sent by the client before. Responses either
3090
+ # approve or reject a request from the client.
3091
+ # Vanilla limits the size of this slice to 4096.
3092
+ responses: ItemStackResponses
3093
+
3094
+ # PlayerArmourDamage is sent by the server to damage the armour of a player. It is a very efficient packet,
3095
+ # but generally it's much easier to just send a slot update for the damaged armour.
3096
+ packet_player_armor_damage:
3097
+ !id: 0x95
3098
+ !bound: client
3099
+ # Bitset holds a bitset of 4 bits that indicate which pieces of armour need to have damage dealt to them.
3100
+ # The first bit, when toggled, is for a helmet, the second for the chestplate, the third for the leggings
3101
+ # and the fourth for boots.
3102
+ type: ArmorDamageType
3103
+ helmet_damage: type.head ?
3104
+ if true: zigzag32
3105
+ chestplate_damage: type.chest ?
3106
+ if true: zigzag32
3107
+ leggings_damage: type.legs ?
3108
+ if true: zigzag32
3109
+ boots_damage: type.feet ?
3110
+ if true: zigzag32
3111
+
3112
+ ArmorDamageType: [ "bitflags",
3113
+ {
3114
+ "type": "u8",
3115
+ "flags": {
3116
+ "head": 0b1,
3117
+ "chest": 0b10,
3118
+ "legs": 0b100,
3119
+ "feet": 0b1000
3120
+ }
3121
+ }
3122
+ ]
3123
+
3124
+ # UpdatePlayerGameType is sent by the server to change the game mode of a player. It is functionally
3125
+ # identical to the SetPlayerGameType packet.
3126
+ packet_update_player_game_type:
3127
+ !id: 0x97
3128
+ !bound: server
3129
+ # GameType is the new game type of the player. It is one of the constants that can be found in
3130
+ # set_player_game_type.go. Some of these game types require additional flags to be set in an
3131
+ # AdventureSettings packet for the game mode to obtain its full functionality.
3132
+ gamemode: GameMode
3133
+ # PlayerUniqueID is the entity unique ID of the player that should have its game mode updated. If this
3134
+ # packet is sent to other clients with the player unique ID of another player, nothing happens.
3135
+ player_unique_id: zigzag64
3136
+
3137
+
3138
+ # EmoteList is sent by the client every time it joins the server and when it equips new emotes. It may be
3139
+ # used by the server to find out which emotes the client has available. If the player has no emotes equipped,
3140
+ # this packet is not sent.
3141
+ # Under certain circumstances, this packet is also sent from the server to the client, but I was unable to
3142
+ # find when this is done.
3143
+ packet_emote_list:
3144
+ !id: 0x98
3145
+ !bound: server
3146
+ # PlayerRuntimeID is the runtime ID of the player that owns the emote pieces below. If sent by the
3147
+ # client, this player runtime ID is always that of the player itself.
3148
+ player_id: varint64
3149
+ # EmotePieces is a list of emote pieces that the player with the runtime ID above has.
3150
+ emote_pieces: uuid[]varint
3151
+
3152
+ # PositionTrackingDBClientRequest is a packet sent by the client to request the position and dimension of a
3153
+ # 'tracking ID'. These IDs are tracked in a database by the server. In 1.16, this is used for lodestones.
3154
+ # The client will send this request to find the position a lodestone compass needs to point to. If found, it
3155
+ # will point to the lodestone. If not, it will start spinning around.
3156
+ # A PositionTrackingDBServerBroadcast packet should be sent in response to this packet.
3157
+ packet_position_tracking_db_request:
3158
+ !id: 0x9a
3159
+ !bound: server
3160
+ # RequestAction is the action that should be performed upon the receiving of the packet. It is one of the
3161
+ # constants found above.
3162
+ action: u8 =>
3163
+ 0: query
3164
+ # TrackingID is a unique ID used to identify the request. The server responds with a
3165
+ # PositionTrackingDBServerBroadcast packet holding the same ID, so that the client can find out what that
3166
+ # packet was in response to.
3167
+ tracking_id: zigzag32
3168
+
3169
+ # PositionTrackingDBServerBroadcast is sent by the server in response to the
3170
+ # PositionTrackingDBClientRequest packet. This packet is, as of 1.16, currently only used for lodestones. The
3171
+ # server maintains a database with tracking IDs and their position and dimension. The client will request
3172
+ # these tracking IDs, (NBT tag set on the lodestone compass with the tracking ID?) and the server will
3173
+ # respond with the status of those tracking IDs.
3174
+ # What is actually done with the data sent depends on what the client chooses to do with it. For the
3175
+ # lodestone compass, it is used to make the compass point towards lodestones and to make it spin if the
3176
+ # lodestone at a position is no longer there.
3177
+ packet_position_tracking_db_broadcast:
3178
+ !id: 0x99
3179
+ !bound: client
3180
+ # BroadcastAction specifies the status of the position tracking DB response. It is one of the constants
3181
+ # above, specifying the result of the request with the ID below.
3182
+ # The Update action is sent for setting the position of a lodestone compass, the Destroy and NotFound to
3183
+ # indicate that there is not (no longer) a lodestone at that position.
3184
+ broadcast_action: u8 =>
3185
+ 0: update
3186
+ 1: destory
3187
+ 2: not_found
3188
+ # TrackingID is the ID of the PositionTrackingDBClientRequest packet that this packet was in response to.
3189
+ # The tracking ID is also present as the 'id' field in the SerialisedData field.
3190
+ tracking_id: zigzag32
3191
+ nbt: nbt
3192
+
3193
+ # PacketViolationWarning is sent by the client when it receives an invalid packet from the server. It holds
3194
+ # some information on the error that occurred.
3195
+ packet_packet_violation_warning:
3196
+ !id: 0x9c
3197
+ !bound: server
3198
+ violation_type: zigzag32 =>
3199
+ 0: malformed
3200
+ # Severity specifies the severity of the packet violation. The action the client takes after this
3201
+ # violation depends on the severity sent.
3202
+ severity: zigzag32 =>
3203
+ 0: warning
3204
+ 1: final_warning
3205
+ 2: terminating
3206
+ # PacketID is the ID of the invalid packet that was received.
3207
+ packet_id: zigzag32
3208
+ # ViolationContext holds a description on the violation of the packet.
3209
+ reason: string
3210
+
3211
+
3212
+ # MotionPredictionHints is sent by the server to the client. There is a predictive movement component for
3213
+ # entities. This packet fills the "history" of that component and entity movement is computed based on the
3214
+ # points. Vanilla sends this packet instead of the SetActorMotion packet when 'spatial optimisations' are
3215
+ # enabled.
3216
+ packet_motion_prediction_hints:
3217
+ !id: 0x9d
3218
+ !bound: client
3219
+ # EntityRuntimeID is the runtime ID of the entity whose velocity is sent to the client.
3220
+ entity_runtime_id: varint64
3221
+ # Velocity is the server-calculated velocity of the entity at the point of sending the packet.
3222
+ velocity: vec3f
3223
+ # OnGround specifies if the server currently thinks the entity is on the ground.
3224
+ on_ground: bool
3225
+
3226
+
3227
+ # AnimateEntity is sent by the server to animate an entity client-side. It may be used to play a single
3228
+ # animation, or to activate a controller which can start a sequence of animations based on different
3229
+ # conditions specified in an animation controller.
3230
+ # Much of the documentation of this packet can be found at
3231
+ # https://minecraft.gamepedia.com/Bedrock_Edition_beta_animation_documentation.
3232
+ packet_animate_entity:
3233
+ !id: 0x9e
3234
+ !bound: client
3235
+ # Animation is the name of a single animation to start playing.
3236
+ animation: string
3237
+ # NextState is the first state to start with. These states are declared in animation controllers (which,
3238
+ # in themselves, are animations too). These states in turn may have animations and transitions to move to
3239
+ # a next state.
3240
+ next_state: string
3241
+ # StopCondition is a MoLang expression that specifies when the animation should be stopped.
3242
+ stop_condition: string
3243
+ # StopConditionVersion is the MoLang stop condition version.
3244
+ stop_condition_version: li32
3245
+ # Controller is the animation controller that is used to manage animations. These controllers decide when
3246
+ # to play which animation.
3247
+ controller: string
3248
+ # How long to move from the previous animation to the next.
3249
+ blend_out_time: lf32
3250
+ # EntityRuntimeIDs is list of runtime IDs of entities that the animation should be applied to.
3251
+ runtime_entity_ids: varint64[]varint
3252
+
3253
+ # CameraShake is sent by the server to make the camera shake client-side. This feature was added for map-
3254
+ # making partners.
3255
+ packet_camera_shake:
3256
+ !id: 0x9f
3257
+ !bound: client
3258
+ # Intensity is the intensity of the shaking. The client limits this value to 4, so anything higher may
3259
+ # not work.
3260
+ intensity: lf32
3261
+ # Duration is the number of seconds the camera will shake for.
3262
+ duration: lf32
3263
+ # Type is the type of shake, and is one of the constants listed above. The different type affects how
3264
+ # the shake looks in game.
3265
+ type: u8
3266
+ # Action is the action to be performed, and is one of the constants listed above. Currently the
3267
+ # different actions will either add or stop shaking the client.
3268
+ action: u8 =>
3269
+ 0: add
3270
+ 1: stop
3271
+
3272
+ # PlayerFog is sent by the server to render the different fogs in the Stack. The types of fog are controlled
3273
+ # by resource packs to change how they are rendered, and the ability to create custom fog.
3274
+ packet_player_fog:
3275
+ !id: 0xa0
3276
+ !bound: client
3277
+ # Stack is a list of fog identifiers to be sent to the client. Examples of fog identifiers are
3278
+ # "minecraft:fog_ocean" and "minecraft:fog_hell".
3279
+ stack: string[]varint
3280
+
3281
+
3282
+ # CorrectPlayerMovePrediction is sent by the server if and only if StartGame.ServerAuthoritativeMovementMode
3283
+ # is set to AuthoritativeMovementModeServerWithRewind. The packet is used to correct movement at a specific
3284
+ # point in time.
3285
+ packet_correct_player_move_prediction:
3286
+ !id: 0xa1
3287
+ !bound: client
3288
+ # Position is the position that the player is supposed to be at at the tick written in the field below.
3289
+ # The client will change its current position based on movement after that tick starting from the
3290
+ # Position.
3291
+ position: vec3f
3292
+ # Delta is the change in position compared to what the client sent as its position at that specific tick.
3293
+ delta: vec3f
3294
+ # OnGround specifies if the player was on the ground at the time of the tick below.
3295
+ on_ground: bool
3296
+ # Tick is the tick of the movement which was corrected by this packet.
3297
+ tick: varint64
3298
+
3299
+ # ItemComponent is sent by the server to attach client-side components to a custom item.
3300
+ packet_item_component:
3301
+ !id: 0xa2
3302
+ !bound: client
3303
+ # `entries` holds a list of all custom items with their respective components set.
3304
+ entries: ItemComponentList
3305
+
3306
+ # FilterText is sent by the both the client and the server. The client sends the packet to the server to
3307
+ # allow the server to filter the text server-side. The server then responds with the same packet and the
3308
+ # safer version of the text.
3309
+ packet_filter_text_packet:
3310
+ !id: 0xa3
3311
+ !bound: client
3312
+ # Text is either the text from the client or the safer version of the text sent by the server.
3313
+ text: string
3314
+ # FromServer indicates if the packet was sent by the server or not.
3315
+ from_server: bool
3316
+
3317
+ # ClientBoundDebugRenderer is sent by the server to spawn an outlined cube on client-side.
3318
+ packet_debug_renderer:
3319
+ !id: 0xa4
3320
+ !bound: client
3321
+ # Type is the type of action. It is one of the constants above.
3322
+ type: li32 =>
3323
+ 1: clear
3324
+ 2: add_cube
3325
+ _: type ?
3326
+ if clear: void
3327
+ if add_cube:
3328
+ # Text is the text that is displayed above the debug.
3329
+ text: string
3330
+ # Position is the position to spawn the debug on.
3331
+ position: vec3f
3332
+ # Red is the red value from the RGBA colour rendered on the debug.
3333
+ red: lf32
3334
+ # Green is the green value from the RGBA colour rendered on the debug.
3335
+ green: lf32
3336
+ # Blue is the blue value from the RGBA colour rendered on the debug.
3337
+ blue: lf32
3338
+ # Alpha is the alpha value from the RGBA colour rendered on the debug.
3339
+ alpha: lf32
3340
+ # Duration is how long the debug will last in the world for. It is measured in milliseconds.
3341
+ duration: li64
3342
+
3343
+ # Sent by the server to synchronize/update entity properties as NBT, an alternative to Set Entity Data.
3344
+ packet_sync_entity_property:
3345
+ !id: 0xa5
3346
+ !bound: client
3347
+ nbt: nbt
3348
+
3349
+ # AddVolumeEntity sends a volume entity's definition and components from server to client.
3350
+ packet_add_volume_entity:
3351
+ !id: 0xa6
3352
+ !bound: client
3353
+ # EntityRuntimeID is the runtime ID of the entity. The runtime ID is unique for each world session, and
3354
+ # entities are generally identified in packets using this runtime ID.
3355
+ runtime_id: varint64
3356
+ # EntityMetadata is a map of entity metadata, which includes flags and data properties that alter in
3357
+ # particular the way the entity looks.
3358
+ nbt: nbt
3359
+ encoding_identifier: string
3360
+ instance_name: string
3361
+ bounds:
3362
+ min: BlockCoordinates
3363
+ max: BlockCoordinates
3364
+ dimension: zigzag32
3365
+ engine_version: string
3366
+
3367
+ # RemoveVolumeEntity indicates a volume entity to be removed from server to client.
3368
+ packet_remove_volume_entity:
3369
+ !id: 0xa7
3370
+ !bound: client
3371
+ # The Runtime Entity ID
3372
+ entity_id: varint64
3373
+
3374
+ # SimulationType is an in-progress packet. We currently do not know the use case.
3375
+ packet_simulation_type:
3376
+ !id: 0xa8
3377
+ # SimulationType is the simulation type selected
3378
+ type: u8 =>
3379
+ 0: game
3380
+ 1: editor
3381
+ 2: test
3382
+ 3: invalid
3383
+
3384
+ # NPCDialogue is a packet that allows the client to display dialog boxes for interacting with NPCs.
3385
+ packet_npc_dialogue:
3386
+ !id: 0xa9
3387
+ # ActorUniqueID is the ID of the NPC being requested.
3388
+ entity_id: lu64
3389
+ # ActionType is the type of action for the packet.
3390
+ action_type: varint =>
3391
+ 0: open
3392
+ 1: close
3393
+ # Dialogue is the text that the client should see.
3394
+ dialogue: string
3395
+ # SceneName is the scene the data was pulled from for the client.
3396
+ screen_name: string
3397
+ # NPCName is the name of the NPC to be displayed to the client.
3398
+ npc_name: string
3399
+ # ActionJSON is the JSON string of the buttons/actions the server can perform.
3400
+ action_json: string
3401
+
3402
+ packet_edu_uri_resource_packet:
3403
+ !id: 0xaa
3404
+ resource: EducationSharedResourceURI
3405
+
3406
+ # CreatePhoto is a packet that allows players to export photos from their portfolios into items in their inventory.
3407
+ # This packet only works on the Education Edition version of Minecraft.
3408
+ packet_create_photo:
3409
+ !id: 0xab
3410
+ # EntityUniqueID is the unique ID of the entity.
3411
+ entity_unique_id: li64
3412
+ # PhotoName is the name of the photo.
3413
+ photo_name: string
3414
+ # ItemName is the name of the photo as an item.
3415
+ item_name: string
3416
+
3417
+ # UpdateSubChunkBlocks is essentially just UpdateBlock packet, however for a set of blocks in a sub chunk.
3418
+ packet_update_subchunk_blocks:
3419
+ !id: 0xac
3420
+ # SubChunkX, SubChunkY, and SubChunkZ help identify the sub chunk.
3421
+ x: zigzag32
3422
+ y: zigzag32
3423
+ z: zigzag32
3424
+ # Blocks contains each updated block change entry.
3425
+ blocks: BlockUpdate[]varint
3426
+ # Extra contains each updated block change entry for the second layer, usually for waterlogged blocks.
3427
+ extra: BlockUpdate[]varint
3428
+
3429
+ packet_photo_info_request:
3430
+ !id: 0xad
3431
+ photo_id: zigzag64
3432
+
3433
+ SubChunkEntryWithoutCaching: []lu32
3434
+ dx: u8
3435
+ dy: u8
3436
+ dz: u8
3437
+ result: u8 =>
3438
+ 0: undefined
3439
+ 1: success
3440
+ 2: chunk_not_found
3441
+ 3: invalid_dimension
3442
+ 4: player_not_found
3443
+ 5: y_index_out_of_bounds
3444
+ 6: success_all_air
3445
+ # Payload has the terrain data, if the chunk isn't empty and caching is disabled
3446
+ payload: ByteArray
3447
+ heightmap_type: u8 =>
3448
+ 0: no_data
3449
+ 1: has_data
3450
+ 2: too_high
3451
+ 3: too_low
3452
+ heightmap: heightmap_type ?
3453
+ if has_data: '["buffer", { "count": 256 }]'
3454
+
3455
+ SubChunkEntryWithCaching: []lu32
3456
+ dx: u8
3457
+ dy: u8
3458
+ dz: u8
3459
+ result: u8 =>
3460
+ 0: undefined
3461
+ 1: success
3462
+ 2: chunk_not_found
3463
+ 3: invalid_dimension
3464
+ 4: player_not_found
3465
+ 5: y_index_out_of_bounds
3466
+ 6: success_all_air
3467
+ # Payload has the terrain data, if the chunk isn't empty and caching is disabled
3468
+ payload: result ?
3469
+ if success_all_air: void
3470
+ default: ByteArray
3471
+ heightmap_type: u8 =>
3472
+ 0: no_data
3473
+ 1: has_data
3474
+ 2: too_high
3475
+ 3: too_low
3476
+ heightmap: heightmap_type ?
3477
+ if has_data: '["buffer", { "count": 256 }]'
3478
+ blob_id: lu64
3479
+
3480
+ # SubChunk sends data about multiple sub-chunks around a center point.
3481
+ packet_subchunk:
3482
+ !id: 0xae
3483
+ !bound: client
3484
+ cache_enabled: bool
3485
+ dimension: zigzag32
3486
+ # Origin point
3487
+ origin: vec3i
3488
+ entries: cache_enabled ?
3489
+ if true: SubChunkEntryWithCaching
3490
+ if false: SubChunkEntryWithoutCaching
3491
+
3492
+ packet_subchunk_request:
3493
+ !id: 0xaf
3494
+ !bound: server
3495
+ dimension: zigzag32
3496
+ # Origin point
3497
+ origin: vec3i
3498
+ requests: []lu32
3499
+ dx: u8
3500
+ dy: u8
3501
+ dz: u8
3502
+
3503
+ # ClientStartItemCooldown is sent by the client to the server to initiate a cooldown on an item. The purpose of this
3504
+ # packet isn't entirely clear.
3505
+ packet_client_start_item_cooldown:
3506
+ !id: 0xb0
3507
+ !bound: server
3508
+ category: string
3509
+ # Duration is the duration of ticks the cooldown should last.
3510
+ duration: zigzag32
3511
+
3512
+ # ScriptMessage is used to communicate custom messages from the client to the server, or from the server to the client.
3513
+ # While the name may suggest this packet is used for the discontinued scripting API, it is likely instead for the
3514
+ # GameTest framework.
3515
+ packet_script_message:
3516
+ !id: 0xb1
3517
+ !bound: server
3518
+ # Message ID is the identifier of the message, used by either party to identify the message data sent.
3519
+ message_id: string
3520
+ # Data contains the data of the message.
3521
+ data: string
3522
+
3523
+ # CodeBuilderSource is an Education Edition packet sent by the client to the server to run an operation with a
3524
+ packet_code_builder_source:
3525
+ !id: 0xb2
3526
+ !bound: client
3527
+ # Operation is used to distinguish the operation performed. It is always one of the constants listed above.
3528
+ operation: u8 =>
3529
+ - none
3530
+ - get
3531
+ - set
3532
+ - reset
3533
+ # Category is used to distinguish the category of the operation performed. It is always one of the constants
3534
+ category: u8 =>
3535
+ - none
3536
+ - code_status
3537
+ - instantiation
3538
+ # Value contains extra data about the operation performed. It is always empty unless the operation is
3539
+ value: string
3540
+
3541
+ # TickingAreasLoadStatus is sent by the server to the client to notify the client of a ticking area's loading status.
3542
+ packet_ticking_areas_load_status:
3543
+ !id: 0xb3
3544
+ !bound: client
3545
+ # Preload is true if the server is waiting for the area's preload.
3546
+ preload: bool
3547
+
3548
+ # DimensionData is a packet sent from the server to the client containing information about data-driven dimensions
3549
+ # that the server may have registered. This packet does not seem to be sent by default, rather only being sent when
3550
+ # any data-driven dimensions are registered.
3551
+ packet_dimension_data:
3552
+ !id: 0xb4
3553
+ !bound: client
3554
+ definitions: []varint
3555
+ id: string
3556
+ max_height: zigzag32
3557
+ min_height: zigzag32
3558
+ generator: zigzag32 =>
3559
+ 0: legacy
3560
+ 1: overworld
3561
+ 2: flat
3562
+ 3: nether
3563
+ 4: end
3564
+ 5: void
3565
+
3566
+ # AgentAction is an Education Edition packet sent from the server to the client to return a response to a
3567
+ # previously requested action.
3568
+ packet_agent_action:
3569
+ !id: 0xb5
3570
+ !bound: client
3571
+ request_id: string
3572
+ action_type: zigzag32 =>
3573
+ - none
3574
+ - attack
3575
+ - collect
3576
+ - destroy
3577
+ - detect_redstone
3578
+ - detect_obstacle
3579
+ - drop
3580
+ - drop_all
3581
+ - inspect
3582
+ - inspect_data
3583
+ - inspect_item_count
3584
+ - inspect_item_detail
3585
+ - inspect_item_space
3586
+ - interact
3587
+ - move
3588
+ - place_block
3589
+ - till
3590
+ - transfer_item_to
3591
+ - turn
3592
+ body: string
3593
+
3594
+ # ChangeMobProperty is a packet sent from the server to the client to change one of the properties of a mob client-side.
3595
+ packet_change_mob_property:
3596
+ !id: 0xb6
3597
+ !bound: client
3598
+ # EntityUniqueID is the unique ID of the entity whose property is being changed.
3599
+ entity_unique_id: zigzag64
3600
+ # Property is the name of the property being updated.
3601
+ property: string
3602
+ # BoolValue is set if the property value is a bool type. If the type is not a bool, this field is ignored.
3603
+ bool_value: bool
3604
+ # StringValue is set if the property value is a string type. If the type is not a string, this field is ignored.
3605
+ string_value: string
3606
+ # IntValue is set if the property value is an int type. If the type is not an int, this field is ignored.
3607
+ int_value: zigzag32
3608
+ # FloatValue is set if the property value is a float type. If the type is not a float, this field is ignored.
3609
+ float_value: lf32
3610
+
3611
+ # LessonProgress is a packet sent by the server to the client to inform the client of updated progress on a lesson.
3612
+ # This packet only functions on the Minecraft: Education Edition version of the game.
3613
+ packet_lesson_progress:
3614
+ !id: 0xb7
3615
+ # Action is the action the client should perform to show progress. This is one of the constants defined above.
3616
+ action: u8
3617
+ # Score is the score the client should use when displaying the progress.
3618
+ score: zigzag32
3619
+ # Identifier is the identifier of the lesson that is being progressed.
3620
+ identifier: string
3621
+
3622
+ # RequestAbility is a packet sent by the client to the server to request permission for a specific ability from the
3623
+ # server.
3624
+ packet_request_ability:
3625
+ !id: 0xb8
3626
+ !bound: server
3627
+ # Ability is the ability that the client is requesting. This is one of the constants defined above.
3628
+ ability: zigzag32 =>
3629
+ - build
3630
+ - mine
3631
+ - doors_and_switches
3632
+ - open_containers
3633
+ - attack_players
3634
+ - attack_mobs
3635
+ - operator_commands
3636
+ - teleport
3637
+ - invulnerable
3638
+ - flying
3639
+ - may_fly
3640
+ - instant_build
3641
+ - lightning
3642
+ - fly_speed
3643
+ - walk_speed
3644
+ - muted
3645
+ - world_builder
3646
+ - no_clip
3647
+ - ability_count
3648
+ # Value type decides which of the fields you should read/write from
3649
+ value_type: u8 =>
3650
+ 1: bool
3651
+ 2: float
3652
+ # If value type is bool, use this value
3653
+ bool_value: bool
3654
+ # If value type is float, use this value
3655
+ float_val: lf32
3656
+
3657
+ # RequestPermissions is a packet sent from the client to the server to request permissions that the client does not
3658
+ # currently have. It can only be sent by operators and host in vanilla Minecraft.
3659
+ packet_request_permissions:
3660
+ !id: 0xb9
3661
+ !bound: server
3662
+ # EntityUniqueID is the unique ID of the player. The unique ID is unique for the entire world and is
3663
+ # often used in packets. Most servers send an EntityUniqueID equal to the EntityRuntimeID.
3664
+ entity_unique_id: li64
3665
+ # PermissionLevel is the current permission level of the player. Same as constants in AdventureSettings packet.
3666
+ permission_level: PermissionLevel
3667
+ # RequestedPermissions contains the requested permission flags.
3668
+ requested_permissions: RequestPermissions
3669
+
3670
+ RequestPermissions: [ "bitflags",
3671
+ {
3672
+ "type": "lu16",
3673
+ "flags": {
3674
+ "build": 0b1,
3675
+ "mine": 0b10,
3676
+ "doors_and_switches": 0b100,
3677
+ "open_containers": 0b1000,
3678
+ "attack_players": 0b10000,
3679
+ "attack_mobs": 0b100000,
3680
+ "operator": 0b1000000,
3681
+ "teleport": 0b10000000
3682
+ }
3683
+ }
3684
+ ]
3685
+
3686
+ # ToastRequest is a packet sent from the server to the client to display a toast to the top of the screen. These toasts
3687
+ # are the same as the ones seen when, for example, loading a new resource pack or obtaining an achievement.
3688
+ packet_toast_request:
3689
+ !id: 0xba
3690
+ !bound: client
3691
+ # Title is the title of the toast.
3692
+ title: string
3693
+ # Message is the message that the toast may contain alongside the title.
3694
+ message: string
3695
+
3696
+ # UpdateAbilities is a packet sent from the server to the client to update the abilities of the player. It, along with
3697
+ # the UpdateAdventureSettings packet, are replacements of the AdventureSettings packet since v1.19.10.
3698
+ packet_update_abilities:
3699
+ !id: 0xbb
3700
+ !bound: client
3701
+ # EntityUniqueID is the unique ID of the player. The unique ID is a value that remains consistent across
3702
+ # different sessions of the same world, but most servers simply fill the runtime ID of the entity out for
3703
+ # this field.
3704
+ entity_unique_id: li64
3705
+ # PlayerPermissions is the permission level of the player. It is a value from 0-3, with 0 being visitor,
3706
+ # 1 being member, 2 being operator and 3 being custom.
3707
+ permission_level: PermissionLevel
3708
+ # CommandPermissions is a permission level that specifies the kind of commands that the player is
3709
+ # allowed to use. It is one of the CommandPermissionLevel constants in the AdventureSettings packet.
3710
+ command_permission: CommandPermissionLevel
3711
+ # Layers contains all ability layers and their potential values. This should at least have one entry, being the
3712
+ # base layer.
3713
+ abilities: AbilityLayers[]u8
3714
+
3715
+ # UpdateAdventureSettings is a packet sent from the server to the client to update the adventure settings of the player.
3716
+ # It, along with the UpdateAbilities packet, are replacements of the AdventureSettings packet since v1.19.10.
3717
+ packet_update_adventure_settings:
3718
+ !id: 0xbc
3719
+ !bound: client
3720
+ # NoPvM is a boolean indicating whether the player is allowed to fight mobs or not.
3721
+ no_pvm: bool
3722
+ # NoMvP is a boolean indicating whether mobs are allowed to fight the player or not. It is unclear why this is sent
3723
+ # to the client.
3724
+ no_mvp: bool
3725
+ # ImmutableWorld is a boolean indicating whether the player is allowed to modify the world or not.
3726
+ immutable_world: bool
3727
+ # ShowNameTags is a boolean indicating whether player name tags are shown or not.
3728
+ show_name_tags: bool
3729
+ # AutoJump is a boolean indicating whether the player is allowed to jump automatically or not.
3730
+ auto_jump: bool
3731
+
3732
+ # DeathInfo is a packet sent from the server to the client expected to be sent when a player dies. It contains messages
3733
+ # related to the player's death, which are shown on the death screen as of v1.19.10.
3734
+ packet_death_info:
3735
+ !id: 0xbd
3736
+ !bound: client
3737
+ # Cause is the cause of the player's death, such as "suffocation" or "suicide".
3738
+ cause: string
3739
+ # Messages is a list of death messages to be shown on the death screen.
3740
+ messages: string[]varint
3741
+
3742
+ # EditorNetwork is a packet sent from the server to the client and vise-versa to communicate editor-mode related
3743
+ # information. It carries a single compound tag containing the relevant information.
3744
+ packet_editor_network:
3745
+ !id: 0xbe
3746
+ !bound: client
3747
+ # Payload is a network little endian compound tag holding data relevant to the editor.
3748
+ payload: nbt
3749
+
3750
+ # FeatureRegistry is a packet used to notify the client about the world generation features the server is currently
3751
+ # using. This is used in combination with the client-side world generation system introduced in v1.19.20, allowing the
3752
+ # client to completely generate the chunks of the world without having to rely on the server.
3753
+ packet_feature_registry:
3754
+ !id: 0xbf
3755
+ !bound: client
3756
+ # Features is a slice of all registered world generation features.
3757
+ features: []varint
3758
+ name: string
3759
+ options: string
3760
+
3761
+ # ServerStats is a packet sent from the server to the client to update the client on server statistics. It is purely
3762
+ # used for telemetry.
3763
+ packet_server_stats:
3764
+ !id: 0xc0
3765
+ !bound: client
3766
+ server_time: lf32
3767
+ network_time: lf32
3768
+
3769
+ packet_request_network_settings:
3770
+ !id: 0xc1
3771
+ !bound: server
3772
+ client_protocol: i32
3773
+
3774
+ packet_game_test_request:
3775
+ !id: 0xc2
3776
+ # MaxTestsPerBatch ...
3777
+ max_tests_per_batch: varint
3778
+ # Repetitions represents the amount of times the test will be run.
3779
+ repetitions: varint
3780
+ # Rotation represents the rotation of the test. It is one of the constants above.
3781
+ rotation: u8 =>
3782
+ - 0deg
3783
+ - 90deg
3784
+ - 180deg
3785
+ - 270deg
3786
+ - 360deg
3787
+ # StopOnError indicates whether the test should immediately stop when an error is encountered.
3788
+ stop_on_error: bool
3789
+ # Position is the position at which the test will be performed.
3790
+ position: BlockCoordinates
3791
+ # TestsPerRow ...
3792
+ tests_per_row: varint
3793
+ # Name represents the name of the test.
3794
+ name: string
3795
+
3796
+ # GameTestResults is a packet sent in response to the GameTestRequest packet, with a boolean indicating whether the
3797
+ # test was successful or not, and an error string if the test failed.
3798
+ packet_game_test_results:
3799
+ !id: 0xc3
3800
+ # Succeeded indicates whether the test succeeded or not.
3801
+ succeeded: bool
3802
+ # Error is the error that occurred. If Succeeded is true, this field is empty.
3803
+ error: string
3804
+ # Name represents the name of the test.
3805
+ name: string
3806
+
3807
+ InputLockFlags: [ "bitflags", {
3808
+ "type": "varint",
3809
+ "flags": {
3810
+ "move": 0x02,
3811
+ "jump": 0x04,
3812
+ "sneak": 0x08,
3813
+ "mount": 0x10,
3814
+ "dismount": 0x20,
3815
+ "rotation": 0x40
3816
+ }
3817
+ } ]
3818
+
3819
+ packet_update_client_input_locks:
3820
+ !id: 0xc4
3821
+ !bound: client
3822
+ # Locks is an encoded bitset of all locks that are currently active. The locks are defined in the constants above.
3823
+ locks: InputLockFlags
3824
+ # Position is the server's position of the client at the time the packet was sent. It is unclear what the exact
3825
+ # purpose of this field is.
3826
+ position: vec3f