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 TOCLIENT_MEDIA_PUSH changed, TOSERVER_HAVE_MEDIA added
212 #define LATEST_PROTOCOL_VERSION 40
213 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
215 // Server's supported network protocol range
216 #define SERVER_PROTOCOL_VERSION_MIN 37
217 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
219 // Client's supported network protocol range
220 // The minimal version depends on whether
221 // send_pre_v25_init is enabled or not
222 #define CLIENT_PROTOCOL_VERSION_MIN 37
223 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
225 // Constant that differentiates the protocol from random data and other protocols
226 #define PROTOCOL_ID 0x4f457403
228 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
229 // base64-encoded SHA-1 (27+\0).
231 // See also: Formspec Version History in doc/lua_api.txt
232 #define FORMSPEC_API_VERSION 5
234 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
236 typedef u16 session_t;
240 TOCLIENT_HELLO = 0x02,
242 Sent after TOSERVER_INIT.
244 u8 deployed serialisation version
245 u16 deployed network compression mode
246 u16 deployed protocol version
247 u32 supported auth methods
248 std::string username that should be used for legacy hash (for proper casing)
250 TOCLIENT_AUTH_ACCEPT = 0x03,
252 Message from server to accept auth.
254 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
256 f1000 recommended send interval
257 u32 : supported auth methods for sudo mode
258 (where the user can change their password)
260 TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
262 Sent to client to show it is in sudo mode now.
264 TOCLIENT_DENY_SUDO_MODE = 0x05,
266 Signals client that sudo mode auth failed.
268 TOCLIENT_ACCESS_DENIED = 0x0A,
271 std::string custom reason (if needed, otherwise "")
275 TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
277 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
278 TOCLIENT_ADDNODE = 0x21,
282 u8 keep_metadata // Added in protocol version 22
284 TOCLIENT_REMOVENODE = 0x22,
286 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
287 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
288 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
289 TOCLIENT_SECTORMETA = 0x26, // Obsolete
291 TOCLIENT_INVENTORY = 0x27,
294 [2] serialized inventory
297 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
299 TOCLIENT_TIME_OF_DAY = 0x29,
302 Added in a later version:
306 TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
308 u32 CSMRestrictionFlags byteflag
311 TOCLIENT_PLAYER_SPEED = 0x2B,
316 TOCLIENT_MEDIA_PUSH = 0x2C,
321 bool should_be_cached
324 // (oops, there is some gap here)
326 TOCLIENT_CHAT_MESSAGE = 0x2F,
330 u16 sendername length
336 TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
338 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
340 u16 count of removed objects
341 for all removed objects {
344 u16 count of added objects
345 for all added objects {
348 u32 initialization data length
349 string initialization data
353 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
368 TOCLIENT_MOVE_PLAYER = 0x34,
370 v3f1000 player position
375 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
383 Sends an FOV override/multiplier to client.
390 TOCLIENT_DEATHSCREEN = 0x37,
392 u8 bool set camera point target
393 v3f1000 camera point target (to point the death cause or whatever)
396 TOCLIENT_MEDIA = 0x38,
398 u16 total number of texture bunches
399 u16 index of this bunch
400 u32 number of files in this bunch
407 u16 length of remote media server url (if applicable)
411 TOCLIENT_TOOLDEF = 0x39,
413 u32 length of the next item
414 serialized ToolDefManager
417 TOCLIENT_NODEDEF = 0x3a,
419 u32 length of the next item
420 serialized NodeDefManager
423 TOCLIENT_CRAFTITEMDEF = 0x3b,
425 u32 length of the next item
426 serialized CraftiItemDefManager
429 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
436 u16 length of sha1_digest
441 TOCLIENT_ITEMDEF = 0x3d,
443 u32 length of next item
444 serialized ItemDefManager
447 TOCLIENT_PLAY_SOUND = 0x3f,
453 u8 type (0=local, 1=positional, 2=object)
454 s32[3] pos_nodes*10000
460 TOCLIENT_STOP_SOUND = 0x40,
465 TOCLIENT_PRIVILEGES = 0x41,
467 u16 number of privileges
473 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
479 TOCLIENT_DETACHED_INVENTORY = 0x43,
484 [2] serialized inventory
487 TOCLIENT_SHOW_FORMSPEC = 0x44,
496 TOCLIENT_MOVEMENT = 0x45,
498 f1000 movement_acceleration_default
499 f1000 movement_acceleration_air
500 f1000 movement_acceleration_fast
501 f1000 movement_speed_walk
502 f1000 movement_speed_crouch
503 f1000 movement_speed_fast
504 f1000 movement_speed_climb
505 f1000 movement_speed_jump
506 f1000 movement_liquid_fluidity
507 f1000 movement_liquid_fluidity_smooth
508 f1000 movement_liquid_sink
509 f1000 movement_gravity
512 TOCLIENT_SPAWN_PARTICLE = 0x46,
519 u8 bool collisiondetection
524 TileAnimation animation
529 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
543 u8 bool collisiondetection
549 TileAnimation animation
554 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
556 TOCLIENT_HUDADD = 0x49,
578 TOCLIENT_HUDRM = 0x4a,
583 TOCLIENT_HUDCHANGE = 0x4b,
593 TOCLIENT_HUD_SET_FLAGS = 0x4c,
599 TOCLIENT_HUD_SET_PARAM = 0x4d,
606 TOCLIENT_BREATH = 0x4e,
611 TOCLIENT_SET_SKY = 0x4f,
614 u8[4] base_color (ARGB)
631 u8[4] day_horizon (ARGB)
632 u8[4] dawn_sky (ARGB)
633 u8[4] dawn_horizon (ARGB)
634 u8[4] night_sky (ARGB)
635 u8[4] night_horizon (ARGB)
637 u8[4] fog_sun_tint (ARGB)
638 u8[4] fog_moon_tint (ARGB)
639 std::string fog_tint_type
642 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
644 u8 do_override (boolean)
645 u16 day-night ratio 0...65535
648 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
657 TOCLIENT_EYE_OFFSET = 0x52,
663 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
668 TOCLIENT_CLOUD_PARAMS = 0x54,
671 u8[4] color_diffuse (ARGB)
672 u8[4] color_ambient (ARGB)
678 TOCLIENT_FADE_SOUND = 0x55,
684 TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
687 u16 number of players
693 TOCLIENT_MODCHANNEL_MSG = 0x57,
695 u16 channel name length
696 std::string channel name
697 u16 channel name sender
698 std::string channel name
703 TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
706 u16 channel name length
707 std::string channel name
710 TOCLIENT_NODEMETA_CHANGED = 0x59,
712 serialized and compressed node metadata
715 TOCLIENT_SET_SUN = 0x5a,
724 TOCLIENT_SET_MOON = 0x5b,
732 TOCLIENT_SET_STARS = 0x5c,
736 u8[4] starcolor (ARGB)
740 TOCLIENT_SRP_BYTES_S_B = 0x60,
742 Belonging to AUTH_MECHANISM_SRP.
748 TOCLIENT_FORMSPEC_PREPEND = 0x61,
754 TOCLIENT_MINIMAP_MODES = 0x62,
757 u16 mode // wanted current mode index after change
765 TOCLIENT_SET_LIGHTING = 0x63,
770 TOCLIENT_NUM_MSG_TYPES = 0x64,
775 TOSERVER_INIT = 0x02,
777 Sent first after connected.
779 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
780 u16 supported network compression modes
781 u16 minimum supported network protocol version
782 u16 maximum supported network protocol version
783 std::string player name
786 TOSERVER_INIT_LEGACY = 0x10, // Obsolete
788 TOSERVER_INIT2 = 0x11,
790 Sent as an ACK for TOCLIENT_INIT.
791 After this, the server can send data.
793 [0] u16 TOSERVER_INIT2
796 TOSERVER_MODCHANNEL_JOIN = 0x17,
798 u16 channel name length
799 std::string channel name
802 TOSERVER_MODCHANNEL_LEAVE = 0x18,
804 u16 channel name length
805 std::string channel name
808 TOSERVER_MODCHANNEL_MSG = 0x19,
810 u16 channel name length
811 std::string channel name
816 TOSERVER_GETBLOCK = 0x20, // Obsolete
817 TOSERVER_ADDNODE = 0x21, // Obsolete
818 TOSERVER_REMOVENODE = 0x22, // Obsolete
820 TOSERVER_PLAYERPOS = 0x23,
823 [2] v3s32 position*100
824 [2+12] v3s32 speed*100
825 [2+12+12] s32 pitch*100
826 [2+12+12+4] s32 yaw*100
827 [2+12+12+4+4] u32 keyPressed
828 [2+12+12+4+4+1] u8 fov*80
829 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
832 TOSERVER_GOTBLOCKS = 0x24,
841 TOSERVER_DELETEDBLOCKS = 0x25,
850 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
851 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
852 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
853 TOSERVER_RELEASE = 0x29, // Obsolete
854 TOSERVER_SIGNTEXT = 0x30, // Obsolete
856 TOSERVER_INVENTORY_ACTION = 0x31,
858 See InventoryAction in inventorymanager.h
861 TOSERVER_CHAT_MESSAGE = 0x32,
867 TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
868 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
870 TOSERVER_DAMAGE = 0x35,
875 TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
877 TOSERVER_PLAYERITEM = 0x37,
879 Sent to change selected item.
881 [0] u16 TOSERVER_PLAYERITEM
885 TOSERVER_RESPAWN = 0x38,
890 TOSERVER_INTERACT = 0x39,
895 [5] u32 length of the next item
896 [9] serialized PointedThing
898 0: start digging (from undersurface) or use
899 1: stop digging (all parameters ignored)
901 3: place block or item (to abovesurface)
905 TOSERVER_REMOVED_SOUNDS = 0x3a,
911 TOSERVER_NODEMETA_FIELDS = 0x3b,
915 u8[len] form name (reserved for future use)
924 TOSERVER_INVENTORY_FIELDS = 0x3c,
927 u8[len] form name (reserved for future use)
936 TOSERVER_REQUEST_MEDIA = 0x40,
938 u16 number of files requested
945 TOSERVER_HAVE_MEDIA = 0x41,
947 u8 number of callback tokens
952 TOSERVER_BREATH = 0x42, // Obsolete
954 TOSERVER_CLIENT_READY = 0x43,
961 u8[len] full_version_string
964 TOSERVER_FIRST_SRP = 0x50,
966 Belonging to AUTH_MECHANISM_FIRST_SRP.
969 std::string srp verification key
970 u8 is_empty (=1 if password is empty, 0 otherwise)
973 TOSERVER_SRP_BYTES_A = 0x51,
975 Belonging to AUTH_MECHANISM_SRP,
976 depending on current_login_based_on.
979 u8 current_login_based_on : on which version of the password's
980 hash this login is based on (0 legacy hash,
981 or 1 directly the password)
984 TOSERVER_SRP_BYTES_M = 0x52,
986 Belonging to AUTH_MECHANISM_SRP.
991 TOSERVER_NUM_MSG_TYPES = 0x53,
997 AUTH_MECHANISM_NONE = 0,
999 // SRP based on the legacy hash
1000 AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
1002 // SRP based on the srp verification key
1003 AUTH_MECHANISM_SRP = 1 << 1,
1005 // Establishes a srp verification key, for first login and password changing
1006 AUTH_MECHANISM_FIRST_SRP = 1 << 2,
1009 enum AccessDeniedCode {
1010 SERVER_ACCESSDENIED_WRONG_PASSWORD,
1011 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
1012 SERVER_ACCESSDENIED_SINGLEPLAYER,
1013 SERVER_ACCESSDENIED_WRONG_VERSION,
1014 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
1015 SERVER_ACCESSDENIED_WRONG_NAME,
1016 SERVER_ACCESSDENIED_TOO_MANY_USERS,
1017 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
1018 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
1019 SERVER_ACCESSDENIED_SERVER_FAIL,
1020 SERVER_ACCESSDENIED_CUSTOM_STRING,
1021 SERVER_ACCESSDENIED_SHUTDOWN,
1022 SERVER_ACCESSDENIED_CRASH,
1023 SERVER_ACCESSDENIED_MAX,
1026 enum NetProtoCompressionMode {
1027 NETPROTO_COMPRESSION_NONE = 0,
1030 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1032 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
1033 "The server is running in simple singleplayer mode. You cannot connect.",
1034 "Your client's version is not supported.\nPlease contact server administrator.",
1035 "Player name contains disallowed characters.",
1036 "Player name not allowed.",
1038 "Empty passwords are disallowed. Set a password and try again.",
1039 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
1040 "Server authentication failed. This is likely a server error.",
1042 "Server shutting down.",
1043 "This server has experienced an internal error. You will now be disconnected."
1046 enum PlayerListModifer : u8
1053 enum CSMRestrictionFlags : u64 {
1054 CSM_RF_NONE = 0x00000000,
1055 // Until server-sent CSM and verifying of builtin are complete,
1056 // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
1057 // When those are complete, this should return to only being a restriction on the
1058 // loading of client mods.
1059 CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
1060 CSM_RF_CHAT_MESSAGES = 0x00000002, // Disable chat message sending from CSM
1061 CSM_RF_READ_ITEMDEFS = 0x00000004, // Disable itemdef lookups
1062 CSM_RF_READ_NODEDEFS = 0x00000008, // Disable nodedef lookups
1063 CSM_RF_LOOKUP_NODES = 0x00000010, // Limit node lookups
1064 CSM_RF_READ_PLAYERINFO = 0x00000020, // Disable player info lookups
1065 CSM_RF_ALL = 0xFFFFFFFF,
1068 enum InteractAction : u8
1070 INTERACT_START_DIGGING, // 0: start digging (from undersurface) or use
1071 INTERACT_STOP_DIGGING, // 1: stop digging (all parameters ignored)
1072 INTERACT_DIGGING_COMPLETED, // 2: digging completed
1073 INTERACT_PLACE, // 3: place block or item (to abovesurface)
1074 INTERACT_USE, // 4: use item
1075 INTERACT_ACTIVATE // 5: rightclick air ("activate")