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 #define PROTOCOL_VERSION 8
53 #define PROTOCOL_ID 0x4f457403
55 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
56 // base64-encoded SHA-1 (27+\0).
58 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
64 Server's reply to TOSERVER_INIT.
65 Sent second after connected.
68 [2] u8 deployed version
69 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
70 [12] u64 map seed (new as of 2011-02-27)
72 NOTE: The position in here is deprecated; position is
73 explicitly sent afterwards
76 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
77 TOCLIENT_ADDNODE = 0x21,
78 TOCLIENT_REMOVENODE = 0x22,
80 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
83 // Followed by an arbitary number of these:
84 // Number is determined from packet length.
86 [N+2] v3s32 position*100
87 [N+2+12] v3s32 speed*100
88 [N+2+12+12] s32 pitch*100
89 [N+2+12+12+4] s32 yaw*100
92 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
95 // Followed by an arbitary number of these:
96 // Number is determined from packet length.
101 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
103 TOCLIENT_SECTORMETA = 0x26, // Obsolete
107 [3...] v2s16 pos + sector metadata
110 TOCLIENT_INVENTORY = 0x27,
113 [2] serialized inventory
116 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
121 u16 number of player positions
134 TOCLIENT_TIME_OF_DAY = 0x29,
140 // (oops, there is some gap here)
142 TOCLIENT_CHAT_MESSAGE = 0x30,
149 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
152 u16 count of removed objects
153 for all removed objects {
156 u16 count of added objects
157 for all added objects {
160 u32 initialization data length
161 string initialization data
165 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
182 TOCLIENT_MOVE_PLAYER = 0x34,
185 v3f1000 player position
190 TOCLIENT_ACCESS_DENIED = 0x35,
197 TOCLIENT_PLAYERITEM = 0x36,
200 u16 count of player items
201 for all player items {
203 u16 length of serialized item
204 string serialized item
208 TOCLIENT_DEATHSCREEN = 0x37,
211 u8 bool set camera point target
212 v3f1000 camera point target (to point the death cause or whatever)
215 TOCLIENT_TEXTURES = 0x38,
218 u16 total number of texture bunches
219 u16 index of this bunch
220 u32 number of textures in this bunch
229 TOCLIENT_TOOLDEF = 0x39,
232 u32 length of the next item
233 serialized ToolDefManager
236 TOCLIENT_NODEDEF = 0x3a,
239 u32 length of the next item
240 serialized NodeDefManager
243 TOCLIENT_CRAFTITEMDEF = 0x3b,
246 u32 length of the next item
247 serialized CraftiItemDefManager
250 TOCLIENT_ANNOUNCE_TEXTURES = 0x3c,
254 u32 number of textures
258 u16 length of sha1_digest
263 TOCLIENT_ITEMDEF = 0x3d,
266 u32 length of next item
267 serialized ItemDefManager
276 Sent first after connected.
278 [0] u16 TOSERVER_INIT
279 [2] u8 SER_FMT_VER_HIGHEST
280 [3] u8[20] player_name
281 [23] u8[28] password (new in some version)
282 [51] u16 client network protocol version (new in some version)
285 TOSERVER_INIT2 = 0x11,
287 Sent as an ACK for TOCLIENT_INIT.
288 After this, the server can send data.
290 [0] u16 TOSERVER_INIT2
293 TOSERVER_GETBLOCK=0x20, // Obsolete
294 TOSERVER_ADDNODE = 0x21, // Obsolete
295 TOSERVER_REMOVENODE = 0x22, // Obsolete
297 TOSERVER_PLAYERPOS = 0x23,
300 [2] v3s32 position*100
301 [2+12] v3s32 speed*100
302 [2+12+12] s32 pitch*100
303 [2+12+12+4] s32 yaw*100
306 TOSERVER_GOTBLOCKS = 0x24,
315 TOSERVER_DELETEDBLOCKS = 0x25,
324 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
331 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
335 [2] u8 button (0=left, 1=right)
341 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
346 [3] v3s16 nodepos_undersurface
347 [9] v3s16 nodepos_abovesurface
350 0: start digging (from undersurface)
351 1: place block (to abovesurface)
352 2: stop digging (all parameters ignored)
356 TOSERVER_RELEASE = 0x29, // Obsolete
358 // (oops, there is some gap here)
360 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
369 TOSERVER_INVENTORY_ACTION = 0x31,
371 See InventoryAction in inventory.h
374 TOSERVER_CHAT_MESSAGE = 0x32,
381 TOSERVER_SIGNNODETEXT = 0x33,
389 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
393 [2] u8 button (0=left, 1=right)
398 TOSERVER_DAMAGE = 0x35,
404 TOSERVER_PASSWORD=0x36,
406 Sent to change password.
408 [0] u16 TOSERVER_PASSWORD
409 [2] u8[28] old password
410 [30] u8[28] new password
413 TOSERVER_PLAYERITEM=0x37,
415 Sent to change selected item.
417 [0] u16 TOSERVER_PLAYERITEM
421 TOSERVER_RESPAWN=0x38,
426 TOSERVER_INTERACT = 0x39,
431 [5] u32 length of the next item
432 [9] serialized PointedThing
434 0: start digging (from undersurface) or use
435 1: stop digging (all parameters ignored)
437 3: place block or item (to abovesurface)
440 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
443 TOSERVER_REQUEST_TEXTURES = 0x40,
447 u16 number of textures requested
456 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
458 SharedBuffer<u8> data(2+2);
459 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
460 writeU16(&data[2], time);