src/clientserver.h

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