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