]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/clientserver.h
Move get_schematic and read_schematic to l_mapgen.cpp
[dragonfireclient.git] / src / clientserver.h
index 9cbb7a68593532a9c0cba7496aa8ad603f345afe..5f7864768be145d559b397a2ed401ef8da0d3e7c 100644 (file)
@@ -1,26 +1,25 @@
 /*
-Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
 #ifndef CLIENTSERVER_HEADER
 #define CLIENTSERVER_HEADER
-
-#include "utility.h"
+#include "util/string.h"
 
 /*
        changes by PROTOCOL_VERSION:
@@ -28,7 +27,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        PROTOCOL_VERSION 3:
                Base for writing changes here
        PROTOCOL_VERSION 4:
-               Add TOCLIENT_TEXTURES
+               Add TOCLIENT_MEDIA
                Add TOCLIENT_TOOLDEF
                Add TOCLIENT_NODEDEF
                Add TOCLIENT_CRAFTITEMDEF
@@ -47,16 +46,90 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        PROTOCOL_VERSION 8:
                Digging based on item groups
                Many things
+       PROTOCOL_VERSION 9:
+               ContentFeatures and NodeDefManager use a different serialization
+                   format; better for future version cross-compatibility
+               Many things
+       PROTOCOL_VERSION 10:
+               TOCLIENT_PRIVILEGES
+               Version raised to force 'fly' and 'fast' privileges into effect.
+               Node metadata change (came in later; somewhat incompatible)
+       PROTOCOL_VERSION 11:
+               TileDef in ContentFeatures
+               Nodebox drawtype
+               (some dev snapshot)
+               TOCLIENT_INVENTORY_FORMSPEC
+               (0.4.0, 0.4.1)
+       PROTOCOL_VERSION 12:
+               TOSERVER_INVENTORY_FIELDS
+               16-bit node ids
+               TOCLIENT_DETACHED_INVENTORY
+       PROTOCOL_VERSION 13:
+               InventoryList field "Width" (deserialization fails with old versions)
+       PROTOCOL_VERSION 14:
+               Added transfer of player pressed keys to the server
+               Added new messages for mesh and bone animation, as well as attachments
+               GENERIC_CMD_SET_ANIMATION
+               GENERIC_CMD_SET_BONE_POSITION
+               GENERIC_CMD_SET_ATTACHMENT
+       PROTOCOL_VERSION 15:
+               Serialization format changes
+       PROTOCOL_VERSION 16:
+               TOCLIENT_SHOW_FORMSPEC
+       PROTOCOL_VERSION 17:
+               Serialization format change: include backface_culling flag in TileDef
+               Added rightclickable field in nodedef
+               TOCLIENT_SPAWN_PARTICLE
+               TOCLIENT_ADD_PARTICLESPAWNER
+               TOCLIENT_DELETE_PARTICLESPAWNER
+       PROTOCOL_VERSION 18:
+               damageGroups added to ToolCapabilities
+               sound_place added to ItemDefinition
+       PROTOCOL_VERSION 19:
+               GENERIC_CMD_SET_PHYSICS_OVERRIDE
+       PROTOCOL_VERSION 20:
+               TOCLIENT_HUDADD
+               TOCLIENT_HUDRM
+               TOCLIENT_HUDCHANGE
+               TOCLIENT_HUD_SET_FLAGS
+       PROTOCOL_VERSION 21:
+               TOCLIENT_BREATH
+               TOSERVER_BREATH
+               range added to ItemDefinition
+               drowning, leveled and liquid_range added to ContentFeatures
+               stepheight and collideWithObjects added to object properties
+               version, heat and humidity transfer in MapBock
+               automatic_face_movement_dir and automatic_face_movement_dir_offset
+                       added to object properties
+       PROTOCOL_VERSION 22:
+               add swap_node
+       PROTOCOL_VERSION 23:
+               TOSERVER_CLIENT_READY
+       PROTOCOL_VERSION 24:
+               ContentFeatures version 7
+               ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
 */
 
-#define PROTOCOL_VERSION 8
+#define LATEST_PROTOCOL_VERSION 24
+
+// Server's supported network protocol range
+#define SERVER_PROTOCOL_VERSION_MIN 13
+#define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
+
+// Client's supported network protocol range
+#define CLIENT_PROTOCOL_VERSION_MIN 13
+#define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 
+// Constant that differentiates the protocol from random data and other protocols
 #define PROTOCOL_ID 0x4f457403
 
 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
                                // base64-encoded SHA-1 (27+\0).
 
-#define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
+#define FORMSPEC_API_VERSION 1
+#define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
+
+#define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 
 enum ToClientCommand
 {
@@ -67,8 +140,9 @@ enum ToClientCommand
 
                [0] u16 TOSERVER_INIT
                [2] u8 deployed version
-               [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd 
+               [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
                [12] u64 map seed (new as of 2011-02-27)
+               [20] f1000 recommended send interval (in seconds) (new as of 14)
 
                NOTE: The position in here is deprecated; position is
                      explicitly sent afterwards
@@ -76,8 +150,14 @@ enum ToClientCommand
 
        TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
        TOCLIENT_ADDNODE = 0x21,
+       /*
+               u16 command
+               v3s16 position
+               serialized mapnode
+               u8 keep_metadata // Added in protocol version 22
+       */
        TOCLIENT_REMOVENODE = 0x22,
-       
+
        TOCLIENT_PLAYERPOS = 0x23, // Obsolete
        /*
                [0] u16 command
@@ -98,7 +178,7 @@ enum ToClientCommand
                [N] u16 peer_id
                [N] char[20] name
        */
-       
+
        TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 
        TOCLIENT_SECTORMETA = 0x26, // Obsolete
@@ -113,7 +193,7 @@ enum ToClientCommand
                [0] u16 command
                [2] serialized inventory
        */
-       
+
        TOCLIENT_OBJECTDATA = 0x28, // Obsolete
        /*
                Sent as unreliable.
@@ -164,7 +244,7 @@ enum ToClientCommand
                        string initialization data
                }
        */
-       
+
        TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
        /*
                u16 command
@@ -197,7 +277,7 @@ enum ToClientCommand
                wstring reason
        */
 
-       TOCLIENT_PLAYERITEM = 0x36,
+       TOCLIENT_PLAYERITEM = 0x36, // Obsolete
        /*
                u16 command
                u16 count of player items
@@ -215,34 +295,36 @@ enum ToClientCommand
                v3f1000 camera point target (to point the death cause or whatever)
        */
 
-       TOCLIENT_TEXTURES = 0x38,
+       TOCLIENT_MEDIA = 0x38,
        /*
                u16 command
                u16 total number of texture bunches
                u16 index of this bunch
-               u32 number of textures in this bunch
-               for each texture {
+               u32 number of files in this bunch
+               for each file {
                        u16 length of name
                        string name
                        u32 length of data
                        data
                }
+               u16 length of remote media server url (if applicable)
+               string url
        */
-       
+
        TOCLIENT_TOOLDEF = 0x39,
        /*
                u16 command
                u32 length of the next item
                serialized ToolDefManager
        */
-       
+
        TOCLIENT_NODEDEF = 0x3a,
        /*
                u16 command
                u32 length of the next item
                serialized NodeDefManager
        */
-       
+
        TOCLIENT_CRAFTITEMDEF = 0x3b,
        /*
                u16 command
@@ -250,11 +332,11 @@ enum ToClientCommand
                serialized CraftiItemDefManager
        */
 
-       TOCLIENT_ANNOUNCE_TEXTURES = 0x3c,
+       TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 
        /*
                u16 command
-               u32 number of textures
+               u32 number of files
                for each texture {
                        u16 length of name
                        string name
@@ -269,7 +351,7 @@ enum ToClientCommand
                u32 length of next item
                serialized ItemDefManager
        */
-       
+
        TOCLIENT_PLAY_SOUND = 0x3f,
        /*
                u16 command
@@ -288,6 +370,192 @@ enum ToClientCommand
                u16 command
                s32 sound_id
        */
+
+       TOCLIENT_PRIVILEGES = 0x41,
+       /*
+               u16 command
+               u16 number of privileges
+               for each privilege
+                       u16 len
+                       u8[len] privilege
+       */
+
+       TOCLIENT_INVENTORY_FORMSPEC = 0x42,
+       /*
+               u16 command
+               u32 len
+               u8[len] formspec
+       */
+
+       TOCLIENT_DETACHED_INVENTORY = 0x43,
+       /*
+               [0] u16 command
+               u16 len
+               u8[len] name
+               [2] serialized inventory
+       */
+
+       TOCLIENT_SHOW_FORMSPEC = 0x44,
+       /*
+               [0] u16 command
+               u32 len
+               u8[len] formspec
+               u16 len
+               u8[len] formname
+       */
+
+       TOCLIENT_MOVEMENT = 0x45,
+       /*
+               u16 command
+               f1000 movement_acceleration_default
+               f1000 movement_acceleration_air
+               f1000 movement_acceleration_fast
+               f1000 movement_speed_walk
+               f1000 movement_speed_crouch
+               f1000 movement_speed_fast
+               f1000 movement_speed_climb
+               f1000 movement_speed_jump
+               f1000 movement_liquid_fluidity
+               f1000 movement_liquid_fluidity_smooth
+               f1000 movement_liquid_sink
+               f1000 movement_gravity
+       */
+
+       TOCLIENT_SPAWN_PARTICLE = 0x46,
+       /*
+               u16 command
+               v3f1000 pos
+               v3f1000 velocity
+               v3f1000 acceleration
+               f1000 expirationtime
+               f1000 size
+               u8 bool collisiondetection
+               u8 bool vertical
+               u32 len
+               u8[len] texture
+       */
+
+       TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
+       /*
+               u16 command
+               u16 amount
+               f1000 spawntime
+               v3f1000 minpos
+               v3f1000 maxpos
+               v3f1000 minvel
+               v3f1000 maxvel
+               v3f1000 minacc
+               v3f1000 maxacc
+               f1000 minexptime
+               f1000 maxexptime
+               f1000 minsize
+               f1000 maxsize
+               u8 bool collisiondetection
+               u8 bool vertical
+               u32 len
+               u8[len] texture
+               u32 id
+       */
+
+       TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
+       /*
+               u16 command
+               u32 id
+       */
+
+       TOCLIENT_HUDADD = 0x49,
+       /*
+               u16 command
+               u32 id
+               u8 type
+               v2f1000 pos
+               u32 len
+               u8[len] name
+               v2f1000 scale
+               u32 len2
+               u8[len2] text
+               u32 number
+               u32 item
+               u32 dir
+               v2f1000 align
+               v2f1000 offset
+               v3f1000 world_pos
+               v2s32 size
+       */
+
+       TOCLIENT_HUDRM = 0x4a,
+       /*
+               u16 command
+               u32 id
+       */
+
+       TOCLIENT_HUDCHANGE = 0x4b,
+       /*
+               u16 command
+               u32 id
+               u8 stat
+               [v2f1000 data |
+                u32 len
+                u8[len] data |
+                u32 data]
+       */
+
+       TOCLIENT_HUD_SET_FLAGS = 0x4c,
+       /*
+               u16 command
+               u32 flags
+               u32 mask
+       */
+
+       TOCLIENT_HUD_SET_PARAM = 0x4d,
+       /*
+               u16 command
+               u16 param
+               u16 len
+               u8[len] value
+       */
+
+       TOCLIENT_BREATH = 0x4e,
+       /*
+               u16 command
+               u16 breath
+       */
+
+       TOCLIENT_SET_SKY = 0x4f,
+       /*
+               u16 command
+               u8[4] color (ARGB)
+               u8 len
+               u8[len] type
+               u16 count
+               foreach count:
+                       u8 len
+                       u8[len] param
+       */
+
+       TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
+       /*
+               u16 command
+               u8 do_override (boolean)
+               u16 day-night ratio 0...65535
+       */
+
+       TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
+       /*
+               u16 command
+               v2s32 stand/idle
+               v2s32 walk
+               v2s32 dig
+               v2s32 walk+dig
+               f1000 frame_speed
+       */
+
+       TOCLIENT_EYE_OFFSET = 0x52,
+       /*
+               u16 command
+               v3f1000 first
+               v3f1000 third
+       */
 };
 
 enum ToServerCommand
@@ -297,10 +565,11 @@ enum ToServerCommand
                Sent first after connected.
 
                [0] u16 TOSERVER_INIT
-               [2] u8 SER_FMT_VER_HIGHEST
+               [2] u8 SER_FMT_VER_HIGHEST_READ
                [3] u8[20] player_name
                [23] u8[28] password (new in some version)
-               [51] u16 client network protocol version (new in some version)
+               [51] u16 minimum supported network protocol version (added sometime)
+               [53] u16 maximum supported network protocol version (added later than the previous one)
        */
 
        TOSERVER_INIT2 = 0x11,
@@ -322,6 +591,7 @@ enum ToServerCommand
                [2+12] v3s32 speed*100
                [2+12+12] s32 pitch*100
                [2+12+12+4] s32 yaw*100
+               [2+12+12+4+4] u32 keyPressed
        */
 
        TOSERVER_GOTBLOCKS = 0x24,
@@ -373,7 +643,7 @@ enum ToServerCommand
                2: stop digging (all parameters ignored)
                3: digging completed
        */
-       
+
        TOSERVER_RELEASE = 0x29, // Obsolete
 
        // (oops, there is some gap here)
@@ -399,7 +669,7 @@ enum ToServerCommand
                wstring message
        */
 
-       TOSERVER_SIGNNODETEXT = 0x33,
+       TOSERVER_SIGNNODETEXT = 0x33, // obsolete
        /*
                u16 command
                v3s16 p
@@ -415,7 +685,7 @@ enum ToServerCommand
                [3] u16 id
                [5] u16 item
        */
-       
+
        TOSERVER_DAMAGE = 0x35,
        /*
                u16 command
@@ -438,7 +708,7 @@ enum ToServerCommand
                [0] u16 TOSERVER_PLAYERITEM
                [2] u16 item
        */
-       
+
        TOSERVER_RESPAWN=0x38,
        /*
                u16 TOSERVER_RESPAWN
@@ -460,7 +730,7 @@ enum ToServerCommand
 
                (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
        */
-       
+
        TOSERVER_REMOVED_SOUNDS = 0x3a,
        /*
                u16 command
@@ -468,26 +738,64 @@ enum ToServerCommand
                s32[len] sound_id
        */
 
-       TOSERVER_REQUEST_TEXTURES = 0x40,
+       TOSERVER_NODEMETA_FIELDS = 0x3b,
        /*
                u16 command
-               u16 number of textures requested
-               for each texture {
+               v3s16 p
+               u16 len
+               u8[len] form name (reserved for future use)
+               u16 number of fields
+               for each field:
+                       u16 len
+                       u8[len] field name
+                       u32 len
+                       u8[len] field value
+       */
+
+       TOSERVER_INVENTORY_FIELDS = 0x3c,
+       /*
+               u16 command
+               u16 len
+               u8[len] form name (reserved for future use)
+               u16 number of fields
+               for each field:
+                       u16 len
+                       u8[len] field name
+                       u32 len
+                       u8[len] field value
+       */
+
+       TOSERVER_REQUEST_MEDIA = 0x40,
+       /*
+               u16 command
+               u16 number of files requested
+               for each file {
                        u16 length of name
                        string name
                }
         */
 
-};
+       TOSERVER_RECEIVED_MEDIA = 0x41,
+       /*
+               u16 command
+       */
 
-inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time, float time_speed)
-{
-       SharedBuffer<u8> data(2+2+4);
-       writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
-       writeU16(&data[2], time);
-       writeF1000(&data[4], time_speed);
-       return data;
-}
+       TOSERVER_BREATH = 0x42,
+       /*
+               u16 command
+               u16 breath
+       */
+
+       TOSERVER_CLIENT_READY = 0x43,
+       /*
+               u8 major
+               u8 minor
+               u8 patch
+               u8 reserved
+               u16 len
+               u8[len] full_version_string
+       */
+};
 
 #endif