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