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