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