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