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
69 #define PROTOCOL_VERSION 12
71 #define PROTOCOL_ID 0x4f457403
73 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
74 // base64-encoded SHA-1 (27+\0).
76 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
82 Server's reply to TOSERVER_INIT.
83 Sent second after connected.
86 [2] u8 deployed version
87 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
88 [12] u64 map seed (new as of 2011-02-27)
90 NOTE: The position in here is deprecated; position is
91 explicitly sent afterwards
94 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
95 TOCLIENT_ADDNODE = 0x21,
96 TOCLIENT_REMOVENODE = 0x22,
98 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
101 // Followed by an arbitary number of these:
102 // Number is determined from packet length.
104 [N+2] v3s32 position*100
105 [N+2+12] v3s32 speed*100
106 [N+2+12+12] s32 pitch*100
107 [N+2+12+12+4] s32 yaw*100
110 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
113 // Followed by an arbitary number of these:
114 // Number is determined from packet length.
119 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
121 TOCLIENT_SECTORMETA = 0x26, // Obsolete
125 [3...] v2s16 pos + sector metadata
128 TOCLIENT_INVENTORY = 0x27,
131 [2] serialized inventory
134 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
139 u16 number of player positions
152 TOCLIENT_TIME_OF_DAY = 0x29,
156 Added in a later version:
160 // (oops, there is some gap here)
162 TOCLIENT_CHAT_MESSAGE = 0x30,
169 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
172 u16 count of removed objects
173 for all removed objects {
176 u16 count of added objects
177 for all added objects {
180 u32 initialization data length
181 string initialization data
185 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
202 TOCLIENT_MOVE_PLAYER = 0x34,
205 v3f1000 player position
210 TOCLIENT_ACCESS_DENIED = 0x35,
217 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
220 u16 count of player items
221 for all player items {
223 u16 length of serialized item
224 string serialized item
228 TOCLIENT_DEATHSCREEN = 0x37,
231 u8 bool set camera point target
232 v3f1000 camera point target (to point the death cause or whatever)
235 TOCLIENT_MEDIA = 0x38,
238 u16 total number of texture bunches
239 u16 index of this bunch
240 u32 number of files in this bunch
249 TOCLIENT_TOOLDEF = 0x39,
252 u32 length of the next item
253 serialized ToolDefManager
256 TOCLIENT_NODEDEF = 0x3a,
259 u32 length of the next item
260 serialized NodeDefManager
263 TOCLIENT_CRAFTITEMDEF = 0x3b,
266 u32 length of the next item
267 serialized CraftiItemDefManager
270 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
278 u16 length of sha1_digest
283 TOCLIENT_ITEMDEF = 0x3d,
286 u32 length of next item
287 serialized ItemDefManager
290 TOCLIENT_PLAY_SOUND = 0x3f,
297 u8 type (0=local, 1=positional, 2=object)
298 s32[3] pos_nodes*10000
303 TOCLIENT_STOP_SOUND = 0x40,
309 TOCLIENT_PRIVILEGES = 0x41,
312 u16 number of privileges
318 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
330 Sent first after connected.
332 [0] u16 TOSERVER_INIT
333 [2] u8 SER_FMT_VER_HIGHEST
334 [3] u8[20] player_name
335 [23] u8[28] password (new in some version)
336 [51] u16 client network protocol version (new in some version)
339 TOSERVER_INIT2 = 0x11,
341 Sent as an ACK for TOCLIENT_INIT.
342 After this, the server can send data.
344 [0] u16 TOSERVER_INIT2
347 TOSERVER_GETBLOCK=0x20, // Obsolete
348 TOSERVER_ADDNODE = 0x21, // Obsolete
349 TOSERVER_REMOVENODE = 0x22, // Obsolete
351 TOSERVER_PLAYERPOS = 0x23,
354 [2] v3s32 position*100
355 [2+12] v3s32 speed*100
356 [2+12+12] s32 pitch*100
357 [2+12+12+4] s32 yaw*100
360 TOSERVER_GOTBLOCKS = 0x24,
369 TOSERVER_DELETEDBLOCKS = 0x25,
378 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
385 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
389 [2] u8 button (0=left, 1=right)
395 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
400 [3] v3s16 nodepos_undersurface
401 [9] v3s16 nodepos_abovesurface
404 0: start digging (from undersurface)
405 1: place block (to abovesurface)
406 2: stop digging (all parameters ignored)
410 TOSERVER_RELEASE = 0x29, // Obsolete
412 // (oops, there is some gap here)
414 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
423 TOSERVER_INVENTORY_ACTION = 0x31,
425 See InventoryAction in inventory.h
428 TOSERVER_CHAT_MESSAGE = 0x32,
435 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
443 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
447 [2] u8 button (0=left, 1=right)
452 TOSERVER_DAMAGE = 0x35,
458 TOSERVER_PASSWORD=0x36,
460 Sent to change password.
462 [0] u16 TOSERVER_PASSWORD
463 [2] u8[28] old password
464 [30] u8[28] new password
467 TOSERVER_PLAYERITEM=0x37,
469 Sent to change selected item.
471 [0] u16 TOSERVER_PLAYERITEM
475 TOSERVER_RESPAWN=0x38,
480 TOSERVER_INTERACT = 0x39,
485 [5] u32 length of the next item
486 [9] serialized PointedThing
488 0: start digging (from undersurface) or use
489 1: stop digging (all parameters ignored)
491 3: place block or item (to abovesurface)
494 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
497 TOSERVER_REMOVED_SOUNDS = 0x3a,
504 TOSERVER_NODEMETA_FIELDS = 0x3b,
509 u8[len] form name (reserved for future use)
518 TOSERVER_INVENTORY_FIELDS = 0x3c,
522 u8[len] form name (reserved for future use)
531 TOSERVER_REQUEST_MEDIA = 0x40,
534 u16 number of files requested
543 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
545 SharedBuffer<u8> data(2+2+4);
546 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
547 writeU16(&data[2], time);
548 writeF1000(&data[4], time_speed);