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