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