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
53 Obsolete TOCLIENT_PLAYERITEM
56 Version raised to force 'fly' and 'fast' privileges into effect.
57 Node metadata change (came in later; somewhat incompatible)
59 TileDef in ContentFeatures
62 TOCLIENT_INVENTORY_FORMSPEC
65 TOSERVER_INVENTORY_FIELDS
67 TOCLIENT_DETACHED_INVENTORY
69 InventoryList field "Width" (deserialization fails with old versions)
71 Added transfer of player pressed keys to the server
72 Added new messages for mesh and bone animation, as well as attachments
73 GENERIC_CMD_SET_ANIMATION
74 GENERIC_CMD_SET_BONE_POSITION
75 GENERIC_CMD_SET_ATTACHMENT
77 Serialization format changes
79 TOCLIENT_SHOW_FORMSPEC
81 Serialization format change: include backface_culling flag in TileDef
82 Added rightclickable field in nodedef
83 TOCLIENT_SPAWN_PARTICLE
84 TOCLIENT_ADD_PARTICLESPAWNER
85 TOCLIENT_DELETE_PARTICLESPAWNER
87 damageGroups added to ToolCapabilities
88 sound_place added to ItemDefinition
90 GENERIC_CMD_SET_PHYSICS_OVERRIDE
95 TOCLIENT_HUD_SET_FLAGS
99 range added to ItemDefinition
100 drowning, leveled and liquid_range added to ContentFeatures
101 stepheight and collideWithObjects added to object properties
102 version, heat and humidity transfer in MapBock
103 automatic_face_movement_dir and automatic_face_movement_dir_offset
104 added to object properties
108 Obsolete TOSERVER_RECEIVED_MEDIA
109 Server: Stop using TOSERVER_CLIENT_READY
111 ContentFeatures version 7
112 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
114 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
115 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
116 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
117 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
118 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
119 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
120 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
121 for standard error, keeping customisation possible. This
123 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
125 Add new opcode TOSERVER_INIT for client presentation to server
126 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
127 TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
128 for the three supported auth mechanisms around srp
129 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
130 for sudo mode handling (auth mech generic way of changing password).
131 Add TOCLIENT_HELLO for presenting server to client after client
133 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
134 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
136 Add TileDef tileable_horizontal, tileable_vertical flags
138 backface_culling: backwards compatibility for playing with
139 newer client on pre-27 servers.
140 Add nodedef v3 - connected nodeboxes
144 Server doesn't accept TOSERVER_BREATH anymore
145 serialization of TileAnimation params changed
147 Removed client-sided chat perdiction
149 New ContentFeatures serialization version
150 Add node and tile color and palette
151 Fix plantlike visual_scale being applied squared and add compatibility
152 with pre-30 clients by sending sqrt(visual_scale)
155 Stop sending TOSERVER_CLIENT_READY
160 #define LATEST_PROTOCOL_VERSION 32
162 // Server's supported network protocol range
163 #define SERVER_PROTOCOL_VERSION_MIN 24
164 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
166 // Client's supported network protocol range
167 // The minimal version depends on whether
168 // send_pre_v25_init is enabled or not
169 #define CLIENT_PROTOCOL_VERSION_MIN 25
170 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
171 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
173 // Constant that differentiates the protocol from random data and other protocols
174 #define PROTOCOL_ID 0x4f457403
176 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
177 // base64-encoded SHA-1 (27+\0).
179 #define FORMSPEC_API_VERSION 1
180 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
182 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
186 TOCLIENT_HELLO = 0x02,
188 Sent after TOSERVER_INIT.
190 u8 deployed serialisation version
191 u16 deployed network compression mode
192 u16 deployed protocol version
193 u32 supported auth methods
194 std::string username that should be used for legacy hash (for proper casing)
196 TOCLIENT_AUTH_ACCEPT = 0x03,
198 Message from server to accept auth.
200 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
202 f1000 recommended send interval
203 u32 : supported auth methods for sudo mode
204 (where the user can change their password)
206 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
208 Sent to client to show it is in sudo mode now.
210 TOCLIENT_DENY_SUDO_MODE = 0x05,
212 Signals client that sudo mode auth failed.
214 TOCLIENT_INIT_LEGACY = 0x10,
216 Server's reply to TOSERVER_INIT.
217 Sent second after connected.
219 [0] u16 TOSERVER_INIT
220 [2] u8 deployed version
221 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
222 [12] u64 map seed (new as of 2011-02-27)
223 [20] f1000 recommended send interval (in seconds) (new as of 14)
225 NOTE: The position in here is deprecated; position is
226 explicitly sent afterwards
228 TOCLIENT_ACCESS_DENIED = 0x0A,
231 std::string custom reason (if needed, otherwise "")
234 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
235 TOCLIENT_ADDNODE = 0x21,
239 u8 keep_metadata // Added in protocol version 22
241 TOCLIENT_REMOVENODE = 0x22,
243 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
246 // Followed by an arbitary number of these:
247 // Number is determined from packet length.
249 [N+2] v3s32 position*100
250 [N+2+12] v3s32 speed*100
251 [N+2+12+12] s32 pitch*100
252 [N+2+12+12+4] s32 yaw*100
255 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
258 // Followed by an arbitary number of these:
259 // Number is determined from packet length.
264 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
266 TOCLIENT_SECTORMETA = 0x26, // Obsolete
270 [3...] v2s16 pos + sector metadata
273 TOCLIENT_INVENTORY = 0x27,
276 [2] serialized inventory
279 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
283 u16 number of player positions
296 TOCLIENT_TIME_OF_DAY = 0x29,
299 Added in a later version:
303 // (oops, there is some gap here)
305 TOCLIENT_CHAT_MESSAGE = 0x30,
311 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
313 u16 count of removed objects
314 for all removed objects {
317 u16 count of added objects
318 for all added objects {
321 u32 initialization data length
322 string initialization data
326 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
341 TOCLIENT_MOVE_PLAYER = 0x34,
343 v3f1000 player position
348 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
354 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
356 u16 count of player items
357 for all player items {
359 u16 length of serialized item
360 string serialized item
364 TOCLIENT_DEATHSCREEN = 0x37,
366 u8 bool set camera point target
367 v3f1000 camera point target (to point the death cause or whatever)
370 TOCLIENT_MEDIA = 0x38,
372 u16 total number of texture bunches
373 u16 index of this bunch
374 u32 number of files in this bunch
381 u16 length of remote media server url (if applicable)
385 TOCLIENT_TOOLDEF = 0x39,
387 u32 length of the next item
388 serialized ToolDefManager
391 TOCLIENT_NODEDEF = 0x3a,
393 u32 length of the next item
394 serialized NodeDefManager
397 TOCLIENT_CRAFTITEMDEF = 0x3b,
399 u32 length of the next item
400 serialized CraftiItemDefManager
403 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
410 u16 length of sha1_digest
415 TOCLIENT_ITEMDEF = 0x3d,
417 u32 length of next item
418 serialized ItemDefManager
421 TOCLIENT_PLAY_SOUND = 0x3f,
427 u8 type (0=local, 1=positional, 2=object)
428 s32[3] pos_nodes*10000
433 TOCLIENT_STOP_SOUND = 0x40,
438 TOCLIENT_PRIVILEGES = 0x41,
440 u16 number of privileges
446 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
452 TOCLIENT_DETACHED_INVENTORY = 0x43,
457 [2] serialized inventory
460 TOCLIENT_SHOW_FORMSPEC = 0x44,
469 TOCLIENT_MOVEMENT = 0x45,
471 f1000 movement_acceleration_default
472 f1000 movement_acceleration_air
473 f1000 movement_acceleration_fast
474 f1000 movement_speed_walk
475 f1000 movement_speed_crouch
476 f1000 movement_speed_fast
477 f1000 movement_speed_climb
478 f1000 movement_speed_jump
479 f1000 movement_liquid_fluidity
480 f1000 movement_liquid_fluidity_smooth
481 f1000 movement_liquid_sink
482 f1000 movement_gravity
485 TOCLIENT_SPAWN_PARTICLE = 0x46,
492 u8 bool collisiondetection
499 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
513 u8 bool collisiondetection
521 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
526 TOCLIENT_HUDADD = 0x49,
545 TOCLIENT_HUDRM = 0x4a,
550 TOCLIENT_HUDCHANGE = 0x4b,
560 TOCLIENT_HUD_SET_FLAGS = 0x4c,
566 TOCLIENT_HUD_SET_PARAM = 0x4d,
573 TOCLIENT_BREATH = 0x4e,
578 TOCLIENT_SET_SKY = 0x4f,
589 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
591 u8 do_override (boolean)
592 u16 day-night ratio 0...65535
595 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
604 TOCLIENT_EYE_OFFSET = 0x52,
610 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
615 TOCLIENT_CLOUD_PARAMS = 0x54,
618 u8[4] color_diffuse (ARGB)
619 u8[4] color_ambient (ARGB)
625 TOCLIENT_FADE_SOUND = 0x55,
632 TOCLIENT_SRP_BYTES_S_B = 0x60,
634 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
640 TOCLIENT_NUM_MSG_TYPES = 0x61,
645 TOSERVER_INIT = 0x02,
647 Sent first after connected.
649 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
650 u16 supported network compression modes
651 u16 minimum supported network protocol version
652 u16 maximum supported network protocol version
653 std::string player name
656 TOSERVER_INIT_LEGACY = 0x10,
658 Sent first after connected.
660 [0] u16 TOSERVER_INIT_LEGACY
661 [2] u8 SER_FMT_VER_HIGHEST_READ
662 [3] u8[20] player_name
663 [23] u8[28] password (new in some version)
664 [51] u16 minimum supported network protocol version (added sometime)
665 [53] u16 maximum supported network protocol version (added later than the previous one)
668 TOSERVER_INIT2 = 0x11,
670 Sent as an ACK for TOCLIENT_INIT.
671 After this, the server can send data.
673 [0] u16 TOSERVER_INIT2
676 TOSERVER_GETBLOCK=0x20, // Obsolete
677 TOSERVER_ADDNODE = 0x21, // Obsolete
678 TOSERVER_REMOVENODE = 0x22, // Obsolete
680 TOSERVER_PLAYERPOS = 0x23,
683 [2] v3s32 position*100
684 [2+12] v3s32 speed*100
685 [2+12+12] s32 pitch*100
686 [2+12+12+4] s32 yaw*100
687 [2+12+12+4+4] u32 keyPressed
688 [2+12+12+4+4+1] u8 fov*80
689 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
692 TOSERVER_GOTBLOCKS = 0x24,
701 TOSERVER_DELETEDBLOCKS = 0x25,
710 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
717 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
721 [2] u8 button (0=left, 1=right)
727 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
732 [3] v3s16 nodepos_undersurface
733 [9] v3s16 nodepos_abovesurface
736 0: start digging (from undersurface)
737 1: place block (to abovesurface)
738 2: stop digging (all parameters ignored)
742 TOSERVER_RELEASE = 0x29, // Obsolete
744 // (oops, there is some gap here)
746 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
754 TOSERVER_INVENTORY_ACTION = 0x31,
756 See InventoryAction in inventorymanager.h
759 TOSERVER_CHAT_MESSAGE = 0x32,
765 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
772 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
776 [2] u8 button (0=left, 1=right)
781 TOSERVER_DAMAGE = 0x35,
786 TOSERVER_PASSWORD_LEGACY = 0x36,
788 Sent to change password.
790 [0] u16 TOSERVER_PASSWORD
791 [2] u8[28] old password
792 [30] u8[28] new password
795 TOSERVER_PLAYERITEM = 0x37,
797 Sent to change selected item.
799 [0] u16 TOSERVER_PLAYERITEM
803 TOSERVER_RESPAWN = 0x38,
808 TOSERVER_INTERACT = 0x39,
813 [5] u32 length of the next item
814 [9] serialized PointedThing
816 0: start digging (from undersurface) or use
817 1: stop digging (all parameters ignored)
819 3: place block or item (to abovesurface)
822 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
825 TOSERVER_REMOVED_SOUNDS = 0x3a,
831 TOSERVER_NODEMETA_FIELDS = 0x3b,
835 u8[len] form name (reserved for future use)
844 TOSERVER_INVENTORY_FIELDS = 0x3c,
847 u8[len] form name (reserved for future use)
856 TOSERVER_REQUEST_MEDIA = 0x40,
858 u16 number of files requested
865 TOSERVER_RECEIVED_MEDIA = 0x41,
870 TOSERVER_BREATH = 0x42, // Obsolete
875 TOSERVER_CLIENT_READY = 0x43,
882 u8[len] full_version_string
885 TOSERVER_FIRST_SRP = 0x50,
887 Belonging to AUTH_MECHANISM_FIRST_SRP.
890 std::string srp verification key
891 u8 is_empty (=1 if password is empty, 0 otherwise)
894 TOSERVER_SRP_BYTES_A = 0x51,
896 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
897 depending on current_login_based_on.
900 u8 current_login_based_on : on which version of the password's
901 hash this login is based on (0 legacy hash,
902 or 1 directly the password)
905 TOSERVER_SRP_BYTES_M = 0x52,
907 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
912 TOSERVER_NUM_MSG_TYPES = 0x53,
918 AUTH_MECHANISM_NONE = 0,
920 // SRP based on the legacy hash
921 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
923 // SRP based on the srp verification key
924 AUTH_MECHANISM_SRP = 1 << 1,
926 // Establishes a srp verification key, for first login and password changing
927 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
930 enum AccessDeniedCode {
931 SERVER_ACCESSDENIED_WRONG_PASSWORD,
932 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
933 SERVER_ACCESSDENIED_SINGLEPLAYER,
934 SERVER_ACCESSDENIED_WRONG_VERSION,
935 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
936 SERVER_ACCESSDENIED_WRONG_NAME,
937 SERVER_ACCESSDENIED_TOO_MANY_USERS,
938 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
939 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
940 SERVER_ACCESSDENIED_SERVER_FAIL,
941 SERVER_ACCESSDENIED_CUSTOM_STRING,
942 SERVER_ACCESSDENIED_SHUTDOWN,
943 SERVER_ACCESSDENIED_CRASH,
944 SERVER_ACCESSDENIED_MAX,
947 enum NetProtoCompressionMode {
948 NETPROTO_COMPRESSION_NONE = 0,
951 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
953 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
954 "The server is running in simple singleplayer mode. You cannot connect.",
955 "Your client's version is not supported.\nPlease contact server administrator.",
956 "Player name contains disallowed characters.",
957 "Player name not allowed.",
959 "Empty passwords are disallowed. Set a password and try again.",
960 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
961 "Server authentication failed. This is likely a server error.",
963 "Server shutting down.",
964 "This server has experienced an internal error. You will now be disconnected."