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