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 #ifndef NETWORKPROTOCOL_HEADER
  21 #define NETWORKPROTOCOL_HEADER
  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         PROTOCOL_VERSION 10:
  54                 TOCLIENT_PRIVILEGES
  55                 Version raised to force 'fly' and 'fast' privileges into effect.
  56                 Node metadata change (came in later; somewhat incompatible)
  57         PROTOCOL_VERSION 11:
  58                 TileDef in ContentFeatures
  59                 Nodebox drawtype
  60                 (some dev snapshot)
  61                 TOCLIENT_INVENTORY_FORMSPEC
  62                 (0.4.0, 0.4.1)
  63         PROTOCOL_VERSION 12:
  64                 TOSERVER_INVENTORY_FIELDS
  65                 16-bit node ids
  66                 TOCLIENT_DETACHED_INVENTORY
  67         PROTOCOL_VERSION 13:
  68                 InventoryList field "Width" (deserialization fails with old versions)
  69         PROTOCOL_VERSION 14:
  70                 Added transfer of player pressed keys to the server
  71                 Added new messages for mesh and bone animation, as well as attachments
  72                 GENERIC_CMD_SET_ANIMATION
  73                 GENERIC_CMD_SET_BONE_POSITION
  74                 GENERIC_CMD_SET_ATTACHMENT
  75         PROTOCOL_VERSION 15:
  76                 Serialization format changes
  77         PROTOCOL_VERSION 16:
  78                 TOCLIENT_SHOW_FORMSPEC
  79         PROTOCOL_VERSION 17:
  80                 Serialization format change: include backface_culling flag in TileDef
  81                 Added rightclickable field in nodedef
  82                 TOCLIENT_SPAWN_PARTICLE
  83                 TOCLIENT_ADD_PARTICLESPAWNER
  84                 TOCLIENT_DELETE_PARTICLESPAWNER
  85         PROTOCOL_VERSION 18:
  86                 damageGroups added to ToolCapabilities
  87                 sound_place added to ItemDefinition
  88         PROTOCOL_VERSION 19:
  89                 GENERIC_CMD_SET_PHYSICS_OVERRIDE
  90         PROTOCOL_VERSION 20:
  91                 TOCLIENT_HUDADD
  92                 TOCLIENT_HUDRM
  93                 TOCLIENT_HUDCHANGE
  94                 TOCLIENT_HUD_SET_FLAGS
  95         PROTOCOL_VERSION 21:
  96                 TOCLIENT_BREATH
  97                 TOSERVER_BREATH
  98                 range added to ItemDefinition
  99                 drowning, leveled and liquid_range added to ContentFeatures
 100                 stepheight and collideWithObjects added to object properties
 101                 version, heat and humidity transfer in MapBock
 102                 automatic_face_movement_dir and automatic_face_movement_dir_offset
 103                         added to object properties
 104         PROTOCOL_VERSION 22:
 105                 add swap_node
 106         PROTOCOL_VERSION 23:
 107                 TOSERVER_CLIENT_READY
 108         PROTOCOL_VERSION 24:
 109                 ContentFeatures version 7
 110                 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
 111         PROTOCOL_VERSION 25:
 112                 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
 113                 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
 114                         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
 115                 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
 116                 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
 117                 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
 118                 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
 119                         for standard error, keeping customisation possible. This
 120                         permit translation
 121                 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
 122                         reading u32
 123                 Add new opcode TOSERVER_INIT for client presentation to server
 124                 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
 125                         TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
 126                         for the three supported auth mechanisms around srp
 127                 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
 128                         for sudo mode handling (auth mech generic way of changing password).
 129                 Add TOCLIENT_HELLO for presenting server to client after client
 130                         presentation
 131                 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
 132                 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
 133         PROTOCOL_VERSION 26:
 134                 Add TileDef tileable_horizontal, tileable_vertical flags
 135         PROTOCOL_VERSION 27:
 136                 backface_culling: backwards compatibility for playing with
 137                 newer client on pre-27 servers.
 138                 Add nodedef v3 - connected nodeboxes
 139         PROTOCOL_VERSION 28:
 140                 CPT2_MESHOPTIONS
 141         PROTOCOL_VERSION 29:
 142                 Server doesn't accept TOSERVER_BREATH anymore
 143                 serialization of TileAnimation params changed
 144                 TAT_SHEET_2D
 145                 Removed client-sided chat perdiction
 146         PROTOCOL VERSION 30:
 147                 New ContentFeatures serialization version
 148                 Add node and tile color and palette
 149                 Fix plantlike visual_scale being applied squared and add compatibility
 150                         with pre-30 clients by sending sqrt(visual_scale)
 151         PROTOCOL VERSION 31:
 152                 Add tile overlay
 153 */
 154
 155 #define LATEST_PROTOCOL_VERSION 31
 156
 157 // Server's supported network protocol range
 158 #define SERVER_PROTOCOL_VERSION_MIN 24
 159 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 160
 161 // Client's supported network protocol range
 162 // The minimal version depends on whether
 163 // send_pre_v25_init is enabled or not
 164 #define CLIENT_PROTOCOL_VERSION_MIN 25
 165 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
 166 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 167
 168 // Constant that differentiates the protocol from random data and other protocols
 169 #define PROTOCOL_ID 0x4f457403
 170
 171 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 172                                // base64-encoded SHA-1 (27+\0).
 173
 174 #define FORMSPEC_API_VERSION 1
 175 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
 176
 177 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 178
 179 enum ToClientCommand
 180 {
 181         TOCLIENT_HELLO = 0x02,
 182         /*
 183                 Sent after TOSERVER_INIT.
 184
 185                 u8 deployed serialisation version
 186                 u16 deployed network compression mode
 187                 u16 deployed protocol version
 188                 u32 supported auth methods
 189                 std::string username that should be used for legacy hash (for proper casing)
 190         */
 191         TOCLIENT_AUTH_ACCEPT = 0x03,
 192         /*
 193                 Message from server to accept auth.
 194
 195                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 196                 u64 map seed
 197                 f1000 recommended send interval
 198                 u32 : supported auth methods for sudo mode
 199                       (where the user can change their password)
 200         */
 201         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 202         /*
 203                 Sent to client to show it is in sudo mode now.
 204         */
 205         TOCLIENT_DENY_SUDO_MODE = 0x05,
 206         /*
 207                 Signals client that sudo mode auth failed.
 208         */
 209         TOCLIENT_INIT_LEGACY = 0x10,
 210         /*
 211                 Server's reply to TOSERVER_INIT.
 212                 Sent second after connected.
 213
 214                 [0] u16 TOSERVER_INIT
 215                 [2] u8 deployed version
 216                 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 217                 [12] u64 map seed (new as of 2011-02-27)
 218                 [20] f1000 recommended send interval (in seconds) (new as of 14)
 219
 220                 NOTE: The position in here is deprecated; position is
 221                       explicitly sent afterwards
 222         */
 223         TOCLIENT_ACCESS_DENIED = 0x0A,
 224         /*
 225                 u8 reason
 226                 std::string custom reason (if needed, otherwise "")
 227                 u8 (bool) reconnect
 228         */
 229         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 230         TOCLIENT_ADDNODE = 0x21,
 231         /*
 232                 v3s16 position
 233                 serialized mapnode
 234                 u8 keep_metadata // Added in protocol version 22
 235         */
 236         TOCLIENT_REMOVENODE = 0x22,
 237
 238         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 239         /*
 240                 [0] u16 command
 241                 // Followed by an arbitary number of these:
 242                 // Number is determined from packet length.
 243                 [N] u16 peer_id
 244                 [N+2] v3s32 position*100
 245                 [N+2+12] v3s32 speed*100
 246                 [N+2+12+12] s32 pitch*100
 247                 [N+2+12+12+4] s32 yaw*100
 248         */
 249
 250         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 251         /*
 252                 [0] u16 command
 253                 // Followed by an arbitary number of these:
 254                 // Number is determined from packet length.
 255                 [N] u16 peer_id
 256                 [N] char[20] name
 257         */
 258
 259         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 260
 261         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 262         /*
 263                 [0] u16 command
 264                 [2] u8 sector count
 265                 [3...] v2s16 pos + sector metadata
 266         */
 267
 268         TOCLIENT_INVENTORY = 0x27,
 269         /*
 270                 [0] u16 command
 271                 [2] serialized inventory
 272         */
 273
 274         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 275         /*
 276                 Sent as unreliable.
 277
 278                 u16 number of player positions
 279                 for each player:
 280                         u16 peer_id
 281                         v3s32 position*100
 282                         v3s32 speed*100
 283                         s32 pitch*100
 284                         s32 yaw*100
 285                 u16 count of blocks
 286                 for each block:
 287                         v3s16 blockpos
 288                         block objects
 289         */
 290
 291         TOCLIENT_TIME_OF_DAY = 0x29,
 292         /*
 293                 u16 time (0-23999)
 294                 Added in a later version:
 295                 f1000 time_speed
 296         */
 297
 298         // (oops, there is some gap here)
 299
 300         TOCLIENT_CHAT_MESSAGE = 0x30,
 301         /*
 302                 u16 length
 303                 wstring message
 304         */
 305
 306         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 307         /*
 308                 u16 count of removed objects
 309                 for all removed objects {
 310                         u16 id
 311                 }
 312                 u16 count of added objects
 313                 for all added objects {
 314                         u16 id
 315                         u8 type
 316                         u32 initialization data length
 317                         string initialization data
 318                 }
 319         */
 320
 321         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 322         /*
 323                 for all objects
 324                 {
 325                         u16 id
 326                         u16 message length
 327                         string message
 328                 }
 329         */
 330
 331         TOCLIENT_HP = 0x33,
 332         /*
 333                 u8 hp
 334         */
 335
 336         TOCLIENT_MOVE_PLAYER = 0x34,
 337         /*
 338                 v3f1000 player position
 339                 f1000 player pitch
 340                 f1000 player yaw
 341         */
 342
 343         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 344         /*
 345                 u16 reason_length
 346                 wstring reason
 347         */
 348
 349         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
 350         /*
 351                 u16 count of player items
 352                 for all player items {
 353                         u16 peer id
 354                         u16 length of serialized item
 355                         string serialized item
 356                 }
 357         */
 358
 359         TOCLIENT_DEATHSCREEN = 0x37,
 360         /*
 361                 u8 bool set camera point target
 362                 v3f1000 camera point target (to point the death cause or whatever)
 363         */
 364
 365         TOCLIENT_MEDIA = 0x38,
 366         /*
 367                 u16 total number of texture bunches
 368                 u16 index of this bunch
 369                 u32 number of files in this bunch
 370                 for each file {
 371                         u16 length of name
 372                         string name
 373                         u32 length of data
 374                         data
 375                 }
 376                 u16 length of remote media server url (if applicable)
 377                 string url
 378         */
 379
 380         TOCLIENT_TOOLDEF = 0x39,
 381         /*
 382                 u32 length of the next item
 383                 serialized ToolDefManager
 384         */
 385
 386         TOCLIENT_NODEDEF = 0x3a,
 387         /*
 388                 u32 length of the next item
 389                 serialized NodeDefManager
 390         */
 391
 392         TOCLIENT_CRAFTITEMDEF = 0x3b,
 393         /*
 394                 u32 length of the next item
 395                 serialized CraftiItemDefManager
 396         */
 397
 398         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 399
 400         /*
 401                 u32 number of files
 402                 for each texture {
 403                         u16 length of name
 404                         string name
 405                         u16 length of sha1_digest
 406                         string sha1_digest
 407                 }
 408         */
 409
 410         TOCLIENT_ITEMDEF = 0x3d,
 411         /*
 412                 u32 length of next item
 413                 serialized ItemDefManager
 414         */
 415
 416         TOCLIENT_PLAY_SOUND = 0x3f,
 417         /*
 418                 s32 sound_id
 419                 u16 len
 420                 u8[len] sound name
 421                 s32 gain*1000
 422                 u8 type (0=local, 1=positional, 2=object)
 423                 s32[3] pos_nodes*10000
 424                 u16 object_id
 425                 u8 loop (bool)
 426         */
 427
 428         TOCLIENT_STOP_SOUND = 0x40,
 429         /*
 430                 s32 sound_id
 431         */
 432
 433         TOCLIENT_PRIVILEGES = 0x41,
 434         /*
 435                 u16 number of privileges
 436                 for each privilege
 437                         u16 len
 438                         u8[len] privilege
 439         */
 440
 441         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 442         /*
 443                 u32 len
 444                 u8[len] formspec
 445         */
 446
 447         TOCLIENT_DETACHED_INVENTORY = 0x43,
 448         /*
 449                 [0] u16 command
 450                 u16 len
 451                 u8[len] name
 452                 [2] serialized inventory
 453         */
 454
 455         TOCLIENT_SHOW_FORMSPEC = 0x44,
 456         /*
 457                 [0] u16 command
 458                 u32 len
 459                 u8[len] formspec
 460                 u16 len
 461                 u8[len] formname
 462         */
 463
 464         TOCLIENT_MOVEMENT = 0x45,
 465         /*
 466                 f1000 movement_acceleration_default
 467                 f1000 movement_acceleration_air
 468                 f1000 movement_acceleration_fast
 469                 f1000 movement_speed_walk
 470                 f1000 movement_speed_crouch
 471                 f1000 movement_speed_fast
 472                 f1000 movement_speed_climb
 473                 f1000 movement_speed_jump
 474                 f1000 movement_liquid_fluidity
 475                 f1000 movement_liquid_fluidity_smooth
 476                 f1000 movement_liquid_sink
 477                 f1000 movement_gravity
 478         */
 479
 480         TOCLIENT_SPAWN_PARTICLE = 0x46,
 481         /*
 482                 v3f1000 pos
 483                 v3f1000 velocity
 484                 v3f1000 acceleration
 485                 f1000 expirationtime
 486                 f1000 size
 487                 u8 bool collisiondetection
 488                 u8 bool vertical
 489                 u32 len
 490                 u8[len] texture
 491                 u8 collision_removal
 492         */
 493
 494         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 495         /*
 496                 u16 amount
 497                 f1000 spawntime
 498                 v3f1000 minpos
 499                 v3f1000 maxpos
 500                 v3f1000 minvel
 501                 v3f1000 maxvel
 502                 v3f1000 minacc
 503                 v3f1000 maxacc
 504                 f1000 minexptime
 505                 f1000 maxexptime
 506                 f1000 minsize
 507                 f1000 maxsize
 508                 u8 bool collisiondetection
 509                 u8 bool vertical
 510                 u32 len
 511                 u8[len] texture
 512                 u32 id
 513                 u8 collision_removal
 514         */
 515
 516         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
 517         /*
 518                 u16 id
 519         */
 520
 521         TOCLIENT_HUDADD = 0x49,
 522         /*
 523                 u32 id
 524                 u8 type
 525                 v2f1000 pos
 526                 u32 len
 527                 u8[len] name
 528                 v2f1000 scale
 529                 u32 len2
 530                 u8[len2] text
 531                 u32 number
 532                 u32 item
 533                 u32 dir
 534                 v2f1000 align
 535                 v2f1000 offset
 536                 v3f1000 world_pos
 537                 v2s32 size
 538         */
 539
 540         TOCLIENT_HUDRM = 0x4a,
 541         /*
 542                 u32 id
 543         */
 544
 545         TOCLIENT_HUDCHANGE = 0x4b,
 546         /*
 547                 u32 id
 548                 u8 stat
 549                 [v2f1000 data |
 550                  u32 len
 551                  u8[len] data |
 552                  u32 data]
 553         */
 554
 555         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 556         /*
 557                 u32 flags
 558                 u32 mask
 559         */
 560
 561         TOCLIENT_HUD_SET_PARAM = 0x4d,
 562         /*
 563                 u16 param
 564                 u16 len
 565                 u8[len] value
 566         */
 567
 568         TOCLIENT_BREATH = 0x4e,
 569         /*
 570                 u16 breath
 571         */
 572
 573         TOCLIENT_SET_SKY = 0x4f,
 574         /*
 575                 u8[4] color (ARGB)
 576                 u8 len
 577                 u8[len] type
 578                 u16 count
 579                 foreach count:
 580                         u8 len
 581                         u8[len] param
 582         */
 583
 584         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 585         /*
 586                 u8 do_override (boolean)
 587                 u16 day-night ratio 0...65535
 588         */
 589
 590         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 591         /*
 592                 v2s32 stand/idle
 593                 v2s32 walk
 594                 v2s32 dig
 595                 v2s32 walk+dig
 596                 f1000 frame_speed
 597         */
 598
 599         TOCLIENT_EYE_OFFSET = 0x52,
 600         /*
 601                 v3f1000 first
 602                 v3f1000 third
 603         */
 604
 605         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 606         /*
 607                 u32 id
 608         */
 609
 610         TOCLIENT_SRP_BYTES_S_B = 0x60,
 611         /*
 612                 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
 613
 614                 std::string bytes_s
 615                 std::string bytes_B
 616         */
 617
 618         TOCLIENT_NUM_MSG_TYPES = 0x61,
 619 };
 620
 621 enum ToServerCommand
 622 {
 623         TOSERVER_INIT = 0x02,
 624         /*
 625                 Sent first after connected.
 626
 627                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 628                 u16 supported network compression modes
 629                 u16 minimum supported network protocol version
 630                 u16 maximum supported network protocol version
 631                 std::string player name
 632         */
 633
 634         TOSERVER_INIT_LEGACY = 0x10,
 635         /*
 636                 Sent first after connected.
 637
 638                 [0] u16 TOSERVER_INIT_LEGACY
 639                 [2] u8 SER_FMT_VER_HIGHEST_READ
 640                 [3] u8[20] player_name
 641                 [23] u8[28] password (new in some version)
 642                 [51] u16 minimum supported network protocol version (added sometime)
 643                 [53] u16 maximum supported network protocol version (added later than the previous one)
 644         */
 645
 646         TOSERVER_INIT2 = 0x11,
 647         /*
 648                 Sent as an ACK for TOCLIENT_INIT.
 649                 After this, the server can send data.
 650
 651                 [0] u16 TOSERVER_INIT2
 652         */
 653
 654         TOSERVER_GETBLOCK=0x20, // Obsolete
 655         TOSERVER_ADDNODE = 0x21, // Obsolete
 656         TOSERVER_REMOVENODE = 0x22, // Obsolete
 657
 658         TOSERVER_PLAYERPOS = 0x23,
 659         /*
 660                 [0] u16 command
 661                 [2] v3s32 position*100
 662                 [2+12] v3s32 speed*100
 663                 [2+12+12] s32 pitch*100
 664                 [2+12+12+4] s32 yaw*100
 665                 [2+12+12+4+4] u32 keyPressed
 666                 [2+12+12+4+4+1] u8 fov*80
 667                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 668         */
 669
 670         TOSERVER_GOTBLOCKS = 0x24,
 671         /*
 672                 [0] u16 command
 673                 [2] u8 count
 674                 [3] v3s16 pos_0
 675                 [3+6] v3s16 pos_1
 676                 ...
 677         */
 678
 679         TOSERVER_DELETEDBLOCKS = 0x25,
 680         /*
 681                 [0] u16 command
 682                 [2] u8 count
 683                 [3] v3s16 pos_0
 684                 [3+6] v3s16 pos_1
 685                 ...
 686         */
 687
 688         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 689         /*
 690                 [0] u16 command
 691                 [2] v3s16 pos
 692                 [8] u16 i
 693         */
 694
 695         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 696         /*
 697                 length: 13
 698                 [0] u16 command
 699                 [2] u8 button (0=left, 1=right)
 700                 [3] v3s16 blockpos
 701                 [9] s16 id
 702                 [11] u16 item
 703         */
 704
 705         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 706         /*
 707                 length: 17
 708                 [0] u16 command
 709                 [2] u8 action
 710                 [3] v3s16 nodepos_undersurface
 711                 [9] v3s16 nodepos_abovesurface
 712                 [15] u16 item
 713                 actions:
 714                 0: start digging (from undersurface)
 715                 1: place block (to abovesurface)
 716                 2: stop digging (all parameters ignored)
 717                 3: digging completed
 718         */
 719
 720         TOSERVER_RELEASE = 0x29, // Obsolete
 721
 722         // (oops, there is some gap here)
 723
 724         TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
 725         /*
 726                 v3s16 blockpos
 727                 s16 id
 728                 u16 textlen
 729                 textdata
 730         */
 731
 732         TOSERVER_INVENTORY_ACTION = 0x31,
 733         /*
 734                 See InventoryAction in inventorymanager.h
 735         */
 736
 737         TOSERVER_CHAT_MESSAGE = 0x32,
 738         /*
 739                 u16 length
 740                 wstring message
 741         */
 742
 743         TOSERVER_SIGNNODETEXT = 0x33, // obsolete
 744         /*
 745                 v3s16 p
 746                 u16 textlen
 747                 textdata
 748         */
 749
 750         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 751         /*
 752                 length: 7
 753                 [0] u16 command
 754                 [2] u8 button (0=left, 1=right)
 755                 [3] u16 id
 756                 [5] u16 item
 757         */
 758
 759         TOSERVER_DAMAGE = 0x35,
 760         /*
 761                 u8 amount
 762         */
 763
 764         TOSERVER_PASSWORD_LEGACY = 0x36,
 765         /*
 766                 Sent to change password.
 767
 768                 [0] u16 TOSERVER_PASSWORD
 769                 [2] u8[28] old password
 770                 [30] u8[28] new password
 771         */
 772
 773         TOSERVER_PLAYERITEM = 0x37,
 774         /*
 775                 Sent to change selected item.
 776
 777                 [0] u16 TOSERVER_PLAYERITEM
 778                 [2] u16 item
 779         */
 780
 781         TOSERVER_RESPAWN = 0x38,
 782         /*
 783                 u16 TOSERVER_RESPAWN
 784         */
 785
 786         TOSERVER_INTERACT = 0x39,
 787         /*
 788                 [0] u16 command
 789                 [2] u8 action
 790                 [3] u16 item
 791                 [5] u32 length of the next item
 792                 [9] serialized PointedThing
 793                 actions:
 794                 0: start digging (from undersurface) or use
 795                 1: stop digging (all parameters ignored)
 796                 2: digging completed
 797                 3: place block or item (to abovesurface)
 798                 4: use item
 799
 800                 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
 801         */
 802
 803         TOSERVER_REMOVED_SOUNDS = 0x3a,
 804         /*
 805                 u16 len
 806                 s32[len] sound_id
 807         */
 808
 809         TOSERVER_NODEMETA_FIELDS = 0x3b,
 810         /*
 811                 v3s16 p
 812                 u16 len
 813                 u8[len] form name (reserved for future use)
 814                 u16 number of fields
 815                 for each field:
 816                         u16 len
 817                         u8[len] field name
 818                         u32 len
 819                         u8[len] field value
 820         */
 821
 822         TOSERVER_INVENTORY_FIELDS = 0x3c,
 823         /*
 824                 u16 len
 825                 u8[len] form name (reserved for future use)
 826                 u16 number of fields
 827                 for each field:
 828                         u16 len
 829                         u8[len] field name
 830                         u32 len
 831                         u8[len] field value
 832         */
 833
 834         TOSERVER_REQUEST_MEDIA = 0x40,
 835         /*
 836                 u16 number of files requested
 837                 for each file {
 838                         u16 length of name
 839                         string name
 840                 }
 841          */
 842
 843         TOSERVER_RECEIVED_MEDIA = 0x41,
 844         /*
 845                 <no payload data>
 846         */
 847
 848         TOSERVER_BREATH = 0x42, // Obsolete
 849         /*
 850                 u16 breath
 851         */
 852
 853         TOSERVER_CLIENT_READY = 0x43,
 854         /*
 855                 u8 major
 856                 u8 minor
 857                 u8 patch
 858                 u8 reserved
 859                 u16 len
 860                 u8[len] full_version_string
 861         */
 862
 863         TOSERVER_FIRST_SRP = 0x50,
 864         /*
 865                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 866
 867                 std::string srp salt
 868                 std::string srp verification key
 869                 u8 is_empty (=1 if password is empty, 0 otherwise)
 870         */
 871
 872         TOSERVER_SRP_BYTES_A = 0x51,
 873         /*
 874                 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
 875                         depending on current_login_based_on.
 876
 877                 std::string bytes_A
 878                 u8 current_login_based_on : on which version of the password's
 879                                             hash this login is based on (0 legacy hash,
 880                                             or 1 directly the password)
 881         */
 882
 883         TOSERVER_SRP_BYTES_M = 0x52,
 884         /*
 885                 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
 886
 887                 std::string bytes_M
 888         */
 889
 890         TOSERVER_NUM_MSG_TYPES = 0x53,
 891 };
 892
 893 enum AuthMechanism
 894 {
 895         // reserved
 896         AUTH_MECHANISM_NONE = 0,
 897
 898         // SRP based on the legacy hash
 899         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 900
 901         // SRP based on the srp verification key
 902         AUTH_MECHANISM_SRP = 1 << 1,
 903
 904         // Establishes a srp verification key, for first login and password changing
 905         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 906 };
 907
 908 enum AccessDeniedCode {
 909         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 910         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 911         SERVER_ACCESSDENIED_SINGLEPLAYER,
 912         SERVER_ACCESSDENIED_WRONG_VERSION,
 913         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 914         SERVER_ACCESSDENIED_WRONG_NAME,
 915         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 916         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 917         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 918         SERVER_ACCESSDENIED_SERVER_FAIL,
 919         SERVER_ACCESSDENIED_CUSTOM_STRING,
 920         SERVER_ACCESSDENIED_SHUTDOWN,
 921         SERVER_ACCESSDENIED_CRASH,
 922         SERVER_ACCESSDENIED_MAX,
 923 };
 924
 925 enum NetProtoCompressionMode {
 926         NETPROTO_COMPRESSION_NONE = 0,
 927 };
 928
 929 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
 930         "Invalid password",
 931         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
 932         "The server is running in simple singleplayer mode.  You cannot connect.",
 933         "Your client's version is not supported.\nPlease contact server administrator.",
 934         "Player name contains disallowed characters.",
 935         "Player name not allowed.",
 936         "Too many users.",
 937         "Empty passwords are disallowed.  Set a password and try again.",
 938         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
 939         "Server authentication failed.  This is likely a server error.",
 940         "",
 941         "Server shutting down.",
 942         "This server has experienced an internal error. You will now be disconnected."
 943 };
 944
 945 #endif