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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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
55 #define PROTOCOL_VERSION 9
57 #define PROTOCOL_ID 0x4f457403
59 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
60 // base64-encoded SHA-1 (27+\0).
62 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
68 Server's reply to TOSERVER_INIT.
69 Sent second after connected.
72 [2] u8 deployed version
73 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
74 [12] u64 map seed (new as of 2011-02-27)
76 NOTE: The position in here is deprecated; position is
77 explicitly sent afterwards
80 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
81 TOCLIENT_ADDNODE = 0x21,
82 TOCLIENT_REMOVENODE = 0x22,
84 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
87 // Followed by an arbitary number of these:
88 // Number is determined from packet length.
90 [N+2] v3s32 position*100
91 [N+2+12] v3s32 speed*100
92 [N+2+12+12] s32 pitch*100
93 [N+2+12+12+4] s32 yaw*100
96 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
99 // Followed by an arbitary number of these:
100 // Number is determined from packet length.
105 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
107 TOCLIENT_SECTORMETA = 0x26, // Obsolete
111 [3...] v2s16 pos + sector metadata
114 TOCLIENT_INVENTORY = 0x27,
117 [2] serialized inventory
120 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
125 u16 number of player positions
138 TOCLIENT_TIME_OF_DAY = 0x29,
142 Added in a later version:
146 // (oops, there is some gap here)
148 TOCLIENT_CHAT_MESSAGE = 0x30,
155 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
158 u16 count of removed objects
159 for all removed objects {
162 u16 count of added objects
163 for all added objects {
166 u32 initialization data length
167 string initialization data
171 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
188 TOCLIENT_MOVE_PLAYER = 0x34,
191 v3f1000 player position
196 TOCLIENT_ACCESS_DENIED = 0x35,
203 TOCLIENT_PLAYERITEM = 0x36,
206 u16 count of player items
207 for all player items {
209 u16 length of serialized item
210 string serialized item
214 TOCLIENT_DEATHSCREEN = 0x37,
217 u8 bool set camera point target
218 v3f1000 camera point target (to point the death cause or whatever)
221 TOCLIENT_MEDIA = 0x38,
224 u16 total number of texture bunches
225 u16 index of this bunch
226 u32 number of files in this bunch
235 TOCLIENT_TOOLDEF = 0x39,
238 u32 length of the next item
239 serialized ToolDefManager
242 TOCLIENT_NODEDEF = 0x3a,
245 u32 length of the next item
246 serialized NodeDefManager
249 TOCLIENT_CRAFTITEMDEF = 0x3b,
252 u32 length of the next item
253 serialized CraftiItemDefManager
256 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
264 u16 length of sha1_digest
269 TOCLIENT_ITEMDEF = 0x3d,
272 u32 length of next item
273 serialized ItemDefManager
276 TOCLIENT_PLAY_SOUND = 0x3f,
283 u8 type (0=local, 1=positional, 2=object)
284 s32[3] pos_nodes*10000
289 TOCLIENT_STOP_SOUND = 0x40,
300 Sent first after connected.
302 [0] u16 TOSERVER_INIT
303 [2] u8 SER_FMT_VER_HIGHEST
304 [3] u8[20] player_name
305 [23] u8[28] password (new in some version)
306 [51] u16 client network protocol version (new in some version)
309 TOSERVER_INIT2 = 0x11,
311 Sent as an ACK for TOCLIENT_INIT.
312 After this, the server can send data.
314 [0] u16 TOSERVER_INIT2
317 TOSERVER_GETBLOCK=0x20, // Obsolete
318 TOSERVER_ADDNODE = 0x21, // Obsolete
319 TOSERVER_REMOVENODE = 0x22, // Obsolete
321 TOSERVER_PLAYERPOS = 0x23,
324 [2] v3s32 position*100
325 [2+12] v3s32 speed*100
326 [2+12+12] s32 pitch*100
327 [2+12+12+4] s32 yaw*100
330 TOSERVER_GOTBLOCKS = 0x24,
339 TOSERVER_DELETEDBLOCKS = 0x25,
348 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
355 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
359 [2] u8 button (0=left, 1=right)
365 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
370 [3] v3s16 nodepos_undersurface
371 [9] v3s16 nodepos_abovesurface
374 0: start digging (from undersurface)
375 1: place block (to abovesurface)
376 2: stop digging (all parameters ignored)
380 TOSERVER_RELEASE = 0x29, // Obsolete
382 // (oops, there is some gap here)
384 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
393 TOSERVER_INVENTORY_ACTION = 0x31,
395 See InventoryAction in inventory.h
398 TOSERVER_CHAT_MESSAGE = 0x32,
405 TOSERVER_SIGNNODETEXT = 0x33,
413 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
417 [2] u8 button (0=left, 1=right)
422 TOSERVER_DAMAGE = 0x35,
428 TOSERVER_PASSWORD=0x36,
430 Sent to change password.
432 [0] u16 TOSERVER_PASSWORD
433 [2] u8[28] old password
434 [30] u8[28] new password
437 TOSERVER_PLAYERITEM=0x37,
439 Sent to change selected item.
441 [0] u16 TOSERVER_PLAYERITEM
445 TOSERVER_RESPAWN=0x38,
450 TOSERVER_INTERACT = 0x39,
455 [5] u32 length of the next item
456 [9] serialized PointedThing
458 0: start digging (from undersurface) or use
459 1: stop digging (all parameters ignored)
461 3: place block or item (to abovesurface)
464 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
467 TOSERVER_REMOVED_SOUNDS = 0x3a,
474 TOSERVER_REQUEST_MEDIA = 0x40,
477 u16 number of files requested
486 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
488 SharedBuffer<u8> data(2+2+4);
489 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
490 writeU16(&data[2], time);
491 writeF1000(&data[4], time_speed);