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