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