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