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_BUILTIN_ENABLE
100 #define LATEST_PROTOCOL_VERSION 20
102 // Server's supported network protocol range
103 #define SERVER_PROTOCOL_VERSION_MIN 13
104 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
106 // Client's supported network protocol range
107 #define CLIENT_PROTOCOL_VERSION_MIN 13
108 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
110 // Constant that differentiates the protocol from random data and other protocols
111 #define PROTOCOL_ID 0x4f457403
113 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
114 // base64-encoded SHA-1 (27+\0).
116 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
120 TOCLIENT_INIT = 0x10,
122 Server's reply to TOSERVER_INIT.
123 Sent second after connected.
125 [0] u16 TOSERVER_INIT
126 [2] u8 deployed version
127 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
128 [12] u64 map seed (new as of 2011-02-27)
129 [20] f1000 recommended send interval (in seconds) (new as of 14)
131 NOTE: The position in here is deprecated; position is
132 explicitly sent afterwards
135 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
136 TOCLIENT_ADDNODE = 0x21,
137 TOCLIENT_REMOVENODE = 0x22,
139 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
142 // Followed by an arbitary number of these:
143 // Number is determined from packet length.
145 [N+2] v3s32 position*100
146 [N+2+12] v3s32 speed*100
147 [N+2+12+12] s32 pitch*100
148 [N+2+12+12+4] s32 yaw*100
151 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
154 // Followed by an arbitary number of these:
155 // Number is determined from packet length.
160 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
162 TOCLIENT_SECTORMETA = 0x26, // Obsolete
166 [3...] v2s16 pos + sector metadata
169 TOCLIENT_INVENTORY = 0x27,
172 [2] serialized inventory
175 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
180 u16 number of player positions
193 TOCLIENT_TIME_OF_DAY = 0x29,
197 Added in a later version:
201 // (oops, there is some gap here)
203 TOCLIENT_CHAT_MESSAGE = 0x30,
210 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
213 u16 count of removed objects
214 for all removed objects {
217 u16 count of added objects
218 for all added objects {
221 u32 initialization data length
222 string initialization data
226 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
243 TOCLIENT_MOVE_PLAYER = 0x34,
246 v3f1000 player position
251 TOCLIENT_ACCESS_DENIED = 0x35,
258 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
261 u16 count of player items
262 for all player items {
264 u16 length of serialized item
265 string serialized item
269 TOCLIENT_DEATHSCREEN = 0x37,
272 u8 bool set camera point target
273 v3f1000 camera point target (to point the death cause or whatever)
276 TOCLIENT_MEDIA = 0x38,
279 u16 total number of texture bunches
280 u16 index of this bunch
281 u32 number of files in this bunch
288 u16 length of remote media server url (if applicable)
292 TOCLIENT_TOOLDEF = 0x39,
295 u32 length of the next item
296 serialized ToolDefManager
299 TOCLIENT_NODEDEF = 0x3a,
302 u32 length of the next item
303 serialized NodeDefManager
306 TOCLIENT_CRAFTITEMDEF = 0x3b,
309 u32 length of the next item
310 serialized CraftiItemDefManager
313 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
321 u16 length of sha1_digest
326 TOCLIENT_ITEMDEF = 0x3d,
329 u32 length of next item
330 serialized ItemDefManager
333 TOCLIENT_PLAY_SOUND = 0x3f,
340 u8 type (0=local, 1=positional, 2=object)
341 s32[3] pos_nodes*10000
346 TOCLIENT_STOP_SOUND = 0x40,
352 TOCLIENT_PRIVILEGES = 0x41,
355 u16 number of privileges
361 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
368 TOCLIENT_DETACHED_INVENTORY = 0x43,
373 [2] serialized inventory
376 TOCLIENT_SHOW_FORMSPEC = 0x44,
385 TOCLIENT_MOVEMENT = 0x45,
388 f1000 movement_acceleration_default
389 f1000 movement_acceleration_air
390 f1000 movement_acceleration_fast
391 f1000 movement_speed_walk
392 f1000 movement_speed_crouch
393 f1000 movement_speed_fast
394 f1000 movement_speed_climb
395 f1000 movement_speed_jump
396 f1000 movement_liquid_fluidity
397 f1000 movement_liquid_fluidity_smooth
398 f1000 movement_liquid_sink
399 f1000 movement_gravity
402 TOCLIENT_SPAWN_PARTICLE = 0x46,
410 u8 bool collisiondetection
415 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
430 u8 bool collisiondetection
436 TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
442 TOCLIENT_HUDADD = 0x49,
460 TOCLIENT_HUDRM = 0x4a,
466 TOCLIENT_HUDCHANGE = 0x4b,
477 TOCLIENT_HUD_SET_FLAGS = 0x4c,
489 Sent first after connected.
491 [0] u16 TOSERVER_INIT
492 [2] u8 SER_FMT_VER_HIGHEST
493 [3] u8[20] player_name
494 [23] u8[28] password (new in some version)
495 [51] u16 minimum supported network protocol version (added sometime)
496 [53] u16 maximum supported network protocol version (added later than the previous one)
499 TOSERVER_INIT2 = 0x11,
501 Sent as an ACK for TOCLIENT_INIT.
502 After this, the server can send data.
504 [0] u16 TOSERVER_INIT2
507 TOSERVER_GETBLOCK=0x20, // Obsolete
508 TOSERVER_ADDNODE = 0x21, // Obsolete
509 TOSERVER_REMOVENODE = 0x22, // Obsolete
511 TOSERVER_PLAYERPOS = 0x23,
514 [2] v3s32 position*100
515 [2+12] v3s32 speed*100
516 [2+12+12] s32 pitch*100
517 [2+12+12+4] s32 yaw*100
518 [2+12+12+4+4] u32 keyPressed
521 TOSERVER_GOTBLOCKS = 0x24,
530 TOSERVER_DELETEDBLOCKS = 0x25,
539 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
546 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
550 [2] u8 button (0=left, 1=right)
556 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
561 [3] v3s16 nodepos_undersurface
562 [9] v3s16 nodepos_abovesurface
565 0: start digging (from undersurface)
566 1: place block (to abovesurface)
567 2: stop digging (all parameters ignored)
571 TOSERVER_RELEASE = 0x29, // Obsolete
573 // (oops, there is some gap here)
575 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
584 TOSERVER_INVENTORY_ACTION = 0x31,
586 See InventoryAction in inventory.h
589 TOSERVER_CHAT_MESSAGE = 0x32,
596 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
604 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
608 [2] u8 button (0=left, 1=right)
613 TOSERVER_DAMAGE = 0x35,
619 TOSERVER_PASSWORD=0x36,
621 Sent to change password.
623 [0] u16 TOSERVER_PASSWORD
624 [2] u8[28] old password
625 [30] u8[28] new password
628 TOSERVER_PLAYERITEM=0x37,
630 Sent to change selected item.
632 [0] u16 TOSERVER_PLAYERITEM
636 TOSERVER_RESPAWN=0x38,
641 TOSERVER_INTERACT = 0x39,
646 [5] u32 length of the next item
647 [9] serialized PointedThing
649 0: start digging (from undersurface) or use
650 1: stop digging (all parameters ignored)
652 3: place block or item (to abovesurface)
655 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
658 TOSERVER_REMOVED_SOUNDS = 0x3a,
665 TOSERVER_NODEMETA_FIELDS = 0x3b,
670 u8[len] form name (reserved for future use)
679 TOSERVER_INVENTORY_FIELDS = 0x3c,
683 u8[len] form name (reserved for future use)
692 TOSERVER_REQUEST_MEDIA = 0x40,
695 u16 number of files requested
702 TOSERVER_RECEIVED_MEDIA = 0x41,