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 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
114 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
115 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
116 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
117 for standard error, keeping customisation possible. This
119 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
123 #define LATEST_PROTOCOL_VERSION 24
125 // Server's supported network protocol range
126 #define SERVER_PROTOCOL_VERSION_MIN 13
127 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
129 // Client's supported network protocol range
130 #define CLIENT_PROTOCOL_VERSION_MIN 13
131 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
133 // Constant that differentiates the protocol from random data and other protocols
134 #define PROTOCOL_ID 0x4f457403
136 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
137 // base64-encoded SHA-1 (27+\0).
139 #define FORMSPEC_API_VERSION 1
140 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
142 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
146 TOCLIENT_ACCESS_DENIED = 0x0A,
153 TOCLIENT_INIT = 0x10,
155 Server's reply to TOSERVER_INIT.
156 Sent second after connected.
158 [0] u16 TOSERVER_INIT
159 [2] u8 deployed version
160 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
161 [12] u64 map seed (new as of 2011-02-27)
162 [20] f1000 recommended send interval (in seconds) (new as of 14)
164 NOTE: The position in here is deprecated; position is
165 explicitly sent afterwards
168 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
169 TOCLIENT_ADDNODE = 0x21,
174 u8 keep_metadata // Added in protocol version 22
176 TOCLIENT_REMOVENODE = 0x22,
178 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
181 // Followed by an arbitary number of these:
182 // Number is determined from packet length.
184 [N+2] v3s32 position*100
185 [N+2+12] v3s32 speed*100
186 [N+2+12+12] s32 pitch*100
187 [N+2+12+12+4] s32 yaw*100
190 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
193 // Followed by an arbitary number of these:
194 // Number is determined from packet length.
199 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
201 TOCLIENT_SECTORMETA = 0x26, // Obsolete
205 [3...] v2s16 pos + sector metadata
208 TOCLIENT_INVENTORY = 0x27,
211 [2] serialized inventory
214 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
219 u16 number of player positions
232 TOCLIENT_TIME_OF_DAY = 0x29,
236 Added in a later version:
240 // (oops, there is some gap here)
242 TOCLIENT_CHAT_MESSAGE = 0x30,
249 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
252 u16 count of removed objects
253 for all removed objects {
256 u16 count of added objects
257 for all added objects {
260 u32 initialization data length
261 string initialization data
265 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
282 TOCLIENT_MOVE_PLAYER = 0x34,
285 v3f1000 player position
290 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
297 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
300 u16 count of player items
301 for all player items {
303 u16 length of serialized item
304 string serialized item
308 TOCLIENT_DEATHSCREEN = 0x37,
311 u8 bool set camera point target
312 v3f1000 camera point target (to point the death cause or whatever)
315 TOCLIENT_MEDIA = 0x38,
318 u16 total number of texture bunches
319 u16 index of this bunch
320 u32 number of files in this bunch
327 u16 length of remote media server url (if applicable)
331 TOCLIENT_TOOLDEF = 0x39,
334 u32 length of the next item
335 serialized ToolDefManager
338 TOCLIENT_NODEDEF = 0x3a,
341 u32 length of the next item
342 serialized NodeDefManager
345 TOCLIENT_CRAFTITEMDEF = 0x3b,
348 u32 length of the next item
349 serialized CraftiItemDefManager
352 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
360 u16 length of sha1_digest
365 TOCLIENT_ITEMDEF = 0x3d,
368 u32 length of next item
369 serialized ItemDefManager
372 TOCLIENT_PLAY_SOUND = 0x3f,
379 u8 type (0=local, 1=positional, 2=object)
380 s32[3] pos_nodes*10000
385 TOCLIENT_STOP_SOUND = 0x40,
391 TOCLIENT_PRIVILEGES = 0x41,
394 u16 number of privileges
400 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
407 TOCLIENT_DETACHED_INVENTORY = 0x43,
412 [2] serialized inventory
415 TOCLIENT_SHOW_FORMSPEC = 0x44,
424 TOCLIENT_MOVEMENT = 0x45,
427 f1000 movement_acceleration_default
428 f1000 movement_acceleration_air
429 f1000 movement_acceleration_fast
430 f1000 movement_speed_walk
431 f1000 movement_speed_crouch
432 f1000 movement_speed_fast
433 f1000 movement_speed_climb
434 f1000 movement_speed_jump
435 f1000 movement_liquid_fluidity
436 f1000 movement_liquid_fluidity_smooth
437 f1000 movement_liquid_sink
438 f1000 movement_gravity
441 TOCLIENT_SPAWN_PARTICLE = 0x46,
449 u8 bool collisiondetection
455 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
470 u8 bool collisiondetection
477 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
483 TOCLIENT_HUDADD = 0x49,
503 TOCLIENT_HUDRM = 0x4a,
509 TOCLIENT_HUDCHANGE = 0x4b,
520 TOCLIENT_HUD_SET_FLAGS = 0x4c,
527 TOCLIENT_HUD_SET_PARAM = 0x4d,
535 TOCLIENT_BREATH = 0x4e,
541 TOCLIENT_SET_SKY = 0x4f,
553 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
556 u8 do_override (boolean)
557 u16 day-night ratio 0...65535
560 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
570 TOCLIENT_EYE_OFFSET = 0x52,
577 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
583 TOCLIENT_NUM_MSG_TYPES = 0x54,
588 TOSERVER_INIT = 0x0F,
590 Sent first after connected.
592 [0] u16 TOSERVER_INIT
593 [2] u8 SER_FMT_VER_HIGHEST_READ
594 [3] u8 compression_modes
595 [4] std::string player_name
596 [4+*] std::string password (new in some version)
597 [4+*+*] u16 minimum supported network protocol version (added sometime)
598 [4+*+*+2] u16 maximum supported network protocol version (added later than the previous one)
601 TOSERVER_INIT_LEGACY = 0x10,
603 Sent first after connected.
605 [0] u16 TOSERVER_INIT
606 [2] u8 SER_FMT_VER_HIGHEST_READ
607 [3] u8[20] player_name
608 [23] u8[28] password (new in some version)
609 [51] u16 minimum supported network protocol version (added sometime)
610 [53] u16 maximum supported network protocol version (added later than the previous one)
613 TOSERVER_INIT2 = 0x11,
615 Sent as an ACK for TOCLIENT_INIT.
616 After this, the server can send data.
618 [0] u16 TOSERVER_INIT2
621 TOSERVER_GETBLOCK=0x20, // Obsolete
622 TOSERVER_ADDNODE = 0x21, // Obsolete
623 TOSERVER_REMOVENODE = 0x22, // Obsolete
625 TOSERVER_PLAYERPOS = 0x23,
628 [2] v3s32 position*100
629 [2+12] v3s32 speed*100
630 [2+12+12] s32 pitch*100
631 [2+12+12+4] s32 yaw*100
632 [2+12+12+4+4] u32 keyPressed
635 TOSERVER_GOTBLOCKS = 0x24,
644 TOSERVER_DELETEDBLOCKS = 0x25,
653 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
660 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
664 [2] u8 button (0=left, 1=right)
670 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
675 [3] v3s16 nodepos_undersurface
676 [9] v3s16 nodepos_abovesurface
679 0: start digging (from undersurface)
680 1: place block (to abovesurface)
681 2: stop digging (all parameters ignored)
685 TOSERVER_RELEASE = 0x29, // Obsolete
687 // (oops, there is some gap here)
689 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
698 TOSERVER_INVENTORY_ACTION = 0x31,
700 See InventoryAction in inventorymanager.h
703 TOSERVER_CHAT_MESSAGE = 0x32,
710 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
718 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
722 [2] u8 button (0=left, 1=right)
727 TOSERVER_DAMAGE = 0x35,
733 TOSERVER_PASSWORD_LEGACY = 0x36,
735 Sent to change password.
737 [0] u16 TOSERVER_PASSWORD
738 [2] u8[28] old password
739 [30] u8[28] new password
742 TOSERVER_PLAYERITEM = 0x37,
744 Sent to change selected item.
746 [0] u16 TOSERVER_PLAYERITEM
750 TOSERVER_RESPAWN = 0x38,
755 TOSERVER_INTERACT = 0x39,
760 [5] u32 length of the next item
761 [9] serialized PointedThing
763 0: start digging (from undersurface) or use
764 1: stop digging (all parameters ignored)
766 3: place block or item (to abovesurface)
769 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
772 TOSERVER_REMOVED_SOUNDS = 0x3a,
779 TOSERVER_NODEMETA_FIELDS = 0x3b,
784 u8[len] form name (reserved for future use)
793 TOSERVER_INVENTORY_FIELDS = 0x3c,
797 u8[len] form name (reserved for future use)
806 TOSERVER_PASSWORD = 0x3d,
808 Sent to change password.
810 [0] u16 TOSERVER_PASSWORD
811 [2] std::string old password
812 [2+*] std::string new password
815 TOSERVER_REQUEST_MEDIA = 0x40,
818 u16 number of files requested
825 TOSERVER_RECEIVED_MEDIA = 0x41,
830 TOSERVER_BREATH = 0x42,
836 TOSERVER_CLIENT_READY = 0x43,
843 u8[len] full_version_string
846 TOSERVER_NUM_MSG_TYPES = 0x44,
849 enum AccessDeniedCode {
850 SERVER_ACCESSDENIED_WRONG_PASSWORD = 0,
851 SERVER_ACCESSDENIED_UNEXPECTED_DATA = 1,
852 SERVER_ACCESSDENIED_SINGLEPLAYER = 2,
853 SERVER_ACCESSDENIED_WRONG_VERSION = 3,
854 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME = 4,
855 SERVER_ACCESSDENIED_WRONG_NAME = 5,
856 SERVER_ACCESSDENIED_TOO_MANY_USERS = 6,
857 SERVER_ACCESSDENIED_EMPTY_PASSWORD = 7,
858 SERVER_ACCESSDENIED_ALREADY_CONNECTED = 8,
859 SERVER_ACCESSDENIED_CUSTOM_STRING = 9,
860 SERVER_ACCESSDENIED_MAX = 10,
863 enum NetProtoCompressionMode {
864 NETPROTO_COMPRESSION_ZLIB = 0,
867 const static std::wstring accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
869 L"Your client sent something server didn't expect. Try reconnecting or updating your client",
870 L"The server is running in simple singleplayer mode. You cannot connect.",
871 L"Your client's version is not supported.\nPlease contact server administrator.",
872 L"Name contains unallowed characters",
873 L"Name is not allowed",
875 L"Empty passwords are disallowed. Set a password and try again.",
876 L"Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",