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         // (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                 float fov
 388                 bool is_multiplier
 389         */
 390
 391         TOCLIENT_DEATHSCREEN = 0x37,
 392         /*
 393                 u8 bool set camera point target
 394                 v3f1000 camera point target (to point the death cause or whatever)
 395         */
 396
 397         TOCLIENT_MEDIA = 0x38,
 398         /*
 399                 u16 total number of texture bunches
 400                 u16 index of this bunch
 401                 u32 number of files in this bunch
 402                 for each file {
 403                         u16 length of name
 404                         string name
 405                         u32 length of data
 406                         data
 407                 }
 408                 u16 length of remote media server url (if applicable)
 409                 string url
 410         */
 411
 412         TOCLIENT_TOOLDEF = 0x39,
 413         /*
 414                 u32 length of the next item
 415                 serialized ToolDefManager
 416         */
 417
 418         TOCLIENT_NODEDEF = 0x3a,
 419         /*
 420                 u32 length of the next item
 421                 serialized NodeDefManager
 422         */
 423
 424         TOCLIENT_CRAFTITEMDEF = 0x3b,
 425         /*
 426                 u32 length of the next item
 427                 serialized CraftiItemDefManager
 428         */
 429
 430         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 431
 432         /*
 433                 u32 number of files
 434                 for each texture {
 435                         u16 length of name
 436                         string name
 437                         u16 length of sha1_digest
 438                         string sha1_digest
 439                 }
 440         */
 441
 442         TOCLIENT_ITEMDEF = 0x3d,
 443         /*
 444                 u32 length of next item
 445                 serialized ItemDefManager
 446         */
 447
 448         TOCLIENT_PLAY_SOUND = 0x3f,
 449         /*
 450                 s32 sound_id
 451                 u16 len
 452                 u8[len] sound name
 453                 s32 gain*1000
 454                 u8 type (0=local, 1=positional, 2=object)
 455                 s32[3] pos_nodes*10000
 456                 u16 object_id
 457                 u8 loop (bool)
 458                 u8 ephemeral (bool)
 459         */
 460
 461         TOCLIENT_STOP_SOUND = 0x40,
 462         /*
 463                 s32 sound_id
 464         */
 465
 466         TOCLIENT_PRIVILEGES = 0x41,
 467         /*
 468                 u16 number of privileges
 469                 for each privilege
 470                         u16 len
 471                         u8[len] privilege
 472         */
 473
 474         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 475         /*
 476                 u32 len
 477                 u8[len] formspec
 478         */
 479
 480         TOCLIENT_DETACHED_INVENTORY = 0x43,
 481         /*
 482                 [0] u16 command
 483                 u16 len
 484                 u8[len] name
 485                 [2] serialized inventory
 486         */
 487
 488         TOCLIENT_SHOW_FORMSPEC = 0x44,
 489         /*
 490                 [0] u16 command
 491                 u32 len
 492                 u8[len] formspec
 493                 u16 len
 494                 u8[len] formname
 495         */
 496
 497         TOCLIENT_MOVEMENT = 0x45,
 498         /*
 499                 f1000 movement_acceleration_default
 500                 f1000 movement_acceleration_air
 501                 f1000 movement_acceleration_fast
 502                 f1000 movement_speed_walk
 503                 f1000 movement_speed_crouch
 504                 f1000 movement_speed_fast
 505                 f1000 movement_speed_climb
 506                 f1000 movement_speed_jump
 507                 f1000 movement_liquid_fluidity
 508                 f1000 movement_liquid_fluidity_smooth
 509                 f1000 movement_liquid_sink
 510                 f1000 movement_gravity
 511         */
 512
 513         TOCLIENT_SPAWN_PARTICLE = 0x46,
 514         /*
 515                 v3f1000 pos
 516                 v3f1000 velocity
 517                 v3f1000 acceleration
 518                 f1000 expirationtime
 519                 f1000 size
 520                 u8 bool collisiondetection
 521                 u32 len
 522                 u8[len] texture
 523                 u8 bool vertical
 524                 u8 collision_removal
 525                 TileAnimation animation
 526                 u8 glow
 527                 u8 object_collision
 528         */
 529
 530         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 531         /*
 532                 u16 amount
 533                 f1000 spawntime
 534                 v3f1000 minpos
 535                 v3f1000 maxpos
 536                 v3f1000 minvel
 537                 v3f1000 maxvel
 538                 v3f1000 minacc
 539                 v3f1000 maxacc
 540                 f1000 minexptime
 541                 f1000 maxexptime
 542                 f1000 minsize
 543                 f1000 maxsize
 544                 u8 bool collisiondetection
 545                 u32 len
 546                 u8[len] texture
 547                 u8 bool vertical
 548                 u8 collision_removal
 549                 u32 id
 550                 TileAnimation animation
 551                 u8 glow
 552                 u8 object_collision
 553         */
 554
 555         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48, // Obsolete
 556
 557         TOCLIENT_HUDADD = 0x49,
 558         /*
 559                 u32 id
 560                 u8 type
 561                 v2f1000 pos
 562                 u32 len
 563                 u8[len] name
 564                 v2f1000 scale
 565                 u32 len2
 566                 u8[len2] text
 567                 u32 number
 568                 u32 item
 569                 u32 dir
 570                 v2f1000 align
 571                 v2f1000 offset
 572                 v3f1000 world_pos
 573                 v2s32 size
 574                 s16 z_index
 575         */
 576
 577         TOCLIENT_HUDRM = 0x4a,
 578         /*
 579                 u32 id
 580         */
 581
 582         TOCLIENT_HUDCHANGE = 0x4b,
 583         /*
 584                 u32 id
 585                 u8 stat
 586                 [v2f1000 data |
 587                  u32 len
 588                  u8[len] data |
 589                  u32 data]
 590         */
 591
 592         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 593         /*
 594                 u32 flags
 595                 u32 mask
 596         */
 597
 598         TOCLIENT_HUD_SET_PARAM = 0x4d,
 599         /*
 600                 u16 param
 601                 u16 len
 602                 u8[len] value
 603         */
 604
 605         TOCLIENT_BREATH = 0x4e,
 606         /*
 607                 u16 breath
 608         */
 609
 610         TOCLIENT_SET_SKY = 0x4f,
 611         /*
 612                 Protocol 38:
 613                 u8[4] base_color (ARGB)
 614                 u8 len
 615                 u8[len] type
 616                 u16 count
 617                 foreach count:
 618                         u8 len
 619                         u8[len] param
 620                 u8 clouds (boolean)
 621
 622                 Protocol 39:
 623                 u8[4] bgcolor (ARGB)
 624                 std::string type
 625                 int texture_count
 626                 std::string[6] param
 627                 bool clouds
 628                 bool bgcolor_fog
 629                 u8[4] day_sky (ARGB)
 630                 u8[4] day_horizon (ARGB)
 631                 u8[4] dawn_sky (ARGB)
 632                 u8[4] dawn_horizon (ARGB)
 633                 u8[4] night_sky (ARGB)
 634                 u8[4] night_horizon (ARGB)
 635                 u8[4] indoors (ARGB)
 636                 u8[4] sun_tint (ARGB)
 637                 u8[4] moon_tint (ARGB)
 638                 std::string tint_type
 639         */
 640
 641         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
 642         /*
 643                 u8 do_override (boolean)
 644                 u16 day-night ratio 0...65535
 645         */
 646
 647         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
 648         /*
 649                 v2s32 stand/idle
 650                 v2s32 walk
 651                 v2s32 dig
 652                 v2s32 walk+dig
 653                 f1000 frame_speed
 654         */
 655
 656         TOCLIENT_EYE_OFFSET = 0x52,
 657         /*
 658                 v3f1000 first
 659                 v3f1000 third
 660         */
 661
 662         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
 663         /*
 664                 u32 id
 665         */
 666
 667         TOCLIENT_CLOUD_PARAMS = 0x54,
 668         /*
 669                 f1000 density
 670                 u8[4] color_diffuse (ARGB)
 671                 u8[4] color_ambient (ARGB)
 672                 f1000 height
 673                 f1000 thickness
 674                 v2f1000 speed
 675         */
 676
 677         TOCLIENT_FADE_SOUND = 0x55,
 678         /*
 679                 s32 sound_id
 680                 float step
 681                 float gain
 682         */
 683         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
 684         /*
 685                 u8 type
 686                 u16 number of players
 687                 for each player
 688                         u16 len
 689                         u8[len] player name
 690         */
 691
 692         TOCLIENT_MODCHANNEL_MSG = 0x57,
 693         /*
 694                 u16 channel name length
 695                 std::string channel name
 696                 u16 channel name sender
 697                 std::string channel name
 698                 u16 message length
 699                 std::string message
 700         */
 701
 702         TOCLIENT_MODCHANNEL_SIGNAL = 0x58,
 703         /*
 704                 u8 signal id
 705                 u16 channel name length
 706                 std::string channel name
 707         */
 708
 709         TOCLIENT_NODEMETA_CHANGED = 0x59,
 710         /*
 711                 serialized and compressed node metadata
 712         */
 713
 714         TOCLIENT_SET_SUN = 0x5a,
 715         /*
 716                 bool visible
 717                 std::string texture
 718                 std::string tonemap
 719                 std::string sunrise
 720                 f32 scale
 721         */
 722
 723         TOCLIENT_SET_MOON = 0x5b,
 724         /*
 725                 bool visible
 726                 std::string texture
 727                 std::string tonemap
 728                 f32 scale
 729         */
 730
 731         TOCLIENT_SET_STARS = 0x5c,
 732         /*
 733                 bool visible
 734                 u32 count
 735                 u8[4] starcolor (ARGB)
 736                 f32 scale
 737         */
 738
 739         TOCLIENT_SRP_BYTES_S_B = 0x60,
 740         /*
 741                 Belonging to AUTH_MECHANISM_SRP.
 742
 743                 std::string bytes_s
 744                 std::string bytes_B
 745         */
 746
 747         TOCLIENT_FORMSPEC_PREPEND = 0x61,
 748         /*
 749                 u16 len
 750                 u8[len] formspec
 751         */
 752
 753         TOCLIENT_NUM_MSG_TYPES = 0x62,
 754 };
 755
 756 enum ToServerCommand
 757 {
 758         TOSERVER_INIT = 0x02,
 759         /*
 760                 Sent first after connected.
 761
 762                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
 763                 u16 supported network compression modes
 764                 u16 minimum supported network protocol version
 765                 u16 maximum supported network protocol version
 766                 std::string player name
 767         */
 768
 769         TOSERVER_INIT_LEGACY = 0x10, // Obsolete
 770
 771         TOSERVER_INIT2 = 0x11,
 772         /*
 773                 Sent as an ACK for TOCLIENT_INIT.
 774                 After this, the server can send data.
 775
 776                 [0] u16 TOSERVER_INIT2
 777         */
 778
 779         TOSERVER_MODCHANNEL_JOIN = 0x17,
 780         /*
 781                 u16 channel name length
 782                 std::string channel name
 783          */
 784
 785         TOSERVER_MODCHANNEL_LEAVE = 0x18,
 786         /*
 787                 u16 channel name length
 788                 std::string channel name
 789          */
 790
 791         TOSERVER_MODCHANNEL_MSG = 0x19,
 792         /*
 793                 u16 channel name length
 794                 std::string channel name
 795                 u16 message length
 796                 std::string message
 797          */
 798
 799         TOSERVER_GETBLOCK = 0x20, // Obsolete
 800         TOSERVER_ADDNODE = 0x21, // Obsolete
 801         TOSERVER_REMOVENODE = 0x22, // Obsolete
 802
 803         TOSERVER_PLAYERPOS = 0x23,
 804         /*
 805                 [0] u16 command
 806                 [2] v3s32 position*100
 807                 [2+12] v3s32 speed*100
 808                 [2+12+12] s32 pitch*100
 809                 [2+12+12+4] s32 yaw*100
 810                 [2+12+12+4+4] u32 keyPressed
 811                 [2+12+12+4+4+1] u8 fov*80
 812                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
 813         */
 814
 815         TOSERVER_GOTBLOCKS = 0x24,
 816         /*
 817                 [0] u16 command
 818                 [2] u8 count
 819                 [3] v3s16 pos_0
 820                 [3+6] v3s16 pos_1
 821                 ...
 822         */
 823
 824         TOSERVER_DELETEDBLOCKS = 0x25,
 825         /*
 826                 [0] u16 command
 827                 [2] u8 count
 828                 [3] v3s16 pos_0
 829                 [3+6] v3s16 pos_1
 830                 ...
 831         */
 832
 833         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 834         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 835         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 836         TOSERVER_RELEASE = 0x29, // Obsolete
 837         TOSERVER_SIGNTEXT = 0x30, // Obsolete
 838
 839         TOSERVER_INVENTORY_ACTION = 0x31,
 840         /*
 841                 See InventoryAction in inventorymanager.h
 842         */
 843
 844         TOSERVER_CHAT_MESSAGE = 0x32,
 845         /*
 846                 u16 length
 847                 wstring message
 848         */
 849
 850         TOSERVER_SIGNNODETEXT = 0x33, // Obsolete
 851         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 852
 853         TOSERVER_DAMAGE = 0x35,
 854         /*
 855                 u8 amount
 856         */
 857
 858         TOSERVER_PASSWORD_LEGACY = 0x36, // Obsolete
 859
 860         TOSERVER_PLAYERITEM = 0x37,
 861         /*
 862                 Sent to change selected item.
 863
 864                 [0] u16 TOSERVER_PLAYERITEM
 865                 [2] u16 item
 866         */
 867
 868         TOSERVER_RESPAWN = 0x38,
 869         /*
 870                 u16 TOSERVER_RESPAWN
 871         */
 872
 873         TOSERVER_INTERACT = 0x39,
 874         /*
 875                 [0] u16 command
 876                 [2] u8 action
 877                 [3] u16 item
 878                 [5] u32 length of the next item
 879                 [9] serialized PointedThing
 880                 actions:
 881                 0: start digging (from undersurface) or use
 882                 1: stop digging (all parameters ignored)
 883                 2: digging completed
 884                 3: place block or item (to abovesurface)
 885                 4: use item
 886         */
 887
 888         TOSERVER_REMOVED_SOUNDS = 0x3a,
 889         /*
 890                 u16 len
 891                 s32[len] sound_id
 892         */
 893
 894         TOSERVER_NODEMETA_FIELDS = 0x3b,
 895         /*
 896                 v3s16 p
 897                 u16 len
 898                 u8[len] form name (reserved for future use)
 899                 u16 number of fields
 900                 for each field:
 901                         u16 len
 902                         u8[len] field name
 903                         u32 len
 904                         u8[len] field value
 905         */
 906
 907         TOSERVER_INVENTORY_FIELDS = 0x3c,
 908         /*
 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_REQUEST_MEDIA = 0x40,
 920         /*
 921                 u16 number of files requested
 922                 for each file {
 923                         u16 length of name
 924                         string name
 925                 }
 926         */
 927
 928         TOSERVER_RECEIVED_MEDIA = 0x41, // Obsolete
 929         TOSERVER_BREATH = 0x42, // Obsolete
 930
 931         TOSERVER_CLIENT_READY = 0x43,
 932         /*
 933                 u8 major
 934                 u8 minor
 935                 u8 patch
 936                 u8 reserved
 937                 u16 len
 938                 u8[len] full_version_string
 939         */
 940
 941         TOSERVER_FIRST_SRP = 0x50,
 942         /*
 943                 Belonging to AUTH_MECHANISM_FIRST_SRP.
 944
 945                 std::string srp salt
 946                 std::string srp verification key
 947                 u8 is_empty (=1 if password is empty, 0 otherwise)
 948         */
 949
 950         TOSERVER_SRP_BYTES_A = 0x51,
 951         /*
 952                 Belonging to AUTH_MECHANISM_SRP,
 953                         depending on current_login_based_on.
 954
 955                 std::string bytes_A
 956                 u8 current_login_based_on : on which version of the password's
 957                                             hash this login is based on (0 legacy hash,
 958                                             or 1 directly the password)
 959         */
 960
 961         TOSERVER_SRP_BYTES_M = 0x52,
 962         /*
 963                 Belonging to AUTH_MECHANISM_SRP.
 964
 965                 std::string bytes_M
 966         */
 967
 968         TOSERVER_NUM_MSG_TYPES = 0x53,
 969 };
 970
 971 enum AuthMechanism
 972 {
 973         // reserved
 974         AUTH_MECHANISM_NONE = 0,
 975
 976         // SRP based on the legacy hash
 977         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
 978
 979         // SRP based on the srp verification key
 980         AUTH_MECHANISM_SRP = 1 << 1,
 981
 982         // Establishes a srp verification key, for first login and password changing
 983         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
 984 };
 985
 986 enum AccessDeniedCode {
 987         SERVER_ACCESSDENIED_WRONG_PASSWORD,
 988         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
 989         SERVER_ACCESSDENIED_SINGLEPLAYER,
 990         SERVER_ACCESSDENIED_WRONG_VERSION,
 991         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
 992         SERVER_ACCESSDENIED_WRONG_NAME,
 993         SERVER_ACCESSDENIED_TOO_MANY_USERS,
 994         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
 995         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
 996         SERVER_ACCESSDENIED_SERVER_FAIL,
 997         SERVER_ACCESSDENIED_CUSTOM_STRING,
 998         SERVER_ACCESSDENIED_SHUTDOWN,
 999         SERVER_ACCESSDENIED_CRASH,
1000         SERVER_ACCESSDENIED_MAX,
1001 };
1002
1003 enum NetProtoCompressionMode {
1004         NETPROTO_COMPRESSION_NONE = 0,
1005 };
1006
1007 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
1008         "Invalid password",
1009         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
1010         "The server is running in simple singleplayer mode.  You cannot connect.",
1011         "Your client's version is not supported.\nPlease contact server administrator.",
1012         "Player name contains disallowed characters.",
1013         "Player name not allowed.",
1014         "Too many users.",
1015         "Empty passwords are disallowed.  Set a password and try again.",
1016         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
1017         "Server authentication failed.  This is likely a server error.",
1018         "",
1019         "Server shutting down.",
1020         "This server has experienced an internal error. You will now be disconnected."
1021 };
1022
1023 enum PlayerListModifer: u8
1024 {
1025         PLAYER_LIST_INIT,
1026         PLAYER_LIST_ADD,
1027         PLAYER_LIST_REMOVE,
1028 };
1029
1030 enum CSMRestrictionFlags : u64 {
1031         CSM_RF_NONE = 0x00000000,
1032         // Until server-sent CSM and verifying of builtin are complete,
1033         // 'CSM_RF_LOAD_CLIENT_MODS' also disables loading 'builtin'.
1034         // When those are complete, this should return to only being a restriction on the
1035         // loading of client mods.
1036         CSM_RF_LOAD_CLIENT_MODS = 0x00000001, // Don't load client-provided mods or 'builtin'
1037         CSM_RF_CHAT_MESSAGES = 0x00000002,    // Disable chat message sending from CSM
1038         CSM_RF_READ_ITEMDEFS = 0x00000004,    // Disable itemdef lookups
1039         CSM_RF_READ_NODEDEFS = 0x00000008,    // Disable nodedef lookups
1040         CSM_RF_LOOKUP_NODES = 0x00000010,     // Limit node lookups
1041         CSM_RF_READ_PLAYERINFO = 0x00000020,  // Disable player info lookups
1042         CSM_RF_ALL = 0xFFFFFFFF,
1043 };
1044
1045 enum InteractAction : u8
1046 {
1047         INTERACT_START_DIGGING,     // 0: start digging (from undersurface) or use
1048         INTERACT_STOP_DIGGING,      // 1: stop digging (all parameters ignored)
1049         INTERACT_DIGGING_COMPLETED, // 2: digging completed
1050         INTERACT_PLACE,             // 3: place block or item (to abovesurface)
1051         INTERACT_USE,               // 4: use item
1052         INTERACT_ACTIVATE           // 5: rightclick air ("activate")
1053 };