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.
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
74 AO_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 AO_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 AO_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.
164 Rename TOCLIENT_CHAT_MESSAGE to TOCLIENT_CHAT_MESSAGE_OLD (0x30)
165 Add TOCLIENT_CHAT_MESSAGE (0x2F)
166 This chat message is a signalisation message containing various
170 * type (RAW, NORMAL, ANNOUNCE, SYSTEM)
172 Add TOCLIENT_CSM_RESTRICTION_FLAGS to define which CSM features should be
174 Add settable player collisionbox. Breaks compatibility with older
175 clients as a 1-node vertical offset has been removed from player's
177 Add settable player stepheight using existing object property.
178 Breaks compatibility with older clients.
180 Backwards compatibility drop
181 Add 'can_zoom' to player object properties
182 Add glow to object properties
183 Change TileDef serialization format.
184 Add world-aligned tiles.
186 Raise ObjectProperties version to 3 for removing 'can_zoom' and adding
189 Add disconnected nodeboxes
190 Add TOCLIENT_FORMSPEC_PREPEND
192 Redo detached inventory sending
193 Add TOCLIENT_NODEMETA_CHANGED
194 New network float format
195 ContentFeatures version 13
196 Add full Euler rotations instead of just yaw
197 Add TOCLIENT_PLAYER_SPEED
199 Incremental inventory sending mode
200 Unknown inventory serialization fields no longer throw an error
201 Mod-specific formspec version
202 Player FOV override API
203 "ephemeral" added to TOCLIENT_PLAY_SOUND
205 Updated set_sky packet
206 Adds new sun, moon and stars packets
209 #define LATEST_PROTOCOL_VERSION 39
210 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
212 // Server's supported network protocol range
213 #define SERVER_PROTOCOL_VERSION_MIN 37
214 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
216 // Client's supported network protocol range
217 // The minimal version depends on whether
218 // send_pre_v25_init is enabled or not
219 #define CLIENT_PROTOCOL_VERSION_MIN 37
220 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
222 // Constant that differentiates the protocol from random data and other protocols
223 #define PROTOCOL_ID 0x4f457403
225 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
226 // base64-encoded SHA-1 (27+\0).
229 Changes by FORMSPEC_API_VERSION:
234 Forced real coordinates
235 background9[]: 9-slice scaling parameters
237 Formspec elements are drawn in the order of definition
238 bgcolor[]: use 3 parameters (bgcolor, formspec (now an enum), fbgcolor)
239 box[] and image[] elements enable clipping by default
240 new element: scroll_container[]
242 #define FORMSPEC_API_VERSION 3
244 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
246 typedef u16 session_t;
250 TOCLIENT_HELLO = 0x02,
252 Sent after TOSERVER_INIT.
254 u8 deployed serialisation version
255 u16 deployed network compression mode
256 u16 deployed protocol version
257 u32 supported auth methods
258 std::string username that should be used for legacy hash (for proper casing)
260 TOCLIENT_AUTH_ACCEPT = 0x03,
262 Message from server to accept auth.
264 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
266 f1000 recommended send interval
267 u32 : supported auth methods for sudo mode
268 (where the user can change their password)
270 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
272 Sent to client to show it is in sudo mode now.
274 TOCLIENT_DENY_SUDO_MODE = 0x05,
276 Signals client that sudo mode auth failed.
278 TOCLIENT_ACCESS_DENIED = 0x0A,
281 std::string custom reason (if needed, otherwise "")
285 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
287 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
288 TOCLIENT_ADDNODE = 0x21,
292 u8 keep_metadata // Added in protocol version 22
294 TOCLIENT_REMOVENODE = 0x22,
296 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
297 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
298 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
299 TOCLIENT_SECTORMETA = 0x26, // Obsolete
301 TOCLIENT_INVENTORY = 0x27,
304 [2] serialized inventory
307 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
309 TOCLIENT_TIME_OF_DAY = 0x29,
312 Added in a later version:
316 TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
318 u32 CSMRestrictionFlags byteflag
321 TOCLIENT_PLAYER_SPEED = 0x2B,
326 TOCLIENT_MEDIA_PUSH = 0x2C,
330 bool should_be_cached
335 // (oops, there is some gap here)
337 TOCLIENT_CHAT_MESSAGE = 0x2F,
341 u16 sendername length
347 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
349 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
351 u16 count of removed objects
352 for all removed objects {
355 u16 count of added objects
356 for all added objects {
359 u32 initialization data length
360 string initialization data
364 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
379 TOCLIENT_MOVE_PLAYER = 0x34,
381 v3f1000 player position
386 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
394 Sends an FOV override/multiplier to client.
401 TOCLIENT_DEATHSCREEN = 0x37,
403 u8 bool set camera point target
404 v3f1000 camera point target (to point the death cause or whatever)
407 TOCLIENT_MEDIA = 0x38,
409 u16 total number of texture bunches
410 u16 index of this bunch
411 u32 number of files in this bunch
418 u16 length of remote media server url (if applicable)
422 TOCLIENT_TOOLDEF = 0x39,
424 u32 length of the next item
425 serialized ToolDefManager
428 TOCLIENT_NODEDEF = 0x3a,
430 u32 length of the next item
431 serialized NodeDefManager
434 TOCLIENT_CRAFTITEMDEF = 0x3b,
436 u32 length of the next item
437 serialized CraftiItemDefManager
440 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
447 u16 length of sha1_digest
452 TOCLIENT_ITEMDEF = 0x3d,
454 u32 length of next item
455 serialized ItemDefManager
458 TOCLIENT_PLAY_SOUND = 0x3f,
464 u8 type (0=local, 1=positional, 2=object)
465 s32[3] pos_nodes*10000
471 TOCLIENT_STOP_SOUND = 0x40,
476 TOCLIENT_PRIVILEGES = 0x41,
478 u16 number of privileges
484 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
490 TOCLIENT_DETACHED_INVENTORY = 0x43,
495 [2] serialized inventory
498 TOCLIENT_SHOW_FORMSPEC = 0x44,
507 TOCLIENT_MOVEMENT = 0x45,
509 f1000 movement_acceleration_default
510 f1000 movement_acceleration_air
511 f1000 movement_acceleration_fast
512 f1000 movement_speed_walk
513 f1000 movement_speed_crouch
514 f1000 movement_speed_fast
515 f1000 movement_speed_climb
516 f1000 movement_speed_jump
517 f1000 movement_liquid_fluidity
518 f1000 movement_liquid_fluidity_smooth
519 f1000 movement_liquid_sink
520 f1000 movement_gravity
523 TOCLIENT_SPAWN_PARTICLE = 0x46,
530 u8 bool collisiondetection
535 TileAnimation animation
540 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
554 u8 bool collisiondetection
560 TileAnimation animation
565 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
567 TOCLIENT_HUDADD = 0x49,
589 TOCLIENT_HUDRM = 0x4a,
594 TOCLIENT_HUDCHANGE = 0x4b,
604 TOCLIENT_HUD_SET_FLAGS = 0x4c,
610 TOCLIENT_HUD_SET_PARAM = 0x4d,
617 TOCLIENT_BREATH = 0x4e,
622 TOCLIENT_SET_SKY = 0x4f,
625 u8[4] base_color (ARGB)
642 u8[4] day_horizon (ARGB)
643 u8[4] dawn_sky (ARGB)
644 u8[4] dawn_horizon (ARGB)
645 u8[4] night_sky (ARGB)
646 u8[4] night_horizon (ARGB)
648 u8[4] fog_sun_tint (ARGB)
649 u8[4] fog_moon_tint (ARGB)
650 std::string fog_tint_type
653 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
655 u8 do_override (boolean)
656 u16 day-night ratio 0...65535
659 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
668 TOCLIENT_EYE_OFFSET = 0x52,
674 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
679 TOCLIENT_CLOUD_PARAMS = 0x54,
682 u8[4] color_diffuse (ARGB)
683 u8[4] color_ambient (ARGB)
689 TOCLIENT_FADE_SOUND = 0x55,
695 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
698 u16 number of players
704 TOCLIENT_MODCHANNEL_MSG = 0x57,
706 u16 channel name length
707 std::string channel name
708 u16 channel name sender
709 std::string channel name
714 TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
717 u16 channel name length
718 std::string channel name
721 TOCLIENT_NODEMETA_CHANGED = 0x59,
723 serialized and compressed node metadata
726 TOCLIENT_SET_SUN = 0x5a,
735 TOCLIENT_SET_MOON = 0x5b,
743 TOCLIENT_SET_STARS = 0x5c,
747 u8[4] starcolor (ARGB)
751 TOCLIENT_SRP_BYTES_S_B = 0x60,
753 Belonging to AUTH_MECHANISM_SRP.
759 TOCLIENT_FORMSPEC_PREPEND = 0x61,
765 TOCLIENT_NUM_MSG_TYPES = 0x62,
770 TOSERVER_INIT = 0x02,
772 Sent first after connected.
774 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
775 u16 supported network compression modes
776 u16 minimum supported network protocol version
777 u16 maximum supported network protocol version
778 std::string player name
781 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
783 TOSERVER_INIT2 = 0x11,
785 Sent as an ACK for TOCLIENT_INIT.
786 After this, the server can send data.
788 [0] u16 TOSERVER_INIT2
791 TOSERVER_MODCHANNEL_JOIN = 0x17,
793 u16 channel name length
794 std::string channel name
797 TOSERVER_MODCHANNEL_LEAVE = 0x18,
799 u16 channel name length
800 std::string channel name
803 TOSERVER_MODCHANNEL_MSG = 0x19,
805 u16 channel name length
806 std::string channel name
811 TOSERVER_GETBLOCK = 0x20, // Obsolete
812 TOSERVER_ADDNODE = 0x21, // Obsolete
813 TOSERVER_REMOVENODE = 0x22, // Obsolete
815 TOSERVER_PLAYERPOS = 0x23,
818 [2] v3s32 position*100
819 [2+12] v3s32 speed*100
820 [2+12+12] s32 pitch*100
821 [2+12+12+4] s32 yaw*100
822 [2+12+12+4+4] u32 keyPressed
823 [2+12+12+4+4+1] u8 fov*80
824 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
827 TOSERVER_GOTBLOCKS = 0x24,
836 TOSERVER_DELETEDBLOCKS = 0x25,
845 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
846 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
847 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
848 TOSERVER_RELEASE = 0x29, // Obsolete
849 TOSERVER_SIGNTEXT = 0x30, // Obsolete
851 TOSERVER_INVENTORY_ACTION = 0x31,
853 See InventoryAction in inventorymanager.h
856 TOSERVER_CHAT_MESSAGE = 0x32,
862 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
863 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
865 TOSERVER_DAMAGE = 0x35,
870 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
872 TOSERVER_PLAYERITEM = 0x37,
874 Sent to change selected item.
876 [0] u16 TOSERVER_PLAYERITEM
880 TOSERVER_RESPAWN = 0x38,
885 TOSERVER_INTERACT = 0x39,
890 [5] u32 length of the next item
891 [9] serialized PointedThing
893 0: start digging (from undersurface) or use
894 1: stop digging (all parameters ignored)
896 3: place block or item (to abovesurface)
900 TOSERVER_REMOVED_SOUNDS = 0x3a,
906 TOSERVER_NODEMETA_FIELDS = 0x3b,
910 u8[len] form name (reserved for future use)
919 TOSERVER_INVENTORY_FIELDS = 0x3c,
922 u8[len] form name (reserved for future use)
931 TOSERVER_REQUEST_MEDIA = 0x40,
933 u16 number of files requested
940 TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
941 TOSERVER_BREATH = 0x42, // Obsolete
943 TOSERVER_CLIENT_READY = 0x43,
950 u8[len] full_version_string
953 TOSERVER_FIRST_SRP = 0x50,
955 Belonging to AUTH_MECHANISM_FIRST_SRP.
958 std::string srp verification key
959 u8 is_empty (=1 if password is empty, 0 otherwise)
962 TOSERVER_SRP_BYTES_A = 0x51,
964 Belonging to AUTH_MECHANISM_SRP,
965 depending on current_login_based_on.
968 u8 current_login_based_on : on which version of the password's
969 hash this login is based on (0 legacy hash,
970 or 1 directly the password)
973 TOSERVER_SRP_BYTES_M = 0x52,
975 Belonging to AUTH_MECHANISM_SRP.
980 TOSERVER_NUM_MSG_TYPES = 0x53,
986 AUTH_MECHANISM_NONE = 0,
988 // SRP based on the legacy hash
989 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
991 // SRP based on the srp verification key
992 AUTH_MECHANISM_SRP = 1 << 1,
994 // Establishes a srp verification key, for first login and password changing
995 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
998 enum AccessDeniedCode {
999 SERVER_ACCESSDENIED_WRONG_PASSWORD,
1000 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
1001 SERVER_ACCESSDENIED_SINGLEPLAYER,
1002 SERVER_ACCESSDENIED_WRONG_VERSION,
1003 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
1004 SERVER_ACCESSDENIED_WRONG_NAME,
1005 SERVER_ACCESSDENIED_TOO_MANY_USERS,
1006 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
1007 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
1008 SERVER_ACCESSDENIED_SERVER_FAIL,
1009 SERVER_ACCESSDENIED_CUSTOM_STRING,
1010 SERVER_ACCESSDENIED_SHUTDOWN,
1011 SERVER_ACCESSDENIED_CRASH,
1012 SERVER_ACCESSDENIED_MAX,
1015 enum NetProtoCompressionMode {
1016 NETPROTO_COMPRESSION_NONE = 0,
1019 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1021 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
1022 "The server is running in simple singleplayer mode. You cannot connect.",
1023 "Your client's version is not supported.\nPlease contact server administrator.",
1024 "Player name contains disallowed characters.",
1025 "Player name not allowed.",
1027 "Empty passwords are disallowed. Set a password and try again.",
1028 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
1029 "Server authentication failed. This is likely a server error.",
1031 "Server shutting down.",
1032 "This server has experienced an internal error. You will now be disconnected."
1035 enum PlayerListModifer: u8
1042 enum CSMRestrictionFlags : u64 {
1043 CSM_RF_NONE = 0x00000000,
1044 // Until server-sent CSM and verifying of builtin are complete,
1045 // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
1046 // When those are complete, this should return to only being a restriction on the
1047 // loading of client mods.
1048 CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
1049 CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
1050 CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
1051 CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
1052 CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
1053 CSM_RF_READ_PLAYERINFO = 0x00000020, // Disable player info lookups
1054 CSM_RF_ALL = 0xFFFFFFFF,
1057 enum InteractAction : u8
1059 INTERACT_START_DIGGING, // 0: start digging (from undersurface) or use
1060 INTERACT_STOP_DIGGING, // 1: stop digging (all parameters ignored)
1061 INTERACT_DIGGING_COMPLETED, // 2: digging completed
1062 INTERACT_PLACE, // 3: place block or item (to abovesurface)
1063 INTERACT_USE, // 4: use item
1064 INTERACT_ACTIVATE // 5: rightclick air ("activate")