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