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                 u16 length of remote media server url (if applicable)
 271                 string url
 272         */
 273
 274         TOCLIENT_TOOLDEF = 0x39,
 275         /*
 276                 u16 command
 277                 u32 length of the next item
 278                 serialized ToolDefManager
 279         */
 280
 281         TOCLIENT_NODEDEF = 0x3a,
 282         /*
 283                 u16 command
 284                 u32 length of the next item
 285                 serialized NodeDefManager
 286         */
 287
 288         TOCLIENT_CRAFTITEMDEF = 0x3b,
 289         /*
 290                 u16 command
 291                 u32 length of the next item
 292                 serialized CraftiItemDefManager
 293         */
 294
 295         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
 296
 297         /*
 298                 u16 command
 299                 u32 number of files
 300                 for each texture {
 301                         u16 length of name
 302                         string name
 303                         u16 length of sha1_digest
 304                         string sha1_digest
 305                 }
 306         */
 307
 308         TOCLIENT_ITEMDEF = 0x3d,
 309         /*
 310                 u16 command
 311                 u32 length of next item
 312                 serialized ItemDefManager
 313         */
 314
 315         TOCLIENT_PLAY_SOUND = 0x3f,
 316         /*
 317                 u16 command
 318                 s32 sound_id
 319                 u16 len
 320                 u8[len] sound name
 321                 s32 gain*1000
 322                 u8 type (0=local, 1=positional, 2=object)
 323                 s32[3] pos_nodes*10000
 324                 u16 object_id
 325                 u8 loop (bool)
 326         */
 327
 328         TOCLIENT_STOP_SOUND = 0x40,
 329         /*
 330                 u16 command
 331                 s32 sound_id
 332         */
 333
 334         TOCLIENT_PRIVILEGES = 0x41,
 335         /*
 336                 u16 command
 337                 u16 number of privileges
 338                 for each privilege
 339                         u16 len
 340                         u8[len] privilege
 341         */
 342
 343         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
 344         /*
 345                 u16 command
 346                 u32 len
 347                 u8[len] formspec
 348         */
 349
 350         TOCLIENT_DETACHED_INVENTORY = 0x43,
 351         /*
 352                 [0] u16 command
 353                 u16 len
 354                 u8[len] name
 355                 [2] serialized inventory
 356         */
 357 };
 358
 359 enum ToServerCommand
 360 {
 361         TOSERVER_INIT=0x10,
 362         /*
 363                 Sent first after connected.
 364
 365                 [0] u16 TOSERVER_INIT
 366                 [2] u8 SER_FMT_VER_HIGHEST
 367                 [3] u8[20] player_name
 368                 [23] u8[28] password (new in some version)
 369                 [51] u16 minimum supported network protocol version (added sometime)
 370                 [53] u16 maximum supported network protocol version (added later than the previous one)
 371         */
 372
 373         TOSERVER_INIT2 = 0x11,
 374         /*
 375                 Sent as an ACK for TOCLIENT_INIT.
 376                 After this, the server can send data.
 377
 378                 [0] u16 TOSERVER_INIT2
 379         */
 380
 381         TOSERVER_GETBLOCK=0x20, // Obsolete
 382         TOSERVER_ADDNODE = 0x21, // Obsolete
 383         TOSERVER_REMOVENODE = 0x22, // Obsolete
 384
 385         TOSERVER_PLAYERPOS = 0x23,
 386         /*
 387                 [0] u16 command
 388                 [2] v3s32 position*100
 389                 [2+12] v3s32 speed*100
 390                 [2+12+12] s32 pitch*100
 391                 [2+12+12+4] s32 yaw*100
 392                 [2+12+12+4+4] u32 keyPressed
 393         */
 394
 395         TOSERVER_GOTBLOCKS = 0x24,
 396         /*
 397                 [0] u16 command
 398                 [2] u8 count
 399                 [3] v3s16 pos_0
 400                 [3+6] v3s16 pos_1
 401                 ...
 402         */
 403
 404         TOSERVER_DELETEDBLOCKS = 0x25,
 405         /*
 406                 [0] u16 command
 407                 [2] u8 count
 408                 [3] v3s16 pos_0
 409                 [3+6] v3s16 pos_1
 410                 ...
 411         */
 412
 413         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 414         /*
 415                 [0] u16 command
 416                 [2] v3s16 pos
 417                 [8] u16 i
 418         */
 419
 420         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
 421         /*
 422                 length: 13
 423                 [0] u16 command
 424                 [2] u8 button (0=left, 1=right)
 425                 [3] v3s16 blockpos
 426                 [9] s16 id
 427                 [11] u16 item
 428         */
 429
 430         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
 431         /*
 432                 length: 17
 433                 [0] u16 command
 434                 [2] u8 action
 435                 [3] v3s16 nodepos_undersurface
 436                 [9] v3s16 nodepos_abovesurface
 437                 [15] u16 item
 438                 actions:
 439                 0: start digging (from undersurface)
 440                 1: place block (to abovesurface)
 441                 2: stop digging (all parameters ignored)
 442                 3: digging completed
 443         */
 444
 445         TOSERVER_RELEASE = 0x29, // Obsolete
 446
 447         // (oops, there is some gap here)
 448
 449         TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
 450         /*
 451                 u16 command
 452                 v3s16 blockpos
 453                 s16 id
 454                 u16 textlen
 455                 textdata
 456         */
 457
 458         TOSERVER_INVENTORY_ACTION = 0x31,
 459         /*
 460                 See InventoryAction in inventory.h
 461         */
 462
 463         TOSERVER_CHAT_MESSAGE = 0x32,
 464         /*
 465                 u16 command
 466                 u16 length
 467                 wstring message
 468         */
 469
 470         TOSERVER_SIGNNODETEXT = 0x33, // obsolete
 471         /*
 472                 u16 command
 473                 v3s16 p
 474                 u16 textlen
 475                 textdata
 476         */
 477
 478         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
 479         /*
 480                 length: 7
 481                 [0] u16 command
 482                 [2] u8 button (0=left, 1=right)
 483                 [3] u16 id
 484                 [5] u16 item
 485         */
 486
 487         TOSERVER_DAMAGE = 0x35,
 488         /*
 489                 u16 command
 490                 u8 amount
 491         */
 492
 493         TOSERVER_PASSWORD=0x36,
 494         /*
 495                 Sent to change password.
 496
 497                 [0] u16 TOSERVER_PASSWORD
 498                 [2] u8[28] old password
 499                 [30] u8[28] new password
 500         */
 501
 502         TOSERVER_PLAYERITEM=0x37,
 503         /*
 504                 Sent to change selected item.
 505
 506                 [0] u16 TOSERVER_PLAYERITEM
 507                 [2] u16 item
 508         */
 509
 510         TOSERVER_RESPAWN=0x38,
 511         /*
 512                 u16 TOSERVER_RESPAWN
 513         */
 514
 515         TOSERVER_INTERACT = 0x39,
 516         /*
 517                 [0] u16 command
 518                 [2] u8 action
 519                 [3] u16 item
 520                 [5] u32 length of the next item
 521                 [9] serialized PointedThing
 522                 actions:
 523                 0: start digging (from undersurface) or use
 524                 1: stop digging (all parameters ignored)
 525                 2: digging completed
 526                 3: place block or item (to abovesurface)
 527                 4: use item
 528
 529                 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
 530         */
 531
 532         TOSERVER_REMOVED_SOUNDS = 0x3a,
 533         /*
 534                 u16 command
 535                 u16 len
 536                 s32[len] sound_id
 537         */
 538
 539         TOSERVER_NODEMETA_FIELDS = 0x3b,
 540         /*
 541                 u16 command
 542                 v3s16 p
 543                 u16 len
 544                 u8[len] form name (reserved for future use)
 545                 u16 number of fields
 546                 for each field:
 547                         u16 len
 548                         u8[len] field name
 549                         u32 len
 550                         u8[len] field value
 551         */
 552
 553         TOSERVER_INVENTORY_FIELDS = 0x3c,
 554         /*
 555                 u16 command
 556                 u16 len
 557                 u8[len] form name (reserved for future use)
 558                 u16 number of fields
 559                 for each field:
 560                         u16 len
 561                         u8[len] field name
 562                         u32 len
 563                         u8[len] field value
 564         */
 565
 566         TOSERVER_REQUEST_MEDIA = 0x40,
 567         /*
 568                 u16 command
 569                 u16 number of files requested
 570                 for each file {
 571                         u16 length of name
 572                         string name
 573                 }
 574          */
 575
 576         TOSERVER_RECEIVED_MEDIA = 0x41,
 577         /*
 578                 u16 command
 579         */
 580 };
 581
 582 #endif
 583