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
23 #include "util/pointer.h"
25 SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed);
28 changes by PROTOCOL_VERSION:
31 Base for writing changes here
36 Add TOCLIENT_CRAFTITEMDEF
38 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
39 Obsolete TOSERVER_GROUND_ACTION
41 Make players to be handled mostly as ActiveObjects
43 Only non-cached textures are sent
46 Obsolete TOCLIENT_TOOLDEF
47 Obsolete TOCLIENT_CRAFTITEMDEF
48 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
50 Digging based on item groups
53 ContentFeatures and NodeDefManager use a different serialization
54 format; better for future version cross-compatibility
58 Version raised to force 'fly' and 'fast' privileges into effect.
59 Node metadata change (came in later; somewhat incompatible)
61 TileDef in ContentFeatures
64 TOCLIENT_INVENTORY_FORMSPEC
67 TOSERVER_INVENTORY_FIELDS
69 TOCLIENT_DETACHED_INVENTORY
71 InventoryList field "Width" (deserialization fails with old versions)
73 Added transfer of player pressed keys to the server
74 Added new messages for mesh and bone animation, as well as attachments
75 GENERIC_CMD_SET_ANIMATION
76 GENERIC_CMD_SET_BONE_POSITION
77 GENERIC_CMD_SET_ATTACHMENT
79 Serialization format changes
81 TOCLIENT_SHOW_FORMSPEC
83 Serialization format change: include backface_culling flag in TileDef
84 Added rightclickable field in nodedef
85 TOCLIENT_SPAWN_PARTICLE
86 TOCLIENT_ADD_PARTICLESPAWNER
87 TOCLIENT_DELETE_PARTICLESPAWNER
89 damageGroups added to ToolCapabilities
90 sound_place added to ItemDefinition
92 GENERIC_CMD_SET_PHYSICS_OVERRIDE
97 TOCLIENT_HUD_SET_FLAGS
101 range added to ItemDefinition
102 drowning, leveled and liquid_range added to ContentFeatures
103 stepheight and collideWithObjects added to object properties
104 version, heat and humidity transfer in MapBock
107 #define LATEST_PROTOCOL_VERSION 21
109 // Server's supported network protocol range
110 #define SERVER_PROTOCOL_VERSION_MIN 13
111 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
113 // Client's supported network protocol range
114 #define CLIENT_PROTOCOL_VERSION_MIN 13
115 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
117 // Constant that differentiates the protocol from random data and other protocols
118 #define PROTOCOL_ID 0x4f457403
120 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
121 // base64-encoded SHA-1 (27+\0).
123 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
127 TOCLIENT_INIT = 0x10,
129 Server's reply to TOSERVER_INIT.
130 Sent second after connected.
132 [0] u16 TOSERVER_INIT
133 [2] u8 deployed version
134 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
135 [12] u64 map seed (new as of 2011-02-27)
136 [20] f1000 recommended send interval (in seconds) (new as of 14)
138 NOTE: The position in here is deprecated; position is
139 explicitly sent afterwards
142 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
143 TOCLIENT_ADDNODE = 0x21,
144 TOCLIENT_REMOVENODE = 0x22,
146 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
149 // Followed by an arbitary number of these:
150 // Number is determined from packet length.
152 [N+2] v3s32 position*100
153 [N+2+12] v3s32 speed*100
154 [N+2+12+12] s32 pitch*100
155 [N+2+12+12+4] s32 yaw*100
158 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
161 // Followed by an arbitary number of these:
162 // Number is determined from packet length.
167 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
169 TOCLIENT_SECTORMETA = 0x26, // Obsolete
173 [3...] v2s16 pos + sector metadata
176 TOCLIENT_INVENTORY = 0x27,
179 [2] serialized inventory
182 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
187 u16 number of player positions
200 TOCLIENT_TIME_OF_DAY = 0x29,
204 Added in a later version:
208 // (oops, there is some gap here)
210 TOCLIENT_CHAT_MESSAGE = 0x30,
217 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
220 u16 count of removed objects
221 for all removed objects {
224 u16 count of added objects
225 for all added objects {
228 u32 initialization data length
229 string initialization data
233 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
250 TOCLIENT_MOVE_PLAYER = 0x34,
253 v3f1000 player position
258 TOCLIENT_ACCESS_DENIED = 0x35,
265 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
268 u16 count of player items
269 for all player items {
271 u16 length of serialized item
272 string serialized item
276 TOCLIENT_DEATHSCREEN = 0x37,
279 u8 bool set camera point target
280 v3f1000 camera point target (to point the death cause or whatever)
283 TOCLIENT_MEDIA = 0x38,
286 u16 total number of texture bunches
287 u16 index of this bunch
288 u32 number of files in this bunch
295 u16 length of remote media server url (if applicable)
299 TOCLIENT_TOOLDEF = 0x39,
302 u32 length of the next item
303 serialized ToolDefManager
306 TOCLIENT_NODEDEF = 0x3a,
309 u32 length of the next item
310 serialized NodeDefManager
313 TOCLIENT_CRAFTITEMDEF = 0x3b,
316 u32 length of the next item
317 serialized CraftiItemDefManager
320 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
328 u16 length of sha1_digest
333 TOCLIENT_ITEMDEF = 0x3d,
336 u32 length of next item
337 serialized ItemDefManager
340 TOCLIENT_PLAY_SOUND = 0x3f,
347 u8 type (0=local, 1=positional, 2=object)
348 s32[3] pos_nodes*10000
353 TOCLIENT_STOP_SOUND = 0x40,
359 TOCLIENT_PRIVILEGES = 0x41,
362 u16 number of privileges
368 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
375 TOCLIENT_DETACHED_INVENTORY = 0x43,
380 [2] serialized inventory
383 TOCLIENT_SHOW_FORMSPEC = 0x44,
392 TOCLIENT_MOVEMENT = 0x45,
395 f1000 movement_acceleration_default
396 f1000 movement_acceleration_air
397 f1000 movement_acceleration_fast
398 f1000 movement_speed_walk
399 f1000 movement_speed_crouch
400 f1000 movement_speed_fast
401 f1000 movement_speed_climb
402 f1000 movement_speed_jump
403 f1000 movement_liquid_fluidity
404 f1000 movement_liquid_fluidity_smooth
405 f1000 movement_liquid_sink
406 f1000 movement_gravity
409 TOCLIENT_SPAWN_PARTICLE = 0x46,
417 u8 bool collisiondetection
422 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
437 u8 bool collisiondetection
443 TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
449 TOCLIENT_HUDADD = 0x49,
467 TOCLIENT_HUDRM = 0x4a,
473 TOCLIENT_HUDCHANGE = 0x4b,
484 TOCLIENT_HUD_SET_FLAGS = 0x4c,
491 TOCLIENT_HUD_SET_PARAM = 0x4d,
499 TOCLIENT_BREATH = 0x4e,
510 Sent first after connected.
512 [0] u16 TOSERVER_INIT
513 [2] u8 SER_FMT_VER_HIGHEST_READ
514 [3] u8[20] player_name
515 [23] u8[28] password (new in some version)
516 [51] u16 minimum supported network protocol version (added sometime)
517 [53] u16 maximum supported network protocol version (added later than the previous one)
520 TOSERVER_INIT2 = 0x11,
522 Sent as an ACK for TOCLIENT_INIT.
523 After this, the server can send data.
525 [0] u16 TOSERVER_INIT2
528 TOSERVER_GETBLOCK=0x20, // Obsolete
529 TOSERVER_ADDNODE = 0x21, // Obsolete
530 TOSERVER_REMOVENODE = 0x22, // Obsolete
532 TOSERVER_PLAYERPOS = 0x23,
535 [2] v3s32 position*100
536 [2+12] v3s32 speed*100
537 [2+12+12] s32 pitch*100
538 [2+12+12+4] s32 yaw*100
539 [2+12+12+4+4] u32 keyPressed
542 TOSERVER_GOTBLOCKS = 0x24,
551 TOSERVER_DELETEDBLOCKS = 0x25,
560 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
567 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
571 [2] u8 button (0=left, 1=right)
577 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
582 [3] v3s16 nodepos_undersurface
583 [9] v3s16 nodepos_abovesurface
586 0: start digging (from undersurface)
587 1: place block (to abovesurface)
588 2: stop digging (all parameters ignored)
592 TOSERVER_RELEASE = 0x29, // Obsolete
594 // (oops, there is some gap here)
596 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
605 TOSERVER_INVENTORY_ACTION = 0x31,
607 See InventoryAction in inventory.h
610 TOSERVER_CHAT_MESSAGE = 0x32,
617 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
625 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
629 [2] u8 button (0=left, 1=right)
634 TOSERVER_DAMAGE = 0x35,
640 TOSERVER_PASSWORD=0x36,
642 Sent to change password.
644 [0] u16 TOSERVER_PASSWORD
645 [2] u8[28] old password
646 [30] u8[28] new password
649 TOSERVER_PLAYERITEM=0x37,
651 Sent to change selected item.
653 [0] u16 TOSERVER_PLAYERITEM
657 TOSERVER_RESPAWN=0x38,
662 TOSERVER_INTERACT = 0x39,
667 [5] u32 length of the next item
668 [9] serialized PointedThing
670 0: start digging (from undersurface) or use
671 1: stop digging (all parameters ignored)
673 3: place block or item (to abovesurface)
676 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
679 TOSERVER_REMOVED_SOUNDS = 0x3a,
686 TOSERVER_NODEMETA_FIELDS = 0x3b,
691 u8[len] form name (reserved for future use)
700 TOSERVER_INVENTORY_FIELDS = 0x3c,
704 u8[len] form name (reserved for future use)
713 TOSERVER_REQUEST_MEDIA = 0x40,
716 u16 number of files requested
723 TOSERVER_RECEIVED_MEDIA = 0x41,
728 TOSERVER_BREATH = 0x42,