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