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