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