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