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