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
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)
58 TileDef in ContentFeatures (non-TileDef deserialization is supported)
61 #define PROTOCOL_VERSION 10
63 #define PROTOCOL_ID 0x4f457403
65 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
66 // base64-encoded SHA-1 (27+\0).
68 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
74 Server's reply to TOSERVER_INIT.
75 Sent second after connected.
78 [2] u8 deployed version
79 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
80 [12] u64 map seed (new as of 2011-02-27)
82 NOTE: The position in here is deprecated; position is
83 explicitly sent afterwards
86 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
87 TOCLIENT_ADDNODE = 0x21,
88 TOCLIENT_REMOVENODE = 0x22,
90 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
93 // Followed by an arbitary number of these:
94 // Number is determined from packet length.
96 [N+2] v3s32 position*100
97 [N+2+12] v3s32 speed*100
98 [N+2+12+12] s32 pitch*100
99 [N+2+12+12+4] s32 yaw*100
102 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
105 // Followed by an arbitary number of these:
106 // Number is determined from packet length.
111 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
113 TOCLIENT_SECTORMETA = 0x26, // Obsolete
117 [3...] v2s16 pos + sector metadata
120 TOCLIENT_INVENTORY = 0x27,
123 [2] serialized inventory
126 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
131 u16 number of player positions
144 TOCLIENT_TIME_OF_DAY = 0x29,
148 Added in a later version:
152 // (oops, there is some gap here)
154 TOCLIENT_CHAT_MESSAGE = 0x30,
161 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
164 u16 count of removed objects
165 for all removed objects {
168 u16 count of added objects
169 for all added objects {
172 u32 initialization data length
173 string initialization data
177 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
194 TOCLIENT_MOVE_PLAYER = 0x34,
197 v3f1000 player position
202 TOCLIENT_ACCESS_DENIED = 0x35,
209 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
212 u16 count of player items
213 for all player items {
215 u16 length of serialized item
216 string serialized item
220 TOCLIENT_DEATHSCREEN = 0x37,
223 u8 bool set camera point target
224 v3f1000 camera point target (to point the death cause or whatever)
227 TOCLIENT_MEDIA = 0x38,
230 u16 total number of texture bunches
231 u16 index of this bunch
232 u32 number of files in this bunch
241 TOCLIENT_TOOLDEF = 0x39,
244 u32 length of the next item
245 serialized ToolDefManager
248 TOCLIENT_NODEDEF = 0x3a,
251 u32 length of the next item
252 serialized NodeDefManager
255 TOCLIENT_CRAFTITEMDEF = 0x3b,
258 u32 length of the next item
259 serialized CraftiItemDefManager
262 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
270 u16 length of sha1_digest
275 TOCLIENT_ITEMDEF = 0x3d,
278 u32 length of next item
279 serialized ItemDefManager
282 TOCLIENT_PLAY_SOUND = 0x3f,
289 u8 type (0=local, 1=positional, 2=object)
290 s32[3] pos_nodes*10000
295 TOCLIENT_STOP_SOUND = 0x40,
301 TOCLIENT_PRIVILEGES = 0x41,
304 u16 number of privileges
315 Sent first after connected.
317 [0] u16 TOSERVER_INIT
318 [2] u8 SER_FMT_VER_HIGHEST
319 [3] u8[20] player_name
320 [23] u8[28] password (new in some version)
321 [51] u16 client network protocol version (new in some version)
324 TOSERVER_INIT2 = 0x11,
326 Sent as an ACK for TOCLIENT_INIT.
327 After this, the server can send data.
329 [0] u16 TOSERVER_INIT2
332 TOSERVER_GETBLOCK=0x20, // Obsolete
333 TOSERVER_ADDNODE = 0x21, // Obsolete
334 TOSERVER_REMOVENODE = 0x22, // Obsolete
336 TOSERVER_PLAYERPOS = 0x23,
339 [2] v3s32 position*100
340 [2+12] v3s32 speed*100
341 [2+12+12] s32 pitch*100
342 [2+12+12+4] s32 yaw*100
345 TOSERVER_GOTBLOCKS = 0x24,
354 TOSERVER_DELETEDBLOCKS = 0x25,
363 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
370 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
374 [2] u8 button (0=left, 1=right)
380 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
385 [3] v3s16 nodepos_undersurface
386 [9] v3s16 nodepos_abovesurface
389 0: start digging (from undersurface)
390 1: place block (to abovesurface)
391 2: stop digging (all parameters ignored)
395 TOSERVER_RELEASE = 0x29, // Obsolete
397 // (oops, there is some gap here)
399 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
408 TOSERVER_INVENTORY_ACTION = 0x31,
410 See InventoryAction in inventory.h
413 TOSERVER_CHAT_MESSAGE = 0x32,
420 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
428 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
432 [2] u8 button (0=left, 1=right)
437 TOSERVER_DAMAGE = 0x35,
443 TOSERVER_PASSWORD=0x36,
445 Sent to change password.
447 [0] u16 TOSERVER_PASSWORD
448 [2] u8[28] old password
449 [30] u8[28] new password
452 TOSERVER_PLAYERITEM=0x37,
454 Sent to change selected item.
456 [0] u16 TOSERVER_PLAYERITEM
460 TOSERVER_RESPAWN=0x38,
465 TOSERVER_INTERACT = 0x39,
470 [5] u32 length of the next item
471 [9] serialized PointedThing
473 0: start digging (from undersurface) or use
474 1: stop digging (all parameters ignored)
476 3: place block or item (to abovesurface)
479 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
482 TOSERVER_REMOVED_SOUNDS = 0x3a,
489 TOSERVER_NODEMETA_FIELDS = 0x3b,
494 u8[len] form name (reserved for future use)
503 TOSERVER_REQUEST_MEDIA = 0x40,
506 u16 number of files requested
515 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
517 SharedBuffer<u8> data(2+2+4);
518 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
519 writeU16(&data[2], time);
520 writeF1000(&data[4], time_speed);