src/network/networkprotocol.h

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