3 Copyright (C) 2010-2013 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
24 changes by PROTOCOL_VERSION:
27 Base for writing changes here
32 Add TOCLIENT_CRAFTITEMDEF
34 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
35 Obsolete TOSERVER_GROUND_ACTION
37 Make players to be handled mostly as ActiveObjects
39 Only non-cached textures are sent
42 Obsolete TOCLIENT_TOOLDEF
43 Obsolete TOCLIENT_CRAFTITEMDEF
44 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
46 Digging based on item groups
49 ContentFeatures and NodeDefManager use a different serialization
50 format; better for future version cross-compatibility
54 Version raised to force 'fly' and 'fast' privileges into effect.
55 Node metadata change (came in later; somewhat incompatible)
57 TileDef in ContentFeatures
60 TOCLIENT_INVENTORY_FORMSPEC
63 TOSERVER_INVENTORY_FIELDS
65 TOCLIENT_DETACHED_INVENTORY
67 InventoryList field "Width" (deserialization fails with old versions)
69 Added transfer of player pressed keys to the server
70 Added new messages for mesh and bone animation, as well as attachments
71 GENERIC_CMD_SET_ANIMATION
72 GENERIC_CMD_SET_BONE_POSITION
73 GENERIC_CMD_SET_ATTACHMENT
75 Serialization format changes
77 TOCLIENT_SHOW_FORMSPEC
79 Serialization format change: include backface_culling flag in TileDef
80 Added rightclickable field in nodedef
81 TOCLIENT_SPAWN_PARTICLE
82 TOCLIENT_ADD_PARTICLESPAWNER
83 TOCLIENT_DELETE_PARTICLESPAWNER
85 damageGroups added to ToolCapabilities
86 sound_place added to ItemDefinition
88 GENERIC_CMD_SET_PHYSICS_OVERRIDE
93 TOCLIENT_HUD_SET_FLAGS
97 range added to ItemDefinition
98 drowning, leveled and liquid_range added to ContentFeatures
99 stepheight and collideWithObjects added to object properties
100 version, heat and humidity transfer in MapBock
101 automatic_face_movement_dir and automatic_face_movement_dir_offset
102 added to object properties
105 #define LATEST_PROTOCOL_VERSION 21
107 // Server's supported network protocol range
108 #define SERVER_PROTOCOL_VERSION_MIN 13
109 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
111 // Client's supported network protocol range
112 #define CLIENT_PROTOCOL_VERSION_MIN 13
113 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
115 // Constant that differentiates the protocol from random data and other protocols
116 #define PROTOCOL_ID 0x4f457403
118 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
119 // base64-encoded SHA-1 (27+\0).
121 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
125 TOCLIENT_INIT = 0x10,
127 Server's reply to TOSERVER_INIT.
128 Sent second after connected.
130 [0] u16 TOSERVER_INIT
131 [2] u8 deployed version
132 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
133 [12] u64 map seed (new as of 2011-02-27)
134 [20] f1000 recommended send interval (in seconds) (new as of 14)
136 NOTE: The position in here is deprecated; position is
137 explicitly sent afterwards
140 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
141 TOCLIENT_ADDNODE = 0x21,
142 TOCLIENT_REMOVENODE = 0x22,
144 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
147 // Followed by an arbitary number of these:
148 // Number is determined from packet length.
150 [N+2] v3s32 position*100
151 [N+2+12] v3s32 speed*100
152 [N+2+12+12] s32 pitch*100
153 [N+2+12+12+4] s32 yaw*100
156 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
159 // Followed by an arbitary number of these:
160 // Number is determined from packet length.
165 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
167 TOCLIENT_SECTORMETA = 0x26, // Obsolete
171 [3...] v2s16 pos + sector metadata
174 TOCLIENT_INVENTORY = 0x27,
177 [2] serialized inventory
180 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
185 u16 number of player positions
198 TOCLIENT_TIME_OF_DAY = 0x29,
202 Added in a later version:
206 // (oops, there is some gap here)
208 TOCLIENT_CHAT_MESSAGE = 0x30,
215 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
218 u16 count of removed objects
219 for all removed objects {
222 u16 count of added objects
223 for all added objects {
226 u32 initialization data length
227 string initialization data
231 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
248 TOCLIENT_MOVE_PLAYER = 0x34,
251 v3f1000 player position
256 TOCLIENT_ACCESS_DENIED = 0x35,
263 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
266 u16 count of player items
267 for all player items {
269 u16 length of serialized item
270 string serialized item
274 TOCLIENT_DEATHSCREEN = 0x37,
277 u8 bool set camera point target
278 v3f1000 camera point target (to point the death cause or whatever)
281 TOCLIENT_MEDIA = 0x38,
284 u16 total number of texture bunches
285 u16 index of this bunch
286 u32 number of files in this bunch
293 u16 length of remote media server url (if applicable)
297 TOCLIENT_TOOLDEF = 0x39,
300 u32 length of the next item
301 serialized ToolDefManager
304 TOCLIENT_NODEDEF = 0x3a,
307 u32 length of the next item
308 serialized NodeDefManager
311 TOCLIENT_CRAFTITEMDEF = 0x3b,
314 u32 length of the next item
315 serialized CraftiItemDefManager
318 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
326 u16 length of sha1_digest
331 TOCLIENT_ITEMDEF = 0x3d,
334 u32 length of next item
335 serialized ItemDefManager
338 TOCLIENT_PLAY_SOUND = 0x3f,
345 u8 type (0=local, 1=positional, 2=object)
346 s32[3] pos_nodes*10000
351 TOCLIENT_STOP_SOUND = 0x40,
357 TOCLIENT_PRIVILEGES = 0x41,
360 u16 number of privileges
366 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
373 TOCLIENT_DETACHED_INVENTORY = 0x43,
378 [2] serialized inventory
381 TOCLIENT_SHOW_FORMSPEC = 0x44,
390 TOCLIENT_MOVEMENT = 0x45,
393 f1000 movement_acceleration_default
394 f1000 movement_acceleration_air
395 f1000 movement_acceleration_fast
396 f1000 movement_speed_walk
397 f1000 movement_speed_crouch
398 f1000 movement_speed_fast
399 f1000 movement_speed_climb
400 f1000 movement_speed_jump
401 f1000 movement_liquid_fluidity
402 f1000 movement_liquid_fluidity_smooth
403 f1000 movement_liquid_sink
404 f1000 movement_gravity
407 TOCLIENT_SPAWN_PARTICLE = 0x46,
415 u8 bool collisiondetection
420 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
435 u8 bool collisiondetection
441 TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
447 TOCLIENT_HUDADD = 0x49,
465 TOCLIENT_HUDRM = 0x4a,
471 TOCLIENT_HUDCHANGE = 0x4b,
482 TOCLIENT_HUD_SET_FLAGS = 0x4c,
489 TOCLIENT_HUD_SET_PARAM = 0x4d,
497 TOCLIENT_BREATH = 0x4e,
508 Sent first after connected.
510 [0] u16 TOSERVER_INIT
511 [2] u8 SER_FMT_VER_HIGHEST_READ
512 [3] u8[20] player_name
513 [23] u8[28] password (new in some version)
514 [51] u16 minimum supported network protocol version (added sometime)
515 [53] u16 maximum supported network protocol version (added later than the previous one)
518 TOSERVER_INIT2 = 0x11,
520 Sent as an ACK for TOCLIENT_INIT.
521 After this, the server can send data.
523 [0] u16 TOSERVER_INIT2
526 TOSERVER_GETBLOCK=0x20, // Obsolete
527 TOSERVER_ADDNODE = 0x21, // Obsolete
528 TOSERVER_REMOVENODE = 0x22, // Obsolete
530 TOSERVER_PLAYERPOS = 0x23,
533 [2] v3s32 position*100
534 [2+12] v3s32 speed*100
535 [2+12+12] s32 pitch*100
536 [2+12+12+4] s32 yaw*100
537 [2+12+12+4+4] u32 keyPressed
540 TOSERVER_GOTBLOCKS = 0x24,
549 TOSERVER_DELETEDBLOCKS = 0x25,
558 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
565 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
569 [2] u8 button (0=left, 1=right)
575 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
580 [3] v3s16 nodepos_undersurface
581 [9] v3s16 nodepos_abovesurface
584 0: start digging (from undersurface)
585 1: place block (to abovesurface)
586 2: stop digging (all parameters ignored)
590 TOSERVER_RELEASE = 0x29, // Obsolete
592 // (oops, there is some gap here)
594 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
603 TOSERVER_INVENTORY_ACTION = 0x31,
605 See InventoryAction in inventory.h
608 TOSERVER_CHAT_MESSAGE = 0x32,
615 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
623 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
627 [2] u8 button (0=left, 1=right)
632 TOSERVER_DAMAGE = 0x35,
638 TOSERVER_PASSWORD=0x36,
640 Sent to change password.
642 [0] u16 TOSERVER_PASSWORD
643 [2] u8[28] old password
644 [30] u8[28] new password
647 TOSERVER_PLAYERITEM=0x37,
649 Sent to change selected item.
651 [0] u16 TOSERVER_PLAYERITEM
655 TOSERVER_RESPAWN=0x38,
660 TOSERVER_INTERACT = 0x39,
665 [5] u32 length of the next item
666 [9] serialized PointedThing
668 0: start digging (from undersurface) or use
669 1: stop digging (all parameters ignored)
671 3: place block or item (to abovesurface)
674 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
677 TOSERVER_REMOVED_SOUNDS = 0x3a,
684 TOSERVER_NODEMETA_FIELDS = 0x3b,
689 u8[len] form name (reserved for future use)
698 TOSERVER_INVENTORY_FIELDS = 0x3c,
702 u8[len] form name (reserved for future use)
711 TOSERVER_REQUEST_MEDIA = 0x40,
714 u16 number of files requested
721 TOSERVER_RECEIVED_MEDIA = 0x41,
726 TOSERVER_BREATH = 0x42,