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 NETWORKPROTOCOL_HEADER
21 #define NETWORKPROTOCOL_HEADER
22 #include "util/string.h"
25 changes by PROTOCOL_VERSION:
28 Base for writing changes here
33 Add TOCLIENT_CRAFTITEMDEF
35 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
36 Obsolete TOSERVER_GROUND_ACTION
38 Make players to be handled mostly as ActiveObjects
40 Only non-cached textures are sent
43 Obsolete TOCLIENT_TOOLDEF
44 Obsolete TOCLIENT_CRAFTITEMDEF
45 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
47 Digging based on item groups
50 ContentFeatures and NodeDefManager use a different serialization
51 format; better for future version cross-compatibility
55 Version raised to force 'fly' and 'fast' privileges into effect.
56 Node metadata change (came in later; somewhat incompatible)
58 TileDef in ContentFeatures
61 TOCLIENT_INVENTORY_FORMSPEC
64 TOSERVER_INVENTORY_FIELDS
66 TOCLIENT_DETACHED_INVENTORY
68 InventoryList field "Width" (deserialization fails with old versions)
70 Added transfer of player pressed keys to the server
71 Added new messages for mesh and bone animation, as well as attachments
72 GENERIC_CMD_SET_ANIMATION
73 GENERIC_CMD_SET_BONE_POSITION
74 GENERIC_CMD_SET_ATTACHMENT
76 Serialization format changes
78 TOCLIENT_SHOW_FORMSPEC
80 Serialization format change: include backface_culling flag in TileDef
81 Added rightclickable field in nodedef
82 TOCLIENT_SPAWN_PARTICLE
83 TOCLIENT_ADD_PARTICLESPAWNER
84 TOCLIENT_DELETE_PARTICLESPAWNER
86 damageGroups added to ToolCapabilities
87 sound_place added to ItemDefinition
89 GENERIC_CMD_SET_PHYSICS_OVERRIDE
94 TOCLIENT_HUD_SET_FLAGS
98 range added to ItemDefinition
99 drowning, leveled and liquid_range added to ContentFeatures
100 stepheight and collideWithObjects added to object properties
101 version, heat and humidity transfer in MapBock
102 automatic_face_movement_dir and automatic_face_movement_dir_offset
103 added to object properties
107 TOSERVER_CLIENT_READY
109 ContentFeatures version 7
110 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
112 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
113 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
114 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
115 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
116 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
117 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
118 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
119 for standard error, keeping customisation possible. This
121 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
123 Add new opcode TOSERVER_INIT for client presentation to server
124 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
125 TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
126 for the three supported auth mechanisms around srp
127 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
128 for sudo mode handling (auth mech generic way of changing password).
129 Add TOCLIENT_HELLO for presenting server to client after client
131 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
132 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
134 Add TileDef tileable_horizontal, tileable_vertical flags
136 backface_culling: backwards compatibility for playing with
137 newer client on pre-27 servers.
138 Add nodedef v3 - connected nodeboxes
143 #define LATEST_PROTOCOL_VERSION 28
145 // Server's supported network protocol range
146 #define SERVER_PROTOCOL_VERSION_MIN 13
147 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
149 // Client's supported network protocol range
150 // The minimal version depends on whether
151 // send_pre_v25_init is enabled or not
152 #define CLIENT_PROTOCOL_VERSION_MIN 25
153 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 13
154 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
156 // Constant that differentiates the protocol from random data and other protocols
157 #define PROTOCOL_ID 0x4f457403
159 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
160 // base64-encoded SHA-1 (27+\0).
162 #define FORMSPEC_API_VERSION 1
163 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
165 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
169 TOCLIENT_HELLO = 0x02,
171 Sent after TOSERVER_INIT.
173 u8 deployed serialisation version
174 u16 deployed network compression mode
175 u16 deployed protocol version
176 u32 supported auth methods
177 std::string username that should be used for legacy hash (for proper casing)
179 TOCLIENT_AUTH_ACCEPT = 0x03,
181 Message from server to accept auth.
183 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
185 f1000 recommended send interval
186 u32 : supported auth methods for sudo mode
187 (where the user can change their password)
189 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
191 Sent to client to show it is in sudo mode now.
193 TOCLIENT_DENY_SUDO_MODE = 0x05,
195 Signals client that sudo mode auth failed.
197 TOCLIENT_INIT_LEGACY = 0x10,
199 Server's reply to TOSERVER_INIT.
200 Sent second after connected.
202 [0] u16 TOSERVER_INIT
203 [2] u8 deployed version
204 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
205 [12] u64 map seed (new as of 2011-02-27)
206 [20] f1000 recommended send interval (in seconds) (new as of 14)
208 NOTE: The position in here is deprecated; position is
209 explicitly sent afterwards
211 TOCLIENT_ACCESS_DENIED = 0x0A,
214 std::string custom reason (if needed, otherwise "")
217 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
218 TOCLIENT_ADDNODE = 0x21,
222 u8 keep_metadata // Added in protocol version 22
224 TOCLIENT_REMOVENODE = 0x22,
226 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
229 // Followed by an arbitary number of these:
230 // Number is determined from packet length.
232 [N+2] v3s32 position*100
233 [N+2+12] v3s32 speed*100
234 [N+2+12+12] s32 pitch*100
235 [N+2+12+12+4] s32 yaw*100
238 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
241 // Followed by an arbitary number of these:
242 // Number is determined from packet length.
247 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
249 TOCLIENT_SECTORMETA = 0x26, // Obsolete
253 [3...] v2s16 pos + sector metadata
256 TOCLIENT_INVENTORY = 0x27,
259 [2] serialized inventory
262 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
266 u16 number of player positions
279 TOCLIENT_TIME_OF_DAY = 0x29,
282 Added in a later version:
286 // (oops, there is some gap here)
288 TOCLIENT_CHAT_MESSAGE = 0x30,
294 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
296 u16 count of removed objects
297 for all removed objects {
300 u16 count of added objects
301 for all added objects {
304 u32 initialization data length
305 string initialization data
309 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
324 TOCLIENT_MOVE_PLAYER = 0x34,
326 v3f1000 player position
331 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
337 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
339 u16 count of player items
340 for all player items {
342 u16 length of serialized item
343 string serialized item
347 TOCLIENT_DEATHSCREEN = 0x37,
349 u8 bool set camera point target
350 v3f1000 camera point target (to point the death cause or whatever)
353 TOCLIENT_MEDIA = 0x38,
355 u16 total number of texture bunches
356 u16 index of this bunch
357 u32 number of files in this bunch
364 u16 length of remote media server url (if applicable)
368 TOCLIENT_TOOLDEF = 0x39,
370 u32 length of the next item
371 serialized ToolDefManager
374 TOCLIENT_NODEDEF = 0x3a,
376 u32 length of the next item
377 serialized NodeDefManager
380 TOCLIENT_CRAFTITEMDEF = 0x3b,
382 u32 length of the next item
383 serialized CraftiItemDefManager
386 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
393 u16 length of sha1_digest
398 TOCLIENT_ITEMDEF = 0x3d,
400 u32 length of next item
401 serialized ItemDefManager
404 TOCLIENT_PLAY_SOUND = 0x3f,
410 u8 type (0=local, 1=positional, 2=object)
411 s32[3] pos_nodes*10000
416 TOCLIENT_STOP_SOUND = 0x40,
421 TOCLIENT_PRIVILEGES = 0x41,
423 u16 number of privileges
429 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
435 TOCLIENT_DETACHED_INVENTORY = 0x43,
440 [2] serialized inventory
443 TOCLIENT_SHOW_FORMSPEC = 0x44,
452 TOCLIENT_MOVEMENT = 0x45,
454 f1000 movement_acceleration_default
455 f1000 movement_acceleration_air
456 f1000 movement_acceleration_fast
457 f1000 movement_speed_walk
458 f1000 movement_speed_crouch
459 f1000 movement_speed_fast
460 f1000 movement_speed_climb
461 f1000 movement_speed_jump
462 f1000 movement_liquid_fluidity
463 f1000 movement_liquid_fluidity_smooth
464 f1000 movement_liquid_sink
465 f1000 movement_gravity
468 TOCLIENT_SPAWN_PARTICLE = 0x46,
475 u8 bool collisiondetection
482 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
496 u8 bool collisiondetection
504 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
509 TOCLIENT_HUDADD = 0x49,
528 TOCLIENT_HUDRM = 0x4a,
533 TOCLIENT_HUDCHANGE = 0x4b,
543 TOCLIENT_HUD_SET_FLAGS = 0x4c,
549 TOCLIENT_HUD_SET_PARAM = 0x4d,
556 TOCLIENT_BREATH = 0x4e,
561 TOCLIENT_SET_SKY = 0x4f,
572 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
574 u8 do_override (boolean)
575 u16 day-night ratio 0...65535
578 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
587 TOCLIENT_EYE_OFFSET = 0x52,
593 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
598 TOCLIENT_SRP_BYTES_S_B = 0x60,
600 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
606 TOCLIENT_NUM_MSG_TYPES = 0x61,
611 TOSERVER_INIT = 0x02,
613 Sent first after connected.
615 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
616 u16 supported network compression modes
617 u16 minimum supported network protocol version
618 u16 maximum supported network protocol version
619 std::string player name
622 TOSERVER_INIT_LEGACY = 0x10,
624 Sent first after connected.
626 [0] u16 TOSERVER_INIT_LEGACY
627 [2] u8 SER_FMT_VER_HIGHEST_READ
628 [3] u8[20] player_name
629 [23] u8[28] password (new in some version)
630 [51] u16 minimum supported network protocol version (added sometime)
631 [53] u16 maximum supported network protocol version (added later than the previous one)
634 TOSERVER_INIT2 = 0x11,
636 Sent as an ACK for TOCLIENT_INIT.
637 After this, the server can send data.
639 [0] u16 TOSERVER_INIT2
642 TOSERVER_GETBLOCK=0x20, // Obsolete
643 TOSERVER_ADDNODE = 0x21, // Obsolete
644 TOSERVER_REMOVENODE = 0x22, // Obsolete
646 TOSERVER_PLAYERPOS = 0x23,
649 [2] v3s32 position*100
650 [2+12] v3s32 speed*100
651 [2+12+12] s32 pitch*100
652 [2+12+12+4] s32 yaw*100
653 [2+12+12+4+4] u32 keyPressed
656 TOSERVER_GOTBLOCKS = 0x24,
665 TOSERVER_DELETEDBLOCKS = 0x25,
674 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
681 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
685 [2] u8 button (0=left, 1=right)
691 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
696 [3] v3s16 nodepos_undersurface
697 [9] v3s16 nodepos_abovesurface
700 0: start digging (from undersurface)
701 1: place block (to abovesurface)
702 2: stop digging (all parameters ignored)
706 TOSERVER_RELEASE = 0x29, // Obsolete
708 // (oops, there is some gap here)
710 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
718 TOSERVER_INVENTORY_ACTION = 0x31,
720 See InventoryAction in inventorymanager.h
723 TOSERVER_CHAT_MESSAGE = 0x32,
729 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
736 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
740 [2] u8 button (0=left, 1=right)
745 TOSERVER_DAMAGE = 0x35,
750 TOSERVER_PASSWORD_LEGACY = 0x36,
752 Sent to change password.
754 [0] u16 TOSERVER_PASSWORD
755 [2] u8[28] old password
756 [30] u8[28] new password
759 TOSERVER_PLAYERITEM = 0x37,
761 Sent to change selected item.
763 [0] u16 TOSERVER_PLAYERITEM
767 TOSERVER_RESPAWN = 0x38,
772 TOSERVER_INTERACT = 0x39,
777 [5] u32 length of the next item
778 [9] serialized PointedThing
780 0: start digging (from undersurface) or use
781 1: stop digging (all parameters ignored)
783 3: place block or item (to abovesurface)
786 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
789 TOSERVER_REMOVED_SOUNDS = 0x3a,
795 TOSERVER_NODEMETA_FIELDS = 0x3b,
799 u8[len] form name (reserved for future use)
808 TOSERVER_INVENTORY_FIELDS = 0x3c,
811 u8[len] form name (reserved for future use)
820 TOSERVER_REQUEST_MEDIA = 0x40,
822 u16 number of files requested
829 TOSERVER_RECEIVED_MEDIA = 0x41,
834 TOSERVER_BREATH = 0x42,
839 TOSERVER_CLIENT_READY = 0x43,
846 u8[len] full_version_string
849 TOSERVER_FIRST_SRP = 0x50,
851 Belonging to AUTH_MECHANISM_FIRST_SRP.
854 std::string srp verification key
855 u8 is_empty (=1 if password is empty, 0 otherwise)
858 TOSERVER_SRP_BYTES_A = 0x51,
860 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
861 depending on current_login_based_on.
864 u8 current_login_based_on : on which version of the password's
865 hash this login is based on (0 legacy hash,
866 or 1 directly the password)
869 TOSERVER_SRP_BYTES_M = 0x52,
871 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
876 TOSERVER_NUM_MSG_TYPES = 0x53,
882 AUTH_MECHANISM_NONE = 0,
884 // SRP based on the legacy hash
885 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
887 // SRP based on the srp verification key
888 AUTH_MECHANISM_SRP = 1 << 1,
890 // Establishes a srp verification key, for first login and password changing
891 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
894 enum AccessDeniedCode {
895 SERVER_ACCESSDENIED_WRONG_PASSWORD,
896 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
897 SERVER_ACCESSDENIED_SINGLEPLAYER,
898 SERVER_ACCESSDENIED_WRONG_VERSION,
899 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
900 SERVER_ACCESSDENIED_WRONG_NAME,
901 SERVER_ACCESSDENIED_TOO_MANY_USERS,
902 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
903 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
904 SERVER_ACCESSDENIED_SERVER_FAIL,
905 SERVER_ACCESSDENIED_CUSTOM_STRING,
906 SERVER_ACCESSDENIED_SHUTDOWN,
907 SERVER_ACCESSDENIED_CRASH,
908 SERVER_ACCESSDENIED_MAX,
911 enum NetProtoCompressionMode {
912 NETPROTO_COMPRESSION_NONE = 0,
915 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
917 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
918 "The server is running in simple singleplayer mode. You cannot connect.",
919 "Your client's version is not supported.\nPlease contact server administrator.",
920 "Player name contains disallowed characters.",
921 "Player name not allowed.",
923 "Empty passwords are disallowed. Set a password and try again.",
924 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
925 "Server authentication failed. This is likely a server error.",
927 "Server shutting down.",
928 "This server has experienced an internal error. You will now be disconnected."