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 #define PROTOCOL_ID 0x4f457403
  26
  27 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
  28                                // base64-encoded SHA-1 (27+\0).
  29
  30 enum ToClientCommand
  31 {
  32         TOCLIENT_INIT = 0x10,
  33         /*
  34                 Server's reply to TOSERVER_INIT.
  35                 Sent second after connected.
  36
  37                 [0] u16 TOSERVER_INIT
  38                 [2] u8 deployed version
  39                 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
  40                 [12] u64 map seed (new as of 2011-02-27)
  41
  42                 NOTE: The position in here is deprecated; position is
  43                       explicitly sent afterwards
  44         */
  45
  46         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
  47         TOCLIENT_ADDNODE = 0x21,
  48         TOCLIENT_REMOVENODE = 0x22,
  49
  50         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
  51         /*
  52                 [0] u16 command
  53                 // Followed by an arbitary number of these:
  54                 // Number is determined from packet length.
  55                 [N] u16 peer_id
  56                 [N+2] v3s32 position*100
  57                 [N+2+12] v3s32 speed*100
  58                 [N+2+12+12] s32 pitch*100
  59                 [N+2+12+12+4] s32 yaw*100
  60         */
  61
  62         TOCLIENT_PLAYERINFO = 0x24,
  63         /*
  64                 [0] u16 command
  65                 // Followed by an arbitary number of these:
  66                 // Number is determined from packet length.
  67                 [N] u16 peer_id
  68                 [N] char[20] name
  69         */
  70
  71         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
  72
  73         TOCLIENT_SECTORMETA = 0x26, // Obsolete
  74         /*
  75                 [0] u16 command
  76                 [2] u8 sector count
  77                 [3...] v2s16 pos + sector metadata
  78         */
  79
  80         TOCLIENT_INVENTORY = 0x27,
  81         /*
  82                 [0] u16 command
  83                 [2] serialized inventory
  84         */
  85
  86         TOCLIENT_OBJECTDATA = 0x28,
  87         /*
  88                 Sent as unreliable.
  89
  90                 u16 command
  91                 u16 number of player positions
  92                 for each player:
  93                         v3s32 position*100
  94                         v3s32 speed*100
  95                         s32 pitch*100
  96                         s32 yaw*100
  97                 u16 count of blocks
  98                 for each block:
  99                         v3s16 blockpos
 100                         block objects
 101         */
 102
 103         TOCLIENT_TIME_OF_DAY = 0x29,
 104         /*
 105                 u16 command
 106                 u16 time (0-23999)
 107         */
 108
 109         TOCLIENT_CHAT_MESSAGE = 0x30,
 110         /*
 111                 u16 command
 112                 u16 length
 113                 wstring message
 114         */
 115
 116         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
 117         /*
 118                 u16 command
 119                 u16 count of removed objects
 120                 for all removed objects {
 121                         u16 id
 122                 }
 123                 u16 count of added objects
 124                 for all added objects {
 125                         u16 id
 126                         u8 type
 127                         u16 initialization data length
 128                         string initialization data
 129                 }
 130         */
 131
 132         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
 133         /*
 134                 u16 command
 135                 for all objects
 136                 {
 137                         u16 id
 138                         u16 message length
 139                         string message
 140                 }
 141         */
 142
 143         TOCLIENT_HP = 0x33,
 144         /*
 145                 u16 command
 146                 u8 hp
 147         */
 148
 149         TOCLIENT_MOVE_PLAYER = 0x34,
 150         /*
 151                 u16 command
 152                 v3f1000 player position
 153                 f1000 player pitch
 154                 f1000 player yaw
 155         */
 156
 157         TOCLIENT_ACCESS_DENIED = 0x35,
 158         /*
 159                 u16 command
 160                 u16 reason_length
 161                 wstring reason
 162         */
 163
 164         TOCLIENT_PLAYERITEM = 0x36,
 165         /*
 166                 u16 command
 167                 u16 peer id
 168                 string serialized item
 169         */
 170 };
 171
 172 enum ToServerCommand
 173 {
 174         TOSERVER_INIT=0x10,
 175         /*
 176                 Sent first after connected.
 177
 178                 [0] u16 TOSERVER_INIT
 179                 [2] u8 SER_FMT_VER_HIGHEST
 180                 [3] u8[20] player_name
 181                 [23] u8[28] password (new in some version)
 182                 [51] u16 client network protocol version (new in some version)
 183         */
 184
 185         TOSERVER_INIT2 = 0x11,
 186         /*
 187                 Sent as an ACK for TOCLIENT_INIT.
 188                 After this, the server can send data.
 189
 190                 [0] u16 TOSERVER_INIT2
 191         */
 192
 193         TOSERVER_GETBLOCK=0x20, // Obsolete
 194         TOSERVER_ADDNODE = 0x21, // Obsolete
 195         TOSERVER_REMOVENODE = 0x22, // Obsolete
 196
 197         TOSERVER_PLAYERPOS = 0x23,
 198         /*
 199                 [0] u16 command
 200                 [2] v3s32 position*100
 201                 [2+12] v3s32 speed*100
 202                 [2+12+12] s32 pitch*100
 203                 [2+12+12+4] s32 yaw*100
 204         */
 205
 206         TOSERVER_GOTBLOCKS = 0x24,
 207         /*
 208                 [0] u16 command
 209                 [2] u8 count
 210                 [3] v3s16 pos_0
 211                 [3+6] v3s16 pos_1
 212                 ...
 213         */
 214
 215         TOSERVER_DELETEDBLOCKS = 0x25,
 216         /*
 217                 [0] u16 command
 218                 [2] u8 count
 219                 [3] v3s16 pos_0
 220                 [3+6] v3s16 pos_1
 221                 ...
 222         */
 223
 224         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
 225         /*
 226                 [0] u16 command
 227                 [2] v3s16 pos
 228                 [8] u16 i
 229         */
 230
 231         TOSERVER_CLICK_OBJECT = 0x27,
 232         /*
 233                 length: 13
 234                 [0] u16 command
 235                 [2] u8 button (0=left, 1=right)
 236                 [3] v3s16 blockpos
 237                 [9] s16 id
 238                 [11] u16 item
 239         */
 240
 241         TOSERVER_GROUND_ACTION = 0x28,
 242         /*
 243                 length: 17
 244                 [0] u16 command
 245                 [2] u8 action
 246                 [3] v3s16 nodepos_undersurface
 247                 [9] v3s16 nodepos_abovesurface
 248                 [15] u16 item
 249                 actions:
 250                 0: start digging (from undersurface)
 251                 1: place block (to abovesurface)
 252                 2: stop digging (all parameters ignored)
 253                 3: digging completed
 254         */
 255
 256         TOSERVER_RELEASE = 0x29, // Obsolete
 257
 258         TOSERVER_SIGNTEXT = 0x30, // Old signs
 259         /*
 260                 u16 command
 261                 v3s16 blockpos
 262                 s16 id
 263                 u16 textlen
 264                 textdata
 265         */
 266
 267         TOSERVER_INVENTORY_ACTION = 0x31,
 268         /*
 269                 See InventoryAction in inventory.h
 270         */
 271
 272         TOSERVER_CHAT_MESSAGE = 0x32,
 273         /*
 274                 u16 command
 275                 u16 length
 276                 wstring message
 277         */
 278
 279         TOSERVER_SIGNNODETEXT = 0x33,
 280         /*
 281                 u16 command
 282                 v3s16 p
 283                 u16 textlen
 284                 textdata
 285         */
 286
 287         TOSERVER_CLICK_ACTIVEOBJECT = 0x34,
 288         /*
 289                 length: 7
 290                 [0] u16 command
 291                 [2] u8 button (0=left, 1=right)
 292                 [3] u16 id
 293                 [5] u16 item
 294         */
 295
 296         TOSERVER_DAMAGE = 0x35,
 297         /*
 298                 u16 command
 299                 u8 amount
 300         */
 301
 302         TOSERVER_PASSWORD=0x36,
 303         /*
 304                 Sent to change password.
 305
 306                 [0] u16 TOSERVER_PASSWORD
 307                 [2] u8[28] old password
 308                 [30] u8[28] new password
 309         */
 310
 311         TOSERVER_PLAYERITEM=0x37,
 312         /*
 313                 Sent to change selected item.
 314
 315                 [0] u16 TOSERVER_PLAYERITEM
 316                 [2] u16 item
 317         */
 318
 319 };
 320
 321 inline SharedBuffer<u8> makePacket_TOCLIENT_TIME_OF_DAY(u16 time)
 322 {
 323         SharedBuffer<u8> data(2+2);
 324         writeU16(&data[0], TOCLIENT_TIME_OF_DAY);
 325         writeU16(&data[2], time);
 326         return data;
 327 }
 328
 329 #endif
 330