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
40 #define PROTOCOL_VERSION 4
42 #define PROTOCOL_ID 0x4f457403
44 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
45 // base64-encoded SHA-1 (27+\0).
51 Server's reply to TOSERVER_INIT.
52 Sent second after connected.
55 [2] u8 deployed version
56 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
57 [12] u64 map seed (new as of 2011-02-27)
59 NOTE: The position in here is deprecated; position is
60 explicitly sent afterwards
63 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
64 TOCLIENT_ADDNODE = 0x21,
65 TOCLIENT_REMOVENODE = 0x22,
67 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
70 // Followed by an arbitary number of these:
71 // Number is determined from packet length.
73 [N+2] v3s32 position*100
74 [N+2+12] v3s32 speed*100
75 [N+2+12+12] s32 pitch*100
76 [N+2+12+12+4] s32 yaw*100
79 TOCLIENT_PLAYERINFO = 0x24,
82 // Followed by an arbitary number of these:
83 // Number is determined from packet length.
88 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
90 TOCLIENT_SECTORMETA = 0x26, // Obsolete
94 [3...] v2s16 pos + sector metadata
97 TOCLIENT_INVENTORY = 0x27,
100 [2] serialized inventory
103 TOCLIENT_OBJECTDATA = 0x28,
108 u16 number of player positions
121 TOCLIENT_TIME_OF_DAY = 0x29,
127 // (oops, there is some gap here)
129 TOCLIENT_CHAT_MESSAGE = 0x30,
136 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
139 u16 count of removed objects
140 for all removed objects {
143 u16 count of added objects
144 for all added objects {
147 u32 initialization data length
148 string initialization data
152 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
169 TOCLIENT_MOVE_PLAYER = 0x34,
172 v3f1000 player position
177 TOCLIENT_ACCESS_DENIED = 0x35,
184 TOCLIENT_PLAYERITEM = 0x36,
187 u16 count of player items
188 for all player items {
190 u16 length of serialized item
191 string serialized item
195 TOCLIENT_DEATHSCREEN = 0x37,
198 u8 bool set camera point target
199 v3f1000 camera point target (to point the death cause or whatever)
202 TOCLIENT_TEXTURES = 0x38,
205 u16 total number of texture bunches
206 u16 index of this bunch
207 u32 number of textures in this bunch
216 TOCLIENT_TOOLDEF = 0x39,
219 u32 length of the next item
220 serialized ToolDefManager
223 TOCLIENT_NODEDEF = 0x3a,
226 u32 length of the next item
227 serialized NodeDefManager
230 TOCLIENT_CRAFTITEMDEF = 0x3b,
233 u32 length of the next item
234 serialized CraftiItemDefManager
242 Sent first after connected.
244 [0] u16 TOSERVER_INIT
245 [2] u8 SER_FMT_VER_HIGHEST
246 [3] u8[20] player_name
247 [23] u8[28] password (new in some version)
248 [51] u16 client network protocol version (new in some version)
251 TOSERVER_INIT2 = 0x11,
253 Sent as an ACK for TOCLIENT_INIT.
254 After this, the server can send data.
256 [0] u16 TOSERVER_INIT2
259 TOSERVER_GETBLOCK=0x20, // Obsolete
260 TOSERVER_ADDNODE = 0x21, // Obsolete
261 TOSERVER_REMOVENODE = 0x22, // Obsolete
263 TOSERVER_PLAYERPOS = 0x23,
266 [2] v3s32 position*100
267 [2+12] v3s32 speed*100
268 [2+12+12] s32 pitch*100
269 [2+12+12+4] s32 yaw*100
272 TOSERVER_GOTBLOCKS = 0x24,
281 TOSERVER_DELETEDBLOCKS = 0x25,
290 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
297 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
301 [2] u8 button (0=left, 1=right)
307 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
312 [3] v3s16 nodepos_undersurface
313 [9] v3s16 nodepos_abovesurface
316 0: start digging (from undersurface)
317 1: place block (to abovesurface)
318 2: stop digging (all parameters ignored)
322 TOSERVER_RELEASE = 0x29, // Obsolete
324 // (oops, there is some gap here)
326 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
335 TOSERVER_INVENTORY_ACTION = 0x31,
337 See InventoryAction in inventory.h
340 TOSERVER_CHAT_MESSAGE = 0x32,
347 TOSERVER_SIGNNODETEXT = 0x33,
355 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
359 [2] u8 button (0=left, 1=right)
364 TOSERVER_DAMAGE = 0x35,
370 TOSERVER_PASSWORD=0x36,
372 Sent to change password.
374 [0] u16 TOSERVER_PASSWORD
375 [2] u8[28] old password
376 [30] u8[28] new password
379 TOSERVER_PLAYERITEM=0x37,
381 Sent to change selected item.
383 [0] u16 TOSERVER_PLAYERITEM
387 TOSERVER_RESPAWN=0x38,
392 TOSERVER_INTERACT = 0x39,
397 [5] u32 length of the next item
398 [9] serialized PointedThing
400 0: start digging (from undersurface) or use
401 1: stop digging (all parameters ignored)
403 3: place block or item (to abovesurface)
406 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
411 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
413 SharedBuffer<u8> data(2+2);
414 writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
415 writeU16(&data[2], time);