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
159 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
160 instead of guessing based on the active object list.
165 #define LATEST_PROTOCOL_VERSION 34
167 // Server's supported network protocol range
168 #define SERVER_PROTOCOL_VERSION_MIN 24
169 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
171 // Client's supported network protocol range
172 // The minimal version depends on whether
173 // send_pre_v25_init is enabled or not
174 #define CLIENT_PROTOCOL_VERSION_MIN 25
175 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
176 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
178 // Constant that differentiates the protocol from random data and other protocols
179 #define PROTOCOL_ID 0x4f457403
181 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
182 // base64-encoded SHA-1 (27+\0).
184 #define FORMSPEC_API_VERSION 1
185 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
187 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
191 TOCLIENT_HELLO = 0x02,
193 Sent after TOSERVER_INIT.
195 u8 deployed serialisation version
196 u16 deployed network compression mode
197 u16 deployed protocol version
198 u32 supported auth methods
199 std::string username that should be used for legacy hash (for proper casing)
201 TOCLIENT_AUTH_ACCEPT = 0x03,
203 Message from server to accept auth.
205 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
207 f1000 recommended send interval
208 u32 : supported auth methods for sudo mode
209 (where the user can change their password)
211 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
213 Sent to client to show it is in sudo mode now.
215 TOCLIENT_DENY_SUDO_MODE = 0x05,
217 Signals client that sudo mode auth failed.
219 TOCLIENT_INIT_LEGACY = 0x10,
221 Server's reply to TOSERVER_INIT.
222 Sent second after connected.
224 [0] u16 TOSERVER_INIT
225 [2] u8 deployed version
226 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
227 [12] u64 map seed (new as of 2011-02-27)
228 [20] f1000 recommended send interval (in seconds) (new as of 14)
230 NOTE: The position in here is deprecated; position is
231 explicitly sent afterwards
233 TOCLIENT_ACCESS_DENIED = 0x0A,
236 std::string custom reason (if needed, otherwise "")
239 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
240 TOCLIENT_ADDNODE = 0x21,
244 u8 keep_metadata // Added in protocol version 22
246 TOCLIENT_REMOVENODE = 0x22,
248 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
251 // Followed by an arbitary number of these:
252 // Number is determined from packet length.
254 [N+2] v3s32 position*100
255 [N+2+12] v3s32 speed*100
256 [N+2+12+12] s32 pitch*100
257 [N+2+12+12+4] s32 yaw*100
260 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
263 // Followed by an arbitary number of these:
264 // Number is determined from packet length.
269 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
271 TOCLIENT_SECTORMETA = 0x26, // Obsolete
275 [3...] v2s16 pos + sector metadata
278 TOCLIENT_INVENTORY = 0x27,
281 [2] serialized inventory
284 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
288 u16 number of player positions
301 TOCLIENT_TIME_OF_DAY = 0x29,
304 Added in a later version:
308 // (oops, there is some gap here)
310 TOCLIENT_CHAT_MESSAGE = 0x30,
316 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
318 u16 count of removed objects
319 for all removed objects {
322 u16 count of added objects
323 for all added objects {
326 u32 initialization data length
327 string initialization data
331 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
346 TOCLIENT_MOVE_PLAYER = 0x34,
348 v3f1000 player position
353 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
359 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
361 u16 count of player items
362 for all player items {
364 u16 length of serialized item
365 string serialized item
369 TOCLIENT_DEATHSCREEN = 0x37,
371 u8 bool set camera point target
372 v3f1000 camera point target (to point the death cause or whatever)
375 TOCLIENT_MEDIA = 0x38,
377 u16 total number of texture bunches
378 u16 index of this bunch
379 u32 number of files in this bunch
386 u16 length of remote media server url (if applicable)
390 TOCLIENT_TOOLDEF = 0x39,
392 u32 length of the next item
393 serialized ToolDefManager
396 TOCLIENT_NODEDEF = 0x3a,
398 u32 length of the next item
399 serialized NodeDefManager
402 TOCLIENT_CRAFTITEMDEF = 0x3b,
404 u32 length of the next item
405 serialized CraftiItemDefManager
408 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
415 u16 length of sha1_digest
420 TOCLIENT_ITEMDEF = 0x3d,
422 u32 length of next item
423 serialized ItemDefManager
426 TOCLIENT_PLAY_SOUND = 0x3f,
432 u8 type (0=local, 1=positional, 2=object)
433 s32[3] pos_nodes*10000
438 TOCLIENT_STOP_SOUND = 0x40,
443 TOCLIENT_PRIVILEGES = 0x41,
445 u16 number of privileges
451 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
457 TOCLIENT_DETACHED_INVENTORY = 0x43,
462 [2] serialized inventory
465 TOCLIENT_SHOW_FORMSPEC = 0x44,
474 TOCLIENT_MOVEMENT = 0x45,
476 f1000 movement_acceleration_default
477 f1000 movement_acceleration_air
478 f1000 movement_acceleration_fast
479 f1000 movement_speed_walk
480 f1000 movement_speed_crouch
481 f1000 movement_speed_fast
482 f1000 movement_speed_climb
483 f1000 movement_speed_jump
484 f1000 movement_liquid_fluidity
485 f1000 movement_liquid_fluidity_smooth
486 f1000 movement_liquid_sink
487 f1000 movement_gravity
490 TOCLIENT_SPAWN_PARTICLE = 0x46,
497 u8 bool collisiondetection
504 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
518 u8 bool collisiondetection
526 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
531 TOCLIENT_HUDADD = 0x49,
550 TOCLIENT_HUDRM = 0x4a,
555 TOCLIENT_HUDCHANGE = 0x4b,
565 TOCLIENT_HUD_SET_FLAGS = 0x4c,
571 TOCLIENT_HUD_SET_PARAM = 0x4d,
578 TOCLIENT_BREATH = 0x4e,
583 TOCLIENT_SET_SKY = 0x4f,
595 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
597 u8 do_override (boolean)
598 u16 day-night ratio 0...65535
601 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
610 TOCLIENT_EYE_OFFSET = 0x52,
616 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
621 TOCLIENT_CLOUD_PARAMS = 0x54,
624 u8[4] color_diffuse (ARGB)
625 u8[4] color_ambient (ARGB)
631 TOCLIENT_FADE_SOUND = 0x55,
637 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
640 u16 number of players
646 TOCLIENT_SRP_BYTES_S_B = 0x60,
648 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
654 TOCLIENT_NUM_MSG_TYPES = 0x61,
659 TOSERVER_INIT = 0x02,
661 Sent first after connected.
663 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
664 u16 supported network compression modes
665 u16 minimum supported network protocol version
666 u16 maximum supported network protocol version
667 std::string player name
670 TOSERVER_INIT_LEGACY = 0x10,
672 Sent first after connected.
674 [0] u16 TOSERVER_INIT_LEGACY
675 [2] u8 SER_FMT_VER_HIGHEST_READ
676 [3] u8[20] player_name
677 [23] u8[28] password (new in some version)
678 [51] u16 minimum supported network protocol version (added sometime)
679 [53] u16 maximum supported network protocol version (added later than the previous one)
682 TOSERVER_INIT2 = 0x11,
684 Sent as an ACK for TOCLIENT_INIT.
685 After this, the server can send data.
687 [0] u16 TOSERVER_INIT2
690 TOSERVER_GETBLOCK=0x20, // Obsolete
691 TOSERVER_ADDNODE = 0x21, // Obsolete
692 TOSERVER_REMOVENODE = 0x22, // Obsolete
694 TOSERVER_PLAYERPOS = 0x23,
697 [2] v3s32 position*100
698 [2+12] v3s32 speed*100
699 [2+12+12] s32 pitch*100
700 [2+12+12+4] s32 yaw*100
701 [2+12+12+4+4] u32 keyPressed
702 [2+12+12+4+4+1] u8 fov*80
703 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
706 TOSERVER_GOTBLOCKS = 0x24,
715 TOSERVER_DELETEDBLOCKS = 0x25,
724 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
731 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
735 [2] u8 button (0=left, 1=right)
741 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
746 [3] v3s16 nodepos_undersurface
747 [9] v3s16 nodepos_abovesurface
750 0: start digging (from undersurface)
751 1: place block (to abovesurface)
752 2: stop digging (all parameters ignored)
756 TOSERVER_RELEASE = 0x29, // Obsolete
758 // (oops, there is some gap here)
760 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
768 TOSERVER_INVENTORY_ACTION = 0x31,
770 See InventoryAction in inventorymanager.h
773 TOSERVER_CHAT_MESSAGE = 0x32,
779 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
786 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
790 [2] u8 button (0=left, 1=right)
795 TOSERVER_DAMAGE = 0x35,
800 TOSERVER_PASSWORD_LEGACY = 0x36,
802 Sent to change password.
804 [0] u16 TOSERVER_PASSWORD
805 [2] u8[28] old password
806 [30] u8[28] new password
809 TOSERVER_PLAYERITEM = 0x37,
811 Sent to change selected item.
813 [0] u16 TOSERVER_PLAYERITEM
817 TOSERVER_RESPAWN = 0x38,
822 TOSERVER_INTERACT = 0x39,
827 [5] u32 length of the next item
828 [9] serialized PointedThing
830 0: start digging (from undersurface) or use
831 1: stop digging (all parameters ignored)
833 3: place block or item (to abovesurface)
836 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
839 TOSERVER_REMOVED_SOUNDS = 0x3a,
845 TOSERVER_NODEMETA_FIELDS = 0x3b,
849 u8[len] form name (reserved for future use)
858 TOSERVER_INVENTORY_FIELDS = 0x3c,
861 u8[len] form name (reserved for future use)
870 TOSERVER_REQUEST_MEDIA = 0x40,
872 u16 number of files requested
879 TOSERVER_RECEIVED_MEDIA = 0x41,
884 TOSERVER_BREATH = 0x42, // Obsolete
889 TOSERVER_CLIENT_READY = 0x43,
896 u8[len] full_version_string
899 TOSERVER_FIRST_SRP = 0x50,
901 Belonging to AUTH_MECHANISM_FIRST_SRP.
904 std::string srp verification key
905 u8 is_empty (=1 if password is empty, 0 otherwise)
908 TOSERVER_SRP_BYTES_A = 0x51,
910 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
911 depending on current_login_based_on.
914 u8 current_login_based_on : on which version of the password's
915 hash this login is based on (0 legacy hash,
916 or 1 directly the password)
919 TOSERVER_SRP_BYTES_M = 0x52,
921 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
926 TOSERVER_NUM_MSG_TYPES = 0x53,
932 AUTH_MECHANISM_NONE = 0,
934 // SRP based on the legacy hash
935 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
937 // SRP based on the srp verification key
938 AUTH_MECHANISM_SRP = 1 << 1,
940 // Establishes a srp verification key, for first login and password changing
941 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
944 enum AccessDeniedCode {
945 SERVER_ACCESSDENIED_WRONG_PASSWORD,
946 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
947 SERVER_ACCESSDENIED_SINGLEPLAYER,
948 SERVER_ACCESSDENIED_WRONG_VERSION,
949 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
950 SERVER_ACCESSDENIED_WRONG_NAME,
951 SERVER_ACCESSDENIED_TOO_MANY_USERS,
952 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
953 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
954 SERVER_ACCESSDENIED_SERVER_FAIL,
955 SERVER_ACCESSDENIED_CUSTOM_STRING,
956 SERVER_ACCESSDENIED_SHUTDOWN,
957 SERVER_ACCESSDENIED_CRASH,
958 SERVER_ACCESSDENIED_MAX,
961 enum NetProtoCompressionMode {
962 NETPROTO_COMPRESSION_NONE = 0,
965 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
967 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
968 "The server is running in simple singleplayer mode. You cannot connect.",
969 "Your client's version is not supported.\nPlease contact server administrator.",
970 "Player name contains disallowed characters.",
971 "Player name not allowed.",
973 "Empty passwords are disallowed. Set a password and try again.",
974 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
975 "Server authentication failed. This is likely a server error.",
977 "Server shutting down.",
978 "This server has experienced an internal error. You will now be disconnected."
981 enum PlayerListModifer: u8