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 TOSERVER_INIT new opcode (0x02) for client presentation to server
124 Add TOSERVER_AUTH new opcode (0x03) for client authentication
125 Add TOCLIENT_HELLO for presenting server to client after client
127 Add TOCLIENT_AUTH_ACCEPT to accept connexion from client
130 #define LATEST_PROTOCOL_VERSION 24
132 // Server's supported network protocol range
133 #define SERVER_PROTOCOL_VERSION_MIN 13
134 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
136 // Client's supported network protocol range
137 #define CLIENT_PROTOCOL_VERSION_MIN 13
138 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
140 // Constant that differentiates the protocol from random data and other protocols
141 #define PROTOCOL_ID 0x4f457403
143 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
144 // base64-encoded SHA-1 (27+\0).
146 #define FORMSPEC_API_VERSION 1
147 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
149 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
153 TOCLIENT_HELLO = 0x02,
154 TOCLIENT_AUTH_ACCEPT = 0x03,
155 TOCLIENT_ACCESS_DENIED = 0x0A,
162 TOCLIENT_INIT_LEGACY = 0x10,
164 Server's reply to TOSERVER_INIT.
165 Sent second after connected.
167 [0] u16 TOSERVER_INIT
168 [2] u8 deployed version
169 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
170 [12] u64 map seed (new as of 2011-02-27)
171 [20] f1000 recommended send interval (in seconds) (new as of 14)
173 NOTE: The position in here is deprecated; position is
174 explicitly sent afterwards
177 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
178 TOCLIENT_ADDNODE = 0x21,
183 u8 keep_metadata // Added in protocol version 22
185 TOCLIENT_REMOVENODE = 0x22,
187 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
190 // Followed by an arbitary number of these:
191 // Number is determined from packet length.
193 [N+2] v3s32 position*100
194 [N+2+12] v3s32 speed*100
195 [N+2+12+12] s32 pitch*100
196 [N+2+12+12+4] s32 yaw*100
199 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
202 // Followed by an arbitary number of these:
203 // Number is determined from packet length.
208 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
210 TOCLIENT_SECTORMETA = 0x26, // Obsolete
214 [3...] v2s16 pos + sector metadata
217 TOCLIENT_INVENTORY = 0x27,
220 [2] serialized inventory
223 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
228 u16 number of player positions
241 TOCLIENT_TIME_OF_DAY = 0x29,
245 Added in a later version:
249 // (oops, there is some gap here)
251 TOCLIENT_CHAT_MESSAGE = 0x30,
258 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
261 u16 count of removed objects
262 for all removed objects {
265 u16 count of added objects
266 for all added objects {
269 u32 initialization data length
270 string initialization data
274 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
291 TOCLIENT_MOVE_PLAYER = 0x34,
294 v3f1000 player position
299 TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
306 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
309 u16 count of player items
310 for all player items {
312 u16 length of serialized item
313 string serialized item
317 TOCLIENT_DEATHSCREEN = 0x37,
320 u8 bool set camera point target
321 v3f1000 camera point target (to point the death cause or whatever)
324 TOCLIENT_MEDIA = 0x38,
327 u16 total number of texture bunches
328 u16 index of this bunch
329 u32 number of files in this bunch
336 u16 length of remote media server url (if applicable)
340 TOCLIENT_TOOLDEF = 0x39,
343 u32 length of the next item
344 serialized ToolDefManager
347 TOCLIENT_NODEDEF = 0x3a,
350 u32 length of the next item
351 serialized NodeDefManager
354 TOCLIENT_CRAFTITEMDEF = 0x3b,
357 u32 length of the next item
358 serialized CraftiItemDefManager
361 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
369 u16 length of sha1_digest
374 TOCLIENT_ITEMDEF = 0x3d,
377 u32 length of next item
378 serialized ItemDefManager
381 TOCLIENT_PLAY_SOUND = 0x3f,
388 u8 type (0=local, 1=positional, 2=object)
389 s32[3] pos_nodes*10000
394 TOCLIENT_STOP_SOUND = 0x40,
400 TOCLIENT_PRIVILEGES = 0x41,
403 u16 number of privileges
409 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
416 TOCLIENT_DETACHED_INVENTORY = 0x43,
421 [2] serialized inventory
424 TOCLIENT_SHOW_FORMSPEC = 0x44,
433 TOCLIENT_MOVEMENT = 0x45,
436 f1000 movement_acceleration_default
437 f1000 movement_acceleration_air
438 f1000 movement_acceleration_fast
439 f1000 movement_speed_walk
440 f1000 movement_speed_crouch
441 f1000 movement_speed_fast
442 f1000 movement_speed_climb
443 f1000 movement_speed_jump
444 f1000 movement_liquid_fluidity
445 f1000 movement_liquid_fluidity_smooth
446 f1000 movement_liquid_sink
447 f1000 movement_gravity
450 TOCLIENT_SPAWN_PARTICLE = 0x46,
458 u8 bool collisiondetection
464 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
479 u8 bool collisiondetection
486 TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
492 TOCLIENT_HUDADD = 0x49,
512 TOCLIENT_HUDRM = 0x4a,
518 TOCLIENT_HUDCHANGE = 0x4b,
529 TOCLIENT_HUD_SET_FLAGS = 0x4c,
536 TOCLIENT_HUD_SET_PARAM = 0x4d,
544 TOCLIENT_BREATH = 0x4e,
550 TOCLIENT_SET_SKY = 0x4f,
562 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
565 u8 do_override (boolean)
566 u16 day-night ratio 0...65535
569 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
579 TOCLIENT_EYE_OFFSET = 0x52,
586 TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
592 TOCLIENT_NUM_MSG_TYPES = 0x54,
597 TOSERVER_INIT = 0x02,
599 Sent first after connected.
601 [0] u16 TOSERVER_INIT
602 [2] u8 SER_FMT_VER_HIGHEST_READ
603 [3] u8 compression_modes
606 TOSERVER_AUTH = 0x03,
608 Sent first after presentation (INIT).
609 [0] std::string player_name
610 [0+*] std::string password (new in some version)
611 [0+*+*] u16 minimum supported network protocol version (added sometime)
612 [0+*+*+2] u16 maximum supported network protocol version (added later than the previous one)
615 TOSERVER_INIT_LEGACY = 0x10,
617 Sent first after connected.
619 [0] u16 TOSERVER_INIT_LEGACY
620 [2] u8 SER_FMT_VER_HIGHEST_READ
621 [3] u8[20] player_name
622 [23] u8[28] password (new in some version)
623 [51] u16 minimum supported network protocol version (added sometime)
624 [53] u16 maximum supported network protocol version (added later than the previous one)
627 TOSERVER_INIT2 = 0x11,
629 Sent as an ACK for TOCLIENT_INIT.
630 After this, the server can send data.
632 [0] u16 TOSERVER_INIT2
635 TOSERVER_GETBLOCK=0x20, // Obsolete
636 TOSERVER_ADDNODE = 0x21, // Obsolete
637 TOSERVER_REMOVENODE = 0x22, // Obsolete
639 TOSERVER_PLAYERPOS = 0x23,
642 [2] v3s32 position*100
643 [2+12] v3s32 speed*100
644 [2+12+12] s32 pitch*100
645 [2+12+12+4] s32 yaw*100
646 [2+12+12+4+4] u32 keyPressed
649 TOSERVER_GOTBLOCKS = 0x24,
658 TOSERVER_DELETEDBLOCKS = 0x25,
667 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
674 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
678 [2] u8 button (0=left, 1=right)
684 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
689 [3] v3s16 nodepos_undersurface
690 [9] v3s16 nodepos_abovesurface
693 0: start digging (from undersurface)
694 1: place block (to abovesurface)
695 2: stop digging (all parameters ignored)
699 TOSERVER_RELEASE = 0x29, // Obsolete
701 // (oops, there is some gap here)
703 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
712 TOSERVER_INVENTORY_ACTION = 0x31,
714 See InventoryAction in inventorymanager.h
717 TOSERVER_CHAT_MESSAGE = 0x32,
724 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
732 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
736 [2] u8 button (0=left, 1=right)
741 TOSERVER_DAMAGE = 0x35,
747 TOSERVER_PASSWORD_LEGACY = 0x36,
749 Sent to change password.
751 [0] u16 TOSERVER_PASSWORD
752 [2] u8[28] old password
753 [30] u8[28] new password
756 TOSERVER_PLAYERITEM = 0x37,
758 Sent to change selected item.
760 [0] u16 TOSERVER_PLAYERITEM
764 TOSERVER_RESPAWN = 0x38,
769 TOSERVER_INTERACT = 0x39,
774 [5] u32 length of the next item
775 [9] serialized PointedThing
777 0: start digging (from undersurface) or use
778 1: stop digging (all parameters ignored)
780 3: place block or item (to abovesurface)
783 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
786 TOSERVER_REMOVED_SOUNDS = 0x3a,
793 TOSERVER_NODEMETA_FIELDS = 0x3b,
798 u8[len] form name (reserved for future use)
807 TOSERVER_INVENTORY_FIELDS = 0x3c,
811 u8[len] form name (reserved for future use)
820 TOSERVER_PASSWORD = 0x3d,
822 Sent to change password.
824 [0] u16 TOSERVER_PASSWORD
825 [2] std::string old password
826 [2+*] std::string new password
829 TOSERVER_REQUEST_MEDIA = 0x40,
832 u16 number of files requested
839 TOSERVER_RECEIVED_MEDIA = 0x41,
844 TOSERVER_BREATH = 0x42,
850 TOSERVER_CLIENT_READY = 0x43,
857 u8[len] full_version_string
860 TOSERVER_NUM_MSG_TYPES = 0x44,
863 enum AccessDeniedCode {
864 SERVER_ACCESSDENIED_WRONG_PASSWORD,
865 SERVER_ACCESSDENIED_UNEXPECTED_DATA,
866 SERVER_ACCESSDENIED_SINGLEPLAYER,
867 SERVER_ACCESSDENIED_WRONG_VERSION,
868 SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
869 SERVER_ACCESSDENIED_WRONG_NAME,
870 SERVER_ACCESSDENIED_TOO_MANY_USERS,
871 SERVER_ACCESSDENIED_EMPTY_PASSWORD,
872 SERVER_ACCESSDENIED_ALREADY_CONNECTED,
873 SERVER_ACCESSDENIED_SERVER_FAIL,
874 SERVER_ACCESSDENIED_CUSTOM_STRING,
875 SERVER_ACCESSDENIED_MAX,
878 enum NetProtoCompressionMode {
879 NETPROTO_COMPRESSION_ZLIB = 0,
882 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
884 "Your client sent something the server didn't expect. Try reconnecting or updating your client",
885 "The server is running in simple singleplayer mode. You cannot connect.",
886 "Your client's version is not supported.\nPlease contact server administrator.",
887 "Player name contains disallowed characters.",
888 "Player name not allowed.",
890 "Empty passwords are disallowed. Set a password and try again.",
891 "Another client is connected with this name. If your client closed unexpectedly, try again in a minute.",
892 "Server authention failed. This is likely a server error."