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