src/network/networkprotocol.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #pragma once
  21
  22 #include "util/string.h"
  23
  24 /*
  25         changes by PROTOCOL_VERSION:
  26
  27         PROTOCOL_VERSION 3:
  28                 Base for writing changes here
  29         PROTOCOL_VERSION 4:
  30                 Add TOCLIENT_MEDIA
  31                 Add TOCLIENT_TOOLDEF
  32                 Add TOCLIENT_NODEDEF
  33                 Add TOCLIENT_CRAFTITEMDEF
  34                 Add TOSERVER_INTERACT
  35                 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
  36                 Obsolete TOSERVER_GROUND_ACTION
  37         PROTOCOL_VERSION 5:
  38                 Make players to be handled mostly as ActiveObjects
  39         PROTOCOL_VERSION 6:
  40                 Only non-cached textures are sent
  41         PROTOCOL_VERSION 7:
  42                 Add TOCLIENT_ITEMDEF
  43                 Obsolete TOCLIENT_TOOLDEF
  44                 Obsolete TOCLIENT_CRAFTITEMDEF
  45                 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
  46         PROTOCOL_VERSION 8:
  47                 Digging based on item groups
  48                 Many things
  49         PROTOCOL_VERSION 9:
  50                 ContentFeatures and NodeDefManager use a different serialization
  51                     format; better for future version cross-compatibility
  52                 Many things
  53                 Obsolete TOCLIENT_PLAYERITEM
  54         PROTOCOL_VERSION 10:
  55                 TOCLIENT_PRIVILEGES
  56                 Version raised to force 'fly' and 'fast' privileges into effect.
  57                 Node metadata change (came in later; somewhat incompatible)
  58         PROTOCOL_VERSION 11:
  59                 TileDef in ContentFeatures
  60                 Nodebox drawtype
  61                 (some dev snapshot)
  62                 TOCLIENT_INVENTORY_FORMSPEC
  63                 (0.4.0, 0.4.1)
  64         PROTOCOL_VERSION 12:
  65                 TOSERVER_INVENTORY_FIELDS
  66                 16-bit node ids
  67                 TOCLIENT_DETACHED_INVENTORY
  68         PROTOCOL_VERSION 13:
  69                 InventoryList field "Width" (deserialization fails with old versions)
  70         PROTOCOL_VERSION 14:
  71                 Added transfer of player pressed keys to the server
  72                 Added new messages for mesh and bone animation, as well as attachments
  73                 AO_CMD_SET_ANIMATION
  74                 AO_CMD_SET_BONE_POSITION
  75                 GENERIC_CMD_SET_ATTACHMENT
  76         PROTOCOL_VERSION 15:
  77                 Serialization format changes
  78         PROTOCOL_VERSION 16:
  79                 TOCLIENT_SHOW_FORMSPEC
  80         PROTOCOL_VERSION 17:
  81                 Serialization format change: include backface_culling flag in TileDef
  82                 Added rightclickable field in nodedef
  83                 TOCLIENT_SPAWN_PARTICLE
  84                 TOCLIENT_ADD_PARTICLESPAWNER
  85                 TOCLIENT_DELETE_PARTICLESPAWNER
  86         PROTOCOL_VERSION 18:
  87                 damageGroups added to ToolCapabilities
  88                 sound_place added to ItemDefinition
  89         PROTOCOL_VERSION 19:
  90                 AO_CMD_SET_PHYSICS_OVERRIDE
  91         PROTOCOL_VERSION 20:
  92                 TOCLIENT_HUDADD
  93                 TOCLIENT_HUDRM
  94                 TOCLIENT_HUDCHANGE
  95                 TOCLIENT_HUD_SET_FLAGS
  96         PROTOCOL_VERSION 21:
  97                 TOCLIENT_BREATH
  98                 TOSERVER_BREATH
  99                 range added to ItemDefinition
 100                 drowning, leveled and liquid_range added to ContentFeatures
 101                 stepheight and collideWithObjects added to object properties
 102                 version, heat and humidity transfer in MapBock
 103                 automatic_face_movement_dir and automatic_face_movement_dir_offset
 104                         added to object properties
 105         PROTOCOL_VERSION 22:
 106                 add swap_node
 107         PROTOCOL_VERSION 23:
 108                 Obsolete TOSERVER_RECEIVED_MEDIA
 109                 Server: Stop using TOSERVER_CLIENT_READY
 110         PROTOCOL_VERSION 24:
 111                 ContentFeatures version 7
 112                 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
 113         PROTOCOL_VERSION 25:
 114                 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
 115                 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
 116                         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
 117                 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
 118                 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
 119                 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
 120                 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
 121                         for standard error, keeping customisation possible. This
 122                         permit translation
 123                 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
 124                         reading u32
 125                 Add new opcode TOSERVER_INIT for client presentation to server
 126                 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
 127                         TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
 128                         for the three supported auth mechanisms around srp
 129                 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
 130                         for sudo mode handling (auth mech generic way of changing password).
 131                 Add TOCLIENT_HELLO for presenting server to client after client
 132                         presentation
 133                 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
 134                 Rename GENERIC_CMD_SET_ATTACHMENT to AO_CMD_ATTACH_TO
 135         PROTOCOL_VERSION 26:
 136                 Add TileDef tileable_horizontal, tileable_vertical flags
 137         PROTOCOL_VERSION 27:
 138                 backface_culling: backwards compatibility for playing with
 139                 newer client on pre-27 servers.
 140                 Add nodedef v3 - connected nodeboxes
 141         PROTOCOL_VERSION 28:
 142                 CPT2_MESHOPTIONS
 143         PROTOCOL_VERSION 29:
 144                 Server doesn't accept TOSERVER_BREATH anymore
 145                 serialization of TileAnimation params changed
 146                 TAT_SHEET_2D
 147                 Removed client-sided chat perdiction
 148         PROTOCOL VERSION 30:
 149                 New ContentFeatures serialization version
 150                 Add node and tile color and palette
 151                 Fix plantlike visual_scale being applied squared and add compatibility
 152                         with pre-30 clients by sending sqrt(visual_scale)
 153         PROTOCOL VERSION 31:
 154                 Add tile overlay
 155                 Stop sending TOSERVER_CLIENT_READY
 156         PROTOCOL VERSION 32:
 157                 Add fading sounds
 158         PROTOCOL VERSION 33:
 159                 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
 160                         instead of guessing based on the active object list.
 161         PROTOCOL VERSION 34:
 162                 Add sound pitch
 163         PROTOCOL VERSION 35:
 164                 Rename TOCLIENT_CHAT_MESSAGE to TOCLIENT_CHAT_MESSAGE_OLD (0x30)
 165                 Add TOCLIENT_CHAT_MESSAGE (0x2F)
 166                         This chat message is a signalisation message containing various
 167                         informations:
 168                         * timestamp
 169                         * sender
 170                         * type (RAW, NORMAL, ANNOUNCE, SYSTEM)
 171                         * content
 172                 Add TOCLIENT_CSM_RESTRICTION_FLAGS to define which CSM features should be
 173                         limited
 174                 Add settable player collisionbox. Breaks compatibility with older
 175                         clients as a 1-node vertical offset has been removed from player's
 176                         position
 177                 Add settable player stepheight using existing object property.
 178                         Breaks compatibility with older clients.
 179         PROTOCOL VERSION 36:
 180                 Backwards compatibility drop
 181                 Add 'can_zoom' to player object properties
 182                 Add glow to object properties
 183                 Change TileDef serialization format.
 184                 Add world-aligned tiles.
 185                 Mod channels
 186                 Raise ObjectProperties version to 3 for removing 'can_zoom' and adding
 187                         'zoom_fov'.
 188                 Nodebox version 5
 189                 Add disconnected nodeboxes
 190                 Add TOCLIENT_FORMSPEC_PREPEND
 191         PROTOCOL VERSION 37:
 192                 Redo detached inventory sending
 193                 Add TOCLIENT_NODEMETA_CHANGED
 194                 New network float format
 195                 ContentFeatures version 13
 196                 Add full Euler rotations instead of just yaw
 197                 Add TOCLIENT_PLAYER_SPEED
 198         PROTOCOL VERSION 38:
 199                 Incremental inventory sending mode
 200                 Unknown inventory serialization fields no longer throw an error
 201                 Mod-specific formspec version
 202                 Player FOV override API
 203                 "ephemeral" added to TOCLIENT_PLAY_SOUND
 204         PROTOCOL VERSION 39:
 205                 Updated set_sky packet
 206                 Adds new sun, moon and stars packets
 207 */
 208
 209 #define LATEST_PROTOCOL_VERSION 39
 210 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
 211
 212 // Server's supported network protocol range
 213 #define SERVER_PROTOCOL_VERSION_MIN 37
 214 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 215
 216 // Client's supported network protocol range
 217 // The minimal version depends on whether
 218 // send_pre_v25_init is enabled or not
 219 #define CLIENT_PROTOCOL_VERSION_MIN 37
 220 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 221
 222 // Constant that differentiates the protocol from random data and other protocols
 223 #define PROTOCOL_ID 0x4f457403
 224
 225 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 226                                // base64-encoded SHA-1 (27+\0).
 227
 228 /*
 229         Changes by FORMSPEC_API_VERSION:
 230
 231         FORMSPEC VERSION 1:
 232                 (too much)
 233         FORMSPEC VERSION 2:
 234                 Forced real coordinates
 235                 background9[]: 9-slice scaling parameters
 236         FORMSPEC VERSION 3:
 237                 Formspec elements are drawn in the order of definition
 238                 bgcolor[]: use 3 parameters (bgcolor, formspec (now an enum), fbgcolor)
 239                 box[] and image[] elements enable clipping by default
 240                 new element: scroll_container[]
 241         FORMSPEC VERSION 4:
 242                 Allow dropdown indexing events
 243 */
 244 #define FORMSPEC_API_VERSION 4
 245
 246 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 247
 248 typedef u16 session_t;
 249
 250 enum ToClientCommand
 251 {
 252         TOCLIENT_HELLO = 0x02,
 253         /*
 254                 Sent after TOSERVER_INIT.
 255
 256                 u8 deployed serialisation version
 257                 u16 deployed network compression mode
 258                 u16 deployed protocol version
 259                 u32 supported auth methods
 260                 std::string username that should be used for legacy hash (for proper casing)
 261         */
 262         TOCLIENT_AUTH_ACCEPT = 0x03,
 263         /*
 264                 Message from server to accept auth.
 265
 266                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 267                 u64 map seed
 268                 f1000 recommended send interval
 269                 u32 : supported auth methods for sudo mode
 270                       (where the user can change their password)
 271         */
 272         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 273         /*
 274                 Sent to client to show it is in sudo mode now.
 275         */
 276         TOCLIENT_DENY_SUDO_MODE = 0x05,
 277         /*
 278                 Signals client that sudo mode auth failed.
 279         */
 280         TOCLIENT_ACCESS_DENIED = 0x0A,
 281         /*
 282                 u8 reason
 283                 std::string custom reason (if needed, otherwise "")
 284                 u8 (bool) reconnect
 285         */
 286
 287         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 288
 289         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 290         TOCLIENT_ADDNODE = 0x21,
 291         /*
 292                 v3s16 position
 293                 serialized mapnode
 294                 u8 keep_metadata // Added in protocol version 22
 295         */
 296         TOCLIENT_REMOVENODE = 0x22,
 297
 298         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 299         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 300         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 301         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 302
 303         TOCLIENT_INVENTORY = 0x27,
 304         /*
 305                 [0] u16 command
 306                 [2] serialized inventory
 307         */
 308
 309         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 310
 311         TOCLIENT_TIME_OF_DAY = 0x29,
 312         /*
 313                 u16 time (0-23999)
 314                 Added in a later version:
 315                 f1000 time_speed
 316         */
 317
 318         TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
 319         /*
 320                 u32 CSMRestrictionFlags byteflag
 321          */
 322
 323         TOCLIENT_PLAYER_SPEED = 0x2B,
 324         /*
 325                 v3f added_vel
 326          */
 327
 328         TOCLIENT_MEDIA_PUSH = 0x2C,
 329         /*
 330                 std::string raw_hash
 331                 std::string filename
 332                 bool should_be_cached
 333                 u32 len
 334                 char filedata[len]
 335         */
 336
 337         // (oops, there is some gap here)
 338
 339         TOCLIENT_CHAT_MESSAGE = 0x2F,
 340         /*
 341                 u8 version
 342                 u8 message_type
 343                 u16 sendername length
 344                 wstring sendername
 345                 u16 length
 346                 wstring message
 347         */
 348
 349         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 350
 351         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 352         /*
 353                 u16 count of removed objects
 354                 for all removed objects {
 355                         u16 id
 356                 }
 357                 u16 count of added objects
 358                 for all added objects {
 359                         u16 id
 360                         u8 type
 361                         u32 initialization data length
 362                         string initialization data
 363                 }
 364         */
 365
 366         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 367         /*
 368                 for all objects
 369                 {
 370                         u16 id
 371                         u16 message length
 372                         string message
 373                 }
 374         */
 375
 376         TOCLIENT_HP = 0x33,
 377         /*
 378                 u8 hp
 379         */
 380
 381         TOCLIENT_MOVE_PLAYER = 0x34,
 382         /*
 383                 v3f1000 player position
 384                 f1000 player pitch
 385                 f1000 player yaw
 386         */
 387
 388         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 389         /*
 390                 u16 reason_length
 391                 wstring reason
 392         */
 393
 394         TOCLIENT_FOV = 0x36,
 395         /*
 396                 Sends an FOV override/multiplier to client.
 397
 398                 f32 fov
 399                 bool is_multiplier
 400                 f32 transition_time
 401         */
 402
 403         TOCLIENT_DEATHSCREEN = 0x37,
 404         /*
 405                 u8 bool set camera point target
 406                 v3f1000 camera point target (to point the death cause or whatever)
 407         */
 408
 409         TOCLIENT_MEDIA = 0x38,
 410         /*
 411                 u16 total number of texture bunches
 412                 u16 index of this bunch
 413                 u32 number of files in this bunch
 414                 for each file {
 415                         u16 length of name
 416                         string name
 417                         u32 length of data
 418                         data
 419                 }
 420                 u16 length of remote media server url (if applicable)
 421                 string url
 422         */
 423
 424         TOCLIENT_TOOLDEF = 0x39,
 425         /*
 426                 u32 length of the next item
 427                 serialized ToolDefManager
 428         */
 429
 430         TOCLIENT_NODEDEF = 0x3a,
 431         /*
 432                 u32 length of the next item
 433                 serialized NodeDefManager
 434         */
 435
 436         TOCLIENT_CRAFTITEMDEF = 0x3b,
 437         /*
 438                 u32 length of the next item
 439                 serialized CraftiItemDefManager
 440         */
 441
 442         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 443
 444         /*
 445                 u32 number of files
 446                 for each texture {
 447                         u16 length of name
 448                         string name
 449                         u16 length of sha1_digest
 450                         string sha1_digest
 451                 }
 452         */
 453
 454         TOCLIENT_ITEMDEF = 0x3d,
 455         /*
 456                 u32 length of next item
 457                 serialized ItemDefManager
 458         */
 459
 460         TOCLIENT_PLAY_SOUND = 0x3f,
 461         /*
 462                 s32 sound_id
 463                 u16 len
 464                 u8[len] sound name
 465                 s32 gain*1000
 466                 u8 type (0=local, 1=positional, 2=object)
 467                 s32[3] pos_nodes*10000
 468                 u16 object_id
 469                 u8 loop (bool)
 470                 u8 ephemeral (bool)
 471         */
 472
 473         TOCLIENT_STOP_SOUND = 0x40,
 474         /*
 475                 s32 sound_id
 476         */
 477
 478         TOCLIENT_PRIVILEGES = 0x41,
 479         /*
 480                 u16 number of privileges
 481                 for each privilege
 482                         u16 len
 483                         u8[len] privilege
 484         */
 485
 486         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 487         /*
 488                 u32 len
 489                 u8[len] formspec
 490         */
 491
 492         TOCLIENT_DETACHED_INVENTORY = 0x43,
 493         /*
 494                 [0] u16 command
 495                 u16 len
 496                 u8[len] name
 497                 [2] serialized inventory
 498         */
 499
 500         TOCLIENT_SHOW_FORMSPEC = 0x44,
 501         /*
 502                 [0] u16 command
 503                 u32 len
 504                 u8[len] formspec
 505                 u16 len
 506                 u8[len] formname
 507         */
 508
 509         TOCLIENT_MOVEMENT = 0x45,
 510         /*
 511                 f1000 movement_acceleration_default
 512                 f1000 movement_acceleration_air
 513                 f1000 movement_acceleration_fast
 514                 f1000 movement_speed_walk
 515                 f1000 movement_speed_crouch
 516                 f1000 movement_speed_fast
 517                 f1000 movement_speed_climb
 518                 f1000 movement_speed_jump
 519                 f1000 movement_liquid_fluidity
 520                 f1000 movement_liquid_fluidity_smooth
 521                 f1000 movement_liquid_sink
 522                 f1000 movement_gravity
 523         */
 524
 525         TOCLIENT_SPAWN_PARTICLE = 0x46,
 526         /*
 527                 v3f1000 pos
 528                 v3f1000 velocity
 529                 v3f1000 acceleration
 530                 f1000 expirationtime
 531                 f1000 size
 532                 u8 bool collisiondetection
 533                 u32 len
 534                 u8[len] texture
 535                 u8 bool vertical
 536                 u8 collision_removal
 537                 TileAnimation animation
 538                 u8 glow
 539                 u8 object_collision
 540         */
 541
 542         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 543         /*
 544                 u16 amount
 545                 f1000 spawntime
 546                 v3f1000 minpos
 547                 v3f1000 maxpos
 548                 v3f1000 minvel
 549                 v3f1000 maxvel
 550                 v3f1000 minacc
 551                 v3f1000 maxacc
 552                 f1000 minexptime
 553                 f1000 maxexptime
 554                 f1000 minsize
 555                 f1000 maxsize
 556                 u8 bool collisiondetection
 557                 u32 len
 558                 u8[len] texture
 559                 u8 bool vertical
 560                 u8 collision_removal
 561                 u32 id
 562                 TileAnimation animation
 563                 u8 glow
 564                 u8 object_collision
 565         */
 566
 567         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 568
 569         TOCLIENT_HUDADD = 0x49,
 570         /*
 571                 u32 id
 572                 u8 type
 573                 v2f1000 pos
 574                 u16 len
 575                 u8[len] name
 576                 v2f1000 scale
 577                 u16 len2
 578                 u8[len2] text
 579                 u32 number
 580                 u32 item
 581                 u32 dir
 582                 v2f1000 align
 583                 v2f1000 offset
 584                 v3f1000 world_pos
 585                 v2s32 size
 586                 s16 z_index
 587                 u16 len3
 588                 u8[len3] text2
 589         */
 590
 591         TOCLIENT_HUDRM = 0x4a,
 592         /*
 593                 u32 id
 594         */
 595
 596         TOCLIENT_HUDCHANGE = 0x4b,
 597         /*
 598                 u32 id
 599                 u8 stat
 600                 [v2f1000 data |
 601                  u32 len
 602                  u8[len] data |
 603                  u32 data]
 604         */
 605
 606         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 607         /*
 608                 u32 flags
 609                 u32 mask
 610         */
 611
 612         TOCLIENT_HUD_SET_PARAM = 0x4d,
 613         /*
 614                 u16 param
 615                 u16 len
 616                 u8[len] value
 617         */
 618
 619         TOCLIENT_BREATH = 0x4e,
 620         /*
 621                 u16 breath
 622         */
 623
 624         TOCLIENT_SET_SKY = 0x4f,
 625         /*
 626                 Protocol 38:
 627                 u8[4] base_color (ARGB)
 628                 u8 len
 629                 u8[len] type
 630                 u16 count
 631                 foreach count:
 632                         u8 len
 633                         u8[len] param
 634                 u8 clouds (boolean)
 635
 636                 Protocol 39:
 637                 u8[4] bgcolor (ARGB)
 638                 std::string type
 639                 int texture_count
 640                 std::string[6] param
 641                 bool clouds
 642                 bool bgcolor_fog
 643                 u8[4] day_sky (ARGB)
 644                 u8[4] day_horizon (ARGB)
 645                 u8[4] dawn_sky (ARGB)
 646                 u8[4] dawn_horizon (ARGB)
 647                 u8[4] night_sky (ARGB)
 648                 u8[4] night_horizon (ARGB)
 649                 u8[4] indoors (ARGB)
 650                 u8[4] fog_sun_tint (ARGB)
 651                 u8[4] fog_moon_tint (ARGB)
 652                 std::string fog_tint_type
 653         */
 654
 655         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 656         /*
 657                 u8 do_override (boolean)
 658                 u16 day-night ratio 0...65535
 659         */
 660
 661         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 662         /*
 663                 v2s32 stand/idle
 664                 v2s32 walk
 665                 v2s32 dig
 666                 v2s32 walk+dig
 667                 f1000 frame_speed
 668         */
 669
 670         TOCLIENT_EYE_OFFSET = 0x52,
 671         /*
 672                 v3f1000 first
 673                 v3f1000 third
 674         */
 675
 676         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 677         /*
 678                 u32 id
 679         */
 680
 681         TOCLIENT_CLOUD_PARAMS = 0x54,
 682         /*
 683                 f1000 density
 684                 u8[4] color_diffuse (ARGB)
 685                 u8[4] color_ambient (ARGB)
 686                 f1000 height
 687                 f1000 thickness
 688                 v2f1000 speed
 689         */
 690
 691         TOCLIENT_FADE_SOUND = 0x55,
 692         /*
 693                 s32 sound_id
 694                 float step
 695                 float gain
 696         */
 697         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 698         /*
 699                 u8 type
 700                 u16 number of players
 701                 for each player
 702                         u16 len
 703                         u8[len] player name
 704         */
 705
 706         TOCLIENT_MODCHANNEL_MSG = 0x57,
 707         /*
 708                 u16 channel name length
 709                 std::string channel name
 710                 u16 channel name sender
 711                 std::string channel name
 712                 u16 message length
 713                 std::string message
 714         */
 715
 716         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 717         /*
 718                 u8 signal id
 719                 u16 channel name length
 720                 std::string channel name
 721         */
 722
 723         TOCLIENT_NODEMETA_CHANGED = 0x59,
 724         /*
 725                 serialized and compressed node metadata
 726         */
 727
 728         TOCLIENT_SET_SUN = 0x5a,
 729         /*
 730                 bool visible
 731                 std::string texture
 732                 std::string tonemap
 733                 std::string sunrise
 734                 f32 scale
 735         */
 736
 737         TOCLIENT_SET_MOON = 0x5b,
 738         /*
 739                 bool visible
 740                 std::string texture
 741                 std::string tonemap
 742                 f32 scale
 743         */
 744
 745         TOCLIENT_SET_STARS = 0x5c,
 746         /*
 747                 bool visible
 748                 u32 count
 749                 u8[4] starcolor (ARGB)
 750                 f32 scale
 751         */
 752
 753         TOCLIENT_SRP_BYTES_S_B = 0x60,
 754         /*
 755                 Belonging to AUTH_MECHANISM_SRP.
 756
 757                 std::string bytes_s
 758                 std::string bytes_B
 759         */
 760
 761         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 762         /*
 763                 u16 len
 764                 u8[len] formspec
 765         */
 766
 767         TOCLIENT_NUM_MSG_TYPES = 0x62,
 768 };
 769
 770 enum ToServerCommand
 771 {
 772         TOSERVER_INIT = 0x02,
 773         /*
 774                 Sent first after connected.
 775
 776                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 777                 u16 supported network compression modes
 778                 u16 minimum supported network protocol version
 779                 u16 maximum supported network protocol version
 780                 std::string player name
 781         */
 782
 783         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 784
 785         TOSERVER_INIT2 = 0x11,
 786         /*
 787                 Sent as an ACK for TOCLIENT_INIT.
 788                 After this, the server can send data.
 789
 790                 [0] u16 TOSERVER_INIT2
 791         */
 792
 793         TOSERVER_MODCHANNEL_JOIN = 0x17,
 794         /*
 795                 u16 channel name length
 796                 std::string channel name
 797          */
 798
 799         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 800         /*
 801                 u16 channel name length
 802                 std::string channel name
 803          */
 804
 805         TOSERVER_MODCHANNEL_MSG = 0x19,
 806         /*
 807                 u16 channel name length
 808                 std::string channel name
 809                 u16 message length
 810                 std::string message
 811          */
 812
 813         TOSERVER_GETBLOCK = 0x20, // Obsolete
 814         TOSERVER_ADDNODE = 0x21, // Obsolete
 815         TOSERVER_REMOVENODE = 0x22, // Obsolete
 816
 817         TOSERVER_PLAYERPOS = 0x23,
 818         /*
 819                 [0] u16 command
 820                 [2] v3s32 position*100
 821                 [2+12] v3s32 speed*100
 822                 [2+12+12] s32 pitch*100
 823                 [2+12+12+4] s32 yaw*100
 824                 [2+12+12+4+4] u32 keyPressed
 825                 [2+12+12+4+4+1] u8 fov*80
 826                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 827         */
 828
 829         TOSERVER_GOTBLOCKS = 0x24,
 830         /*
 831                 [0] u16 command
 832                 [2] u8 count
 833                 [3] v3s16 pos_0
 834                 [3+6] v3s16 pos_1
 835                 ...
 836         */
 837
 838         TOSERVER_DELETEDBLOCKS = 0x25,
 839         /*
 840                 [0] u16 command
 841                 [2] u8 count
 842                 [3] v3s16 pos_0
 843                 [3+6] v3s16 pos_1
 844                 ...
 845         */
 846
 847         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 848         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 849         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 850         TOSERVER_RELEASE = 0x29, // Obsolete
 851         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 852
 853         TOSERVER_INVENTORY_ACTION = 0x31,
 854         /*
 855                 See InventoryAction in inventorymanager.h
 856         */
 857
 858         TOSERVER_CHAT_MESSAGE = 0x32,
 859         /*
 860                 u16 length
 861                 wstring message
 862         */
 863
 864         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 865         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 866
 867         TOSERVER_DAMAGE = 0x35,
 868         /*
 869                 u8 amount
 870         */
 871
 872         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 873
 874         TOSERVER_PLAYERITEM = 0x37,
 875         /*
 876                 Sent to change selected item.
 877
 878                 [0] u16 TOSERVER_PLAYERITEM
 879                 [2] u16 item
 880         */
 881
 882         TOSERVER_RESPAWN = 0x38,
 883         /*
 884                 u16 TOSERVER_RESPAWN
 885         */
 886
 887         TOSERVER_INTERACT = 0x39,
 888         /*
 889                 [0] u16 command
 890                 [2] u8 action
 891                 [3] u16 item
 892                 [5] u32 length of the next item
 893                 [9] serialized PointedThing
 894                 actions:
 895                 0: start digging (from undersurface) or use
 896                 1: stop digging (all parameters ignored)
 897                 2: digging completed
 898                 3: place block or item (to abovesurface)
 899                 4: use item
 900         */
 901
 902         TOSERVER_REMOVED_SOUNDS = 0x3a,
 903         /*
 904                 u16 len
 905                 s32[len] sound_id
 906         */
 907
 908         TOSERVER_NODEMETA_FIELDS = 0x3b,
 909         /*
 910                 v3s16 p
 911                 u16 len
 912                 u8[len] form name (reserved for future use)
 913                 u16 number of fields
 914                 for each field:
 915                         u16 len
 916                         u8[len] field name
 917                         u32 len
 918                         u8[len] field value
 919         */
 920
 921         TOSERVER_INVENTORY_FIELDS = 0x3c,
 922         /*
 923                 u16 len
 924                 u8[len] form name (reserved for future use)
 925                 u16 number of fields
 926                 for each field:
 927                         u16 len
 928                         u8[len] field name
 929                         u32 len
 930                         u8[len] field value
 931         */
 932
 933         TOSERVER_REQUEST_MEDIA = 0x40,
 934         /*
 935                 u16 number of files requested
 936                 for each file {
 937                         u16 length of name
 938                         string name
 939                 }
 940         */
 941
 942         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 943         TOSERVER_BREATH = 0x42, // Obsolete
 944
 945         TOSERVER_CLIENT_READY = 0x43,
 946         /*
 947                 u8 major
 948                 u8 minor
 949                 u8 patch
 950                 u8 reserved
 951                 u16 len
 952                 u8[len] full_version_string
 953         */
 954
 955         TOSERVER_FIRST_SRP = 0x50,
 956         /*
 957                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 958
 959                 std::string srp salt
 960                 std::string srp verification key
 961                 u8 is_empty (=1 if password is empty, 0 otherwise)
 962         */
 963
 964         TOSERVER_SRP_BYTES_A = 0x51,
 965         /*
 966                 Belonging to AUTH_MECHANISM_SRP,
 967                         depending on current_login_based_on.
 968
 969                 std::string bytes_A
 970                 u8 current_login_based_on : on which version of the password's
 971                                             hash this login is based on (0 legacy hash,
 972                                             or 1 directly the password)
 973         */
 974
 975         TOSERVER_SRP_BYTES_M = 0x52,
 976         /*
 977                 Belonging to AUTH_MECHANISM_SRP.
 978
 979                 std::string bytes_M
 980         */
 981
 982         TOSERVER_NUM_MSG_TYPES = 0x53,
 983 };
 984
 985 enum AuthMechanism
 986 {
 987         // reserved
 988         AUTH_MECHANISM_NONE = 0,
 989
 990         // SRP based on the legacy hash
 991         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 992
 993         // SRP based on the srp verification key
 994         AUTH_MECHANISM_SRP = 1 << 1,
 995
 996         // Establishes a srp verification key, for first login and password changing
 997         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 998 };
 999
1000 enum AccessDeniedCode {
1001         SERVER_ACCESSDENIED_WRONG_PASSWORD,
1002         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
1003         SERVER_ACCESSDENIED_SINGLEPLAYER,
1004         SERVER_ACCESSDENIED_WRONG_VERSION,
1005         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
1006         SERVER_ACCESSDENIED_WRONG_NAME,
1007         SERVER_ACCESSDENIED_TOO_MANY_USERS,
1008         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
1009         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
1010         SERVER_ACCESSDENIED_SERVER_FAIL,
1011         SERVER_ACCESSDENIED_CUSTOM_STRING,
1012         SERVER_ACCESSDENIED_SHUTDOWN,
1013         SERVER_ACCESSDENIED_CRASH,
1014         SERVER_ACCESSDENIED_MAX,
1015 };
1016
1017 enum NetProtoCompressionMode {
1018         NETPROTO_COMPRESSION_NONE = 0,
1019 };
1020
1021 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1022         "Invalid password",
1023         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
1024         "The server is running in simple singleplayer mode.  You cannot connect.",
1025         "Your client's version is not supported.\nPlease contact server administrator.",
1026         "Player name contains disallowed characters.",
1027         "Player name not allowed.",
1028         "Too many users.",
1029         "Empty passwords are disallowed.  Set a password and try again.",
1030         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
1031         "Server authentication failed.  This is likely a server error.",
1032         "",
1033         "Server shutting down.",
1034         "This server has experienced an internal error. You will now be disconnected."
1035 };
1036
1037 enum PlayerListModifer : u8
1038 {
1039         PLAYER_LIST_INIT,
1040         PLAYER_LIST_ADD,
1041         PLAYER_LIST_REMOVE,
1042 };
1043
1044 enum CSMRestrictionFlags : u64 {
1045         CSM_RF_NONE = 0x00000000,
1046         // Until server-sent CSM and verifying of builtin are complete,
1047         // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
1048         // When those are complete, this should return to only being a restriction on the
1049         // loading of client mods.
1050         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
1051         CSM_RF_CHAT_MESSAGES = 0x00000002,    // Disable chat message sending from CSM
1052         CSM_RF_READ_ITEMDEFS = 0x00000004,    // Disable itemdef lookups
1053         CSM_RF_READ_NODEDEFS = 0x00000008,    // Disable nodedef lookups
1054         CSM_RF_LOOKUP_NODES = 0x00000010,     // Limit node lookups
1055         CSM_RF_READ_PLAYERINFO = 0x00000020,  // Disable player info lookups
1056         CSM_RF_ALL = 0xFFFFFFFF,
1057 };
1058
1059 enum InteractAction : u8
1060 {
1061         INTERACT_START_DIGGING,     // 0: start digging (from undersurface) or use
1062         INTERACT_STOP_DIGGING,      // 1: stop digging (all parameters ignored)
1063         INTERACT_DIGGING_COMPLETED, // 2: digging completed
1064         INTERACT_PLACE,             // 3: place block or item (to abovesurface)
1065         INTERACT_USE,               // 4: use item
1066         INTERACT_ACTIVATE           // 5: rightclick air ("activate")
1067 };