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