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
93 #define LATEST_PROTOCOL_VERSION 18
95 // Server's supported network protocol range
96 #define SERVER_PROTOCOL_VERSION_MIN 13
97 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
99 // Client's supported network protocol range
100 #define CLIENT_PROTOCOL_VERSION_MIN 13
101 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
103 // Constant that differentiates the protocol from random data and other protocols
104 #define PROTOCOL_ID 0x4f457403
106 #define PASSWORD_SIZE 28 // Maximum password length. Allows for
107 // base64-encoded SHA-1 (27+\0).
109 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
113 TOCLIENT_INIT = 0x10,
115 Server's reply to TOSERVER_INIT.
116 Sent second after connected.
118 [0] u16 TOSERVER_INIT
119 [2] u8 deployed version
120 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
121 [12] u64 map seed (new as of 2011-02-27)
122 [20] f1000 recommended send interval (in seconds) (new as of 14)
124 NOTE: The position in here is deprecated; position is
125 explicitly sent afterwards
128 TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
129 TOCLIENT_ADDNODE = 0x21,
130 TOCLIENT_REMOVENODE = 0x22,
132 TOCLIENT_PLAYERPOS = 0x23, // Obsolete
135 // Followed by an arbitary number of these:
136 // Number is determined from packet length.
138 [N+2] v3s32 position*100
139 [N+2+12] v3s32 speed*100
140 [N+2+12+12] s32 pitch*100
141 [N+2+12+12+4] s32 yaw*100
144 TOCLIENT_PLAYERINFO = 0x24, // Obsolete
147 // Followed by an arbitary number of these:
148 // Number is determined from packet length.
153 TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
155 TOCLIENT_SECTORMETA = 0x26, // Obsolete
159 [3...] v2s16 pos + sector metadata
162 TOCLIENT_INVENTORY = 0x27,
165 [2] serialized inventory
168 TOCLIENT_OBJECTDATA = 0x28, // Obsolete
173 u16 number of player positions
186 TOCLIENT_TIME_OF_DAY = 0x29,
190 Added in a later version:
194 // (oops, there is some gap here)
196 TOCLIENT_CHAT_MESSAGE = 0x30,
203 TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
206 u16 count of removed objects
207 for all removed objects {
210 u16 count of added objects
211 for all added objects {
214 u32 initialization data length
215 string initialization data
219 TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
236 TOCLIENT_MOVE_PLAYER = 0x34,
239 v3f1000 player position
244 TOCLIENT_ACCESS_DENIED = 0x35,
251 TOCLIENT_PLAYERITEM = 0x36, // Obsolete
254 u16 count of player items
255 for all player items {
257 u16 length of serialized item
258 string serialized item
262 TOCLIENT_DEATHSCREEN = 0x37,
265 u8 bool set camera point target
266 v3f1000 camera point target (to point the death cause or whatever)
269 TOCLIENT_MEDIA = 0x38,
272 u16 total number of texture bunches
273 u16 index of this bunch
274 u32 number of files in this bunch
281 u16 length of remote media server url (if applicable)
285 TOCLIENT_TOOLDEF = 0x39,
288 u32 length of the next item
289 serialized ToolDefManager
292 TOCLIENT_NODEDEF = 0x3a,
295 u32 length of the next item
296 serialized NodeDefManager
299 TOCLIENT_CRAFTITEMDEF = 0x3b,
302 u32 length of the next item
303 serialized CraftiItemDefManager
306 TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
314 u16 length of sha1_digest
319 TOCLIENT_ITEMDEF = 0x3d,
322 u32 length of next item
323 serialized ItemDefManager
326 TOCLIENT_PLAY_SOUND = 0x3f,
333 u8 type (0=local, 1=positional, 2=object)
334 s32[3] pos_nodes*10000
339 TOCLIENT_STOP_SOUND = 0x40,
345 TOCLIENT_PRIVILEGES = 0x41,
348 u16 number of privileges
354 TOCLIENT_INVENTORY_FORMSPEC = 0x42,
361 TOCLIENT_DETACHED_INVENTORY = 0x43,
366 [2] serialized inventory
369 TOCLIENT_SHOW_FORMSPEC = 0x44,
378 TOCLIENT_MOVEMENT = 0x45,
381 f1000 movement_acceleration_default
382 f1000 movement_acceleration_air
383 f1000 movement_acceleration_fast
384 f1000 movement_speed_walk
385 f1000 movement_speed_crouch
386 f1000 movement_speed_fast
387 f1000 movement_speed_climb
388 f1000 movement_speed_jump
389 f1000 movement_liquid_fluidity
390 f1000 movement_liquid_fluidity_smooth
391 f1000 movement_liquid_sink
392 f1000 movement_gravity
395 TOCLIENT_SPAWN_PARTICLE = 0x46,
403 u8 bool collisiondetection
408 TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
423 u8 bool collisiondetection
429 TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
440 Sent first after connected.
442 [0] u16 TOSERVER_INIT
443 [2] u8 SER_FMT_VER_HIGHEST
444 [3] u8[20] player_name
445 [23] u8[28] password (new in some version)
446 [51] u16 minimum supported network protocol version (added sometime)
447 [53] u16 maximum supported network protocol version (added later than the previous one)
450 TOSERVER_INIT2 = 0x11,
452 Sent as an ACK for TOCLIENT_INIT.
453 After this, the server can send data.
455 [0] u16 TOSERVER_INIT2
458 TOSERVER_GETBLOCK=0x20, // Obsolete
459 TOSERVER_ADDNODE = 0x21, // Obsolete
460 TOSERVER_REMOVENODE = 0x22, // Obsolete
462 TOSERVER_PLAYERPOS = 0x23,
465 [2] v3s32 position*100
466 [2+12] v3s32 speed*100
467 [2+12+12] s32 pitch*100
468 [2+12+12+4] s32 yaw*100
469 [2+12+12+4+4] u32 keyPressed
472 TOSERVER_GOTBLOCKS = 0x24,
481 TOSERVER_DELETEDBLOCKS = 0x25,
490 TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
497 TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
501 [2] u8 button (0=left, 1=right)
507 TOSERVER_GROUND_ACTION = 0x28, // Obsolete
512 [3] v3s16 nodepos_undersurface
513 [9] v3s16 nodepos_abovesurface
516 0: start digging (from undersurface)
517 1: place block (to abovesurface)
518 2: stop digging (all parameters ignored)
522 TOSERVER_RELEASE = 0x29, // Obsolete
524 // (oops, there is some gap here)
526 TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
535 TOSERVER_INVENTORY_ACTION = 0x31,
537 See InventoryAction in inventory.h
540 TOSERVER_CHAT_MESSAGE = 0x32,
547 TOSERVER_SIGNNODETEXT = 0x33, // obsolete
555 TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
559 [2] u8 button (0=left, 1=right)
564 TOSERVER_DAMAGE = 0x35,
570 TOSERVER_PASSWORD=0x36,
572 Sent to change password.
574 [0] u16 TOSERVER_PASSWORD
575 [2] u8[28] old password
576 [30] u8[28] new password
579 TOSERVER_PLAYERITEM=0x37,
581 Sent to change selected item.
583 [0] u16 TOSERVER_PLAYERITEM
587 TOSERVER_RESPAWN=0x38,
592 TOSERVER_INTERACT = 0x39,
597 [5] u32 length of the next item
598 [9] serialized PointedThing
600 0: start digging (from undersurface) or use
601 1: stop digging (all parameters ignored)
603 3: place block or item (to abovesurface)
606 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
609 TOSERVER_REMOVED_SOUNDS = 0x3a,
616 TOSERVER_NODEMETA_FIELDS = 0x3b,
621 u8[len] form name (reserved for future use)
630 TOSERVER_INVENTORY_FIELDS = 0x3c,
634 u8[len] form name (reserved for future use)
643 TOSERVER_REQUEST_MEDIA = 0x40,
646 u16 number of files requested
653 TOSERVER_RECEIVED_MEDIA = 0x41,