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 */
 241 #define FORMSPEC_API_VERSION 3
 242
 243 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
 244
 245 typedef u16 session_t;
 246
 247 enum ToClientCommand
 248 {
 249         TOCLIENT_HELLO = 0x02,
 250         /*
 251                 Sent after TOSERVER_INIT.
 252
 253                 u8 deployed serialisation version
 254                 u16 deployed network compression mode
 255                 u16 deployed protocol version
 256                 u32 supported auth methods
 257                 std::string username that should be used for legacy hash (for proper casing)
 258         */
 259         TOCLIENT_AUTH_ACCEPT = 0x03,
 260         /*
 261                 Message from server to accept auth.
 262
 263                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 264                 u64 map seed
 265                 f1000 recommended send interval
 266                 u32 : supported auth methods for sudo mode
 267                       (where the user can change their password)
 268         */
 269         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
 270         /*
 271                 Sent to client to show it is in sudo mode now.
 272         */
 273         TOCLIENT_DENY_SUDO_MODE = 0x05,
 274         /*
 275                 Signals client that sudo mode auth failed.
 276         */
 277         TOCLIENT_ACCESS_DENIED = 0x0A,
 278         /*
 279                 u8 reason
 280                 std::string custom reason (if needed, otherwise "")
 281                 u8 (bool) reconnect
 282         */
 283
 284         TOCLIENT_INIT_LEGACY = 0x10, // Obsolete
 285
 286         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 287         TOCLIENT_ADDNODE = 0x21,
 288         /*
 289                 v3s16 position
 290                 serialized mapnode
 291                 u8 keep_metadata // Added in protocol version 22
 292         */
 293         TOCLIENT_REMOVENODE = 0x22,
 294
 295         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 296         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 297         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 298         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 299
 300         TOCLIENT_INVENTORY = 0x27,
 301         /*
 302                 [0] u16 command
 303                 [2] serialized inventory
 304         */
 305
 306         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 307
 308         TOCLIENT_TIME_OF_DAY = 0x29,
 309         /*
 310                 u16 time (0-23999)
 311                 Added in a later version:
 312                 f1000 time_speed
 313         */
 314
 315         TOCLIENT_CSM_RESTRICTION_FLAGS = 0x2A,
 316         /*
 317                 u32 CSMRestrictionFlags byteflag
 318          */
 319
 320         TOCLIENT_PLAYER_SPEED = 0x2B,
 321         /*
 322                 v3f added_vel
 323          */
 324
 325         // (oops, there is some gap here)
 326
 327         TOCLIENT_CHAT_MESSAGE = 0x2F,
 328         /*
 329                 u8 version
 330                 u8 message_type
 331                 u16 sendername length
 332                 wstring sendername
 333                 u16 length
 334                 wstring message
 335         */
 336
 337         TOCLIENT_CHAT_MESSAGE_OLD = 0x30, // Obsolete
 338
 339         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 340         /*
 341                 u16 count of removed objects
 342                 for all removed objects {
 343                         u16 id
 344                 }
 345                 u16 count of added objects
 346                 for all added objects {
 347                         u16 id
 348                         u8 type
 349                         u32 initialization data length
 350                         string initialization data
 351                 }
 352         */
 353
 354         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 355         /*
 356                 for all objects
 357                 {
 358                         u16 id
 359                         u16 message length
 360                         string message
 361                 }
 362         */
 363
 364         TOCLIENT_HP = 0x33,
 365         /*
 366                 u8 hp
 367         */
 368
 369         TOCLIENT_MOVE_PLAYER = 0x34,
 370         /*
 371                 v3f1000 player position
 372                 f1000 player pitch
 373                 f1000 player yaw
 374         */
 375
 376         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
 377         /*
 378                 u16 reason_length
 379                 wstring reason
 380         */
 381
 382         TOCLIENT_FOV = 0x36,
 383         /*
 384                 Sends an FOV override/multiplier to client.
 385
 386                 float fov
 387                 bool is_multiplier
 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                 u32 len
 562                 u8[len] name
 563                 v2f1000 scale
 564                 u32 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         */
 575
 576         TOCLIENT_HUDRM = 0x4a,
 577         /*
 578                 u32 id
 579         */
 580
 581         TOCLIENT_HUDCHANGE = 0x4b,
 582         /*
 583                 u32 id
 584                 u8 stat
 585                 [v2f1000 data |
 586                  u32 len
 587                  u8[len] data |
 588                  u32 data]
 589         */
 590
 591         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 592         /*
 593                 u32 flags
 594                 u32 mask
 595         */
 596
 597         TOCLIENT_HUD_SET_PARAM = 0x4d,
 598         /*
 599                 u16 param
 600                 u16 len
 601                 u8[len] value
 602         */
 603
 604         TOCLIENT_BREATH = 0x4e,
 605         /*
 606                 u16 breath
 607         */
 608
 609         TOCLIENT_SET_SKY = 0x4f,
 610         /*
 611                 Protocol 38:
 612                 u8[4] base_color (ARGB)
 613                 u8 len
 614                 u8[len] type
 615                 u16 count
 616                 foreach count:
 617                         u8 len
 618                         u8[len] param
 619                 u8 clouds (boolean)
 620
 621                 Protocol 39:
 622                 u8[4] bgcolor (ARGB)
 623                 std::string type
 624                 int texture_count
 625                 std::string[6] param
 626                 bool clouds
 627                 bool bgcolor_fog
 628                 u8[4] day_sky (ARGB)
 629                 u8[4] day_horizon (ARGB)
 630                 u8[4] dawn_sky (ARGB)
 631                 u8[4] dawn_horizon (ARGB)
 632                 u8[4] night_sky (ARGB)
 633                 u8[4] night_horizon (ARGB)
 634                 u8[4] indoors (ARGB)
 635                 u8[4] sun_tint (ARGB)
 636                 u8[4] moon_tint (ARGB)
 637                 std::string tint_type
 638         */
 639
 640         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 641         /*
 642                 u8 do_override (boolean)
 643                 u16 day-night ratio 0...65535
 644         */
 645
 646         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 647         /*
 648                 v2s32 stand/idle
 649                 v2s32 walk
 650                 v2s32 dig
 651                 v2s32 walk+dig
 652                 f1000 frame_speed
 653         */
 654
 655         TOCLIENT_EYE_OFFSET = 0x52,
 656         /*
 657                 v3f1000 first
 658                 v3f1000 third
 659         */
 660
 661         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 662         /*
 663                 u32 id
 664         */
 665
 666         TOCLIENT_CLOUD_PARAMS = 0x54,
 667         /*
 668                 f1000 density
 669                 u8[4] color_diffuse (ARGB)
 670                 u8[4] color_ambient (ARGB)
 671                 f1000 height
 672                 f1000 thickness
 673                 v2f1000 speed
 674         */
 675
 676         TOCLIENT_FADE_SOUND = 0x55,
 677         /*
 678                 s32 sound_id
 679                 float step
 680                 float gain
 681         */
 682         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 683         /*
 684                 u8 type
 685                 u16 number of players
 686                 for each player
 687                         u16 len
 688                         u8[len] player name
 689         */
 690
 691         TOCLIENT_MODCHANNEL_MSG = 0x57,
 692         /*
 693                 u16 channel name length
 694                 std::string channel name
 695                 u16 channel name sender
 696                 std::string channel name
 697                 u16 message length
 698                 std::string message
 699         */
 700
 701         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 702         /*
 703                 u8 signal id
 704                 u16 channel name length
 705                 std::string channel name
 706         */
 707
 708         TOCLIENT_NODEMETA_CHANGED = 0x59,
 709         /*
 710                 serialized and compressed node metadata
 711         */
 712
 713         TOCLIENT_SET_SUN = 0x5a,
 714         /*
 715                 bool visible
 716                 std::string texture
 717                 std::string tonemap
 718                 std::string sunrise
 719                 f32 scale
 720         */
 721
 722         TOCLIENT_SET_MOON = 0x5b,
 723         /*
 724                 bool visible
 725                 std::string texture
 726                 std::string tonemap
 727                 f32 scale
 728         */
 729
 730         TOCLIENT_SET_STARS = 0x5c,
 731         /*
 732                 bool visible
 733                 u32 count
 734                 u8[4] starcolor (ARGB)
 735                 f32 scale
 736         */
 737
 738         TOCLIENT_SRP_BYTES_S_B = 0x60,
 739         /*
 740                 Belonging to AUTH_MECHANISM_SRP.
 741
 742                 std::string bytes_s
 743                 std::string bytes_B
 744         */
 745
 746         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 747         /*
 748                 u16 len
 749                 u8[len] formspec
 750         */
 751
 752         TOCLIENT_NUM_MSG_TYPES = 0x62,
 753 };
 754
 755 enum ToServerCommand
 756 {
 757         TOSERVER_INIT = 0x02,
 758         /*
 759                 Sent first after connected.
 760
 761                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 762                 u16 supported network compression modes
 763                 u16 minimum supported network protocol version
 764                 u16 maximum supported network protocol version
 765                 std::string player name
 766         */
 767
 768         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 769
 770         TOSERVER_INIT2 = 0x11,
 771         /*
 772                 Sent as an ACK for TOCLIENT_INIT.
 773                 After this, the server can send data.
 774
 775                 [0] u16 TOSERVER_INIT2
 776         */
 777
 778         TOSERVER_MODCHANNEL_JOIN = 0x17,
 779         /*
 780                 u16 channel name length
 781                 std::string channel name
 782          */
 783
 784         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 785         /*
 786                 u16 channel name length
 787                 std::string channel name
 788          */
 789
 790         TOSERVER_MODCHANNEL_MSG = 0x19,
 791         /*
 792                 u16 channel name length
 793                 std::string channel name
 794                 u16 message length
 795                 std::string message
 796          */
 797
 798         TOSERVER_GETBLOCK = 0x20, // Obsolete
 799         TOSERVER_ADDNODE = 0x21, // Obsolete
 800         TOSERVER_REMOVENODE = 0x22, // Obsolete
 801
 802         TOSERVER_PLAYERPOS = 0x23,
 803         /*
 804                 [0] u16 command
 805                 [2] v3s32 position*100
 806                 [2+12] v3s32 speed*100
 807                 [2+12+12] s32 pitch*100
 808                 [2+12+12+4] s32 yaw*100
 809                 [2+12+12+4+4] u32 keyPressed
 810                 [2+12+12+4+4+1] u8 fov*80
 811                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 812         */
 813
 814         TOSERVER_GOTBLOCKS = 0x24,
 815         /*
 816                 [0] u16 command
 817                 [2] u8 count
 818                 [3] v3s16 pos_0
 819                 [3+6] v3s16 pos_1
 820                 ...
 821         */
 822
 823         TOSERVER_DELETEDBLOCKS = 0x25,
 824         /*
 825                 [0] u16 command
 826                 [2] u8 count
 827                 [3] v3s16 pos_0
 828                 [3+6] v3s16 pos_1
 829                 ...
 830         */
 831
 832         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 833         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 834         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 835         TOSERVER_RELEASE = 0x29, // Obsolete
 836         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 837
 838         TOSERVER_INVENTORY_ACTION = 0x31,
 839         /*
 840                 See InventoryAction in inventorymanager.h
 841         */
 842
 843         TOSERVER_CHAT_MESSAGE = 0x32,
 844         /*
 845                 u16 length
 846                 wstring message
 847         */
 848
 849         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 850         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 851
 852         TOSERVER_DAMAGE = 0x35,
 853         /*
 854                 u8 amount
 855         */
 856
 857         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 858
 859         TOSERVER_PLAYERITEM = 0x37,
 860         /*
 861                 Sent to change selected item.
 862
 863                 [0] u16 TOSERVER_PLAYERITEM
 864                 [2] u16 item
 865         */
 866
 867         TOSERVER_RESPAWN = 0x38,
 868         /*
 869                 u16 TOSERVER_RESPAWN
 870         */
 871
 872         TOSERVER_INTERACT = 0x39,
 873         /*
 874                 [0] u16 command
 875                 [2] u8 action
 876                 [3] u16 item
 877                 [5] u32 length of the next item
 878                 [9] serialized PointedThing
 879                 actions:
 880                 0: start digging (from undersurface) or use
 881                 1: stop digging (all parameters ignored)
 882                 2: digging completed
 883                 3: place block or item (to abovesurface)
 884                 4: use item
 885         */
 886
 887         TOSERVER_REMOVED_SOUNDS = 0x3a,
 888         /*
 889                 u16 len
 890                 s32[len] sound_id
 891         */
 892
 893         TOSERVER_NODEMETA_FIELDS = 0x3b,
 894         /*
 895                 v3s16 p
 896                 u16 len
 897                 u8[len] form name (reserved for future use)
 898                 u16 number of fields
 899                 for each field:
 900                         u16 len
 901                         u8[len] field name
 902                         u32 len
 903                         u8[len] field value
 904         */
 905
 906         TOSERVER_INVENTORY_FIELDS = 0x3c,
 907         /*
 908                 u16 len
 909                 u8[len] form name (reserved for future use)
 910                 u16 number of fields
 911                 for each field:
 912                         u16 len
 913                         u8[len] field name
 914                         u32 len
 915                         u8[len] field value
 916         */
 917
 918         TOSERVER_REQUEST_MEDIA = 0x40,
 919         /*
 920                 u16 number of files requested
 921                 for each file {
 922                         u16 length of name
 923                         string name
 924                 }
 925         */
 926
 927         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 928         TOSERVER_BREATH = 0x42, // Obsolete
 929
 930         TOSERVER_CLIENT_READY = 0x43,
 931         /*
 932                 u8 major
 933                 u8 minor
 934                 u8 patch
 935                 u8 reserved
 936                 u16 len
 937                 u8[len] full_version_string
 938         */
 939
 940         TOSERVER_FIRST_SRP = 0x50,
 941         /*
 942                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 943
 944                 std::string srp salt
 945                 std::string srp verification key
 946                 u8 is_empty (=1 if password is empty, 0 otherwise)
 947         */
 948
 949         TOSERVER_SRP_BYTES_A = 0x51,
 950         /*
 951                 Belonging to AUTH_MECHANISM_SRP,
 952                         depending on current_login_based_on.
 953
 954                 std::string bytes_A
 955                 u8 current_login_based_on : on which version of the password's
 956                                             hash this login is based on (0 legacy hash,
 957                                             or 1 directly the password)
 958         */
 959
 960         TOSERVER_SRP_BYTES_M = 0x52,
 961         /*
 962                 Belonging to AUTH_MECHANISM_SRP.
 963
 964                 std::string bytes_M
 965         */
 966
 967         TOSERVER_NUM_MSG_TYPES = 0x53,
 968 };
 969
 970 enum AuthMechanism
 971 {
 972         // reserved
 973         AUTH_MECHANISM_NONE = 0,
 974
 975         // SRP based on the legacy hash
 976         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 977
 978         // SRP based on the srp verification key
 979         AUTH_MECHANISM_SRP = 1 << 1,
 980
 981         // Establishes a srp verification key, for first login and password changing
 982         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 983 };
 984
 985 enum AccessDeniedCode {
 986         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 987         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 988         SERVER_ACCESSDENIED_SINGLEPLAYER,
 989         SERVER_ACCESSDENIED_WRONG_VERSION,
 990         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 991         SERVER_ACCESSDENIED_WRONG_NAME,
 992         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 993         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 994         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 995         SERVER_ACCESSDENIED_SERVER_FAIL,
 996         SERVER_ACCESSDENIED_CUSTOM_STRING,
 997         SERVER_ACCESSDENIED_SHUTDOWN,
 998         SERVER_ACCESSDENIED_CRASH,
 999         SERVER_ACCESSDENIED_MAX,
1000 };
1001
1002 enum NetProtoCompressionMode {
1003         NETPROTO_COMPRESSION_NONE = 0,
1004 };
1005
1006 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1007         "Invalid password",
1008         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
1009         "The server is running in simple singleplayer mode.  You cannot connect.",
1010         "Your client's version is not supported.\nPlease contact server administrator.",
1011         "Player name contains disallowed characters.",
1012         "Player name not allowed.",
1013         "Too many users.",
1014         "Empty passwords are disallowed.  Set a password and try again.",
1015         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
1016         "Server authentication failed.  This is likely a server error.",
1017         "",
1018         "Server shutting down.",
1019         "This server has experienced an internal error. You will now be disconnected."
1020 };
1021
1022 enum PlayerListModifer: u8
1023 {
1024         PLAYER_LIST_INIT,
1025         PLAYER_LIST_ADD,
1026         PLAYER_LIST_REMOVE,
1027 };
1028
1029 enum CSMRestrictionFlags : u64 {
1030         CSM_RF_NONE = 0x00000000,
1031         // Until server-sent CSM and verifying of builtin are complete,
1032         // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
1033         // When those are complete, this should return to only being a restriction on the
1034         // loading of client mods.
1035         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
1036         CSM_RF_CHAT_MESSAGES = 0x00000002,    // Disable chat message sending from CSM
1037         CSM_RF_READ_ITEMDEFS = 0x00000004,    // Disable itemdef lookups
1038         CSM_RF_READ_NODEDEFS = 0x00000008,    // Disable nodedef lookups
1039         CSM_RF_LOOKUP_NODES = 0x00000010,     // Limit node lookups
1040         CSM_RF_READ_PLAYERINFO = 0x00000020,  // Disable player info lookups
1041         CSM_RF_ALL = 0xFFFFFFFF,
1042 };
1043
1044 enum InteractAction : u8
1045 {
1046         INTERACT_START_DIGGING,     // 0: start digging (from undersurface) or use
1047         INTERACT_STOP_DIGGING,      // 1: stop digging (all parameters ignored)
1048         INTERACT_DIGGING_COMPLETED, // 2: digging completed
1049         INTERACT_PLACE,             // 3: place block or item (to abovesurface)
1050         INTERACT_USE,               // 4: use item
1051         INTERACT_ACTIVATE           // 5: rightclick air ("activate")
1052 };