server/include/config.h

/*
 * CrossFire, A Multiplayer game for X-windows
 * 
 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
 * Copyright (C) 1992 Frank Tore Johansen
 * 
 * This program 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
 * (at your option) any later version.
 * 
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * The authors can be reached via e-mail at crossfire@schmorp.de
 */

/* This file contains various #defines that select various options.
 * Some may not be desirable, and some just may not work.
 *
 * There are some options that are not selectable in this file which
 * may not always be undesirable.  An example would be certain
 * treasures that you may not want to have available.  To remove the
 * activation code would make these items worthless - instead remove
 * these from the treasure file.  Some things to look for are:
 *
 * prepare_weapon, improve_*: Allow characters to enchant their own
 *      weapons
 * ench_armour: Allow characters to enchant their armor.
 *
 * In theory, most of the values here should just be defaults, and 
 * everything here should just be selectable by different run time
 * flags  However, for some things, that would just be too messy.
 */

/* There are 4 main sections to this file-
 * Section 1 is feature selection (enabling/disabling certain features)
 *
 * Section 2 is compiler/machine dependant section (stuff that just
 *     makes the program compile and run properly, but don't change the
 *     behavior)
 *
 * Section 3 is location of certain files and other defaults.  Things in
 *     this section generally do not need to be changed, and generally do
 *     not alter the play as perceived by players.  However, you may
 *     have your own values you want to set here.
 *
 * Section 4 deals with save file related options.
 */

 /*******************************************************************
 * SECTION 1 - FEATURES
 *
 * You don't have to change anything here to get a working program, but
 * you may want to on personal preferance.  Items are arranged
 * alphabetically.
 *
 * Short list of features, and what to search for:
 * CS_LOGSTATS - log various new client/server data.
 * DEBUG - more verbose message logging?
 * MAP_CLIENT_X, MAP_CLIENT_Y - determines max size client map will receive
 * MAX_TIME - how long an internal tick is in microseconds
 * MANY_CORES - generate core dumps on gross errors instead of continuing?
 * PARTY_KILL_LOG - stores party kill information
 *
 ***********************************************************************/

/* Use a very easy, non-challenging server?
 * Defining the COZY_SERVER will make the server much less challenging:
 * no stats loss on death, much less experience loss, and party members
 * are treated by pet monsters as the owner itself when moving "through" them.
 */
#define COZY_SERVER 1

/*
 * Make it impossible to pk outside the arena.
 */
#define PROHIBIT_PLAYERKILL 1

/* Use balanced stat loss code?
 * This code is a little more merciful with repeated stat loss at lower
 * levels. Basically, the more stats you have lost, the less likely that
 * you will lose more. Additionally, lower level characters are shown
 * a lot more mercy (there are caps on how much of a stat you can lose too).
 * On the nasty side, if you are higher level, you can lose mutiple stats
 * _at_once_ and are shown less mercy when you die. But when you're higher
 * level, it is much easier to buy back your stats with potions.
 * Turn this on if you want death-based stat loss to be more merciful
 * at low levels and more cruel at high levels.
 * Only works when stats are depleted rather than lost. This option has
 * no effect if you are using genuine stat loss.
 *
 * The BALSL_.. values control this behaviour.
 * BALSL_NUMBER_LOSSES_RATIO determines the number of stats to lose.
 * the character level is divided by that value, and that is how many
 * stats are lost.
 *
 * BALSL_MAX_LOSS_RATIO puts the upper limit on depletion of a stat - 
 * basically, level/max_loss_ratio is the most a stat can be depleted.
 *
 * BALSL_LOSS_CHANCE_RATIO controls how likely it is a stat is depleted.
 * The chance not to lose a stat is 
 * depleteness^2 / (depletedness^2+ level/ratio).
 * ie, if the stats current depleted value is 2 and the character is level
 * 15, the chance not to lose the stat is 4/(4+3) or 4/7.  The higher the
 * level, the more likely it is a stat can get really depleted, but
 * this gets more offset as the stat gets more depleted.
 * 
 */
/* GD */

#define BALSL_LOSS_CHANCE_RATIO    100
#define BALSL_NUMBER_LOSSES_RATIO  100
#define BALSL_MAX_LOSS_RATIO       100


/* Don't edit these values.  They are configured in lib/settings.  These are
   Simply the defaults. */

#define BALANCED_STAT_LOSS FALSE
#define PERMANENT_EXPERIENCE_RATIO 25
#define DEATH_PENALTY_RATIO 20
#define DEATH_PENALTY_LEVEL 3
#define SET_TITLE TRUE
#define SIMPLE_EXP TRUE
#define SPELLPOINT_LEVEL_DEPEND TRUE
#define SPELL_ENCUMBRANCE TRUE
#define SPELL_FAILURE_EFFECTS FALSE
#define REAL_WIZ TRUE
#define RESURRECTION FALSE
#define SEARCH_ITEMS TRUE
#define NOT_PERMADETH TRUE
#define EXPLORE_MODE FALSE
#define STAT_LOSS_ON_DEATH FALSE
#define PK_LUCK_PENALTY 1
#define CASTING_TIME FALSE
#define SET_FRIENDLY_FIRE 5
#define ARMOR_MAX_ENCHANT   5
#define ARMOR_WEIGHT_REDUCTION  10
#define ARMOR_WEIGHT_LINEAR TRUE
#define ARMOR_SPEED_IMPROVEMENT 10
#define ARMOR_SPEED_LINEAR  TRUE
#define CREATE_HOME_PORTALS FALSE

/* you can edit the ones below */


/* CS_LOGSTATS will cause the server to log various usage stats
 * (number of connections, amount of data sent, amount of data received,
 * and so on.)  This can be very useful if you are trying to measure
 * server/bandwidth usage.  It will periodially dump out information 
 * which contains usage stats for the last X amount of time.
 * CS_LOGTIME is how often it will print out stats.
 */
#define CS_LOGSTATS
#define CS_LOGTIME  600

/* DEBUG generates copious amounts of output.  I tend to change the CC options
 * in the crosssite.def file if I want this.  By default, you probably
 * dont want this defined.
 */
#ifndef DEBUG
#define DEBUG
#endif
/*
 * This option creates more core files.  In some areas, there are certain
 * checks done to try and make the program more stable (ie, check
 * parameter for null, return if it is).  These checks are being done
 * for things that should not happen (ie, being supplied a null parameter).
 * What MANY_CORES does, is if one of these checks is true, it will
 * dump core at that time, allowing for fairly easy tracking down of the
 * problem.  Better to fix problems than create thousands of checks.
 */

#define MANY_CORES

/*
 * This determines the maximum map size the client can request (and
 * thus what the server will send to the client.
 * Client can still request a smaller map size (for bandwidth reasons
 * or display size of whatever else).
 * The larger this number, the more cpu time and memory the server will
 * need to spend to figure this out in addition to bandwidth needs.
 * The server cpu time should be pretty trivial.
 * There may be reasons to keep it smaller for the 'classic' crossfire
 * experience which was 11x11.  Big maps will likely make the same at
 * least somewhat easier, but client will need to worry about lag
 * more.
 * I put support in for non square map updates in the define, but
 * there very well might be things that break horribly if this is
 * used.  I figure it is easier to fix that if needed than go back
 * at the future and have to redo a lot of stuff to support rectangular
 * maps at that point.
 *
 * MSW 2001-05-28
 */

#define MAP_CLIENT_X    32
#define MAP_CLIENT_Y    32

/*
 * If you feel the game is too fast or too slow, change MAX_TIME.
 * You can experiment with the 'speed <new_max_time> command first.
 * The length of a tick is MAX_TIME microseconds.  During a tick,
 * players, monsters, or items with speed 1 can do one thing.
 */

#define MAX_TIME        120000

/* Polymorph as it currently stands is unbalancing, so by default
 * we have it disabled.  It can be enabled and it works, but
 * it can be abused in various ways.
 */
#define NO_POLYMORPH


/* This determine how many entries are stored in the kill log.  You
 * can see this information with the 'party kills' command. More entries
 * mean slower performance and more memory.
 */
#define PARTY_KILL_LOG 40

/*
 * The PERM_EXP values adjust the behaviour of permenent experience. - if
 * the setting permanent_experience_percentage is zero, these values have 
 * no meaning. The value in the settings file is the percentage of the 
 * experience that is permenent, the rest could be lost on death. When dying,
 * the greatest amount of non-permenent exp it is possible to lose at one time
 * is PERM_EXP_MAX_LOSS_RATIO  - this is calculated as 
 * total exp - perm exp * loss ratio. The gain ratio is how much of experienced 
 * experience goes to the permanent value. This does not detract from total 
 * exp gain (ie, if you gained 100 exp, 100 would go to the skill total and 
 * 10 to the permanent value). 
 *
 * A few thoughts on these default value (by MSW)
 * gain ratio is pretty much meaningless until exp has been lost, as until
 * that poin, the value in the settings file will be used.
 * It is also impossible for the exp to actually be reduced to the permanent
 * exp ratio - since the loss ratio is .5, it will just get closer and
 * closer.  However, after about half a dozen hits, pretty much all the
 * exp that can be lost has been lost, and after that, only minor loss
 * will occur.
 */
/* GD */

#define PERM_EXP_GAIN_RATIO           0.10f
#define PERM_EXP_MAX_LOSS_RATIO       0.50f

/* Enable the new material code - it needs some work.  You can
 * enable this, and things will work, just you'll see a whole
 * bunch more materials show up, and thus a whole bunch more materials
 * in your inventory, and the sorting for them isn't really good.
 */

/*
#define NEW_MATERIAL_CODE
*/

/***********************************************************************
 * SECTION 2 - Machine/Compiler specific stuff.
 *
 * Short list of items:
 * COMPRESS_SUFFIX - selection of compression programs
 * O_NDELAY - If you don't have O_NDELAY, uncomment it.
 *
 ***********************************************************************/

/*
 * If you compress your files to save space, set the COMPRESS_SUFFIX below
 * to the compression suffix you want (.Z, .gz, .bz2).  The autoconf
 * should already find the program to use.  If you set the suffix to
 * something that autoconf did not find, you are likely to have serious
 * problems, so make sure you have the appropriate compression tool installed
 * before you set this.  You can look at the autoconf.h file to see
 * what compression tools it found (search for COMPRESS).
 * Note that this is used when saving files.  Crossfire will search all
 * methods when loading a file to see if it finds a match
 */

#ifndef COMPRESS_SUFFIX
/* #define COMPRESS_SUFFIX ".Z" */
#endif

/* If you get a complaint about O_NDELAY not being known/undefined, try
 * uncommenting this.
 * This may cause problems - O_NONBLOCK will return -1 on blocking writes
 * and set error to EAGAIN.  O_NDELAY returns 0.  This is only if no bytes
 * can be written - otherwise, the number of bytes written will be returned
 * for both modes.
 */

/*
#define O_NDELAY O_NONBLOCK
*/


/***********************************************************************
 * Section 3
 *
 * General file and other defaults that don't need to be changed, and
 * do not change gameplay as percieved by players much.  Some options
 * may affect memory consumption however.
 *
 * Values:
 *
 * BANFILE - ban certain users/hosts.
 * CSPORT - port to use for new client/server
 * DMFILE - file with dm/wizard access lists
 * LOGFILE - where to log if using -daemon option
 * MAP_ - various map timeout and swapping parameters
 * MAX_OBJECTS - how many objects to keep in memory.
 * MAX_OBJECTS_LWM - only swap maps out if below that value
 * MOTD - message of the day - printed each time someone joins the game
 * PERM_FILE - limit play times
 * SHUTDOWN - used when shutting down the server
 * SOCKETBUFSIZE - size of buffer used internally by the server for storing
 *    backlogged messages.
 * TMPDIR - directory to use for temp files
 * UNIQUE_DIR - directory to put unique item files into
 ***********************************************************************
 */

/*
 * BANFILE - file used to ban certain sites from playing.  See the example
 * ban_file for examples.
 */
#ifndef BANFILE
#define BANFILE         "ban_file"
#endif

/* CSPORT is the port used for the new client/server code.  Change
 * if desired.  Only of relevance if ERIC_SERVER is set above
 */
#define CSPORT 13327 /* old port + 1 */


/*
 * DMFILE
 * A file containing valid names that can be dm, one on each line.  See
 * example dm_file for syntax help.
 */
#ifndef DMFILE
#define DMFILE "dm_file"
#endif


/* LOGFILE specifies which file to log to when playing with the
 * -daemon option.
 */
#ifndef LOGFILE
#define LOGFILE "/var/log/crossfire/logfile"
#endif

/*
 * If you want to have a Message Of The Day file, define MOTD to be
 * the file with the message.  If the file doesn't exist or if it
 * is empty, no message will be displayed.
 * (It resides in the CONFDIR directory)
 */
#define MOTD "motd"

/*
 * You can restrict playing in certain times by creating a PERMIT_FILE
 * in CONFDIR. See the sample for usage notes.
 */
#define PERM_FILE "forbid"

/*
 * If you want to take the game down while installing new versions, or
 * for other reasons, put a message into the SHUTDOWN_FILE file.
 * Remember to delete it when you open the game again.
 * (It resides in the CONFDIR directory)
 */
#ifndef SHUTDOWN_FILE
#define SHUTDOWN_FILE "shutdown"
#endif


/*
 * SOCKETBUFSIZE is the size of the buffer used internally by the server for
 * storing backlogged messages for the client.  This is not operating system
 * buffers or the like.  This amount is used per connection (client).
 * This buffer is in addition to OS buffers, so it may not need to be very
 * large.  When the OS buffer and this buffer is exhausted, the server
 * will drop the client connection for falling too far behind.  So if
 * you have very slow client connections, a larger value may be 
 * warranted.
 */
#define SOCKETBUFSIZE 256*1024

/*
 * Your tmp-directory should be large enough to hold the uncompressed
 * map-files for all who are playing. Local to 'lib' directory.
 */
#define TMPDIR "tmp"


/* Directory to use for unique items. This is placed into the 'lib' 
 * directory.  Changing this will cause any old unique items file
 * not to be used.
 */
#define UNIQUE_DIR "unique-items"

/*
 * These defines tells where, relative to LIBDIR, the maps, the map-index,
 * archetypes highscore and treaures files and directories can be found.
 */

#define MAPDIR          "maps"
#define TEMPLATE_DIR    "template-maps"
#define ARCHETYPES      "archetypes"
#define REGIONS "regions"
#define HIGHSCORE       "highscore"
#define TREASURES       "treasures"
#define BANISHFILE  "banish_file"

#define HIGHSCORE_LENGTH 1000   /* How many entries there are room for */

#define MAXSTRING 20

#define COMMAND_HASH_SIZE 107   /* If you change this, delete all characters :) */


/***********************************************************************
 * Section 4 - save player options.
 *
 * There are a lot of things that deal with the save files, and what
 * gets saved with them, so I put them in there own section.
 *
 ***********************************************************************/

/*
 * If you want the players to be able to save their characters between
 * games, define SAVE_PLAYER and set PLAYERDIR to the directories
 * where the player-files will be put.
 * Remember to create the directory (make install will do that though).
 *
 * If you intend to run a central server, and not allow the players to
 * start their own crossfire, you won't need to define this.
 *
 */

#ifndef PLAYERDIR
# define PLAYERDIR "players"
#endif

/*
 * If you have defined SAVE_PLAYER, you might want to change this, too.
 * This is the access rights for the players savefiles.
 * Given that crossfire runs in a client/server model, there should
 * be no issue setting these to be quite restrictive (600 and 700).
 * Before client/server, multiple people might run the executable,
 * thus requiring that the server be setuid/setgid, and more generous
 * permisisons needed.
 * SAVE_MODE is permissions for the files, SAVE_DIR_MODE is permission
 * for nay directories created.
 */
/* IMPORTANT: there is a race during saving, where the umask is being applied */
#define SAVE_MODE       0660
#define SAVE_DIR_MODE   0770

/*
 * AUTOSAVE saves the player every AUTOSAVE ticks.  A value of
 * 5000 with MAX_TIME set at 120,000 means that the player will be
 * saved every 10 minutes.  Some effort should probably be made to
 * spread out these saves, but that might be more effort than it is
 * worth (Depending on the spacing, if enough players log on, the spacing
 * may not be large enough to save all of them.)  As it is now, it will
 * just set the base tick of when they log on, which should keep the
 * saves pretty well spread out (in a fairly random fashion.)
 */

#define AUTOSAVE 1000

/* RESET_LOCATION_TIME is the number of seconds that must elapse before
 * we will return the player to his savebed location.  If this is zero,
 * this feature is disabled (player will resume where ever he was
 * when he last logged off).  If this is set to less than two hours,
 * it will prevent players from camping out in treasure rooms.
 * Do not comment this out - it must be set to something - if you
 * comment this out, the program will not compile.
 *
 * This will work to BACKUP_SAVE_AT_HOME at home above, but where the player
 * where appear under what conditions is a little complicated depending
 * on how the player exited the game.  But if the elapsed time is greater than
 * the value below, player will always get returned to savebed location
 * location.
 * 
 * Set to one hour as default
 */

#define RESET_LOCATION_TIME     3600

/*
 * The message to send to clients when the server calls cleanup (on crash, shutdown, restart and so on).
 */
#define CLEANUP_MESSAGE "The server will likely restart within the minute. Our apologies."

Revision:	1.39
Committed:	Thu Feb 15 16:22:50 2007 UTC (17 years, 3 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.38:	+2 -2 lines
Log Message:	µ-opt, but the effects might be visible macroscopically
#	Content
1	/*
2	* CrossFire, A Multiplayer game for X-windows
3	*
4	* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5	* Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6	* Copyright (C) 1992 Frank Tore Johansen
7	*
8	* This program is free software; you can redistribute it and/or modify
9	* it under the terms of the GNU General Public License as published by
10	* the Free Software Foundation; either version 2 of the License, or
11	* (at your option) any later version.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License
19	* along with this program; if not, write to the Free Software
20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21	*
22	* The authors can be reached via e-mail at crossfire@schmorp.de
23	*/
24
25	/* This file contains various #defines that select various options.
26	* Some may not be desirable, and some just may not work.
27	*
28	* There are some options that are not selectable in this file which
29	* may not always be undesirable. An example would be certain
30	* treasures that you may not want to have available. To remove the
31	* activation code would make these items worthless - instead remove
32	* these from the treasure file. Some things to look for are:
33	*
34	* prepare_weapon, improve_*: Allow characters to enchant their own
35	* weapons
36	* ench_armour: Allow characters to enchant their armor.
37	*
38	* In theory, most of the values here should just be defaults, and
39	* everything here should just be selectable by different run time
40	* flags However, for some things, that would just be too messy.
41	*/
42
43	/* There are 4 main sections to this file-
44	* Section 1 is feature selection (enabling/disabling certain features)
45	*
46	* Section 2 is compiler/machine dependant section (stuff that just
47	* makes the program compile and run properly, but don't change the
48	* behavior)
49	*
50	* Section 3 is location of certain files and other defaults. Things in
51	* this section generally do not need to be changed, and generally do
52	* not alter the play as perceived by players. However, you may
53	* have your own values you want to set here.
54	*
55	* Section 4 deals with save file related options.
56	*/
57
58	/*******************************************************************
59	* SECTION 1 - FEATURES
60	*
61	* You don't have to change anything here to get a working program, but
62	* you may want to on personal preferance. Items are arranged
63	* alphabetically.
64	*
65	* Short list of features, and what to search for:
66	* CS_LOGSTATS - log various new client/server data.
67	* DEBUG - more verbose message logging?
68	* MAP_CLIENT_X, MAP_CLIENT_Y - determines max size client map will receive
69	* MAX_TIME - how long an internal tick is in microseconds
70	* MANY_CORES - generate core dumps on gross errors instead of continuing?
71	* PARTY_KILL_LOG - stores party kill information
72	*
73	***********************************************************************/
74
75	/* Use a very easy, non-challenging server?
76	* Defining the COZY_SERVER will make the server much less challenging:
77	* no stats loss on death, much less experience loss, and party members
78	* are treated by pet monsters as the owner itself when moving "through" them.
79	*/
80	#define COZY_SERVER 1
81
82	/*
83	* Make it impossible to pk outside the arena.
84	*/
85	#define PROHIBIT_PLAYERKILL 1
86
87	/* Use balanced stat loss code?
88	* This code is a little more merciful with repeated stat loss at lower
89	* levels. Basically, the more stats you have lost, the less likely that
90	* you will lose more. Additionally, lower level characters are shown
91	* a lot more mercy (there are caps on how much of a stat you can lose too).
92	* On the nasty side, if you are higher level, you can lose mutiple stats
93	* _at_once_ and are shown less mercy when you die. But when you're higher
94	* level, it is much easier to buy back your stats with potions.
95	* Turn this on if you want death-based stat loss to be more merciful
96	* at low levels and more cruel at high levels.
97	* Only works when stats are depleted rather than lost. This option has
98	* no effect if you are using genuine stat loss.
99	*
100	* The BALSL_.. values control this behaviour.
101	* BALSL_NUMBER_LOSSES_RATIO determines the number of stats to lose.
102	* the character level is divided by that value, and that is how many
103	* stats are lost.
104	*
105	* BALSL_MAX_LOSS_RATIO puts the upper limit on depletion of a stat -
106	* basically, level/max_loss_ratio is the most a stat can be depleted.
107	*
108	* BALSL_LOSS_CHANCE_RATIO controls how likely it is a stat is depleted.
109	* The chance not to lose a stat is
110	* depleteness^2 / (depletedness^2+ level/ratio).
111	* ie, if the stats current depleted value is 2 and the character is level
112	* 15, the chance not to lose the stat is 4/(4+3) or 4/7. The higher the
113	* level, the more likely it is a stat can get really depleted, but
114	* this gets more offset as the stat gets more depleted.
115	*
116	*/
117	/* GD */
118
119	#define BALSL_LOSS_CHANCE_RATIO 100
120	#define BALSL_NUMBER_LOSSES_RATIO 100
121	#define BALSL_MAX_LOSS_RATIO 100
122
123
124	/* Don't edit these values. They are configured in lib/settings. These are
125	Simply the defaults. */
126
127	#define BALANCED_STAT_LOSS FALSE
128	#define PERMANENT_EXPERIENCE_RATIO 25
129	#define DEATH_PENALTY_RATIO 20
130	#define DEATH_PENALTY_LEVEL 3
131	#define SET_TITLE TRUE
132	#define SIMPLE_EXP TRUE
133	#define SPELLPOINT_LEVEL_DEPEND TRUE
134	#define SPELL_ENCUMBRANCE TRUE
135	#define SPELL_FAILURE_EFFECTS FALSE
136	#define REAL_WIZ TRUE
137	#define RESURRECTION FALSE
138	#define SEARCH_ITEMS TRUE
139	#define NOT_PERMADETH TRUE
140	#define EXPLORE_MODE FALSE
141	#define STAT_LOSS_ON_DEATH FALSE
142	#define PK_LUCK_PENALTY 1
143	#define CASTING_TIME FALSE
144	#define SET_FRIENDLY_FIRE 5
145	#define ARMOR_MAX_ENCHANT 5
146	#define ARMOR_WEIGHT_REDUCTION 10
147	#define ARMOR_WEIGHT_LINEAR TRUE
148	#define ARMOR_SPEED_IMPROVEMENT 10
149	#define ARMOR_SPEED_LINEAR TRUE
150	#define CREATE_HOME_PORTALS FALSE
151
152	/* you can edit the ones below */
153
154
155	/* CS_LOGSTATS will cause the server to log various usage stats
156	* (number of connections, amount of data sent, amount of data received,
157	* and so on.) This can be very useful if you are trying to measure
158	* server/bandwidth usage. It will periodially dump out information
159	* which contains usage stats for the last X amount of time.
160	* CS_LOGTIME is how often it will print out stats.
161	*/
162	#define CS_LOGSTATS
163	#define CS_LOGTIME 600
164
165	/* DEBUG generates copious amounts of output. I tend to change the CC options
166	* in the crosssite.def file if I want this. By default, you probably
167	* dont want this defined.
168	*/
169	#ifndef DEBUG
170	#define DEBUG
171	#endif
172	/*
173	* This option creates more core files. In some areas, there are certain
174	* checks done to try and make the program more stable (ie, check
175	* parameter for null, return if it is). These checks are being done
176	* for things that should not happen (ie, being supplied a null parameter).
177	* What MANY_CORES does, is if one of these checks is true, it will
178	* dump core at that time, allowing for fairly easy tracking down of the
179	* problem. Better to fix problems than create thousands of checks.
180	*/
181
182	#define MANY_CORES
183
184	/*
185	* This determines the maximum map size the client can request (and
186	* thus what the server will send to the client.
187	* Client can still request a smaller map size (for bandwidth reasons
188	* or display size of whatever else).
189	* The larger this number, the more cpu time and memory the server will
190	* need to spend to figure this out in addition to bandwidth needs.
191	* The server cpu time should be pretty trivial.
192	* There may be reasons to keep it smaller for the 'classic' crossfire
193	* experience which was 11x11. Big maps will likely make the same at
194	* least somewhat easier, but client will need to worry about lag
195	* more.
196	* I put support in for non square map updates in the define, but
197	* there very well might be things that break horribly if this is
198	* used. I figure it is easier to fix that if needed than go back
199	* at the future and have to redo a lot of stuff to support rectangular
200	* maps at that point.
201	*
202	* MSW 2001-05-28
203	*/
204
205	#define MAP_CLIENT_X 32
206	#define MAP_CLIENT_Y 32
207
208	/*
209	* If you feel the game is too fast or too slow, change MAX_TIME.
210	* You can experiment with the 'speed <new_max_time> command first.
211	* The length of a tick is MAX_TIME microseconds. During a tick,
212	* players, monsters, or items with speed 1 can do one thing.
213	*/
214
215	#define MAX_TIME 120000
216
217	/* Polymorph as it currently stands is unbalancing, so by default
218	* we have it disabled. It can be enabled and it works, but
219	* it can be abused in various ways.
220	*/
221	#define NO_POLYMORPH
222
223
224	/* This determine how many entries are stored in the kill log. You
225	* can see this information with the 'party kills' command. More entries
226	* mean slower performance and more memory.
227	*/
228	#define PARTY_KILL_LOG 40
229
230	/*
231	* The PERM_EXP values adjust the behaviour of permenent experience. - if
232	* the setting permanent_experience_percentage is zero, these values have
233	* no meaning. The value in the settings file is the percentage of the
234	* experience that is permenent, the rest could be lost on death. When dying,
235	* the greatest amount of non-permenent exp it is possible to lose at one time
236	* is PERM_EXP_MAX_LOSS_RATIO - this is calculated as
237	* total exp - perm exp * loss ratio. The gain ratio is how much of experienced
238	* experience goes to the permanent value. This does not detract from total
239	* exp gain (ie, if you gained 100 exp, 100 would go to the skill total and
240	* 10 to the permanent value).
241	*
242	* A few thoughts on these default value (by MSW)
243	* gain ratio is pretty much meaningless until exp has been lost, as until
244	* that poin, the value in the settings file will be used.
245	* It is also impossible for the exp to actually be reduced to the permanent
246	* exp ratio - since the loss ratio is .5, it will just get closer and
247	* closer. However, after about half a dozen hits, pretty much all the
248	* exp that can be lost has been lost, and after that, only minor loss
249	* will occur.
250	*/
251	/* GD */
252
253	#define PERM_EXP_GAIN_RATIO 0.10f
254	#define PERM_EXP_MAX_LOSS_RATIO 0.50f
255
256	/* Enable the new material code - it needs some work. You can
257	* enable this, and things will work, just you'll see a whole
258	* bunch more materials show up, and thus a whole bunch more materials
259	* in your inventory, and the sorting for them isn't really good.
260	*/
261
262	/*
263	#define NEW_MATERIAL_CODE
264	*/
265
266	/***********************************************************************
267	* SECTION 2 - Machine/Compiler specific stuff.
268	*
269	* Short list of items:
270	* COMPRESS_SUFFIX - selection of compression programs
271	* O_NDELAY - If you don't have O_NDELAY, uncomment it.
272	*
273	***********************************************************************/
274
275	/*
276	* If you compress your files to save space, set the COMPRESS_SUFFIX below
277	* to the compression suffix you want (.Z, .gz, .bz2). The autoconf
278	* should already find the program to use. If you set the suffix to
279	* something that autoconf did not find, you are likely to have serious
280	* problems, so make sure you have the appropriate compression tool installed
281	* before you set this. You can look at the autoconf.h file to see
282	* what compression tools it found (search for COMPRESS).
283	* Note that this is used when saving files. Crossfire will search all
284	* methods when loading a file to see if it finds a match
285	*/
286
287	#ifndef COMPRESS_SUFFIX
288	/* #define COMPRESS_SUFFIX ".Z" */
289	#endif
290
291	/* If you get a complaint about O_NDELAY not being known/undefined, try
292	* uncommenting this.
293	* This may cause problems - O_NONBLOCK will return -1 on blocking writes
294	* and set error to EAGAIN. O_NDELAY returns 0. This is only if no bytes
295	* can be written - otherwise, the number of bytes written will be returned
296	* for both modes.
297	*/
298
299	/*
300	#define O_NDELAY O_NONBLOCK
301	*/
302
303
304	/***********************************************************************
305	* Section 3
306	*
307	* General file and other defaults that don't need to be changed, and
308	* do not change gameplay as percieved by players much. Some options
309	* may affect memory consumption however.
310	*
311	* Values:
312	*
313	* BANFILE - ban certain users/hosts.
314	* CSPORT - port to use for new client/server
315	* DMFILE - file with dm/wizard access lists
316	* LOGFILE - where to log if using -daemon option
317	* MAP_ - various map timeout and swapping parameters
318	* MAX_OBJECTS - how many objects to keep in memory.
319	* MAX_OBJECTS_LWM - only swap maps out if below that value
320	* MOTD - message of the day - printed each time someone joins the game
321	* PERM_FILE - limit play times
322	* SHUTDOWN - used when shutting down the server
323	* SOCKETBUFSIZE - size of buffer used internally by the server for storing
324	* backlogged messages.
325	* TMPDIR - directory to use for temp files
326	* UNIQUE_DIR - directory to put unique item files into
327	***********************************************************************
328	*/
329
330	/*
331	* BANFILE - file used to ban certain sites from playing. See the example
332	* ban_file for examples.
333	*/
334	#ifndef BANFILE
335	#define BANFILE "ban_file"
336	#endif
337
338	/* CSPORT is the port used for the new client/server code. Change
339	* if desired. Only of relevance if ERIC_SERVER is set above
340	*/
341	#define CSPORT 13327 /* old port + 1 */
342
343
344	/*
345	* DMFILE
346	* A file containing valid names that can be dm, one on each line. See
347	* example dm_file for syntax help.
348	*/
349	#ifndef DMFILE
350	#define DMFILE "dm_file"
351	#endif
352
353
354	/* LOGFILE specifies which file to log to when playing with the
355	* -daemon option.
356	*/
357	#ifndef LOGFILE
358	#define LOGFILE "/var/log/crossfire/logfile"
359	#endif
360
361	/*
362	* If you want to have a Message Of The Day file, define MOTD to be
363	* the file with the message. If the file doesn't exist or if it
364	* is empty, no message will be displayed.
365	* (It resides in the CONFDIR directory)
366	*/
367	#define MOTD "motd"
368
369	/*
370	* You can restrict playing in certain times by creating a PERMIT_FILE
371	* in CONFDIR. See the sample for usage notes.
372	*/
373	#define PERM_FILE "forbid"
374
375	/*
376	* If you want to take the game down while installing new versions, or
377	* for other reasons, put a message into the SHUTDOWN_FILE file.
378	* Remember to delete it when you open the game again.
379	* (It resides in the CONFDIR directory)
380	*/
381	#ifndef SHUTDOWN_FILE
382	#define SHUTDOWN_FILE "shutdown"
383	#endif
384
385
386	/*
387	* SOCKETBUFSIZE is the size of the buffer used internally by the server for
388	* storing backlogged messages for the client. This is not operating system
389	* buffers or the like. This amount is used per connection (client).
390	* This buffer is in addition to OS buffers, so it may not need to be very
391	* large. When the OS buffer and this buffer is exhausted, the server
392	* will drop the client connection for falling too far behind. So if
393	* you have very slow client connections, a larger value may be
394	* warranted.
395	*/
396	#define SOCKETBUFSIZE 256*1024
397
398	/*
399	* Your tmp-directory should be large enough to hold the uncompressed
400	* map-files for all who are playing. Local to 'lib' directory.
401	*/
402	#define TMPDIR "tmp"
403
404
405	/* Directory to use for unique items. This is placed into the 'lib'
406	* directory. Changing this will cause any old unique items file
407	* not to be used.
408	*/
409	#define UNIQUE_DIR "unique-items"
410
411	/*
412	* These defines tells where, relative to LIBDIR, the maps, the map-index,
413	* archetypes highscore and treaures files and directories can be found.
414	*/
415
416	#define MAPDIR "maps"
417	#define TEMPLATE_DIR "template-maps"
418	#define ARCHETYPES "archetypes"
419	#define REGIONS "regions"
420	#define HIGHSCORE "highscore"
421	#define TREASURES "treasures"
422	#define BANISHFILE "banish_file"
423
424	#define HIGHSCORE_LENGTH 1000 /* How many entries there are room for */
425
426	#define MAXSTRING 20
427
428	#define COMMAND_HASH_SIZE 107 /* If you change this, delete all characters :) */
429
430
431
432	/***********************************************************************
433	* Section 4 - save player options.
434	*
435	* There are a lot of things that deal with the save files, and what
436	* gets saved with them, so I put them in there own section.
437	*
438	***********************************************************************/
439
440	/*
441	* If you want the players to be able to save their characters between
442	* games, define SAVE_PLAYER and set PLAYERDIR to the directories
443	* where the player-files will be put.
444	* Remember to create the directory (make install will do that though).
445	*
446	* If you intend to run a central server, and not allow the players to
447	* start their own crossfire, you won't need to define this.
448	*
449	*/
450
451	#ifndef PLAYERDIR
452	# define PLAYERDIR "players"
453	#endif
454
455	/*
456	* If you have defined SAVE_PLAYER, you might want to change this, too.
457	* This is the access rights for the players savefiles.
458	* Given that crossfire runs in a client/server model, there should
459	* be no issue setting these to be quite restrictive (600 and 700).
460	* Before client/server, multiple people might run the executable,
461	* thus requiring that the server be setuid/setgid, and more generous
462	* permisisons needed.
463	* SAVE_MODE is permissions for the files, SAVE_DIR_MODE is permission
464	* for nay directories created.
465	*/
466	/* IMPORTANT: there is a race during saving, where the umask is being applied */
467	#define SAVE_MODE 0660
468	#define SAVE_DIR_MODE 0770
469
470	/*
471	* AUTOSAVE saves the player every AUTOSAVE ticks. A value of
472	* 5000 with MAX_TIME set at 120,000 means that the player will be
473	* saved every 10 minutes. Some effort should probably be made to
474	* spread out these saves, but that might be more effort than it is
475	* worth (Depending on the spacing, if enough players log on, the spacing
476	* may not be large enough to save all of them.) As it is now, it will
477	* just set the base tick of when they log on, which should keep the
478	* saves pretty well spread out (in a fairly random fashion.)
479	*/
480
481	#define AUTOSAVE 1000
482
483	/* RESET_LOCATION_TIME is the number of seconds that must elapse before
484	* we will return the player to his savebed location. If this is zero,
485	* this feature is disabled (player will resume where ever he was
486	* when he last logged off). If this is set to less than two hours,
487	* it will prevent players from camping out in treasure rooms.
488	* Do not comment this out - it must be set to something - if you
489	* comment this out, the program will not compile.
490	*
491	* This will work to BACKUP_SAVE_AT_HOME at home above, but where the player
492	* where appear under what conditions is a little complicated depending
493	* on how the player exited the game. But if the elapsed time is greater than
494	* the value below, player will always get returned to savebed location
495	* location.
496	*
497	* Set to one hour as default
498	*/
499
500	#define RESET_LOCATION_TIME 3600
501
502	/*
503	* The message to send to clients when the server calls cleanup (on crash, shutdown, restart and so on).
504	*/
505	#define CLEANUP_MESSAGE "The server will likely restart within the minute. Our apologies."
506