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