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