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