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