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