src/clientserver.h

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