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
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
110 #define LATEST_PROTOCOL_VERSION 23
112 // Server's supported network protocol range
113 #define SERVER_PROTOCOL_VERSION_MIN 13
114 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
116 // Client's supported network protocol range
117 #define CLIENT_PROTOCOL_VERSION_MIN 13
118 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
120 // Constant that differentiates the protocol from random data and other protocols
121 #define PROTOCOL_ID 0x4f457403
123 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
124 // base64-encoded SHA-1 (27+\0).
126 #define FORMSPEC_API_VERSION 1
127 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
129 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
133 TOCLIENT_INIT = 0x10,
135 Server's reply to TOSERVER_INIT.
136 Sent second after connected.
138 [0] u16 TOSERVER_INIT
139 [2] u8 deployed version
140 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
141 [12] u64 map seed (new as of 2011-02-27)
142 [20] f1000 recommended send interval (in seconds) (new as of 14)
144 NOTE: The position in here is deprecated; position is
145 explicitly sent afterwards
148 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
149 TOCLIENT_ADDNODE = 0x21,
154 u8 keep_metadata // Added in protocol version 22
156 TOCLIENT_REMOVENODE = 0x22,
158 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
161 // Followed by an arbitary number of these:
162 // Number is determined from packet length.
164 [N+2] v3s32 position*100
165 [N+2+12] v3s32 speed*100
166 [N+2+12+12] s32 pitch*100
167 [N+2+12+12+4] s32 yaw*100
170 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
173 // Followed by an arbitary number of these:
174 // Number is determined from packet length.
179 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
181 TOCLIENT_SECTORMETA = 0x26, // Obsolete
185 [3...] v2s16 pos + sector metadata
188 TOCLIENT_INVENTORY = 0x27,
191 [2] serialized inventory
194 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
199 u16 number of player positions
212 TOCLIENT_TIME_OF_DAY = 0x29,
216 Added in a later version:
220 // (oops, there is some gap here)
222 TOCLIENT_CHAT_MESSAGE = 0x30,
229 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
232 u16 count of removed objects
233 for all removed objects {
236 u16 count of added objects
237 for all added objects {
240 u32 initialization data length
241 string initialization data
245 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
262 TOCLIENT_MOVE_PLAYER = 0x34,
265 v3f1000 player position
270 TOCLIENT_ACCESS_DENIED = 0x35,
277 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
280 u16 count of player items
281 for all player items {
283 u16 length of serialized item
284 string serialized item
288 TOCLIENT_DEATHSCREEN = 0x37,
291 u8 bool set camera point target
292 v3f1000 camera point target (to point the death cause or whatever)
295 TOCLIENT_MEDIA = 0x38,
298 u16 total number of texture bunches
299 u16 index of this bunch
300 u32 number of files in this bunch
307 u16 length of remote media server url (if applicable)
311 TOCLIENT_TOOLDEF = 0x39,
314 u32 length of the next item
315 serialized ToolDefManager
318 TOCLIENT_NODEDEF = 0x3a,
321 u32 length of the next item
322 serialized NodeDefManager
325 TOCLIENT_CRAFTITEMDEF = 0x3b,
328 u32 length of the next item
329 serialized CraftiItemDefManager
332 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
340 u16 length of sha1_digest
345 TOCLIENT_ITEMDEF = 0x3d,
348 u32 length of next item
349 serialized ItemDefManager
352 TOCLIENT_PLAY_SOUND = 0x3f,
359 u8 type (0=local, 1=positional, 2=object)
360 s32[3] pos_nodes*10000
365 TOCLIENT_STOP_SOUND = 0x40,
371 TOCLIENT_PRIVILEGES = 0x41,
374 u16 number of privileges
380 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
387 TOCLIENT_DETACHED_INVENTORY = 0x43,
392 [2] serialized inventory
395 TOCLIENT_SHOW_FORMSPEC = 0x44,
404 TOCLIENT_MOVEMENT = 0x45,
407 f1000 movement_acceleration_default
408 f1000 movement_acceleration_air
409 f1000 movement_acceleration_fast
410 f1000 movement_speed_walk
411 f1000 movement_speed_crouch
412 f1000 movement_speed_fast
413 f1000 movement_speed_climb
414 f1000 movement_speed_jump
415 f1000 movement_liquid_fluidity
416 f1000 movement_liquid_fluidity_smooth
417 f1000 movement_liquid_sink
418 f1000 movement_gravity
421 TOCLIENT_SPAWN_PARTICLE = 0x46,
429 u8 bool collisiondetection
435 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
450 u8 bool collisiondetection
457 TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
463 TOCLIENT_HUDADD = 0x49,
483 TOCLIENT_HUDRM = 0x4a,
489 TOCLIENT_HUDCHANGE = 0x4b,
500 TOCLIENT_HUD_SET_FLAGS = 0x4c,
507 TOCLIENT_HUD_SET_PARAM = 0x4d,
515 TOCLIENT_BREATH = 0x4e,
521 TOCLIENT_SET_SKY = 0x4f,
533 TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
536 u8 do_override (boolean)
537 u16 day-night ratio 0...65535
540 TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
550 TOCLIENT_EYE_OFFSET = 0x52,
562 Sent first after connected.
564 [0] u16 TOSERVER_INIT
565 [2] u8 SER_FMT_VER_HIGHEST_READ
566 [3] u8[20] player_name
567 [23] u8[28] password (new in some version)
568 [51] u16 minimum supported network protocol version (added sometime)
569 [53] u16 maximum supported network protocol version (added later than the previous one)
572 TOSERVER_INIT2 = 0x11,
574 Sent as an ACK for TOCLIENT_INIT.
575 After this, the server can send data.
577 [0] u16 TOSERVER_INIT2
580 TOSERVER_GETBLOCK=0x20, // Obsolete
581 TOSERVER_ADDNODE = 0x21, // Obsolete
582 TOSERVER_REMOVENODE = 0x22, // Obsolete
584 TOSERVER_PLAYERPOS = 0x23,
587 [2] v3s32 position*100
588 [2+12] v3s32 speed*100
589 [2+12+12] s32 pitch*100
590 [2+12+12+4] s32 yaw*100
591 [2+12+12+4+4] u32 keyPressed
594 TOSERVER_GOTBLOCKS = 0x24,
603 TOSERVER_DELETEDBLOCKS = 0x25,
612 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
619 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
623 [2] u8 button (0=left, 1=right)
629 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
634 [3] v3s16 nodepos_undersurface
635 [9] v3s16 nodepos_abovesurface
638 0: start digging (from undersurface)
639 1: place block (to abovesurface)
640 2: stop digging (all parameters ignored)
644 TOSERVER_RELEASE = 0x29, // Obsolete
646 // (oops, there is some gap here)
648 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
657 TOSERVER_INVENTORY_ACTION = 0x31,
659 See InventoryAction in inventory.h
662 TOSERVER_CHAT_MESSAGE = 0x32,
669 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
677 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
681 [2] u8 button (0=left, 1=right)
686 TOSERVER_DAMAGE = 0x35,
692 TOSERVER_PASSWORD=0x36,
694 Sent to change password.
696 [0] u16 TOSERVER_PASSWORD
697 [2] u8[28] old password
698 [30] u8[28] new password
701 TOSERVER_PLAYERITEM=0x37,
703 Sent to change selected item.
705 [0] u16 TOSERVER_PLAYERITEM
709 TOSERVER_RESPAWN=0x38,
714 TOSERVER_INTERACT = 0x39,
719 [5] u32 length of the next item
720 [9] serialized PointedThing
722 0: start digging (from undersurface) or use
723 1: stop digging (all parameters ignored)
725 3: place block or item (to abovesurface)
728 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
731 TOSERVER_REMOVED_SOUNDS = 0x3a,
738 TOSERVER_NODEMETA_FIELDS = 0x3b,
743 u8[len] form name (reserved for future use)
752 TOSERVER_INVENTORY_FIELDS = 0x3c,
756 u8[len] form name (reserved for future use)
765 TOSERVER_REQUEST_MEDIA = 0x40,
768 u16 number of files requested
775 TOSERVER_RECEIVED_MEDIA = 0x41,
780 TOSERVER_BREATH = 0x42,
786 TOSERVER_CLIENT_READY = 0x43,
793 u8[len] full_version_string