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                 Minimap modes
 208         PROTOCOL VERSION 40:
 209                 Added 'basic_debug' privilege
 210 */
 211
 212 #define LATEST_PROTOCOL_VERSION 40
 213 #define LATEST_PROTOCOL_VERSION_STRING TOSTRING(LATEST_PROTOCOL_VERSION)
 214
 215 // Server's supported network protocol range
 216 #define SERVER_PROTOCOL_VERSION_MIN 37
 217 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 218
 219 // Client's supported network protocol range
 220 // The minimal version depends on whether
 221 // send_pre_v25_init is enabled or not
 222 #define CLIENT_PROTOCOL_VERSION_MIN 37
 223 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 224
 225 // Constant that differentiates the protocol from random data and other protocols
 226 #define PROTOCOL_ID 0x4f457403
 227
 228 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 229                                // base64-encoded SHA-1 (27+\0).
 230
 231 // See also: Formspec Version History in doc/lua_api.txt
 232 #define FORMSPEC_API_VERSION 4
 233
 234 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 235
 236 typedef u16 session_t;
 237
 238 enum ToClientCommand
 239 {
 240         TOCLIENT_HELLO = 0x02,
 241         /*
 242                 Sent after TOSERVER_INIT.
 243
 244                 u8 deployed serialisation version
 245                 u16 deployed network compression mode
 246                 u16 deployed protocol version
 247                 u32 supported auth methods
 248                 std::string username that should be used for legacy hash (for proper casing)
 249         */
 250         TOCLIENT_AUTH_ACCEPT = 0x03,
 251         /*
 252                 Message from server to accept auth.
 253
 254                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 255                 u64 map seed
 256                 f1000 recommended send interval
 257                 u32 : supported auth methods for sudo mode
 258                       (where the user can change their password)
 259         */
 260         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 261         /*
 262                 Sent to client to show it is in sudo mode now.
 263         */
 264         TOCLIENT_DENY_SUDO_MODE = 0x05,
 265         /*
 266                 Signals client that sudo mode auth failed.
 267         */
 268         TOCLIENT_ACCESS_DENIED = 0x0A,
 269         /*
 270                 u8 reason
 271                 std::string custom reason (if needed, otherwise "")
 272                 u8 (bool) reconnect
 273         */
 274
 275         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 276
 277         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 278         TOCLIENT_ADDNODE = 0x21,
 279         /*
 280                 v3s16 position
 281                 serialized mapnode
 282                 u8 keep_metadata // Added in protocol version 22
 283         */
 284         TOCLIENT_REMOVENODE = 0x22,
 285
 286         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 287         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 288         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 289         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 290
 291         TOCLIENT_INVENTORY = 0x27,
 292         /*
 293                 [0] u16 command
 294                 [2] serialized inventory
 295         */
 296
 297         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 298
 299         TOCLIENT_TIME_OF_DAY = 0x29,
 300         /*
 301                 u16 time (0-23999)
 302                 Added in a later version:
 303                 f1000 time_speed
 304         */
 305
 306         TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
 307         /*
 308                 u32 CSMRestrictionFlags byteflag
 309          */
 310
 311         TOCLIENT_PLAYER_SPEED = 0x2B,
 312         /*
 313                 v3f added_vel
 314          */
 315
 316         TOCLIENT_MEDIA_PUSH = 0x2C,
 317         /*
 318                 std::string raw_hash
 319                 std::string filename
 320                 bool should_be_cached
 321                 u32 len
 322                 char filedata[len]
 323         */
 324
 325         // (oops, there is some gap here)
 326
 327         TOCLIENT_CHAT_MESSAGE = 0x2F,
 328         /*
 329                 u8 version
 330                 u8 message_type
 331                 u16 sendername length
 332                 wstring sendername
 333                 u16 length
 334                 wstring message
 335         */
 336
 337         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 338
 339         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 340         /*
 341                 u16 count of removed objects
 342                 for all removed objects {
 343                         u16 id
 344                 }
 345                 u16 count of added objects
 346                 for all added objects {
 347                         u16 id
 348                         u8 type
 349                         u32 initialization data length
 350                         string initialization data
 351                 }
 352         */
 353
 354         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 355         /*
 356                 for all objects
 357                 {
 358                         u16 id
 359                         u16 message length
 360                         string message
 361                 }
 362         */
 363
 364         TOCLIENT_HP = 0x33,
 365         /*
 366                 u8 hp
 367         */
 368
 369         TOCLIENT_MOVE_PLAYER = 0x34,
 370         /*
 371                 v3f1000 player position
 372                 f1000 player pitch
 373                 f1000 player yaw
 374         */
 375
 376         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 377         /*
 378                 u16 reason_length
 379                 wstring reason
 380         */
 381
 382         TOCLIENT_FOV = 0x36,
 383         /*
 384                 Sends an FOV override/multiplier to client.
 385
 386                 f32 fov
 387                 bool is_multiplier
 388                 f32 transition_time
 389         */
 390
 391         TOCLIENT_DEATHSCREEN = 0x37,
 392         /*
 393                 u8 bool set camera point target
 394                 v3f1000 camera point target (to point the death cause or whatever)
 395         */
 396
 397         TOCLIENT_MEDIA = 0x38,
 398         /*
 399                 u16 total number of texture bunches
 400                 u16 index of this bunch
 401                 u32 number of files in this bunch
 402                 for each file {
 403                         u16 length of name
 404                         string name
 405                         u32 length of data
 406                         data
 407                 }
 408                 u16 length of remote media server url (if applicable)
 409                 string url
 410         */
 411
 412         TOCLIENT_TOOLDEF = 0x39,
 413         /*
 414                 u32 length of the next item
 415                 serialized ToolDefManager
 416         */
 417
 418         TOCLIENT_NODEDEF = 0x3a,
 419         /*
 420                 u32 length of the next item
 421                 serialized NodeDefManager
 422         */
 423
 424         TOCLIENT_CRAFTITEMDEF = 0x3b,
 425         /*
 426                 u32 length of the next item
 427                 serialized CraftiItemDefManager
 428         */
 429
 430         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 431
 432         /*
 433                 u32 number of files
 434                 for each texture {
 435                         u16 length of name
 436                         string name
 437                         u16 length of sha1_digest
 438                         string sha1_digest
 439                 }
 440         */
 441
 442         TOCLIENT_ITEMDEF = 0x3d,
 443         /*
 444                 u32 length of next item
 445                 serialized ItemDefManager
 446         */
 447
 448         TOCLIENT_PLAY_SOUND = 0x3f,
 449         /*
 450                 s32 sound_id
 451                 u16 len
 452                 u8[len] sound name
 453                 s32 gain*1000
 454                 u8 type (0=local, 1=positional, 2=object)
 455                 s32[3] pos_nodes*10000
 456                 u16 object_id
 457                 u8 loop (bool)
 458                 u8 ephemeral (bool)
 459         */
 460
 461         TOCLIENT_STOP_SOUND = 0x40,
 462         /*
 463                 s32 sound_id
 464         */
 465
 466         TOCLIENT_PRIVILEGES = 0x41,
 467         /*
 468                 u16 number of privileges
 469                 for each privilege
 470                         u16 len
 471                         u8[len] privilege
 472         */
 473
 474         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 475         /*
 476                 u32 len
 477                 u8[len] formspec
 478         */
 479
 480         TOCLIENT_DETACHED_INVENTORY = 0x43,
 481         /*
 482                 [0] u16 command
 483                 u16 len
 484                 u8[len] name
 485                 [2] serialized inventory
 486         */
 487
 488         TOCLIENT_SHOW_FORMSPEC = 0x44,
 489         /*
 490                 [0] u16 command
 491                 u32 len
 492                 u8[len] formspec
 493                 u16 len
 494                 u8[len] formname
 495         */
 496
 497         TOCLIENT_MOVEMENT = 0x45,
 498         /*
 499                 f1000 movement_acceleration_default
 500                 f1000 movement_acceleration_air
 501                 f1000 movement_acceleration_fast
 502                 f1000 movement_speed_walk
 503                 f1000 movement_speed_crouch
 504                 f1000 movement_speed_fast
 505                 f1000 movement_speed_climb
 506                 f1000 movement_speed_jump
 507                 f1000 movement_liquid_fluidity
 508                 f1000 movement_liquid_fluidity_smooth
 509                 f1000 movement_liquid_sink
 510                 f1000 movement_gravity
 511         */
 512
 513         TOCLIENT_SPAWN_PARTICLE = 0x46,
 514         /*
 515                 v3f1000 pos
 516                 v3f1000 velocity
 517                 v3f1000 acceleration
 518                 f1000 expirationtime
 519                 f1000 size
 520                 u8 bool collisiondetection
 521                 u32 len
 522                 u8[len] texture
 523                 u8 bool vertical
 524                 u8 collision_removal
 525                 TileAnimation animation
 526                 u8 glow
 527                 u8 object_collision
 528         */
 529
 530         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 531         /*
 532                 u16 amount
 533                 f1000 spawntime
 534                 v3f1000 minpos
 535                 v3f1000 maxpos
 536                 v3f1000 minvel
 537                 v3f1000 maxvel
 538                 v3f1000 minacc
 539                 v3f1000 maxacc
 540                 f1000 minexptime
 541                 f1000 maxexptime
 542                 f1000 minsize
 543                 f1000 maxsize
 544                 u8 bool collisiondetection
 545                 u32 len
 546                 u8[len] texture
 547                 u8 bool vertical
 548                 u8 collision_removal
 549                 u32 id
 550                 TileAnimation animation
 551                 u8 glow
 552                 u8 object_collision
 553         */
 554
 555         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 556
 557         TOCLIENT_HUDADD = 0x49,
 558         /*
 559                 u32 id
 560                 u8 type
 561                 v2f1000 pos
 562                 u16 len
 563                 u8[len] name
 564                 v2f1000 scale
 565                 u16 len2
 566                 u8[len2] text
 567                 u32 number
 568                 u32 item
 569                 u32 dir
 570                 v2f1000 align
 571                 v2f1000 offset
 572                 v3f1000 world_pos
 573                 v2s32 size
 574                 s16 z_index
 575                 u16 len3
 576                 u8[len3] text2
 577         */
 578
 579         TOCLIENT_HUDRM = 0x4a,
 580         /*
 581                 u32 id
 582         */
 583
 584         TOCLIENT_HUDCHANGE = 0x4b,
 585         /*
 586                 u32 id
 587                 u8 stat
 588                 [v2f1000 data |
 589                  u32 len
 590                  u8[len] data |
 591                  u32 data]
 592         */
 593
 594         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 595         /*
 596                 u32 flags
 597                 u32 mask
 598         */
 599
 600         TOCLIENT_HUD_SET_PARAM = 0x4d,
 601         /*
 602                 u16 param
 603                 u16 len
 604                 u8[len] value
 605         */
 606
 607         TOCLIENT_BREATH = 0x4e,
 608         /*
 609                 u16 breath
 610         */
 611
 612         TOCLIENT_SET_SKY = 0x4f,
 613         /*
 614                 Protocol 38:
 615                 u8[4] base_color (ARGB)
 616                 u8 len
 617                 u8[len] type
 618                 u16 count
 619                 foreach count:
 620                         u8 len
 621                         u8[len] param
 622                 u8 clouds (boolean)
 623
 624                 Protocol 39:
 625                 u8[4] bgcolor (ARGB)
 626                 std::string type
 627                 int texture_count
 628                 std::string[6] param
 629                 bool clouds
 630                 bool bgcolor_fog
 631                 u8[4] day_sky (ARGB)
 632                 u8[4] day_horizon (ARGB)
 633                 u8[4] dawn_sky (ARGB)
 634                 u8[4] dawn_horizon (ARGB)
 635                 u8[4] night_sky (ARGB)
 636                 u8[4] night_horizon (ARGB)
 637                 u8[4] indoors (ARGB)
 638                 u8[4] fog_sun_tint (ARGB)
 639                 u8[4] fog_moon_tint (ARGB)
 640                 std::string fog_tint_type
 641         */
 642
 643         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 644         /*
 645                 u8 do_override (boolean)
 646                 u16 day-night ratio 0...65535
 647         */
 648
 649         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 650         /*
 651                 v2s32 stand/idle
 652                 v2s32 walk
 653                 v2s32 dig
 654                 v2s32 walk+dig
 655                 f1000 frame_speed
 656         */
 657
 658         TOCLIENT_EYE_OFFSET = 0x52,
 659         /*
 660                 v3f1000 first
 661                 v3f1000 third
 662         */
 663
 664         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 665         /*
 666                 u32 id
 667         */
 668
 669         TOCLIENT_CLOUD_PARAMS = 0x54,
 670         /*
 671                 f1000 density
 672                 u8[4] color_diffuse (ARGB)
 673                 u8[4] color_ambient (ARGB)
 674                 f1000 height
 675                 f1000 thickness
 676                 v2f1000 speed
 677         */
 678
 679         TOCLIENT_FADE_SOUND = 0x55,
 680         /*
 681                 s32 sound_id
 682                 float step
 683                 float gain
 684         */
 685         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 686         /*
 687                 u8 type
 688                 u16 number of players
 689                 for each player
 690                         u16 len
 691                         u8[len] player name
 692         */
 693
 694         TOCLIENT_MODCHANNEL_MSG = 0x57,
 695         /*
 696                 u16 channel name length
 697                 std::string channel name
 698                 u16 channel name sender
 699                 std::string channel name
 700                 u16 message length
 701                 std::string message
 702         */
 703
 704         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 705         /*
 706                 u8 signal id
 707                 u16 channel name length
 708                 std::string channel name
 709         */
 710
 711         TOCLIENT_NODEMETA_CHANGED = 0x59,
 712         /*
 713                 serialized and compressed node metadata
 714         */
 715
 716         TOCLIENT_SET_SUN = 0x5a,
 717         /*
 718                 bool visible
 719                 std::string texture
 720                 std::string tonemap
 721                 std::string sunrise
 722                 f32 scale
 723         */
 724
 725         TOCLIENT_SET_MOON = 0x5b,
 726         /*
 727                 bool visible
 728                 std::string texture
 729                 std::string tonemap
 730                 f32 scale
 731         */
 732
 733         TOCLIENT_SET_STARS = 0x5c,
 734         /*
 735                 bool visible
 736                 u32 count
 737                 u8[4] starcolor (ARGB)
 738                 f32 scale
 739         */
 740
 741         TOCLIENT_SRP_BYTES_S_B = 0x60,
 742         /*
 743                 Belonging to AUTH_MECHANISM_SRP.
 744
 745                 std::string bytes_s
 746                 std::string bytes_B
 747         */
 748
 749         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 750         /*
 751                 u16 len
 752                 u8[len] formspec
 753         */
 754
 755         TOCLIENT_MINIMAP_MODES = 0x62,
 756         /*
 757                 u16 count // modes
 758                 u16 mode  // wanted current mode index after change
 759                 for each mode
 760                         u16 type
 761                         std::string label
 762                         u16 size
 763                         std::string extra
 764         */
 765
 766         TOCLIENT_NUM_MSG_TYPES = 0x63,
 767 };
 768
 769 enum ToServerCommand
 770 {
 771         TOSERVER_INIT = 0x02,
 772         /*
 773                 Sent first after connected.
 774
 775                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 776                 u16 supported network compression modes
 777                 u16 minimum supported network protocol version
 778                 u16 maximum supported network protocol version
 779                 std::string player name
 780         */
 781
 782         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 783
 784         TOSERVER_INIT2 = 0x11,
 785         /*
 786                 Sent as an ACK for TOCLIENT_INIT.
 787                 After this, the server can send data.
 788
 789                 [0] u16 TOSERVER_INIT2
 790         */
 791
 792         TOSERVER_MODCHANNEL_JOIN = 0x17,
 793         /*
 794                 u16 channel name length
 795                 std::string channel name
 796          */
 797
 798         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 799         /*
 800                 u16 channel name length
 801                 std::string channel name
 802          */
 803
 804         TOSERVER_MODCHANNEL_MSG = 0x19,
 805         /*
 806                 u16 channel name length
 807                 std::string channel name
 808                 u16 message length
 809                 std::string message
 810          */
 811
 812         TOSERVER_GETBLOCK = 0x20, // Obsolete
 813         TOSERVER_ADDNODE = 0x21, // Obsolete
 814         TOSERVER_REMOVENODE = 0x22, // Obsolete
 815
 816         TOSERVER_PLAYERPOS = 0x23,
 817         /*
 818                 [0] u16 command
 819                 [2] v3s32 position*100
 820                 [2+12] v3s32 speed*100
 821                 [2+12+12] s32 pitch*100
 822                 [2+12+12+4] s32 yaw*100
 823                 [2+12+12+4+4] u32 keyPressed
 824                 [2+12+12+4+4+1] u8 fov*80
 825                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 826         */
 827
 828         TOSERVER_GOTBLOCKS = 0x24,
 829         /*
 830                 [0] u16 command
 831                 [2] u8 count
 832                 [3] v3s16 pos_0
 833                 [3+6] v3s16 pos_1
 834                 ...
 835         */
 836
 837         TOSERVER_DELETEDBLOCKS = 0x25,
 838         /*
 839                 [0] u16 command
 840                 [2] u8 count
 841                 [3] v3s16 pos_0
 842                 [3+6] v3s16 pos_1
 843                 ...
 844         */
 845
 846         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 847         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 848         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 849         TOSERVER_RELEASE = 0x29, // Obsolete
 850         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 851
 852         TOSERVER_INVENTORY_ACTION = 0x31,
 853         /*
 854                 See InventoryAction in inventorymanager.h
 855         */
 856
 857         TOSERVER_CHAT_MESSAGE = 0x32,
 858         /*
 859                 u16 length
 860                 wstring message
 861         */
 862
 863         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 864         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 865
 866         TOSERVER_DAMAGE = 0x35,
 867         /*
 868                 u8 amount
 869         */
 870
 871         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 872
 873         TOSERVER_PLAYERITEM = 0x37,
 874         /*
 875                 Sent to change selected item.
 876
 877                 [0] u16 TOSERVER_PLAYERITEM
 878                 [2] u16 item
 879         */
 880
 881         TOSERVER_RESPAWN = 0x38,
 882         /*
 883                 u16 TOSERVER_RESPAWN
 884         */
 885
 886         TOSERVER_INTERACT = 0x39,
 887         /*
 888                 [0] u16 command
 889                 [2] u8 action
 890                 [3] u16 item
 891                 [5] u32 length of the next item
 892                 [9] serialized PointedThing
 893                 actions:
 894                 0: start digging (from undersurface) or use
 895                 1: stop digging (all parameters ignored)
 896                 2: digging completed
 897                 3: place block or item (to abovesurface)
 898                 4: use item
 899         */
 900
 901         TOSERVER_REMOVED_SOUNDS = 0x3a,
 902         /*
 903                 u16 len
 904                 s32[len] sound_id
 905         */
 906
 907         TOSERVER_NODEMETA_FIELDS = 0x3b,
 908         /*
 909                 v3s16 p
 910                 u16 len
 911                 u8[len] form name (reserved for future use)
 912                 u16 number of fields
 913                 for each field:
 914                         u16 len
 915                         u8[len] field name
 916                         u32 len
 917                         u8[len] field value
 918         */
 919
 920         TOSERVER_INVENTORY_FIELDS = 0x3c,
 921         /*
 922                 u16 len
 923                 u8[len] form name (reserved for future use)
 924                 u16 number of fields
 925                 for each field:
 926                         u16 len
 927                         u8[len] field name
 928                         u32 len
 929                         u8[len] field value
 930         */
 931
 932         TOSERVER_REQUEST_MEDIA = 0x40,
 933         /*
 934                 u16 number of files requested
 935                 for each file {
 936                         u16 length of name
 937                         string name
 938                 }
 939         */
 940
 941         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 942         TOSERVER_BREATH = 0x42, // Obsolete
 943
 944         TOSERVER_CLIENT_READY = 0x43,
 945         /*
 946                 u8 major
 947                 u8 minor
 948                 u8 patch
 949                 u8 reserved
 950                 u16 len
 951                 u8[len] full_version_string
 952         */
 953
 954         TOSERVER_FIRST_SRP = 0x50,
 955         /*
 956                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 957
 958                 std::string srp salt
 959                 std::string srp verification key
 960                 u8 is_empty (=1 if password is empty, 0 otherwise)
 961         */
 962
 963         TOSERVER_SRP_BYTES_A = 0x51,
 964         /*
 965                 Belonging to AUTH_MECHANISM_SRP,
 966                         depending on current_login_based_on.
 967
 968                 std::string bytes_A
 969                 u8 current_login_based_on : on which version of the password's
 970                                             hash this login is based on (0 legacy hash,
 971                                             or 1 directly the password)
 972         */
 973
 974         TOSERVER_SRP_BYTES_M = 0x52,
 975         /*
 976                 Belonging to AUTH_MECHANISM_SRP.
 977
 978                 std::string bytes_M
 979         */
 980
 981         TOSERVER_NUM_MSG_TYPES = 0x53,
 982 };
 983
 984 enum AuthMechanism
 985 {
 986         // reserved
 987         AUTH_MECHANISM_NONE = 0,
 988
 989         // SRP based on the legacy hash
 990         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 991
 992         // SRP based on the srp verification key
 993         AUTH_MECHANISM_SRP = 1 << 1,
 994
 995         // Establishes a srp verification key, for first login and password changing
 996         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 997 };
 998
 999 enum AccessDeniedCode {
1000         SERVER_ACCESSDENIED_WRONG_PASSWORD,
1001         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
1002         SERVER_ACCESSDENIED_SINGLEPLAYER,
1003         SERVER_ACCESSDENIED_WRONG_VERSION,
1004         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
1005         SERVER_ACCESSDENIED_WRONG_NAME,
1006         SERVER_ACCESSDENIED_TOO_MANY_USERS,
1007         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
1008         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
1009         SERVER_ACCESSDENIED_SERVER_FAIL,
1010         SERVER_ACCESSDENIED_CUSTOM_STRING,
1011         SERVER_ACCESSDENIED_SHUTDOWN,
1012         SERVER_ACCESSDENIED_CRASH,
1013         SERVER_ACCESSDENIED_MAX,
1014 };
1015
1016 enum NetProtoCompressionMode {
1017         NETPROTO_COMPRESSION_NONE = 0,
1018 };
1019
1020 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1021         "Invalid password",
1022         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
1023         "The server is running in simple singleplayer mode.  You cannot connect.",
1024         "Your client's version is not supported.\nPlease contact server administrator.",
1025         "Player name contains disallowed characters.",
1026         "Player name not allowed.",
1027         "Too many users.",
1028         "Empty passwords are disallowed.  Set a password and try again.",
1029         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
1030         "Server authentication failed.  This is likely a server error.",
1031         "",
1032         "Server shutting down.",
1033         "This server has experienced an internal error. You will now be disconnected."
1034 };
1035
1036 enum PlayerListModifer : u8
1037 {
1038         PLAYER_LIST_INIT,
1039         PLAYER_LIST_ADD,
1040         PLAYER_LIST_REMOVE,
1041 };
1042
1043 enum CSMRestrictionFlags : u64 {
1044         CSM_RF_NONE = 0x00000000,
1045         // Until server-sent CSM and verifying of builtin are complete,
1046         // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
1047         // When those are complete, this should return to only being a restriction on the
1048         // loading of client mods.
1049         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
1050         CSM_RF_CHAT_MESSAGES = 0x00000002,    // Disable chat message sending from CSM
1051         CSM_RF_READ_ITEMDEFS = 0x00000004,    // Disable itemdef lookups
1052         CSM_RF_READ_NODEDEFS = 0x00000008,    // Disable nodedef lookups
1053         CSM_RF_LOOKUP_NODES = 0x00000010,     // Limit node lookups
1054         CSM_RF_READ_PLAYERINFO = 0x00000020,  // Disable player info lookups
1055         CSM_RF_ALL = 0xFFFFFFFF,
1056 };
1057
1058 enum InteractAction : u8
1059 {
1060         INTERACT_START_DIGGING,     // 0: start digging (from undersurface) or use
1061         INTERACT_STOP_DIGGING,      // 1: stop digging (all parameters ignored)
1062         INTERACT_DIGGING_COMPLETED, // 2: digging completed
1063         INTERACT_PLACE,             // 3: place block or item (to abovesurface)
1064         INTERACT_USE,               // 4: use item
1065         INTERACT_ACTIVATE           // 5: rightclick air ("activate")
1066 };