3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef CLIENTSERVER_HEADER
21 #define CLIENTSERVER_HEADER
23 #include "util/serialize.h"
26 changes by PROTOCOL_VERSION:
29 Base for writing changes here
34 Add TOCLIENT_CRAFTITEMDEF
36 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
37 Obsolete TOSERVER_GROUND_ACTION
39 Make players to be handled mostly as ActiveObjects
41 Only non-cached textures are sent
44 Obsolete TOCLIENT_TOOLDEF
45 Obsolete TOCLIENT_CRAFTITEMDEF
46 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
48 Digging based on item groups
51 ContentFeatures and NodeDefManager use a different serialization
52 format; better for future version cross-compatibility
56 Version raised to force 'fly' and 'fast' privileges into effect.
57 Node metadata change (came in later; somewhat incompatible)
59 TileDef in ContentFeatures
62 TOCLIENT_INVENTORY_FORMSPEC
65 TOSERVER_INVENTORY_FIELDS
67 TOCLIENT_DETACHED_INVENTORY
69 InventoryList field "Width" (deserialization fails with old versions)
71 Added transfer of player pressed keys to the server
72 Added new messages for mesh and bone animation, as well as attachments
73 GENERIC_CMD_SET_ANIMATION
74 GENERIC_CMD_SET_BONE_POSITION
75 GENERIC_CMD_SET_ATTACHMENT
78 #define PROTOCOL_VERSION 14
80 #define PROTOCOL_ID 0x4f457403
82 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
83 // base64-encoded SHA-1 (27+\0).
85 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
91 Server's reply to TOSERVER_INIT.
92 Sent second after connected.
95 [2] u8 deployed version
96 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
97 [12] u64 map seed (new as of 2011-02-27)
99 NOTE: The position in here is deprecated; position is
100 explicitly sent afterwards
103 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
104 TOCLIENT_ADDNODE = 0x21,
105 TOCLIENT_REMOVENODE = 0x22,
107 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
110 // Followed by an arbitary number of these:
111 // Number is determined from packet length.
113 [N+2] v3s32 position*100
114 [N+2+12] v3s32 speed*100
115 [N+2+12+12] s32 pitch*100
116 [N+2+12+12+4] s32 yaw*100
119 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
122 // Followed by an arbitary number of these:
123 // Number is determined from packet length.
128 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
130 TOCLIENT_SECTORMETA = 0x26, // Obsolete
134 [3...] v2s16 pos + sector metadata
137 TOCLIENT_INVENTORY = 0x27,
140 [2] serialized inventory
143 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
148 u16 number of player positions
161 TOCLIENT_TIME_OF_DAY = 0x29,
165 Added in a later version:
169 // (oops, there is some gap here)
171 TOCLIENT_CHAT_MESSAGE = 0x30,
178 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
181 u16 count of removed objects
182 for all removed objects {
185 u16 count of added objects
186 for all added objects {
189 u32 initialization data length
190 string initialization data
194 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
211 TOCLIENT_MOVE_PLAYER = 0x34,
214 v3f1000 player position
219 TOCLIENT_ACCESS_DENIED = 0x35,
226 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
229 u16 count of player items
230 for all player items {
232 u16 length of serialized item
233 string serialized item
237 TOCLIENT_DEATHSCREEN = 0x37,
240 u8 bool set camera point target
241 v3f1000 camera point target (to point the death cause or whatever)
244 TOCLIENT_MEDIA = 0x38,
247 u16 total number of texture bunches
248 u16 index of this bunch
249 u32 number of files in this bunch
258 TOCLIENT_TOOLDEF = 0x39,
261 u32 length of the next item
262 serialized ToolDefManager
265 TOCLIENT_NODEDEF = 0x3a,
268 u32 length of the next item
269 serialized NodeDefManager
272 TOCLIENT_CRAFTITEMDEF = 0x3b,
275 u32 length of the next item
276 serialized CraftiItemDefManager
279 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
287 u16 length of sha1_digest
292 TOCLIENT_ITEMDEF = 0x3d,
295 u32 length of next item
296 serialized ItemDefManager
299 TOCLIENT_PLAY_SOUND = 0x3f,
306 u8 type (0=local, 1=positional, 2=object)
307 s32[3] pos_nodes*10000
312 TOCLIENT_STOP_SOUND = 0x40,
318 TOCLIENT_PRIVILEGES = 0x41,
321 u16 number of privileges
327 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
334 TOCLIENT_DETACHED_INVENTORY = 0x43,
339 [2] serialized inventory
347 Sent first after connected.
349 [0] u16 TOSERVER_INIT
350 [2] u8 SER_FMT_VER_HIGHEST
351 [3] u8[20] player_name
352 [23] u8[28] password (new in some version)
353 [51] u16 client network protocol version (new in some version)
356 TOSERVER_INIT2 = 0x11,
358 Sent as an ACK for TOCLIENT_INIT.
359 After this, the server can send data.
361 [0] u16 TOSERVER_INIT2
364 TOSERVER_GETBLOCK=0x20, // Obsolete
365 TOSERVER_ADDNODE = 0x21, // Obsolete
366 TOSERVER_REMOVENODE = 0x22, // Obsolete
368 TOSERVER_PLAYERPOS = 0x23,
371 [2] v3s32 position*100
372 [2+12] v3s32 speed*100
373 [2+12+12] s32 pitch*100
374 [2+12+12+4] s32 yaw*100
375 [2+12+12+4+4] u32 keyPressed
378 TOSERVER_GOTBLOCKS = 0x24,
387 TOSERVER_DELETEDBLOCKS = 0x25,
396 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
403 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
407 [2] u8 button (0=left, 1=right)
413 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
418 [3] v3s16 nodepos_undersurface
419 [9] v3s16 nodepos_abovesurface
422 0: start digging (from undersurface)
423 1: place block (to abovesurface)
424 2: stop digging (all parameters ignored)
428 TOSERVER_RELEASE = 0x29, // Obsolete
430 // (oops, there is some gap here)
432 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
441 TOSERVER_INVENTORY_ACTION = 0x31,
443 See InventoryAction in inventory.h
446 TOSERVER_CHAT_MESSAGE = 0x32,
453 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
461 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
465 [2] u8 button (0=left, 1=right)
470 TOSERVER_DAMAGE = 0x35,
476 TOSERVER_PASSWORD=0x36,
478 Sent to change password.
480 [0] u16 TOSERVER_PASSWORD
481 [2] u8[28] old password
482 [30] u8[28] new password
485 TOSERVER_PLAYERITEM=0x37,
487 Sent to change selected item.
489 [0] u16 TOSERVER_PLAYERITEM
493 TOSERVER_RESPAWN=0x38,
498 TOSERVER_INTERACT = 0x39,
503 [5] u32 length of the next item
504 [9] serialized PointedThing
506 0: start digging (from undersurface) or use
507 1: stop digging (all parameters ignored)
509 3: place block or item (to abovesurface)
512 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
515 TOSERVER_REMOVED_SOUNDS = 0x3a,
522 TOSERVER_NODEMETA_FIELDS = 0x3b,
527 u8[len] form name (reserved for future use)
536 TOSERVER_INVENTORY_FIELDS = 0x3c,
540 u8[len] form name (reserved for future use)
549 TOSERVER_REQUEST_MEDIA = 0x40,
552 u16 number of files requested
561 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
563 SharedBuffer<u8> data(2+2+4);
564 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
565 writeU16(&data[2], time);
566 writeF1000(&data[4], time_speed);