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
142 Server doesn't accept TOSERVER_BREATH anymore
143 serialization of TileAnimation params changed
145 Removed client-sided chat perdiction
147 New ContentFeatures serialization version
148 Add node and tile color and palette
149 Fix plantlike visual_scale being applied squared and add compatibility
150 with pre-30 clients by sending sqrt(visual_scale)
153 #define LATEST_PROTOCOL_VERSION 30
155 // Server's supported network protocol range
156 #define SERVER_PROTOCOL_VERSION_MIN 24
157 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
159 // Client's supported network protocol range
160 // The minimal version depends on whether
161 // send_pre_v25_init is enabled or not
162 #define CLIENT_PROTOCOL_VERSION_MIN 25
163 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
164 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
166 // Constant that differentiates the protocol from random data and other protocols
167 #define PROTOCOL_ID 0x4f457403
169 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
170 // base64-encoded SHA-1 (27+\0).
172 #define FORMSPEC_API_VERSION 1
173 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
175 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
179 TOCLIENT_HELLO = 0x02,
181 Sent after TOSERVER_INIT.
183 u8 deployed serialisation version
184 u16 deployed network compression mode
185 u16 deployed protocol version
186 u32 supported auth methods
187 std::string username that should be used for legacy hash (for proper casing)
189 TOCLIENT_AUTH_ACCEPT = 0x03,
191 Message from server to accept auth.
193 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
195 f1000 recommended send interval
196 u32 : supported auth methods for sudo mode
197 (where the user can change their password)
199 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
201 Sent to client to show it is in sudo mode now.
203 TOCLIENT_DENY_SUDO_MODE = 0x05,
205 Signals client that sudo mode auth failed.
207 TOCLIENT_INIT_LEGACY = 0x10,
209 Server's reply to TOSERVER_INIT.
210 Sent second after connected.
212 [0] u16 TOSERVER_INIT
213 [2] u8 deployed version
214 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
215 [12] u64 map seed (new as of 2011-02-27)
216 [20] f1000 recommended send interval (in seconds) (new as of 14)
218 NOTE: The position in here is deprecated; position is
219 explicitly sent afterwards
221 TOCLIENT_ACCESS_DENIED = 0x0A,
224 std::string custom reason (if needed, otherwise "")
227 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
228 TOCLIENT_ADDNODE = 0x21,
232 u8 keep_metadata // Added in protocol version 22
234 TOCLIENT_REMOVENODE = 0x22,
236 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
239 // Followed by an arbitary number of these:
240 // Number is determined from packet length.
242 [N+2] v3s32 position*100
243 [N+2+12] v3s32 speed*100
244 [N+2+12+12] s32 pitch*100
245 [N+2+12+12+4] s32 yaw*100
248 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
251 // Followed by an arbitary number of these:
252 // Number is determined from packet length.
257 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
259 TOCLIENT_SECTORMETA = 0x26, // Obsolete
263 [3...] v2s16 pos + sector metadata
266 TOCLIENT_INVENTORY = 0x27,
269 [2] serialized inventory
272 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
276 u16 number of player positions
289 TOCLIENT_TIME_OF_DAY = 0x29,
292 Added in a later version:
296 // (oops, there is some gap here)
298 TOCLIENT_CHAT_MESSAGE = 0x30,
304 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
306 u16 count of removed objects
307 for all removed objects {
310 u16 count of added objects
311 for all added objects {
314 u32 initialization data length
315 string initialization data
319 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
334 TOCLIENT_MOVE_PLAYER = 0x34,
336 v3f1000 player position
341 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
347 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
349 u16 count of player items
350 for all player items {
352 u16 length of serialized item
353 string serialized item
357 TOCLIENT_DEATHSCREEN = 0x37,
359 u8 bool set camera point target
360 v3f1000 camera point target (to point the death cause or whatever)
363 TOCLIENT_MEDIA = 0x38,
365 u16 total number of texture bunches
366 u16 index of this bunch
367 u32 number of files in this bunch
374 u16 length of remote media server url (if applicable)
378 TOCLIENT_TOOLDEF = 0x39,
380 u32 length of the next item
381 serialized ToolDefManager
384 TOCLIENT_NODEDEF = 0x3a,
386 u32 length of the next item
387 serialized NodeDefManager
390 TOCLIENT_CRAFTITEMDEF = 0x3b,
392 u32 length of the next item
393 serialized CraftiItemDefManager
396 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
403 u16 length of sha1_digest
408 TOCLIENT_ITEMDEF = 0x3d,
410 u32 length of next item
411 serialized ItemDefManager
414 TOCLIENT_PLAY_SOUND = 0x3f,
420 u8 type (0=local, 1=positional, 2=object)
421 s32[3] pos_nodes*10000
426 TOCLIENT_STOP_SOUND = 0x40,
431 TOCLIENT_PRIVILEGES = 0x41,
433 u16 number of privileges
439 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
445 TOCLIENT_DETACHED_INVENTORY = 0x43,
450 [2] serialized inventory
453 TOCLIENT_SHOW_FORMSPEC = 0x44,
462 TOCLIENT_MOVEMENT = 0x45,
464 f1000 movement_acceleration_default
465 f1000 movement_acceleration_air
466 f1000 movement_acceleration_fast
467 f1000 movement_speed_walk
468 f1000 movement_speed_crouch
469 f1000 movement_speed_fast
470 f1000 movement_speed_climb
471 f1000 movement_speed_jump
472 f1000 movement_liquid_fluidity
473 f1000 movement_liquid_fluidity_smooth
474 f1000 movement_liquid_sink
475 f1000 movement_gravity
478 TOCLIENT_SPAWN_PARTICLE = 0x46,
485 u8 bool collisiondetection
492 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
506 u8 bool collisiondetection
514 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
519 TOCLIENT_HUDADD = 0x49,
538 TOCLIENT_HUDRM = 0x4a,
543 TOCLIENT_HUDCHANGE = 0x4b,
553 TOCLIENT_HUD_SET_FLAGS = 0x4c,
559 TOCLIENT_HUD_SET_PARAM = 0x4d,
566 TOCLIENT_BREATH = 0x4e,
571 TOCLIENT_SET_SKY = 0x4f,
582 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
584 u8 do_override (boolean)
585 u16 day-night ratio 0...65535
588 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
597 TOCLIENT_EYE_OFFSET = 0x52,
603 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
608 TOCLIENT_SRP_BYTES_S_B = 0x60,
610 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
616 TOCLIENT_NUM_MSG_TYPES = 0x61,
621 TOSERVER_INIT = 0x02,
623 Sent first after connected.
625 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
626 u16 supported network compression modes
627 u16 minimum supported network protocol version
628 u16 maximum supported network protocol version
629 std::string player name
632 TOSERVER_INIT_LEGACY = 0x10,
634 Sent first after connected.
636 [0] u16 TOSERVER_INIT_LEGACY
637 [2] u8 SER_FMT_VER_HIGHEST_READ
638 [3] u8[20] player_name
639 [23] u8[28] password (new in some version)
640 [51] u16 minimum supported network protocol version (added sometime)
641 [53] u16 maximum supported network protocol version (added later than the previous one)
644 TOSERVER_INIT2 = 0x11,
646 Sent as an ACK for TOCLIENT_INIT.
647 After this, the server can send data.
649 [0] u16 TOSERVER_INIT2
652 TOSERVER_GETBLOCK=0x20, // Obsolete
653 TOSERVER_ADDNODE = 0x21, // Obsolete
654 TOSERVER_REMOVENODE = 0x22, // Obsolete
656 TOSERVER_PLAYERPOS = 0x23,
659 [2] v3s32 position*100
660 [2+12] v3s32 speed*100
661 [2+12+12] s32 pitch*100
662 [2+12+12+4] s32 yaw*100
663 [2+12+12+4+4] u32 keyPressed
664 [2+12+12+4+4+1] u8 fov*80
665 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
668 TOSERVER_GOTBLOCKS = 0x24,
677 TOSERVER_DELETEDBLOCKS = 0x25,
686 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
693 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
697 [2] u8 button (0=left, 1=right)
703 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
708 [3] v3s16 nodepos_undersurface
709 [9] v3s16 nodepos_abovesurface
712 0: start digging (from undersurface)
713 1: place block (to abovesurface)
714 2: stop digging (all parameters ignored)
718 TOSERVER_RELEASE = 0x29, // Obsolete
720 // (oops, there is some gap here)
722 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
730 TOSERVER_INVENTORY_ACTION = 0x31,
732 See InventoryAction in inventorymanager.h
735 TOSERVER_CHAT_MESSAGE = 0x32,
741 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
748 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
752 [2] u8 button (0=left, 1=right)
757 TOSERVER_DAMAGE = 0x35,
762 TOSERVER_PASSWORD_LEGACY = 0x36,
764 Sent to change password.
766 [0] u16 TOSERVER_PASSWORD
767 [2] u8[28] old password
768 [30] u8[28] new password
771 TOSERVER_PLAYERITEM = 0x37,
773 Sent to change selected item.
775 [0] u16 TOSERVER_PLAYERITEM
779 TOSERVER_RESPAWN = 0x38,
784 TOSERVER_INTERACT = 0x39,
789 [5] u32 length of the next item
790 [9] serialized PointedThing
792 0: start digging (from undersurface) or use
793 1: stop digging (all parameters ignored)
795 3: place block or item (to abovesurface)
798 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
801 TOSERVER_REMOVED_SOUNDS = 0x3a,
807 TOSERVER_NODEMETA_FIELDS = 0x3b,
811 u8[len] form name (reserved for future use)
820 TOSERVER_INVENTORY_FIELDS = 0x3c,
823 u8[len] form name (reserved for future use)
832 TOSERVER_REQUEST_MEDIA = 0x40,
834 u16 number of files requested
841 TOSERVER_RECEIVED_MEDIA = 0x41,
846 TOSERVER_BREATH = 0x42, // Obsolete
851 TOSERVER_CLIENT_READY = 0x43,
858 u8[len] full_version_string
861 TOSERVER_FIRST_SRP = 0x50,
863 Belonging to AUTH_MECHANISM_FIRST_SRP.
866 std::string srp verification key
867 u8 is_empty (=1 if password is empty, 0 otherwise)
870 TOSERVER_SRP_BYTES_A = 0x51,
872 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
873 depending on current_login_based_on.
876 u8 current_login_based_on : on which version of the password's
877 hash this login is based on (0 legacy hash,
878 or 1 directly the password)
881 TOSERVER_SRP_BYTES_M = 0x52,
883 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
888 TOSERVER_NUM_MSG_TYPES = 0x53,
894 AUTH_MECHANISM_NONE = 0,
896 // SRP based on the legacy hash
897 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
899 // SRP based on the srp verification key
900 AUTH_MECHANISM_SRP = 1 << 1,
902 // Establishes a srp verification key, for first login and password changing
903 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
906 enum AccessDeniedCode {
907 SERVER_ACCESSDENIED_WRONG_PASSWORD,
908 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
909 SERVER_ACCESSDENIED_SINGLEPLAYER,
910 SERVER_ACCESSDENIED_WRONG_VERSION,
911 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
912 SERVER_ACCESSDENIED_WRONG_NAME,
913 SERVER_ACCESSDENIED_TOO_MANY_USERS,
914 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
915 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
916 SERVER_ACCESSDENIED_SERVER_FAIL,
917 SERVER_ACCESSDENIED_CUSTOM_STRING,
918 SERVER_ACCESSDENIED_SHUTDOWN,
919 SERVER_ACCESSDENIED_CRASH,
920 SERVER_ACCESSDENIED_MAX,
923 enum NetProtoCompressionMode {
924 NETPROTO_COMPRESSION_NONE = 0,
927 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
929 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
930 "The server is running in simple singleplayer mode. You cannot connect.",
931 "Your client's version is not supported.\nPlease contact server administrator.",
932 "Player name contains disallowed characters.",
933 "Player name not allowed.",
935 "Empty passwords are disallowed. Set a password and try again.",
936 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
937 "Server authentication failed. This is likely a server error.",
939 "Server shutting down.",
940 "This server has experienced an internal error. You will now be disconnected."