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