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 CLIENTSERVER_HEADER
21 #define CLIENTSERVER_HEADER
24 changes by PROTOCOL_VERSION:
27 Base for writing changes here
32 Add TOCLIENT_CRAFTITEMDEF
34 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
35 Obsolete TOSERVER_GROUND_ACTION
37 Make players to be handled mostly as ActiveObjects
39 Only non-cached textures are sent
42 Obsolete TOCLIENT_TOOLDEF
43 Obsolete TOCLIENT_CRAFTITEMDEF
44 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
46 Digging based on item groups
49 ContentFeatures and NodeDefManager use a different serialization
50 format; better for future version cross-compatibility
54 Version raised to force 'fly' and 'fast' privileges into effect.
55 Node metadata change (came in later; somewhat incompatible)
57 TileDef in ContentFeatures
60 TOCLIENT_INVENTORY_FORMSPEC
63 TOSERVER_INVENTORY_FIELDS
65 TOCLIENT_DETACHED_INVENTORY
67 InventoryList field "Width" (deserialization fails with old versions)
69 Added transfer of player pressed keys to the server
70 Added new messages for mesh and bone animation, as well as attachments
71 GENERIC_CMD_SET_ANIMATION
72 GENERIC_CMD_SET_BONE_POSITION
73 GENERIC_CMD_SET_ATTACHMENT
75 Serialization format changes
77 TOCLIENT_SHOW_FORMSPEC
79 Serialization format change: include backface_culling flag in TileDef
80 Added rightclickable field in nodedef
81 TOCLIENT_SPAWN_PARTICLE
82 TOCLIENT_ADD_PARTICLESPAWNER
83 TOCLIENT_DELETE_PARTICLESPAWNER
85 damageGroups added to ToolCapabilities
86 sound_place added to ItemDefinition
88 GENERIC_CMD_SET_PHYSICS_OVERRIDE
93 TOCLIENT_HUD_SET_FLAGS
97 range added to ItemDefinition
98 drowning, leveled and liquid_range added to ContentFeatures
99 stepheight and collideWithObjects added to object properties
100 version, heat and humidity transfer in MapBock
101 automatic_face_movement_dir and automatic_face_movement_dir_offset
102 added to object properties
106 TOSERVER_CLIENT_READY
109 #define LATEST_PROTOCOL_VERSION 23
111 // Server's supported network protocol range
112 #define SERVER_PROTOCOL_VERSION_MIN 13
113 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
115 // Client's supported network protocol range
116 #define CLIENT_PROTOCOL_VERSION_MIN 13
117 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
119 // Constant that differentiates the protocol from random data and other protocols
120 #define PROTOCOL_ID 0x4f457403
122 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
123 // base64-encoded SHA-1 (27+\0).
125 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
129 TOCLIENT_INIT = 0x10,
131 Server's reply to TOSERVER_INIT.
132 Sent second after connected.
134 [0] u16 TOSERVER_INIT
135 [2] u8 deployed version
136 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
137 [12] u64 map seed (new as of 2011-02-27)
138 [20] f1000 recommended send interval (in seconds) (new as of 14)
140 NOTE: The position in here is deprecated; position is
141 explicitly sent afterwards
144 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
145 TOCLIENT_ADDNODE = 0x21,
150 u8 keep_metadata // Added in protocol version 22
152 TOCLIENT_REMOVENODE = 0x22,
154 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
157 // Followed by an arbitary number of these:
158 // Number is determined from packet length.
160 [N+2] v3s32 position*100
161 [N+2+12] v3s32 speed*100
162 [N+2+12+12] s32 pitch*100
163 [N+2+12+12+4] s32 yaw*100
166 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
169 // Followed by an arbitary number of these:
170 // Number is determined from packet length.
175 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
177 TOCLIENT_SECTORMETA = 0x26, // Obsolete
181 [3...] v2s16 pos + sector metadata
184 TOCLIENT_INVENTORY = 0x27,
187 [2] serialized inventory
190 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
195 u16 number of player positions
208 TOCLIENT_TIME_OF_DAY = 0x29,
212 Added in a later version:
216 // (oops, there is some gap here)
218 TOCLIENT_CHAT_MESSAGE = 0x30,
225 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
228 u16 count of removed objects
229 for all removed objects {
232 u16 count of added objects
233 for all added objects {
236 u32 initialization data length
237 string initialization data
241 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
258 TOCLIENT_MOVE_PLAYER = 0x34,
261 v3f1000 player position
266 TOCLIENT_ACCESS_DENIED = 0x35,
273 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
276 u16 count of player items
277 for all player items {
279 u16 length of serialized item
280 string serialized item
284 TOCLIENT_DEATHSCREEN = 0x37,
287 u8 bool set camera point target
288 v3f1000 camera point target (to point the death cause or whatever)
291 TOCLIENT_MEDIA = 0x38,
294 u16 total number of texture bunches
295 u16 index of this bunch
296 u32 number of files in this bunch
303 u16 length of remote media server url (if applicable)
307 TOCLIENT_TOOLDEF = 0x39,
310 u32 length of the next item
311 serialized ToolDefManager
314 TOCLIENT_NODEDEF = 0x3a,
317 u32 length of the next item
318 serialized NodeDefManager
321 TOCLIENT_CRAFTITEMDEF = 0x3b,
324 u32 length of the next item
325 serialized CraftiItemDefManager
328 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
336 u16 length of sha1_digest
341 TOCLIENT_ITEMDEF = 0x3d,
344 u32 length of next item
345 serialized ItemDefManager
348 TOCLIENT_PLAY_SOUND = 0x3f,
355 u8 type (0=local, 1=positional, 2=object)
356 s32[3] pos_nodes*10000
361 TOCLIENT_STOP_SOUND = 0x40,
367 TOCLIENT_PRIVILEGES = 0x41,
370 u16 number of privileges
376 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
383 TOCLIENT_DETACHED_INVENTORY = 0x43,
388 [2] serialized inventory
391 TOCLIENT_SHOW_FORMSPEC = 0x44,
400 TOCLIENT_MOVEMENT = 0x45,
403 f1000 movement_acceleration_default
404 f1000 movement_acceleration_air
405 f1000 movement_acceleration_fast
406 f1000 movement_speed_walk
407 f1000 movement_speed_crouch
408 f1000 movement_speed_fast
409 f1000 movement_speed_climb
410 f1000 movement_speed_jump
411 f1000 movement_liquid_fluidity
412 f1000 movement_liquid_fluidity_smooth
413 f1000 movement_liquid_sink
414 f1000 movement_gravity
417 TOCLIENT_SPAWN_PARTICLE = 0x46,
425 u8 bool collisiondetection
431 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
446 u8 bool collisiondetection
453 TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
459 TOCLIENT_HUDADD = 0x49,
479 TOCLIENT_HUDRM = 0x4a,
485 TOCLIENT_HUDCHANGE = 0x4b,
496 TOCLIENT_HUD_SET_FLAGS = 0x4c,
503 TOCLIENT_HUD_SET_PARAM = 0x4d,
511 TOCLIENT_BREATH = 0x4e,
517 TOCLIENT_SET_SKY = 0x4f,
529 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
532 u8 do_override (boolean)
533 u16 day-night ratio 0...65535
536 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
546 TOCLIENT_EYE_OFFSET = 0x52,
558 Sent first after connected.
560 [0] u16 TOSERVER_INIT
561 [2] u8 SER_FMT_VER_HIGHEST_READ
562 [3] u8[20] player_name
563 [23] u8[28] password (new in some version)
564 [51] u16 minimum supported network protocol version (added sometime)
565 [53] u16 maximum supported network protocol version (added later than the previous one)
568 TOSERVER_INIT2 = 0x11,
570 Sent as an ACK for TOCLIENT_INIT.
571 After this, the server can send data.
573 [0] u16 TOSERVER_INIT2
576 TOSERVER_GETBLOCK=0x20, // Obsolete
577 TOSERVER_ADDNODE = 0x21, // Obsolete
578 TOSERVER_REMOVENODE = 0x22, // Obsolete
580 TOSERVER_PLAYERPOS = 0x23,
583 [2] v3s32 position*100
584 [2+12] v3s32 speed*100
585 [2+12+12] s32 pitch*100
586 [2+12+12+4] s32 yaw*100
587 [2+12+12+4+4] u32 keyPressed
590 TOSERVER_GOTBLOCKS = 0x24,
599 TOSERVER_DELETEDBLOCKS = 0x25,
608 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
615 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
619 [2] u8 button (0=left, 1=right)
625 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
630 [3] v3s16 nodepos_undersurface
631 [9] v3s16 nodepos_abovesurface
634 0: start digging (from undersurface)
635 1: place block (to abovesurface)
636 2: stop digging (all parameters ignored)
640 TOSERVER_RELEASE = 0x29, // Obsolete
642 // (oops, there is some gap here)
644 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
653 TOSERVER_INVENTORY_ACTION = 0x31,
655 See InventoryAction in inventory.h
658 TOSERVER_CHAT_MESSAGE = 0x32,
665 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
673 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
677 [2] u8 button (0=left, 1=right)
682 TOSERVER_DAMAGE = 0x35,
688 TOSERVER_PASSWORD=0x36,
690 Sent to change password.
692 [0] u16 TOSERVER_PASSWORD
693 [2] u8[28] old password
694 [30] u8[28] new password
697 TOSERVER_PLAYERITEM=0x37,
699 Sent to change selected item.
701 [0] u16 TOSERVER_PLAYERITEM
705 TOSERVER_RESPAWN=0x38,
710 TOSERVER_INTERACT = 0x39,
715 [5] u32 length of the next item
716 [9] serialized PointedThing
718 0: start digging (from undersurface) or use
719 1: stop digging (all parameters ignored)
721 3: place block or item (to abovesurface)
724 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
727 TOSERVER_REMOVED_SOUNDS = 0x3a,
734 TOSERVER_NODEMETA_FIELDS = 0x3b,
739 u8[len] form name (reserved for future use)
748 TOSERVER_INVENTORY_FIELDS = 0x3c,
752 u8[len] form name (reserved for future use)
761 TOSERVER_REQUEST_MEDIA = 0x40,
764 u16 number of files requested
771 TOSERVER_RECEIVED_MEDIA = 0x41,
776 TOSERVER_BREATH = 0x42,
782 TOSERVER_CLIENT_READY = 0x43,
789 u8[len] full_version_string