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