1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*
* The Mana World Server
* Copyright 2004 The Mana World Development Team
*
* This file is part of The Mana World.
*
* The Mana World is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or any later version.
*
* The Mana World is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with The Mana World; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* $Id$
*/
#ifndef _TMWSERV_DEFINES_H_
#define _TMWSERV_DEFINES_H_
/**
* Enumeration type for account levels.
*
* Note the the actual tasks that can be done by admin or gm, or the
* restrictions on a restricted user, are not specified yet. Also, banned
* status will probably be derived from a date field (the time until an account
* is banned).
*
* It may be better to wait and see what permissions we'd want to grant to or
* take from users, and then come up with a convenient way to handle that.
*/
typedef enum {
AL_NORMAL, // User has regular rights
AL_ADMIN, // User can perform administrator tasks
AL_GM, // User can perform a subset of administrator tasks
AL_BANNED, // This user is currently banned
AL_RESTRICTED // User rights have been restricted
} AccountLevels;
/**
* Enumeration type for the player genders.
*/
typedef enum {
GENDER_MALE,
GENDER_FEMALE,
GENDER_UNKNOWN
} Genders;
// Network related
const unsigned int MAX_CLIENTS = 1024,
// Chat related
/**
* N.B: Private channels can't have an id less
* than MAX_PUBLIC_CHANNELS_RANGE.
*/
MAX_PUBLIC_CHANNELS_RANGE = 1000,
MAX_PRIVATE_CHANNELS_RANGE = 10000,
MAX_CHANNEL_NAME = 15,
MAX_CHANNEL_ANNOUNCEMENT = 150,
MAX_CHANNEL_PASSWORD = 12,
// Registering related
MIN_LOGIN_LENGTH = 4,
MAX_LOGIN_LENGTH = 16,
MIN_PASSWORD_LENGTH = 4,
MAX_PASSWORD_LENGTH = 25,
MIN_EMAIL_LENGTH = 7,
MAX_EMAIL_LENGTH = 50,
// Character related
MIN_CHARACTER_LENGTH = 4,
MAX_CHARACTER_LENGTH = 25,
MAX_OF_CHARACTERS = 3,
MAX_HAIRSTYLE_VALUE = 5,
MAX_HAIRCOLOR_VALUE = 10,
MAX_GENDER_VALUE = 2,
/** Tells the max difference between the
* less big stat and the biggest one.
* So that players haven't disproportionned
* Raw statistics.
*/
MAX_DIFF_BETWEEN_STATS = 5,
/**
* Points to give to a brand new character
*/
POINTS_TO_DISTRIBUTES_AT_LVL1 = 60,
// Screen Related
/**
* Determine the area in which a character
* can hear another one speak
*/
AROUND_AREA_IN_TILES = 10;
/**
* Enumerated type for communicated messages
* - PAMSG_*: from client to account server
* - APMSG_*: from account server to client
* - PCMSG_*: from client to chat server
* - CPMSG_*: from chat server to client
* - PGMSG_*: from client to game server
* - GPMSG_*: from game server to client
* Components: B byte, W word, D double word, S variable-size string
*/
enum {
// Login/Register
PAMSG_REGISTER = 0x0000, // L version, S username, S password, S email
APMSG_REGISTER_RESPONSE = 0x0002, // B error
PAMSG_UNREGISTER = 0x0003, // -
APMSG_UNREGISTER_RESPONSE = 0x0004, // B error
PAMSG_LOGIN = 0x0010, // L version, S username, S password
APMSG_LOGIN_RESPONSE = 0x0012, // B error
PAMSG_LOGOUT = 0x0013, // -
APMSG_LOGOUT_RESPONSE = 0x0014, // B error
PAMSG_CHAR_CREATE = 0x0020, // S name, B hair style, B hair color, B gender, W*6 stats
APMSG_CHAR_CREATE_RESPONSE = 0x0021, // B error
PAMSG_CHAR_DELETE = 0x0022, // B index
APMSG_CHAR_DELETE_RESPONSE = 0x0023, // B error
PAMSG_CHAR_LIST = 0x0024, // -
APMSG_CHAR_LIST_RESPONSE = 0x0025, // B number, { B index, S name, B gender, B hair style, B hair color, B level, W money, W*6 stats, S mapname, W*2 position }*
PAMSG_CHAR_SELECT = 0x0026, // B index
APMSG_CHAR_SELECT_RESPONSE = 0x0027, // B error, S mapname, W*2 position
PAMSG_EMAIL_CHANGE = 0x0030, // S email
APMSG_EMAIL_CHANGE_RESPONSE = 0x0031, // B error
PAMSG_EMAIL_GET = 0x0032, // -
APMSG_EMAIL_GET_RESPONSE = 0x0033, // B error, S email
PAMSG_PASSWORD_CHANGE = 0x0034, // S old password, S new password
APMSG_PASSWORD_CHANGE_RESPONSE = 0x0035, // B error
PAMSG_ENTER_WORLD = 0x0040, // -
APMSG_ENTER_WORLD_RESPONSE = 0x0041, // B error, S address, W port, B*32 token
PAMSG_ENTER_CHAT = 0x0042, // -
APMSG_ENTER_CHAT_RESPONSE = 0x0043, // B error, S address, W port, B*32 token
PGMSG_CONNECT = 0x0050, // B*32 token
GPMSG_CONNECT_RESPONSE = 0x0051, // B error
PCMSG_CONNECT = 0x0053, // B*32 token
CPMSG_CONNECT_RESPONSE = 0x0054, // B error
// Game
PGMSG_PICKUP = 0x0110,
GPMSG_PICKUP_RESPONSE = 0x0111,
GPMSG_BEING_ENTER = 0x0200, // B type, L being id
// player: S name, B hair style, B hair color, B gender
GPMSG_BEING_LEAVE = 0x0201, // B type, L being id
PGMSG_WALK = 0x0260, // L*2 destination
PGMSG_SAY = 0x02A0, // S text
GPMSG_SAY = 0x02A1, // S being, S text
PGMSG_USE_ITEM = 0x0300, // L item id
GPMSG_USE_RESPONSE = 0x0301, // B error
PGMSG_EQUIP = 0x0302, // L item id, B slot
GPMSG_EQUIP_RESPONSE = 0x0303, // B error
// Chat
CPMSG_ERROR = 0x0401, // B error
CPMSG_ANNOUNCEMENT = 0x0402, // S text
CPMSG_PRIVMSG = 0x0403, // S user, S text
CPMSG_PUBMSG = 0x0404, // W channel, S user, S text
PCMSG_CHAT = 0x0410, // S text, W channel
PCMSG_ANNOUNCE = 0x0411, // S text
PCMSG_PRIVMSG = 0x0412, // S user, S text
// -- Channeling
PCMSG_REGISTER_CHANNEL = 0x0413, // B pub/priv, S name, S announcement, S password
CPMSG_REGISTER_CHANNEL_RESPONSE = 0x0414, // B error
PCMSG_UNREGISTER_CHANNEL = 0x0415, // W channel
CPMSG_UNREGISTER_CHANNEL_RESPONSE = 0x0416, // B error
CPMSG_CHANNEL_EVENT = 0x0418, // W channel, B event, S user
PCMSG_ENTER_CHANNEL = 0x0419, // W channel, S password
CPMSG_ENTER_CHANNEL_RESPONSE = 0x0420, // B error
PCMSG_QUIT_CHANNEL = 0x0421, // W channel
CPMSG_QUIT_CHANNEL_RESPONSE = 0x0422, // B error
XXMSG_INVALID = 0x7FFF
};
// Generic return values
enum {
ERRMSG_OK = 0, // everything is fine
ERRMSG_FAILURE, // the action failed
ERRMSG_NO_LOGIN, // the user is not yet logged
ERRMSG_NO_CHARACTER_SELECTED, // the user needs a character
ERRMSG_INSUFFICIENT_RIGHTS, // the user is not privileged
ERRMSG_INVALID_ARGUMENT, // part of the received message was invalid
};
// Login specific return values
enum {
LOGIN_INVALID_VERSION = 0x40, // the user is using an incompatible protocol
LOGIN_SERVER_FULL // the server is overloaded
};
// Account register specific return values
enum {
REGISTER_INVALID_VERSION = 0x40, // the user is using an incompatible protocol
REGISTER_EXISTS_USERNAME, // there already is an account with this username
REGISTER_EXISTS_EMAIL // there already is an account with this email address
};
// Character creation specific return values
enum {
CREATE_INVALID_HAIRSTYLE = 0x40,
CREATE_INVALID_HAIRCOLOR,
CREATE_INVALID_GENDER,
CREATE_RAW_STATS_TOO_HIGH,
CREATE_RAW_STATS_TOO_LOW,
CREATE_RAW_STATS_INVALID_DIFF,
CREATE_RAW_STATS_EQUAL_TO_ZERO,
CREATE_EXISTS_NAME,
CREATE_TOO_MUCH_CHARACTERS
};
// Email change specific return values
enum {
EMAILCHG_EXISTS_EMAIL = 0x40
};
// Chat errors return values
enum {
CHAT_USING_BAD_WORDS = 0x40,
CHAT_UNHANDLED_COMMAND,
};
// Chat channels event values
enum {
CHAT_EVENT_NEW_PLAYER = 0,
CHAT_EVENT_LEAVING_PLAYER
};
// Object type enumeration
enum {
OBJECT_ITEM = 0, // A simple item
OBJECT_ACTOR, // An item that toggle map/quest actions (doors, switchs, ...) and can speak (map panels).
OBJECT_NPC, // Non-Playable-Character is an actor capable of movement and maybe actions
OBJECT_MONSTER, // A monster (moving actor with AI. Should be able to toggle map/quest actions, too)
OBJECT_PLAYER // A normal being
};
#endif // _TMWSERV_DEFINES_H_
|