3 Copyright (C) 2010-2012 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/pointer.h"
25 SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed);
28 changes by PROTOCOL_VERSION:
31 Base for writing changes here
36 Add TOCLIENT_CRAFTITEMDEF
38 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
39 Obsolete TOSERVER_GROUND_ACTION
41 Make players to be handled mostly as ActiveObjects
43 Only non-cached textures are sent
46 Obsolete TOCLIENT_TOOLDEF
47 Obsolete TOCLIENT_CRAFTITEMDEF
48 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
50 Digging based on item groups
53 ContentFeatures and NodeDefManager use a different serialization
54 format; better for future version cross-compatibility
58 Version raised to force 'fly' and 'fast' privileges into effect.
59 Node metadata change (came in later; somewhat incompatible)
61 TileDef in ContentFeatures
64 TOCLIENT_INVENTORY_FORMSPEC
67 TOSERVER_INVENTORY_FIELDS
69 TOCLIENT_DETACHED_INVENTORY
71 InventoryList field "Width" (deserialization fails with old versions)
73 Added transfer of player pressed keys to the server
74 Added new messages for mesh and bone animation, as well as attachments
75 GENERIC_CMD_SET_ANIMATION
76 GENERIC_CMD_SET_BONE_POSITION
77 GENERIC_CMD_SET_ATTACHMENT
80 // Server always only supports one version
81 #define SERVER_PROTOCOL_VERSION 14
83 // Client can support older versions too
84 #define CLIENT_PROTOCOL_VERSION_MIN 13
85 #define CLIENT_PROTOCOL_VERSION_MAX SERVER_PROTOCOL_VERSION
87 // Constant that differentiates the protocol from random data and other protocols
88 #define PROTOCOL_ID 0x4f457403
90 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
91 // base64-encoded SHA-1 (27+\0).
93 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
99 Server's reply to TOSERVER_INIT.
100 Sent second after connected.
102 [0] u16 TOSERVER_INIT
103 [2] u8 deployed version
104 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
105 [12] u64 map seed (new as of 2011-02-27)
106 [20] f1000 recommended send interval (in seconds) (new as of 14)
108 NOTE: The position in here is deprecated; position is
109 explicitly sent afterwards
112 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
113 TOCLIENT_ADDNODE = 0x21,
114 TOCLIENT_REMOVENODE = 0x22,
116 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
119 // Followed by an arbitary number of these:
120 // Number is determined from packet length.
122 [N+2] v3s32 position*100
123 [N+2+12] v3s32 speed*100
124 [N+2+12+12] s32 pitch*100
125 [N+2+12+12+4] s32 yaw*100
128 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
131 // Followed by an arbitary number of these:
132 // Number is determined from packet length.
137 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
139 TOCLIENT_SECTORMETA = 0x26, // Obsolete
143 [3...] v2s16 pos + sector metadata
146 TOCLIENT_INVENTORY = 0x27,
149 [2] serialized inventory
152 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
157 u16 number of player positions
170 TOCLIENT_TIME_OF_DAY = 0x29,
174 Added in a later version:
178 // (oops, there is some gap here)
180 TOCLIENT_CHAT_MESSAGE = 0x30,
187 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
190 u16 count of removed objects
191 for all removed objects {
194 u16 count of added objects
195 for all added objects {
198 u32 initialization data length
199 string initialization data
203 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
220 TOCLIENT_MOVE_PLAYER = 0x34,
223 v3f1000 player position
228 TOCLIENT_ACCESS_DENIED = 0x35,
235 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
238 u16 count of player items
239 for all player items {
241 u16 length of serialized item
242 string serialized item
246 TOCLIENT_DEATHSCREEN = 0x37,
249 u8 bool set camera point target
250 v3f1000 camera point target (to point the death cause or whatever)
253 TOCLIENT_MEDIA = 0x38,
256 u16 total number of texture bunches
257 u16 index of this bunch
258 u32 number of files in this bunch
267 TOCLIENT_TOOLDEF = 0x39,
270 u32 length of the next item
271 serialized ToolDefManager
274 TOCLIENT_NODEDEF = 0x3a,
277 u32 length of the next item
278 serialized NodeDefManager
281 TOCLIENT_CRAFTITEMDEF = 0x3b,
284 u32 length of the next item
285 serialized CraftiItemDefManager
288 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
296 u16 length of sha1_digest
301 TOCLIENT_ITEMDEF = 0x3d,
304 u32 length of next item
305 serialized ItemDefManager
308 TOCLIENT_PLAY_SOUND = 0x3f,
315 u8 type (0=local, 1=positional, 2=object)
316 s32[3] pos_nodes*10000
321 TOCLIENT_STOP_SOUND = 0x40,
327 TOCLIENT_PRIVILEGES = 0x41,
330 u16 number of privileges
336 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
343 TOCLIENT_DETACHED_INVENTORY = 0x43,
348 [2] serialized inventory
356 Sent first after connected.
358 [0] u16 TOSERVER_INIT
359 [2] u8 SER_FMT_VER_HIGHEST
360 [3] u8[20] player_name
361 [23] u8[28] password (new in some version)
362 [51] u16 minimum supported network protocol version (added sometime)
363 [53] u16 maximum supported network protocol version (added later than the previous one)
366 TOSERVER_INIT2 = 0x11,
368 Sent as an ACK for TOCLIENT_INIT.
369 After this, the server can send data.
371 [0] u16 TOSERVER_INIT2
374 TOSERVER_GETBLOCK=0x20, // Obsolete
375 TOSERVER_ADDNODE = 0x21, // Obsolete
376 TOSERVER_REMOVENODE = 0x22, // Obsolete
378 TOSERVER_PLAYERPOS = 0x23,
381 [2] v3s32 position*100
382 [2+12] v3s32 speed*100
383 [2+12+12] s32 pitch*100
384 [2+12+12+4] s32 yaw*100
385 [2+12+12+4+4] u32 keyPressed
388 TOSERVER_GOTBLOCKS = 0x24,
397 TOSERVER_DELETEDBLOCKS = 0x25,
406 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
413 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
417 [2] u8 button (0=left, 1=right)
423 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
428 [3] v3s16 nodepos_undersurface
429 [9] v3s16 nodepos_abovesurface
432 0: start digging (from undersurface)
433 1: place block (to abovesurface)
434 2: stop digging (all parameters ignored)
438 TOSERVER_RELEASE = 0x29, // Obsolete
440 // (oops, there is some gap here)
442 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
451 TOSERVER_INVENTORY_ACTION = 0x31,
453 See InventoryAction in inventory.h
456 TOSERVER_CHAT_MESSAGE = 0x32,
463 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
471 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
475 [2] u8 button (0=left, 1=right)
480 TOSERVER_DAMAGE = 0x35,
486 TOSERVER_PASSWORD=0x36,
488 Sent to change password.
490 [0] u16 TOSERVER_PASSWORD
491 [2] u8[28] old password
492 [30] u8[28] new password
495 TOSERVER_PLAYERITEM=0x37,
497 Sent to change selected item.
499 [0] u16 TOSERVER_PLAYERITEM
503 TOSERVER_RESPAWN=0x38,
508 TOSERVER_INTERACT = 0x39,
513 [5] u32 length of the next item
514 [9] serialized PointedThing
516 0: start digging (from undersurface) or use
517 1: stop digging (all parameters ignored)
519 3: place block or item (to abovesurface)
522 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
525 TOSERVER_REMOVED_SOUNDS = 0x3a,
532 TOSERVER_NODEMETA_FIELDS = 0x3b,
537 u8[len] form name (reserved for future use)
546 TOSERVER_INVENTORY_FIELDS = 0x3c,
550 u8[len] form name (reserved for future use)
559 TOSERVER_REQUEST_MEDIA = 0x40,
562 u16 number of files requested