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
52 #define PROTOCOL_VERSION 8
54 #define PROTOCOL_ID 0x4f457403
56 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
57 // base64-encoded SHA-1 (27+\0).
59 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
65 Server's reply to TOSERVER_INIT.
66 Sent second after connected.
69 [2] u8 deployed version
70 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
71 [12] u64 map seed (new as of 2011-02-27)
73 NOTE: The position in here is deprecated; position is
74 explicitly sent afterwards
77 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
78 TOCLIENT_ADDNODE = 0x21,
79 TOCLIENT_REMOVENODE = 0x22,
81 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
84 // Followed by an arbitary number of these:
85 // Number is determined from packet length.
87 [N+2] v3s32 position*100
88 [N+2+12] v3s32 speed*100
89 [N+2+12+12] s32 pitch*100
90 [N+2+12+12+4] s32 yaw*100
93 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
96 // Followed by an arbitary number of these:
97 // Number is determined from packet length.
102 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
104 TOCLIENT_SECTORMETA = 0x26, // Obsolete
108 [3...] v2s16 pos + sector metadata
111 TOCLIENT_INVENTORY = 0x27,
114 [2] serialized inventory
117 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
122 u16 number of player positions
135 TOCLIENT_TIME_OF_DAY = 0x29,
139 Added in a later version:
143 // (oops, there is some gap here)
145 TOCLIENT_CHAT_MESSAGE = 0x30,
152 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
155 u16 count of removed objects
156 for all removed objects {
159 u16 count of added objects
160 for all added objects {
163 u32 initialization data length
164 string initialization data
168 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
185 TOCLIENT_MOVE_PLAYER = 0x34,
188 v3f1000 player position
193 TOCLIENT_ACCESS_DENIED = 0x35,
200 TOCLIENT_PLAYERITEM = 0x36,
203 u16 count of player items
204 for all player items {
206 u16 length of serialized item
207 string serialized item
211 TOCLIENT_DEATHSCREEN = 0x37,
214 u8 bool set camera point target
215 v3f1000 camera point target (to point the death cause or whatever)
218 TOCLIENT_MEDIA = 0x38,
221 u16 total number of texture bunches
222 u16 index of this bunch
223 u32 number of files in this bunch
232 TOCLIENT_TOOLDEF = 0x39,
235 u32 length of the next item
236 serialized ToolDefManager
239 TOCLIENT_NODEDEF = 0x3a,
242 u32 length of the next item
243 serialized NodeDefManager
246 TOCLIENT_CRAFTITEMDEF = 0x3b,
249 u32 length of the next item
250 serialized CraftiItemDefManager
253 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
261 u16 length of sha1_digest
266 TOCLIENT_ITEMDEF = 0x3d,
269 u32 length of next item
270 serialized ItemDefManager
273 TOCLIENT_PLAY_SOUND = 0x3f,
280 u8 type (0=local, 1=positional, 2=object)
281 s32[3] pos_nodes*10000
286 TOCLIENT_STOP_SOUND = 0x40,
297 Sent first after connected.
299 [0] u16 TOSERVER_INIT
300 [2] u8 SER_FMT_VER_HIGHEST
301 [3] u8[20] player_name
302 [23] u8[28] password (new in some version)
303 [51] u16 client network protocol version (new in some version)
306 TOSERVER_INIT2 = 0x11,
308 Sent as an ACK for TOCLIENT_INIT.
309 After this, the server can send data.
311 [0] u16 TOSERVER_INIT2
314 TOSERVER_GETBLOCK=0x20, // Obsolete
315 TOSERVER_ADDNODE = 0x21, // Obsolete
316 TOSERVER_REMOVENODE = 0x22, // Obsolete
318 TOSERVER_PLAYERPOS = 0x23,
321 [2] v3s32 position*100
322 [2+12] v3s32 speed*100
323 [2+12+12] s32 pitch*100
324 [2+12+12+4] s32 yaw*100
327 TOSERVER_GOTBLOCKS = 0x24,
336 TOSERVER_DELETEDBLOCKS = 0x25,
345 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
352 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
356 [2] u8 button (0=left, 1=right)
362 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
367 [3] v3s16 nodepos_undersurface
368 [9] v3s16 nodepos_abovesurface
371 0: start digging (from undersurface)
372 1: place block (to abovesurface)
373 2: stop digging (all parameters ignored)
377 TOSERVER_RELEASE = 0x29, // Obsolete
379 // (oops, there is some gap here)
381 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
390 TOSERVER_INVENTORY_ACTION = 0x31,
392 See InventoryAction in inventory.h
395 TOSERVER_CHAT_MESSAGE = 0x32,
402 TOSERVER_SIGNNODETEXT = 0x33,
410 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
414 [2] u8 button (0=left, 1=right)
419 TOSERVER_DAMAGE = 0x35,
425 TOSERVER_PASSWORD=0x36,
427 Sent to change password.
429 [0] u16 TOSERVER_PASSWORD
430 [2] u8[28] old password
431 [30] u8[28] new password
434 TOSERVER_PLAYERITEM=0x37,
436 Sent to change selected item.
438 [0] u16 TOSERVER_PLAYERITEM
442 TOSERVER_RESPAWN=0x38,
447 TOSERVER_INTERACT = 0x39,
452 [5] u32 length of the next item
453 [9] serialized PointedThing
455 0: start digging (from undersurface) or use
456 1: stop digging (all parameters ignored)
458 3: place block or item (to abovesurface)
461 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
464 TOSERVER_REMOVED_SOUNDS = 0x3a,
471 TOSERVER_REQUEST_MEDIA = 0x40,
474 u16 number of files requested
483 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
485 SharedBuffer<u8> data(2+2+4);
486 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
487 writeU16(&data[2], time);
488 writeF1000(&data[4], time_speed);