config.h

Go to the documentation of this file.

#ifndef CONFIG_H
#define CONFIG_H

/* 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
 * WATCHDOG - allows use of an external watchdog program
 *
 ***********************************************************************/

/* These are basically experimental values right now - perhaps should
 * be turned into settings values at load time, but want to make
 * sure we go down this road before doing that.
 *
 * MIN_PLAYER_SPEED: If a player is fully loaded with junk, this is
 * how slow the character will move.
 *
 * MAX_PLAYER_SPEED: If the player is unloaded, this is how fast the
 * player will move.  Note that armor will still affect this (a
 * character otherwise unloaded but wearing plate will be slower)
 *
 * FREE_PLAYER_LOAD_PERCENT: This value is how much of the players
 * load is 'free' before it starts slowing them down - just because
 * I pick up a book doesn't make me slower.
 *
 * Example:  Player has a max carrying capacity of 1000 kg.  If he is
 * carrying 1000 KG, he moves at MIN_PLAYER_SPEED (0.25 by default).
 * The free load is 0.50 (50%), which means he can carry 500 kg before
 * he starts to slow down.  So if his load is anywhere between 0 and 500 kg
 * and character is otherwise not wearing armor or other things that slow
 * him down, he moves at 0.75
 * Once he goes above 500 kg, his speed is now a linear difference of
 * MIN and MAX.  With the nice round numbers chosen, it amounts to
 * each 1 kg of look slows character down 0.001 (500 * 0.001 = 0.5,
 * 0.75 - 0.5 = 0.25)
 *
 * The values can be adjusted in various ways - a free load percent
 * of 1.0 means how much you carry does not affect movement speed.
 * One could also adjust these values for slower of faster movement.
 *
 * 0.75 was chosen as default for fast movement as this gives room
 * for magic (and other effects) to speed up the player, but speed
 * still remain below 1.
 *
 * 0.25 was chosen as low end as that is still fairly slow (about
 * 2 spaces/second), but not so slow to be really painful -
 * typically it is low level characters that have this issue
 * more, so I think this will improve playing quality.
 */
#define MIN_PLAYER_SPEED    0.25
#define MAX_PLAYER_SPEED    0.75
#define FREE_PLAYER_LOAD_PERCENT    0.50

/*
 * BASE_WEAPON_SPEED is sort of like the speed - what the characters
 * weapon_speed is before we start factoring in bonuses & penalties.
 * Want fast melee?  Increase this.  Slow melee?  decrease this.
 * Note that weapon_speed decreases this, so generally you want
 * to start higher, as there isn't a lot of things that
 * will increase this
 */
#define BASE_WEAPON_SPEED   1.0

/* 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    4
#define BALSL_NUMBER_LOSSES_RATIO  6
#define BALSL_MAX_LOSS_RATIO       2

/* 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 50
#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 RECYCLE_TMP_MAPS FALSE
#define ALWAYS_SHOW_HP FALSE
#define RESURRECTION FALSE
#define SEARCH_ITEMS TRUE
#define NOT_PERMADETH TRUE
#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

/* you can edit the ones below */

#ifndef WIN32    /* ***win32 we set the following stuff in the IDE */
#define CS_LOGSTATS
#endif
#ifdef CS_LOGSTATS
#define CS_LOGTIME  600
#endif

#ifndef WIN32                   /* ***win32 we set the following stuff in the IDE */
#ifndef DEBUG
#define DEBUG
#endif
#endif

#define MANY_CORES

#define MAP_CLIENT_X    25
#define MAP_CLIENT_Y    25

#define MAX_TIME        120000

#define NO_POLYMORPH

/*
#define PARTY_KILL_LOG 20
*/

/* GD */

#define PERM_EXP_GAIN_RATIO           0.50f
#define PERM_EXP_MAX_LOSS_RATIO       0.50f

#ifndef WIN32   /* ***win32 disable watchdog as win32 default */
#define WATCHDOG
#endif


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

/*
#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
 * 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 the output socket buffer
 * TMPDIR - directory to use for temp files
 * UNIQUE_DIR - directory to put unique item files into
 * USE_CALLOC for some memory requests
 ***********************************************************************
 */

#ifndef BANFILE
#define BANFILE         "ban_file"
#endif

#define CSPORT 13327 /* old port + 1 */

#ifndef DMFILE
#define DMFILE "dm_file"
#endif

#ifndef LOGFILE
#ifdef WIN32 /* change define path */
#define LOGFILE "var\\crossfire.log"
#else
#define LOGFILE "/var/log/crossfire/logfile"
#endif
#endif

#define MAP_MAXTIMEOUT  1000

#define MAP_MINTIMEOUT  500

#define MAP_MAXRESET    7200

#define MAP_DEFAULTRESET       7200

/*#define MEMORY_DEBUG*/

#define MOTD "motd"

#define PERM_FILE "forbid"

#ifndef SHUTDOWN_FILE
#define SHUTDOWN_FILE "shutdown"
#endif

#define SOCKETBUFSIZE 256*1024

/*#define TMPDIR "/home/hugin/a/crossfire/crossfire/tmp"*/
#ifdef WIN32 /* change define path tmp */
#define TMPDIR "tmp"
#else
#define TMPDIR "/tmp"
#endif

#define UNIQUE_DIR "unique-items"

#ifdef WIN32 /* change define path city */
#  define EMERGENCY_MAPPATH "\\world\\world_105_115"
#else
#  define EMERGENCY_MAPPATH "/world/world_105_115"
#endif
#  define EMERGENCY_X 5
#  define EMERGENCY_Y 37

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

#define MAX_ERRORS      25      
#define STARTMAX        500     
#define OBJ_EXPAND      100     
#define HIGHSCORE_LENGTH 1000   
#define ARCHTABLE 8192          
#define MAXSTRING 20

#define COMMAND_HASH_SIZE 107   
/***********************************************************************
 * 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.
 *
 ***********************************************************************/

#ifndef PLAYERDIR
#define PLAYERDIR "players"
#endif

#define SAVE_MODE       0660
#define SAVE_DIR_MODE   0770

/* NOTE ON SAVE_INTERVAL and AUTOSAVE:  Only one of these two really
 * needs to be selected.  You can set both, and things will work fine,
 * however, it just means that a lot more saving will be done, which
 * can slow things down some.
 */

/*#define SAVE_INTERVAL 300*/

#define AUTOSAVE 5000

#define NO_EMERGENCY_SAVE

/*#define BACKUP_SAVE_AT_HOME*/

#define RESET_LOCATION_TIME     3600

#define BEAT_INTERVAL 3

#endif /* CONFIG_H */