src/clientserver.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 #ifndef CLIENTSERVER_HEADER
  21 #define CLIENTSERVER_HEADER
  22
  23 /*
  24         changes by PROTOCOL_VERSION:
  25
  26         PROTOCOL_VERSION 3:
  27                 Base for writing changes here
  28         PROTOCOL_VERSION 4:
  29                 Add TOCLIENT_MEDIA
  30                 Add TOCLIENT_TOOLDEF
  31                 Add TOCLIENT_NODEDEF
  32                 Add TOCLIENT_CRAFTITEMDEF
  33                 Add TOSERVER_INTERACT
  34                 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
  35                 Obsolete TOSERVER_GROUND_ACTION
  36         PROTOCOL_VERSION 5:
  37                 Make players to be handled mostly as ActiveObjects
  38         PROTOCOL_VERSION 6:
  39                 Only non-cached textures are sent
  40         PROTOCOL_VERSION 7:
  41                 Add TOCLIENT_ITEMDEF
  42                 Obsolete TOCLIENT_TOOLDEF
  43                 Obsolete TOCLIENT_CRAFTITEMDEF
  44                 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
  45         PROTOCOL_VERSION 8:
  46                 Digging based on item groups
  47                 Many things
  48         PROTOCOL_VERSION 9:
  49                 ContentFeatures and NodeDefManager use a different serialization
  50                     format; better for future version cross-compatibility
  51                 Many things
  52         PROTOCOL_VERSION 10:
  53                 TOCLIENT_PRIVILEGES
  54                 Version raised to force 'fly' and 'fast' privileges into effect.
  55                 Node metadata change (came in later; somewhat incompatible)
  56         PROTOCOL_VERSION 11:
  57                 TileDef in ContentFeatures
  58                 Nodebox drawtype
  59                 (some dev snapshot)
  60                 TOCLIENT_INVENTORY_FORMSPEC
  61                 (0.4.0, 0.4.1)
  62         PROTOCOL_VERSION 12:
  63                 TOSERVER_INVENTORY_FIELDS
  64                 16-bit node ids
  65                 TOCLIENT_DETACHED_INVENTORY
  66         PROTOCOL_VERSION 13:
  67                 InventoryList field "Width" (deserialization fails with old versions)
  68         PROTOCOL_VERSION 14:
  69                 Added transfer of player pressed keys to the server
  70                 Added new messages for mesh and bone animation, as well as attachments
  71                 GENERIC_CMD_SET_ANIMATION
  72                 GENERIC_CMD_SET_BONE_POSITION
  73                 GENERIC_CMD_SET_ATTACHMENT
  74         PROTOCOL_VERSION 15:
  75                 Serialization format changes
  76         PROTOCOL_VERSION 16:
  77                 TOCLIENT_SHOW_FORMSPEC
  78         PROTOCOL_VERSION 17:
  79                 Serialization format change: include backface_culling flag in TileDef
  80                 Added rightclickable field in nodedef
  81                 TOCLIENT_SPAWN_PARTICLE
  82                 TOCLIENT_ADD_PARTICLESPAWNER
  83                 TOCLIENT_DELETE_PARTICLESPAWNER
  84         PROTOCOL_VERSION 18:
  85                 damageGroups added to ToolCapabilities
  86                 sound_place added to ItemDefinition
  87         PROTOCOL_VERSION 19:
  88                 GENERIC_CMD_SET_PHYSICS_OVERRIDE
  89         PROTOCOL_VERSION 20:
  90                 TOCLIENT_HUDADD
  91                 TOCLIENT_HUDRM
  92                 TOCLIENT_HUDCHANGE
  93                 TOCLIENT_HUD_SET_FLAGS
  94         PROTOCOL_VERSION 21:
  95                 TOCLIENT_BREATH
  96                 TOSERVER_BREATH
  97                 range added to ItemDefinition
  98                 drowning, leveled and liquid_range added to ContentFeatures
  99                 stepheight and collideWithObjects added to object properties
 100                 version, heat and humidity transfer in MapBock
 101                 automatic_face_movement_dir and automatic_face_movement_dir_offset
 102                         added to object properties
 103 */
 104
 105 #define LATEST_PROTOCOL_VERSION 22
 106
 107 // Server's supported network protocol range
 108 #define SERVER_PROTOCOL_VERSION_MIN 13
 109 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 110
 111 // Client's supported network protocol range
 112 #define CLIENT_PROTOCOL_VERSION_MIN 13
 113 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
 114
 115 // Constant that differentiates the protocol from random data and other protocols
 116 #define PROTOCOL_ID 0x4f457403
 117
 118 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
 119                                // base64-encoded SHA-1 (27+\0).
 120
 121 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_."
 122
 123 enum ToClientCommand
 124 {
 125         TOCLIENT_INIT = 0x10,
 126         /*
 127                 Server's reply to TOSERVER_INIT.
 128                 Sent second after connected.
 129
 130                 [0] u16 TOSERVER_INIT
 131                 [2] u8 deployed version
 132                 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
 133                 [12] u64 map seed (new as of 2011-02-27)
 134                 [20] f1000 recommended send interval (in seconds) (new as of 14)
 135
 136                 NOTE: The position in here is deprecated; position is
 137                       explicitly sent afterwards
 138         */
 139
 140         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
 141         TOCLIENT_ADDNODE = 0x21,
 142         /*
 143                 u16 command
 144                 v3s16 position
 145                 serialized mapnode
 146                 u8 keep_metadata // Added in protocol version 22
 147         */
 148         TOCLIENT_REMOVENODE = 0x22,
 149
 150         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
 151         /*
 152                 [0] u16 command
 153                 // Followed by an arbitary number of these:
 154                 // Number is determined from packet length.
 155                 [N] u16 peer_id
 156                 [N+2] v3s32 position*100
 157                 [N+2+12] v3s32 speed*100
 158                 [N+2+12+12] s32 pitch*100
 159                 [N+2+12+12+4] s32 yaw*100
 160         */
 161
 162         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
 163         /*
 164                 [0] u16 command
 165                 // Followed by an arbitary number of these:
 166                 // Number is determined from packet length.
 167                 [N] u16 peer_id
 168                 [N] char[20] name
 169         */
 170
 171         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
 172
 173         TOCLIENT_SECTORMETA = 0x26, // Obsolete
 174         /*
 175                 [0] u16 command
 176                 [2] u8 sector count
 177                 [3...] v2s16 pos + sector metadata
 178         */
 179
 180         TOCLIENT_INVENTORY = 0x27,
 181         /*
 182                 [0] u16 command
 183                 [2] serialized inventory
 184         */
 185
 186         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
 187         /*
 188                 Sent as unreliable.
 189
 190                 u16 command
 191                 u16 number of player positions
 192                 for each player:
 193                         u16 peer_id
 194                         v3s32 position*100
 195                         v3s32 speed*100
 196                         s32 pitch*100
 197                         s32 yaw*100
 198                 u16 count of blocks
 199                 for each block:
 200                         v3s16 blockpos
 201                         block objects
 202         */
 203
 204         TOCLIENT_TIME_OF_DAY = 0x29,
 205         /*
 206                 u16 command
 207                 u16 time (0-23999)
 208                 Added in a later version:
 209                 f1000 time_speed
 210         */
 211
 212         // (oops, there is some gap here)
 213
 214         TOCLIENT_CHAT_MESSAGE = 0x30,
 215         /*
 216                 u16 command
 217                 u16 length
 218                 wstring message
 219         */
 220
 221         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 222         /*
 223                 u16 command
 224                 u16 count of removed objects
 225                 for all removed objects {
 226                         u16 id
 227                 }
 228                 u16 count of added objects
 229                 for all added objects {
 230                         u16 id
 231                         u8 type
 232                         u32 initialization data length
 233                         string initialization data
 234                 }
 235         */
 236
 237         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 238         /*
 239                 u16 command
 240                 for all objects
 241                 {
 242                         u16 id
 243                         u16 message length
 244                         string message
 245                 }
 246         */
 247
 248         TOCLIENT_HP = 0x33,
 249         /*
 250                 u16 command
 251                 u8 hp
 252         */
 253
 254         TOCLIENT_MOVE_PLAYER = 0x34,
 255         /*
 256                 u16 command
 257                 v3f1000 player position
 258                 f1000 player pitch
 259                 f1000 player yaw
 260         */
 261
 262         TOCLIENT_ACCESS_DENIED = 0x35,
 263         /*
 264                 u16 command
 265                 u16 reason_length
 266                 wstring reason
 267         */
 268
 269         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
 270         /*
 271                 u16 command
 272                 u16 count of player items
 273                 for all player items {
 274                         u16 peer id
 275                         u16 length of serialized item
 276                         string serialized item
 277                 }
 278         */
 279
 280         TOCLIENT_DEATHSCREEN = 0x37,
 281         /*
 282                 u16 command
 283                 u8 bool set camera point target
 284                 v3f1000 camera point target (to point the death cause or whatever)
 285         */
 286
 287         TOCLIENT_MEDIA = 0x38,
 288         /*
 289                 u16 command
 290                 u16 total number of texture bunches
 291                 u16 index of this bunch
 292                 u32 number of files in this bunch
 293                 for each file {
 294                         u16 length of name
 295                         string name
 296                         u32 length of data
 297                         data
 298                 }
 299                 u16 length of remote media server url (if applicable)
 300                 string url
 301         */
 302
 303         TOCLIENT_TOOLDEF = 0x39,
 304         /*
 305                 u16 command
 306                 u32 length of the next item
 307                 serialized ToolDefManager
 308         */
 309
 310         TOCLIENT_NODEDEF = 0x3a,
 311         /*
 312                 u16 command
 313                 u32 length of the next item
 314                 serialized NodeDefManager
 315         */
 316
 317         TOCLIENT_CRAFTITEMDEF = 0x3b,
 318         /*
 319                 u16 command
 320                 u32 length of the next item
 321                 serialized CraftiItemDefManager
 322         */
 323
 324         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 325
 326         /*
 327                 u16 command
 328                 u32 number of files
 329                 for each texture {
 330                         u16 length of name
 331                         string name
 332                         u16 length of sha1_digest
 333                         string sha1_digest
 334                 }
 335         */
 336
 337         TOCLIENT_ITEMDEF = 0x3d,
 338         /*
 339                 u16 command
 340                 u32 length of next item
 341                 serialized ItemDefManager
 342         */
 343
 344         TOCLIENT_PLAY_SOUND = 0x3f,
 345         /*
 346                 u16 command
 347                 s32 sound_id
 348                 u16 len
 349                 u8[len] sound name
 350                 s32 gain*1000
 351                 u8 type (0=local, 1=positional, 2=object)
 352                 s32[3] pos_nodes*10000
 353                 u16 object_id
 354                 u8 loop (bool)
 355         */
 356
 357         TOCLIENT_STOP_SOUND = 0x40,
 358         /*
 359                 u16 command
 360                 s32 sound_id
 361         */
 362
 363         TOCLIENT_PRIVILEGES = 0x41,
 364         /*
 365                 u16 command
 366                 u16 number of privileges
 367                 for each privilege
 368                         u16 len
 369                         u8[len] privilege
 370         */
 371
 372         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 373         /*
 374                 u16 command
 375                 u32 len
 376                 u8[len] formspec
 377         */
 378
 379         TOCLIENT_DETACHED_INVENTORY = 0x43,
 380         /*
 381                 [0] u16 command
 382                 u16 len
 383                 u8[len] name
 384                 [2] serialized inventory
 385         */
 386
 387         TOCLIENT_SHOW_FORMSPEC = 0x44,
 388         /*
 389                 [0] u16 command
 390                 u32 len
 391                 u8[len] formspec
 392                 u16 len
 393                 u8[len] formname
 394         */
 395
 396         TOCLIENT_MOVEMENT = 0x45,
 397         /*
 398                 u16 command
 399                 f1000 movement_acceleration_default
 400                 f1000 movement_acceleration_air
 401                 f1000 movement_acceleration_fast
 402                 f1000 movement_speed_walk
 403                 f1000 movement_speed_crouch
 404                 f1000 movement_speed_fast
 405                 f1000 movement_speed_climb
 406                 f1000 movement_speed_jump
 407                 f1000 movement_liquid_fluidity
 408                 f1000 movement_liquid_fluidity_smooth
 409                 f1000 movement_liquid_sink
 410                 f1000 movement_gravity
 411         */
 412
 413         TOCLIENT_SPAWN_PARTICLE = 0x46,
 414         /*
 415                 u16 command
 416                 v3f1000 pos
 417                 v3f1000 velocity
 418                 v3f1000 acceleration
 419                 f1000 expirationtime
 420                 f1000 size
 421                 u8 bool collisiondetection
 422                 u8 bool vertical
 423                 u32 len
 424                 u8[len] texture
 425         */
 426
 427         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
 428         /*
 429                 u16 command
 430                 u16 amount
 431                 f1000 spawntime
 432                 v3f1000 minpos
 433                 v3f1000 maxpos
 434                 v3f1000 minvel
 435                 v3f1000 maxvel
 436                 v3f1000 minacc
 437                 v3f1000 maxacc
 438                 f1000 minexptime
 439                 f1000 maxexptime
 440                 f1000 minsize
 441                 f1000 maxsize
 442                 u8 bool collisiondetection
 443                 u8 bool vertical
 444                 u32 len
 445                 u8[len] texture
 446                 u32 id
 447         */
 448
 449         TOCLIENT_DELETE_PARTICLESPAWNER = 0x48,
 450         /*
 451                 u16 command
 452                 u32 id
 453         */
 454
 455         TOCLIENT_HUDADD = 0x49,
 456         /*
 457                 u16 command
 458                 u32 id
 459                 u8 type
 460                 v2f1000 pos
 461                 u32 len
 462                 u8[len] name
 463                 v2f1000 scale
 464                 u32 len2
 465                 u8[len2] text
 466                 u32 number
 467                 u32 item
 468                 u32 dir
 469                 v2f1000 align
 470                 v2f1000 offset
 471         */
 472
 473         TOCLIENT_HUDRM = 0x4a,
 474         /*
 475                 u16 command
 476                 u32 id
 477         */
 478
 479         TOCLIENT_HUDCHANGE = 0x4b,
 480         /*
 481                 u16 command
 482                 u32 id
 483                 u8 stat
 484                 [v2f1000 data |
 485                  u32 len
 486                  u8[len] data |
 487                  u32 data]
 488         */
 489
 490         TOCLIENT_HUD_SET_FLAGS = 0x4c,
 491         /*
 492                 u16 command
 493                 u32 flags
 494                 u32 mask
 495         */
 496
 497         TOCLIENT_HUD_SET_PARAM = 0x4d,
 498         /*
 499                 u16 command
 500                 u16 param
 501                 u16 len
 502                 u8[len] value
 503         */
 504
 505         TOCLIENT_BREATH = 0x4e,
 506         /*
 507                 u16 command
 508                 u16 breath
 509         */
 510
 511         TOCLIENT_SET_SKY = 0x4f,
 512         /*
 513                 u16 command
 514                 u8[4] color (ARGB)
 515                 u8 len
 516                 u8[len] type
 517                 u16 count
 518                 foreach count:
 519                         u8 len
 520                         u8[len] param
 521         */
 522 };
 523
 524 enum ToServerCommand
 525 {
 526         TOSERVER_INIT=0x10,
 527         /*
 528                 Sent first after connected.
 529
 530                 [0] u16 TOSERVER_INIT
 531                 [2] u8 SER_FMT_VER_HIGHEST_READ
 532                 [3] u8[20] player_name
 533                 [23] u8[28] password (new in some version)
 534                 [51] u16 minimum supported network protocol version (added sometime)
 535                 [53] u16 maximum supported network protocol version (added later than the previous one)
 536         */
 537
 538         TOSERVER_INIT2 = 0x11,
 539         /*
 540                 Sent as an ACK for TOCLIENT_INIT.
 541                 After this, the server can send data.
 542
 543                 [0] u16 TOSERVER_INIT2
 544         */
 545
 546         TOSERVER_GETBLOCK=0x20, // Obsolete
 547         TOSERVER_ADDNODE = 0x21, // Obsolete
 548         TOSERVER_REMOVENODE = 0x22, // Obsolete
 549
 550         TOSERVER_PLAYERPOS = 0x23,
 551         /*
 552                 [0] u16 command
 553                 [2] v3s32 position*100
 554                 [2+12] v3s32 speed*100
 555                 [2+12+12] s32 pitch*100
 556                 [2+12+12+4] s32 yaw*100
 557                 [2+12+12+4+4] u32 keyPressed
 558         */
 559
 560         TOSERVER_GOTBLOCKS = 0x24,
 561         /*
 562                 [0] u16 command
 563                 [2] u8 count
 564                 [3] v3s16 pos_0
 565                 [3+6] v3s16 pos_1
 566                 ...
 567         */
 568
 569         TOSERVER_DELETEDBLOCKS = 0x25,
 570         /*
 571                 [0] u16 command
 572                 [2] u8 count
 573                 [3] v3s16 pos_0
 574                 [3+6] v3s16 pos_1
 575                 ...
 576         */
 577
 578         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 579         /*
 580                 [0] u16 command
 581                 [2] v3s16 pos
 582                 [8] u16 i
 583         */
 584
 585         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 586         /*
 587                 length: 13
 588                 [0] u16 command
 589                 [2] u8 button (0=left, 1=right)
 590                 [3] v3s16 blockpos
 591                 [9] s16 id
 592                 [11] u16 item
 593         */
 594
 595         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 596         /*
 597                 length: 17
 598                 [0] u16 command
 599                 [2] u8 action
 600                 [3] v3s16 nodepos_undersurface
 601                 [9] v3s16 nodepos_abovesurface
 602                 [15] u16 item
 603                 actions:
 604                 0: start digging (from undersurface)
 605                 1: place block (to abovesurface)
 606                 2: stop digging (all parameters ignored)
 607                 3: digging completed
 608         */
 609
 610         TOSERVER_RELEASE = 0x29, // Obsolete
 611
 612         // (oops, there is some gap here)
 613
 614         TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
 615         /*
 616                 u16 command
 617                 v3s16 blockpos
 618                 s16 id
 619                 u16 textlen
 620                 textdata
 621         */
 622
 623         TOSERVER_INVENTORY_ACTION = 0x31,
 624         /*
 625                 See InventoryAction in inventory.h
 626         */
 627
 628         TOSERVER_CHAT_MESSAGE = 0x32,
 629         /*
 630                 u16 command
 631                 u16 length
 632                 wstring message
 633         */
 634
 635         TOSERVER_SIGNNODETEXT = 0x33, // obsolete
 636         /*
 637                 u16 command
 638                 v3s16 p
 639                 u16 textlen
 640                 textdata
 641         */
 642
 643         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 644         /*
 645                 length: 7
 646                 [0] u16 command
 647                 [2] u8 button (0=left, 1=right)
 648                 [3] u16 id
 649                 [5] u16 item
 650         */
 651
 652         TOSERVER_DAMAGE = 0x35,
 653         /*
 654                 u16 command
 655                 u8 amount
 656         */
 657
 658         TOSERVER_PASSWORD=0x36,
 659         /*
 660                 Sent to change password.
 661
 662                 [0] u16 TOSERVER_PASSWORD
 663                 [2] u8[28] old password
 664                 [30] u8[28] new password
 665         */
 666
 667         TOSERVER_PLAYERITEM=0x37,
 668         /*
 669                 Sent to change selected item.
 670
 671                 [0] u16 TOSERVER_PLAYERITEM
 672                 [2] u16 item
 673         */
 674
 675         TOSERVER_RESPAWN=0x38,
 676         /*
 677                 u16 TOSERVER_RESPAWN
 678         */
 679
 680         TOSERVER_INTERACT = 0x39,
 681         /*
 682                 [0] u16 command
 683                 [2] u8 action
 684                 [3] u16 item
 685                 [5] u32 length of the next item
 686                 [9] serialized PointedThing
 687                 actions:
 688                 0: start digging (from undersurface) or use
 689                 1: stop digging (all parameters ignored)
 690                 2: digging completed
 691                 3: place block or item (to abovesurface)
 692                 4: use item
 693
 694                 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
 695         */
 696
 697         TOSERVER_REMOVED_SOUNDS = 0x3a,
 698         /*
 699                 u16 command
 700                 u16 len
 701                 s32[len] sound_id
 702         */
 703
 704         TOSERVER_NODEMETA_FIELDS = 0x3b,
 705         /*
 706                 u16 command
 707                 v3s16 p
 708                 u16 len
 709                 u8[len] form name (reserved for future use)
 710                 u16 number of fields
 711                 for each field:
 712                         u16 len
 713                         u8[len] field name
 714                         u32 len
 715                         u8[len] field value
 716         */
 717
 718         TOSERVER_INVENTORY_FIELDS = 0x3c,
 719         /*
 720                 u16 command
 721                 u16 len
 722                 u8[len] form name (reserved for future use)
 723                 u16 number of fields
 724                 for each field:
 725                         u16 len
 726                         u8[len] field name
 727                         u32 len
 728                         u8[len] field value
 729         */
 730
 731         TOSERVER_REQUEST_MEDIA = 0x40,
 732         /*
 733                 u16 command
 734                 u16 number of files requested
 735                 for each file {
 736                         u16 length of name
 737                         string name
 738                 }
 739          */
 740
 741         TOSERVER_RECEIVED_MEDIA = 0x41,
 742         /*
 743                 u16 command
 744         */
 745
 746         TOSERVER_BREATH = 0x42,
 747         /*
 748                 u16 command
 749                 u16 breath
 750         */
 751 };
 752
 753 #endif
 754