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