Fix the serialization error by ff73c7a (#5964)
[oweals/minetest.git] / src / network / networkprotocol.h
1 /*
2 Minetest
3 Copyright (C) 2010-2013 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 NETWORKPROTOCOL_HEADER
21 #define NETWORKPROTOCOL_HEADER
22 #include "util/string.h"
23
24 /*
25         changes by PROTOCOL_VERSION:
26
27         PROTOCOL_VERSION 3:
28                 Base for writing changes here
29         PROTOCOL_VERSION 4:
30                 Add TOCLIENT_MEDIA
31                 Add TOCLIENT_TOOLDEF
32                 Add TOCLIENT_NODEDEF
33                 Add TOCLIENT_CRAFTITEMDEF
34                 Add TOSERVER_INTERACT
35                 Obsolete TOSERVER_CLICK_ACTIVEOBJECT
36                 Obsolete TOSERVER_GROUND_ACTION
37         PROTOCOL_VERSION 5:
38                 Make players to be handled mostly as ActiveObjects
39         PROTOCOL_VERSION 6:
40                 Only non-cached textures are sent
41         PROTOCOL_VERSION 7:
42                 Add TOCLIENT_ITEMDEF
43                 Obsolete TOCLIENT_TOOLDEF
44                 Obsolete TOCLIENT_CRAFTITEMDEF
45                 Compress the contents of TOCLIENT_ITEMDEF and TOCLIENT_NODEDEF
46         PROTOCOL_VERSION 8:
47                 Digging based on item groups
48                 Many things
49         PROTOCOL_VERSION 9:
50                 ContentFeatures and NodeDefManager use a different serialization
51                     format; better for future version cross-compatibility
52                 Many things
53                 Obsolete TOCLIENT_PLAYERITEM
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         PROTOCOL_VERSION 13:
69                 InventoryList field "Width" (deserialization fails with old versions)
70         PROTOCOL_VERSION 14:
71                 Added transfer of player pressed keys to the server
72                 Added new messages for mesh and bone animation, as well as attachments
73                 GENERIC_CMD_SET_ANIMATION
74                 GENERIC_CMD_SET_BONE_POSITION
75                 GENERIC_CMD_SET_ATTACHMENT
76         PROTOCOL_VERSION 15:
77                 Serialization format changes
78         PROTOCOL_VERSION 16:
79                 TOCLIENT_SHOW_FORMSPEC
80         PROTOCOL_VERSION 17:
81                 Serialization format change: include backface_culling flag in TileDef
82                 Added rightclickable field in nodedef
83                 TOCLIENT_SPAWN_PARTICLE
84                 TOCLIENT_ADD_PARTICLESPAWNER
85                 TOCLIENT_DELETE_PARTICLESPAWNER
86         PROTOCOL_VERSION 18:
87                 damageGroups added to ToolCapabilities
88                 sound_place added to ItemDefinition
89         PROTOCOL_VERSION 19:
90                 GENERIC_CMD_SET_PHYSICS_OVERRIDE
91         PROTOCOL_VERSION 20:
92                 TOCLIENT_HUDADD
93                 TOCLIENT_HUDRM
94                 TOCLIENT_HUDCHANGE
95                 TOCLIENT_HUD_SET_FLAGS
96         PROTOCOL_VERSION 21:
97                 TOCLIENT_BREATH
98                 TOSERVER_BREATH
99                 range added to ItemDefinition
100                 drowning, leveled and liquid_range added to ContentFeatures
101                 stepheight and collideWithObjects added to object properties
102                 version, heat and humidity transfer in MapBock
103                 automatic_face_movement_dir and automatic_face_movement_dir_offset
104                         added to object properties
105         PROTOCOL_VERSION 22:
106                 add swap_node
107         PROTOCOL_VERSION 23:
108                 Obsolete TOSERVER_RECEIVED_MEDIA
109                 Server: Stop using TOSERVER_CLIENT_READY
110         PROTOCOL_VERSION 24:
111                 ContentFeatures version 7
112                 ContentFeatures: change number of special tiles to 6 (CF_SPECIAL_COUNT)
113         PROTOCOL_VERSION 25:
114                 Rename TOCLIENT_ACCESS_DENIED to TOCLIENT_ACCESS_DENIED_LEGAGY
115                 Rename TOCLIENT_DELETE_PARTICLESPAWNER to
116                         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY
117                 Rename TOSERVER_PASSWORD to TOSERVER_PASSWORD_LEGACY
118                 Rename TOSERVER_INIT to TOSERVER_INIT_LEGACY
119                 Rename TOCLIENT_INIT to TOCLIENT_INIT_LEGACY
120                 Add TOCLIENT_ACCESS_DENIED new opcode (0x0A), using error codes
121                         for standard error, keeping customisation possible. This
122                         permit translation
123                 Add TOCLIENT_DELETE_PARTICLESPAWNER (0x53), fixing the u16 read and
124                         reading u32
125                 Add new opcode TOSERVER_INIT for client presentation to server
126                 Add new opcodes TOSERVER_FIRST_SRP, TOSERVER_SRP_BYTES_A,
127                         TOSERVER_SRP_BYTES_M, TOCLIENT_SRP_BYTES_S_B
128                         for the three supported auth mechanisms around srp
129                 Add new opcodes TOCLIENT_ACCEPT_SUDO_MODE and TOCLIENT_DENY_SUDO_MODE
130                         for sudo mode handling (auth mech generic way of changing password).
131                 Add TOCLIENT_HELLO for presenting server to client after client
132                         presentation
133                 Add TOCLIENT_AUTH_ACCEPT to accept connection from client
134                 Rename GENERIC_CMD_SET_ATTACHMENT to GENERIC_CMD_ATTACH_TO
135         PROTOCOL_VERSION 26:
136                 Add TileDef tileable_horizontal, tileable_vertical flags
137         PROTOCOL_VERSION 27:
138                 backface_culling: backwards compatibility for playing with
139                 newer client on pre-27 servers.
140                 Add nodedef v3 - connected nodeboxes
141         PROTOCOL_VERSION 28:
142                 CPT2_MESHOPTIONS
143         PROTOCOL_VERSION 29:
144                 Server doesn't accept TOSERVER_BREATH anymore
145                 serialization of TileAnimation params changed
146                 TAT_SHEET_2D
147                 Removed client-sided chat perdiction
148         PROTOCOL VERSION 30:
149                 New ContentFeatures serialization version
150                 Add node and tile color and palette
151                 Fix plantlike visual_scale being applied squared and add compatibility
152                         with pre-30 clients by sending sqrt(visual_scale)
153         PROTOCOL VERSION 31:
154                 Add tile overlay
155                 Stop sending TOSERVER_CLIENT_READY
156         PROTOCOL VERSION 32:
157                 Add fading sounds
158         PROTOCOL VERSION 33:
159                 Add TOCLIENT_UPDATE_PLAYER_LIST and send the player list to the client,
160                         instead of guessing based on the active object list.
161         PROTOCOL VERSION 34:
162                 Add sound pitch
163 */
164
165 #define LATEST_PROTOCOL_VERSION 34
166
167 // Server's supported network protocol range
168 #define SERVER_PROTOCOL_VERSION_MIN 24
169 #define SERVER_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
170
171 // Client's supported network protocol range
172 // The minimal version depends on whether
173 // send_pre_v25_init is enabled or not
174 #define CLIENT_PROTOCOL_VERSION_MIN 25
175 #define CLIENT_PROTOCOL_VERSION_MIN_LEGACY 24
176 #define CLIENT_PROTOCOL_VERSION_MAX LATEST_PROTOCOL_VERSION
177
178 // Constant that differentiates the protocol from random data and other protocols
179 #define PROTOCOL_ID 0x4f457403
180
181 #define PASSWORD_SIZE 28       // Maximum password length. Allows for
182                                // base64-encoded SHA-1 (27+\0).
183
184 #define FORMSPEC_API_VERSION 1
185 #define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"
186
187 #define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"
188
189 enum ToClientCommand
190 {
191         TOCLIENT_HELLO = 0x02,
192         /*
193                 Sent after TOSERVER_INIT.
194
195                 u8 deployed serialisation version
196                 u16 deployed network compression mode
197                 u16 deployed protocol version
198                 u32 supported auth methods
199                 std::string username that should be used for legacy hash (for proper casing)
200         */
201         TOCLIENT_AUTH_ACCEPT = 0x03,
202         /*
203                 Message from server to accept auth.
204
205                 v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
206                 u64 map seed
207                 f1000 recommended send interval
208                 u32 : supported auth methods for sudo mode
209                       (where the user can change their password)
210         */
211         TOCLIENT_ACCEPT_SUDO_MODE = 0x04,
212         /*
213                 Sent to client to show it is in sudo mode now.
214         */
215         TOCLIENT_DENY_SUDO_MODE = 0x05,
216         /*
217                 Signals client that sudo mode auth failed.
218         */
219         TOCLIENT_INIT_LEGACY = 0x10,
220         /*
221                 Server's reply to TOSERVER_INIT.
222                 Sent second after connected.
223
224                 [0] u16 TOSERVER_INIT
225                 [2] u8 deployed version
226                 [3] v3s16 player's position + v3f(0,BS/2,0) floatToInt'd
227                 [12] u64 map seed (new as of 2011-02-27)
228                 [20] f1000 recommended send interval (in seconds) (new as of 14)
229
230                 NOTE: The position in here is deprecated; position is
231                       explicitly sent afterwards
232         */
233         TOCLIENT_ACCESS_DENIED = 0x0A,
234         /*
235                 u8 reason
236                 std::string custom reason (if needed, otherwise "")
237                 u8 (bool) reconnect
238         */
239         TOCLIENT_BLOCKDATA = 0x20, //TODO: Multiple blocks
240         TOCLIENT_ADDNODE = 0x21,
241         /*
242                 v3s16 position
243                 serialized mapnode
244                 u8 keep_metadata // Added in protocol version 22
245         */
246         TOCLIENT_REMOVENODE = 0x22,
247
248         TOCLIENT_PLAYERPOS = 0x23, // Obsolete
249         /*
250                 [0] u16 command
251                 // Followed by an arbitary number of these:
252                 // Number is determined from packet length.
253                 [N] u16 peer_id
254                 [N+2] v3s32 position*100
255                 [N+2+12] v3s32 speed*100
256                 [N+2+12+12] s32 pitch*100
257                 [N+2+12+12+4] s32 yaw*100
258         */
259
260         TOCLIENT_PLAYERINFO = 0x24, // Obsolete
261         /*
262                 [0] u16 command
263                 // Followed by an arbitary number of these:
264                 // Number is determined from packet length.
265                 [N] u16 peer_id
266                 [N] char[20] name
267         */
268
269         TOCLIENT_OPT_BLOCK_NOT_FOUND = 0x25, // Obsolete
270
271         TOCLIENT_SECTORMETA = 0x26, // Obsolete
272         /*
273                 [0] u16 command
274                 [2] u8 sector count
275                 [3...] v2s16 pos + sector metadata
276         */
277
278         TOCLIENT_INVENTORY = 0x27,
279         /*
280                 [0] u16 command
281                 [2] serialized inventory
282         */
283
284         TOCLIENT_OBJECTDATA = 0x28, // Obsolete
285         /*
286                 Sent as unreliable.
287
288                 u16 number of player positions
289                 for each player:
290                         u16 peer_id
291                         v3s32 position*100
292                         v3s32 speed*100
293                         s32 pitch*100
294                         s32 yaw*100
295                 u16 count of blocks
296                 for each block:
297                         v3s16 blockpos
298                         block objects
299         */
300
301         TOCLIENT_TIME_OF_DAY = 0x29,
302         /*
303                 u16 time (0-23999)
304                 Added in a later version:
305                 f1000 time_speed
306         */
307
308         // (oops, there is some gap here)
309
310         TOCLIENT_CHAT_MESSAGE = 0x30,
311         /*
312                 u16 length
313                 wstring message
314         */
315
316         TOCLIENT_ACTIVE_OBJECT_REMOVE_ADD = 0x31,
317         /*
318                 u16 count of removed objects
319                 for all removed objects {
320                         u16 id
321                 }
322                 u16 count of added objects
323                 for all added objects {
324                         u16 id
325                         u8 type
326                         u32 initialization data length
327                         string initialization data
328                 }
329         */
330
331         TOCLIENT_ACTIVE_OBJECT_MESSAGES = 0x32,
332         /*
333                 for all objects
334                 {
335                         u16 id
336                         u16 message length
337                         string message
338                 }
339         */
340
341         TOCLIENT_HP = 0x33,
342         /*
343                 u8 hp
344         */
345
346         TOCLIENT_MOVE_PLAYER = 0x34,
347         /*
348                 v3f1000 player position
349                 f1000 player pitch
350                 f1000 player yaw
351         */
352
353         TOCLIENT_ACCESS_DENIED_LEGACY = 0x35,
354         /*
355                 u16 reason_length
356                 wstring reason
357         */
358
359         TOCLIENT_PLAYERITEM = 0x36, // Obsolete
360         /*
361                 u16 count of player items
362                 for all player items {
363                         u16 peer id
364                         u16 length of serialized item
365                         string serialized item
366                 }
367         */
368
369         TOCLIENT_DEATHSCREEN = 0x37,
370         /*
371                 u8 bool set camera point target
372                 v3f1000 camera point target (to point the death cause or whatever)
373         */
374
375         TOCLIENT_MEDIA = 0x38,
376         /*
377                 u16 total number of texture bunches
378                 u16 index of this bunch
379                 u32 number of files in this bunch
380                 for each file {
381                         u16 length of name
382                         string name
383                         u32 length of data
384                         data
385                 }
386                 u16 length of remote media server url (if applicable)
387                 string url
388         */
389
390         TOCLIENT_TOOLDEF = 0x39,
391         /*
392                 u32 length of the next item
393                 serialized ToolDefManager
394         */
395
396         TOCLIENT_NODEDEF = 0x3a,
397         /*
398                 u32 length of the next item
399                 serialized NodeDefManager
400         */
401
402         TOCLIENT_CRAFTITEMDEF = 0x3b,
403         /*
404                 u32 length of the next item
405                 serialized CraftiItemDefManager
406         */
407
408         TOCLIENT_ANNOUNCE_MEDIA = 0x3c,
409
410         /*
411                 u32 number of files
412                 for each texture {
413                         u16 length of name
414                         string name
415                         u16 length of sha1_digest
416                         string sha1_digest
417                 }
418         */
419
420         TOCLIENT_ITEMDEF = 0x3d,
421         /*
422                 u32 length of next item
423                 serialized ItemDefManager
424         */
425
426         TOCLIENT_PLAY_SOUND = 0x3f,
427         /*
428                 s32 sound_id
429                 u16 len
430                 u8[len] sound name
431                 s32 gain*1000
432                 u8 type (0=local, 1=positional, 2=object)
433                 s32[3] pos_nodes*10000
434                 u16 object_id
435                 u8 loop (bool)
436         */
437
438         TOCLIENT_STOP_SOUND = 0x40,
439         /*
440                 s32 sound_id
441         */
442
443         TOCLIENT_PRIVILEGES = 0x41,
444         /*
445                 u16 number of privileges
446                 for each privilege
447                         u16 len
448                         u8[len] privilege
449         */
450
451         TOCLIENT_INVENTORY_FORMSPEC = 0x42,
452         /*
453                 u32 len
454                 u8[len] formspec
455         */
456
457         TOCLIENT_DETACHED_INVENTORY = 0x43,
458         /*
459                 [0] u16 command
460                 u16 len
461                 u8[len] name
462                 [2] serialized inventory
463         */
464
465         TOCLIENT_SHOW_FORMSPEC = 0x44,
466         /*
467                 [0] u16 command
468                 u32 len
469                 u8[len] formspec
470                 u16 len
471                 u8[len] formname
472         */
473
474         TOCLIENT_MOVEMENT = 0x45,
475         /*
476                 f1000 movement_acceleration_default
477                 f1000 movement_acceleration_air
478                 f1000 movement_acceleration_fast
479                 f1000 movement_speed_walk
480                 f1000 movement_speed_crouch
481                 f1000 movement_speed_fast
482                 f1000 movement_speed_climb
483                 f1000 movement_speed_jump
484                 f1000 movement_liquid_fluidity
485                 f1000 movement_liquid_fluidity_smooth
486                 f1000 movement_liquid_sink
487                 f1000 movement_gravity
488         */
489
490         TOCLIENT_SPAWN_PARTICLE = 0x46,
491         /*
492                 v3f1000 pos
493                 v3f1000 velocity
494                 v3f1000 acceleration
495                 f1000 expirationtime
496                 f1000 size
497                 u8 bool collisiondetection
498                 u8 bool vertical
499                 u32 len
500                 u8[len] texture
501                 u8 collision_removal
502         */
503
504         TOCLIENT_ADD_PARTICLESPAWNER = 0x47,
505         /*
506                 u16 amount
507                 f1000 spawntime
508                 v3f1000 minpos
509                 v3f1000 maxpos
510                 v3f1000 minvel
511                 v3f1000 maxvel
512                 v3f1000 minacc
513                 v3f1000 maxacc
514                 f1000 minexptime
515                 f1000 maxexptime
516                 f1000 minsize
517                 f1000 maxsize
518                 u8 bool collisiondetection
519                 u8 bool vertical
520                 u32 len
521                 u8[len] texture
522                 u32 id
523                 u8 collision_removal
524         */
525
526         TOCLIENT_DELETE_PARTICLESPAWNER_LEGACY = 0x48,
527         /*
528                 u16 id
529         */
530
531         TOCLIENT_HUDADD = 0x49,
532         /*
533                 u32 id
534                 u8 type
535                 v2f1000 pos
536                 u32 len
537                 u8[len] name
538                 v2f1000 scale
539                 u32 len2
540                 u8[len2] text
541                 u32 number
542                 u32 item
543                 u32 dir
544                 v2f1000 align
545                 v2f1000 offset
546                 v3f1000 world_pos
547                 v2s32 size
548         */
549
550         TOCLIENT_HUDRM = 0x4a,
551         /*
552                 u32 id
553         */
554
555         TOCLIENT_HUDCHANGE = 0x4b,
556         /*
557                 u32 id
558                 u8 stat
559                 [v2f1000 data |
560                  u32 len
561                  u8[len] data |
562                  u32 data]
563         */
564
565         TOCLIENT_HUD_SET_FLAGS = 0x4c,
566         /*
567                 u32 flags
568                 u32 mask
569         */
570
571         TOCLIENT_HUD_SET_PARAM = 0x4d,
572         /*
573                 u16 param
574                 u16 len
575                 u8[len] value
576         */
577
578         TOCLIENT_BREATH = 0x4e,
579         /*
580                 u16 breath
581         */
582
583         TOCLIENT_SET_SKY = 0x4f,
584         /*
585                 u8[4] color (ARGB)
586                 u8 len
587                 u8[len] type
588                 u16 count
589                 foreach count:
590                         u8 len
591                         u8[len] param
592                 u8 clouds (boolean)
593         */
594
595         TOCLIENT_OVERRIDE_DAY_NIGHT_RATIO = 0x50,
596         /*
597                 u8 do_override (boolean)
598                 u16 day-night ratio 0...65535
599         */
600
601         TOCLIENT_LOCAL_PLAYER_ANIMATIONS = 0x51,
602         /*
603                 v2s32 stand/idle
604                 v2s32 walk
605                 v2s32 dig
606                 v2s32 walk+dig
607                 f1000 frame_speed
608         */
609
610         TOCLIENT_EYE_OFFSET = 0x52,
611         /*
612                 v3f1000 first
613                 v3f1000 third
614         */
615
616         TOCLIENT_DELETE_PARTICLESPAWNER = 0x53,
617         /*
618                 u32 id
619         */
620
621         TOCLIENT_CLOUD_PARAMS = 0x54,
622         /*
623                 f1000 density
624                 u8[4] color_diffuse (ARGB)
625                 u8[4] color_ambient (ARGB)
626                 f1000 height
627                 f1000 thickness
628                 v2f1000 speed
629         */
630
631         TOCLIENT_FADE_SOUND = 0x55,
632         /*
633                 s32 sound_id
634                 float step
635                 float gain
636         */
637         TOCLIENT_UPDATE_PLAYER_LIST = 0x56,
638         /*
639                 u8 type
640                 u16 number of players
641                 for each player
642                         u16 len
643                         u8[len] player name
644         */
645
646         TOCLIENT_SRP_BYTES_S_B = 0x60,
647         /*
648                 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
649
650                 std::string bytes_s
651                 std::string bytes_B
652         */
653
654         TOCLIENT_NUM_MSG_TYPES = 0x61,
655 };
656
657 enum ToServerCommand
658 {
659         TOSERVER_INIT = 0x02,
660         /*
661                 Sent first after connected.
662
663                 u8 serialisation version (=SER_FMT_VER_HIGHEST_READ)
664                 u16 supported network compression modes
665                 u16 minimum supported network protocol version
666                 u16 maximum supported network protocol version
667                 std::string player name
668         */
669
670         TOSERVER_INIT_LEGACY = 0x10,
671         /*
672                 Sent first after connected.
673
674                 [0] u16 TOSERVER_INIT_LEGACY
675                 [2] u8 SER_FMT_VER_HIGHEST_READ
676                 [3] u8[20] player_name
677                 [23] u8[28] password (new in some version)
678                 [51] u16 minimum supported network protocol version (added sometime)
679                 [53] u16 maximum supported network protocol version (added later than the previous one)
680         */
681
682         TOSERVER_INIT2 = 0x11,
683         /*
684                 Sent as an ACK for TOCLIENT_INIT.
685                 After this, the server can send data.
686
687                 [0] u16 TOSERVER_INIT2
688         */
689
690         TOSERVER_GETBLOCK=0x20, // Obsolete
691         TOSERVER_ADDNODE = 0x21, // Obsolete
692         TOSERVER_REMOVENODE = 0x22, // Obsolete
693
694         TOSERVER_PLAYERPOS = 0x23,
695         /*
696                 [0] u16 command
697                 [2] v3s32 position*100
698                 [2+12] v3s32 speed*100
699                 [2+12+12] s32 pitch*100
700                 [2+12+12+4] s32 yaw*100
701                 [2+12+12+4+4] u32 keyPressed
702                 [2+12+12+4+4+1] u8 fov*80
703                 [2+12+12+4+4+4+1] u8 ceil(wanted_range / MAP_BLOCKSIZE)
704         */
705
706         TOSERVER_GOTBLOCKS = 0x24,
707         /*
708                 [0] u16 command
709                 [2] u8 count
710                 [3] v3s16 pos_0
711                 [3+6] v3s16 pos_1
712                 ...
713         */
714
715         TOSERVER_DELETEDBLOCKS = 0x25,
716         /*
717                 [0] u16 command
718                 [2] u8 count
719                 [3] v3s16 pos_0
720                 [3+6] v3s16 pos_1
721                 ...
722         */
723
724         TOSERVER_ADDNODE_FROM_INVENTORY = 0x26, // Obsolete
725         /*
726                 [0] u16 command
727                 [2] v3s16 pos
728                 [8] u16 i
729         */
730
731         TOSERVER_CLICK_OBJECT = 0x27, // Obsolete
732         /*
733                 length: 13
734                 [0] u16 command
735                 [2] u8 button (0=left, 1=right)
736                 [3] v3s16 blockpos
737                 [9] s16 id
738                 [11] u16 item
739         */
740
741         TOSERVER_GROUND_ACTION = 0x28, // Obsolete
742         /*
743                 length: 17
744                 [0] u16 command
745                 [2] u8 action
746                 [3] v3s16 nodepos_undersurface
747                 [9] v3s16 nodepos_abovesurface
748                 [15] u16 item
749                 actions:
750                 0: start digging (from undersurface)
751                 1: place block (to abovesurface)
752                 2: stop digging (all parameters ignored)
753                 3: digging completed
754         */
755
756         TOSERVER_RELEASE = 0x29, // Obsolete
757
758         // (oops, there is some gap here)
759
760         TOSERVER_SIGNTEXT = 0x30, // Old signs, obsolete
761         /*
762                 v3s16 blockpos
763                 s16 id
764                 u16 textlen
765                 textdata
766         */
767
768         TOSERVER_INVENTORY_ACTION = 0x31,
769         /*
770                 See InventoryAction in inventorymanager.h
771         */
772
773         TOSERVER_CHAT_MESSAGE = 0x32,
774         /*
775                 u16 length
776                 wstring message
777         */
778
779         TOSERVER_SIGNNODETEXT = 0x33, // obsolete
780         /*
781                 v3s16 p
782                 u16 textlen
783                 textdata
784         */
785
786         TOSERVER_CLICK_ACTIVEOBJECT = 0x34, // Obsolete
787         /*
788                 length: 7
789                 [0] u16 command
790                 [2] u8 button (0=left, 1=right)
791                 [3] u16 id
792                 [5] u16 item
793         */
794
795         TOSERVER_DAMAGE = 0x35,
796         /*
797                 u8 amount
798         */
799
800         TOSERVER_PASSWORD_LEGACY = 0x36,
801         /*
802                 Sent to change password.
803
804                 [0] u16 TOSERVER_PASSWORD
805                 [2] u8[28] old password
806                 [30] u8[28] new password
807         */
808
809         TOSERVER_PLAYERITEM = 0x37,
810         /*
811                 Sent to change selected item.
812
813                 [0] u16 TOSERVER_PLAYERITEM
814                 [2] u16 item
815         */
816
817         TOSERVER_RESPAWN = 0x38,
818         /*
819                 u16 TOSERVER_RESPAWN
820         */
821
822         TOSERVER_INTERACT = 0x39,
823         /*
824                 [0] u16 command
825                 [2] u8 action
826                 [3] u16 item
827                 [5] u32 length of the next item
828                 [9] serialized PointedThing
829                 actions:
830                 0: start digging (from undersurface) or use
831                 1: stop digging (all parameters ignored)
832                 2: digging completed
833                 3: place block or item (to abovesurface)
834                 4: use item
835
836                 (Obsoletes TOSERVER_GROUND_ACTION and TOSERVER_CLICK_ACTIVEOBJECT.)
837         */
838
839         TOSERVER_REMOVED_SOUNDS = 0x3a,
840         /*
841                 u16 len
842                 s32[len] sound_id
843         */
844
845         TOSERVER_NODEMETA_FIELDS = 0x3b,
846         /*
847                 v3s16 p
848                 u16 len
849                 u8[len] form name (reserved for future use)
850                 u16 number of fields
851                 for each field:
852                         u16 len
853                         u8[len] field name
854                         u32 len
855                         u8[len] field value
856         */
857
858         TOSERVER_INVENTORY_FIELDS = 0x3c,
859         /*
860                 u16 len
861                 u8[len] form name (reserved for future use)
862                 u16 number of fields
863                 for each field:
864                         u16 len
865                         u8[len] field name
866                         u32 len
867                         u8[len] field value
868         */
869
870         TOSERVER_REQUEST_MEDIA = 0x40,
871         /*
872                 u16 number of files requested
873                 for each file {
874                         u16 length of name
875                         string name
876                 }
877          */
878
879         TOSERVER_RECEIVED_MEDIA = 0x41,
880         /*
881                 <no payload data>
882         */
883
884         TOSERVER_BREATH = 0x42, // Obsolete
885         /*
886                 u16 breath
887         */
888
889         TOSERVER_CLIENT_READY = 0x43,
890         /*
891                 u8 major
892                 u8 minor
893                 u8 patch
894                 u8 reserved
895                 u16 len
896                 u8[len] full_version_string
897         */
898
899         TOSERVER_FIRST_SRP = 0x50,
900         /*
901                 Belonging to AUTH_MECHANISM_FIRST_SRP.
902
903                 std::string srp salt
904                 std::string srp verification key
905                 u8 is_empty (=1 if password is empty, 0 otherwise)
906         */
907
908         TOSERVER_SRP_BYTES_A = 0x51,
909         /*
910                 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP,
911                         depending on current_login_based_on.
912
913                 std::string bytes_A
914                 u8 current_login_based_on : on which version of the password's
915                                             hash this login is based on (0 legacy hash,
916                                             or 1 directly the password)
917         */
918
919         TOSERVER_SRP_BYTES_M = 0x52,
920         /*
921                 Belonging to AUTH_MECHANISM_LEGACY_PASSWORD and AUTH_MECHANISM_SRP.
922
923                 std::string bytes_M
924         */
925
926         TOSERVER_NUM_MSG_TYPES = 0x53,
927 };
928
929 enum AuthMechanism
930 {
931         // reserved
932         AUTH_MECHANISM_NONE = 0,
933
934         // SRP based on the legacy hash
935         AUTH_MECHANISM_LEGACY_PASSWORD = 1 << 0,
936
937         // SRP based on the srp verification key
938         AUTH_MECHANISM_SRP = 1 << 1,
939
940         // Establishes a srp verification key, for first login and password changing
941         AUTH_MECHANISM_FIRST_SRP = 1 << 2,
942 };
943
944 enum AccessDeniedCode {
945         SERVER_ACCESSDENIED_WRONG_PASSWORD,
946         SERVER_ACCESSDENIED_UNEXPECTED_DATA,
947         SERVER_ACCESSDENIED_SINGLEPLAYER,
948         SERVER_ACCESSDENIED_WRONG_VERSION,
949         SERVER_ACCESSDENIED_WRONG_CHARS_IN_NAME,
950         SERVER_ACCESSDENIED_WRONG_NAME,
951         SERVER_ACCESSDENIED_TOO_MANY_USERS,
952         SERVER_ACCESSDENIED_EMPTY_PASSWORD,
953         SERVER_ACCESSDENIED_ALREADY_CONNECTED,
954         SERVER_ACCESSDENIED_SERVER_FAIL,
955         SERVER_ACCESSDENIED_CUSTOM_STRING,
956         SERVER_ACCESSDENIED_SHUTDOWN,
957         SERVER_ACCESSDENIED_CRASH,
958         SERVER_ACCESSDENIED_MAX,
959 };
960
961 enum NetProtoCompressionMode {
962         NETPROTO_COMPRESSION_NONE = 0,
963 };
964
965 const static std::string accessDeniedStrings[SERVER_ACCESSDENIED_MAX] = {
966         "Invalid password",
967         "Your client sent something the server didn't expect.  Try reconnecting or updating your client",
968         "The server is running in simple singleplayer mode.  You cannot connect.",
969         "Your client's version is not supported.\nPlease contact server administrator.",
970         "Player name contains disallowed characters.",
971         "Player name not allowed.",
972         "Too many users.",
973         "Empty passwords are disallowed.  Set a password and try again.",
974         "Another client is connected with this name.  If your client closed unexpectedly, try again in a minute.",
975         "Server authentication failed.  This is likely a server error.",
976         "",
977         "Server shutting down.",
978         "This server has experienced an internal error. You will now be disconnected."
979 };
980
981 enum PlayerListModifer: u8
982 {
983         PLAYER_LIST_INIT,
984         PLAYER_LIST_ADD,
985         PLAYER_LIST_REMOVE,
986 };
987
988
989 #endif