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)
72 #define PROTOCOL_VERSION 13
74 #define PROTOCOL_ID 0x4f457403
76 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
77 // base64-encoded SHA-1 (27+\0).
79 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
85 Server's reply to TOSERVER_INIT.
86 Sent second after connected.
89 [2] u8 deployed version
90 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
91 [12] u64 map seed (new as of 2011-02-27)
93 NOTE: The position in here is deprecated; position is
94 explicitly sent afterwards
97 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
98 TOCLIENT_ADDNODE = 0x21,
99 TOCLIENT_REMOVENODE = 0x22,
101 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
104 // Followed by an arbitary number of these:
105 // Number is determined from packet length.
107 [N+2] v3s32 position*100
108 [N+2+12] v3s32 speed*100
109 [N+2+12+12] s32 pitch*100
110 [N+2+12+12+4] s32 yaw*100
113 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
116 // Followed by an arbitary number of these:
117 // Number is determined from packet length.
122 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
124 TOCLIENT_SECTORMETA = 0x26, // Obsolete
128 [3...] v2s16 pos + sector metadata
131 TOCLIENT_INVENTORY = 0x27,
134 [2] serialized inventory
137 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
142 u16 number of player positions
155 TOCLIENT_TIME_OF_DAY = 0x29,
159 Added in a later version:
163 // (oops, there is some gap here)
165 TOCLIENT_CHAT_MESSAGE = 0x30,
172 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
175 u16 count of removed objects
176 for all removed objects {
179 u16 count of added objects
180 for all added objects {
183 u32 initialization data length
184 string initialization data
188 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
205 TOCLIENT_MOVE_PLAYER = 0x34,
208 v3f1000 player position
213 TOCLIENT_ACCESS_DENIED = 0x35,
220 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
223 u16 count of player items
224 for all player items {
226 u16 length of serialized item
227 string serialized item
231 TOCLIENT_DEATHSCREEN = 0x37,
234 u8 bool set camera point target
235 v3f1000 camera point target (to point the death cause or whatever)
238 TOCLIENT_MEDIA = 0x38,
241 u16 total number of texture bunches
242 u16 index of this bunch
243 u32 number of files in this bunch
252 TOCLIENT_TOOLDEF = 0x39,
255 u32 length of the next item
256 serialized ToolDefManager
259 TOCLIENT_NODEDEF = 0x3a,
262 u32 length of the next item
263 serialized NodeDefManager
266 TOCLIENT_CRAFTITEMDEF = 0x3b,
269 u32 length of the next item
270 serialized CraftiItemDefManager
273 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
281 u16 length of sha1_digest
286 TOCLIENT_ITEMDEF = 0x3d,
289 u32 length of next item
290 serialized ItemDefManager
293 TOCLIENT_PLAY_SOUND = 0x3f,
300 u8 type (0=local, 1=positional, 2=object)
301 s32[3] pos_nodes*10000
306 TOCLIENT_STOP_SOUND = 0x40,
312 TOCLIENT_PRIVILEGES = 0x41,
315 u16 number of privileges
321 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
328 TOCLIENT_DETACHED_INVENTORY = 0x43,
333 [2] serialized inventory
341 Sent first after connected.
343 [0] u16 TOSERVER_INIT
344 [2] u8 SER_FMT_VER_HIGHEST
345 [3] u8[20] player_name
346 [23] u8[28] password (new in some version)
347 [51] u16 client network protocol version (new in some version)
350 TOSERVER_INIT2 = 0x11,
352 Sent as an ACK for TOCLIENT_INIT.
353 After this, the server can send data.
355 [0] u16 TOSERVER_INIT2
358 TOSERVER_GETBLOCK=0x20, // Obsolete
359 TOSERVER_ADDNODE = 0x21, // Obsolete
360 TOSERVER_REMOVENODE = 0x22, // Obsolete
362 TOSERVER_PLAYERPOS = 0x23,
365 [2] v3s32 position*100
366 [2+12] v3s32 speed*100
367 [2+12+12] s32 pitch*100
368 [2+12+12+4] s32 yaw*100
371 TOSERVER_GOTBLOCKS = 0x24,
380 TOSERVER_DELETEDBLOCKS = 0x25,
389 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
396 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
400 [2] u8 button (0=left, 1=right)
406 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
411 [3] v3s16 nodepos_undersurface
412 [9] v3s16 nodepos_abovesurface
415 0: start digging (from undersurface)
416 1: place block (to abovesurface)
417 2: stop digging (all parameters ignored)
421 TOSERVER_RELEASE = 0x29, // Obsolete
423 // (oops, there is some gap here)
425 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
434 TOSERVER_INVENTORY_ACTION = 0x31,
436 See InventoryAction in inventory.h
439 TOSERVER_CHAT_MESSAGE = 0x32,
446 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
454 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
458 [2] u8 button (0=left, 1=right)
463 TOSERVER_DAMAGE = 0x35,
469 TOSERVER_PASSWORD=0x36,
471 Sent to change password.
473 [0] u16 TOSERVER_PASSWORD
474 [2] u8[28] old password
475 [30] u8[28] new password
478 TOSERVER_PLAYERITEM=0x37,
480 Sent to change selected item.
482 [0] u16 TOSERVER_PLAYERITEM
486 TOSERVER_RESPAWN=0x38,
491 TOSERVER_INTERACT = 0x39,
496 [5] u32 length of the next item
497 [9] serialized PointedThing
499 0: start digging (from undersurface) or use
500 1: stop digging (all parameters ignored)
502 3: place block or item (to abovesurface)
505 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
508 TOSERVER_REMOVED_SOUNDS = 0x3a,
515 TOSERVER_NODEMETA_FIELDS = 0x3b,
520 u8[len] form name (reserved for future use)
529 TOSERVER_INVENTORY_FIELDS = 0x3c,
533 u8[len] form name (reserved for future use)
542 TOSERVER_REQUEST_MEDIA = 0x40,
545 u16 number of files requested
554 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
556 SharedBuffer<u8> data(2+2+4);
557 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
558 writeU16(&data[2], time);
559 writeF1000(&data[4], time_speed);