crossfire-crossfire-server/doc/server-directories.txt File Reference

Functions
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited etc mapdir Usually maps Always relative to datadir or depending on context Relative to the this is the path to the complete map hierarchy for the server Relative to the this holds overlay maps that can patch the maps from the base hierarchy at load time playerdir Usually players Always relative to localdir Holds per player save data templatedir Usually template maps Always relative to localdir Holds maps generated at runtime and saved to	disk (I think. -TF) uniquedir --------- Usually "unique-items". Always relative to localdir. Holds information about items that don 't disappear when the map resets. tmpdir ------ Usually/tmp. Holds scratch files that don 't need to persist across restarts. In practice this is mostly live maps. On a busy server with a long reset time this can get a bit cluttered
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single or trs file and the graphics into a	face (metadata) and .tar(bitmaps) file

Variables
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single	arc
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the	archetype
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the	archetypes
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the	artifact
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single	artifacts
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like	attackmess
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited	books
*envar *is the environment if one that can also be used as an override If both the flag and the envar are the envar takes precedence name flag envar notes confdir conf absolute datadir data CROSSFIRE_LIBDIR absolute localdir CROSSFIRE_LOCALDIR absolute mapdir maps CROSSFIRE_MAPDIR relative to datadir or localdir playerdir playerdir CROSSFIRE_PLAYERDIR relative to localdir templatedir tmpdir CROSSFIRE_TEMPLATEDIR relative to localdir uniquedir uniquedir CROSSFIRE_UNIQUEDIR relative to localdir tmpdir templatedir CROSSFIRE_TMPDIR absolute regions regions unused Paths marked absolute	can
Server as a resource for server administrators and developers the server recognizes the following distinct directories The *name *is what it s called in the server	code
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment	contents
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited etc mapdir Usually maps Always relative to datadir or depending on context Relative to the	datadir
Server	Directories
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single or trs file	each
*envar *is the environment if one	exists
the server will also quite happily load unpacked files as long as they have the right file	extensions
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few	files
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the	graphics
	however
Server as a resource for server administrators and developers	Internally
*flag *is the command line flag that can be used to override	it
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited etc mapdir Usually maps Always relative to datadir or	localdir
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the	maps
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to	modify
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific	motd
*envar *is the environment if one that can also be used as an override If both the flag and the envar are the envar takes precedence name flag envar notes confdir conf absolute datadir data CROSSFIRE_LIBDIR absolute localdir CROSSFIRE_LOCALDIR absolute mapdir maps CROSSFIRE_MAPDIR relative to datadir or localdir playerdir playerdir CROSSFIRE_PLAYERDIR relative to localdir templatedir tmpdir CROSSFIRE_TEMPLATEDIR relative to localdir uniquedir uniquedir CROSSFIRE_UNIQUEDIR relative to localdir tmpdir templatedir CROSSFIRE_TMPDIR absolute regions regions unused Paths marked absolute if you contain relative	paths
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific	Paths
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while	running
the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high	scores
*envar *is the environment if one that can also be used as an override If both the flag and the envar are	set
in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn	t
*envar *is the environment	variable
*envar *is the environment if one that can also be used as an override If both the flag and the envar are the envar takes precedence name flag envar notes confdir conf absolute datadir data CROSSFIRE_LIBDIR absolute localdir CROSSFIRE_LOCALDIR absolute mapdir maps CROSSFIRE_MAPDIR relative to datadir or localdir playerdir playerdir CROSSFIRE_PLAYERDIR relative to localdir templatedir tmpdir CROSSFIRE_TEMPLATEDIR relative to localdir uniquedir uniquedir CROSSFIRE_UNIQUEDIR relative to localdir tmpdir templatedir CROSSFIRE_TMPDIR absolute regions regions unused Paths marked absolute if you	want

Function Documentation

disk()

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited etc mapdir Usually maps Always relative to datadir or depending on context Relative to the this is the path to the complete map hierarchy for the server Relative to the this holds overlay maps that can patch the maps from the base hierarchy at load time playerdir Usually players Always relative to localdir Holds per player save data templatedir Usually template maps Always relative to localdir Holds maps generated at runtime and saved to disk

(

I think. -

TF

)

face()

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single or trs file and the graphics into a face

(

metadata

)

Referenced by add_abilities(), add_face_layer(), AllAnimations::added(), Faces::added(), Facesets::added(), asset_create(), cf_object_set_face(), cfapi_object_set_property(), cfapi_system_find_face(), dump_faces(), esrv_send_face(), find_smooth(), Faces::findById(), knowledge_process_incremental(), knowledge_send_info(), MessageLoader::load(), PngLoader::load(), FaceLoader::loadAnimationBlock(), map2_add_ob(), map_clearcell(), Object_SetFace(), pack_images(), recipe_get_face(), AllAnimations::replace(), send_account_players(), send_image_sums(), send_smooth(), shuffle_attack(), AnimationWriter::write(), and FaceWriter::write().

Here is the caller graph for this function:

Variable Documentation

arc

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single arc

Definition at line 47 of file server-directories.txt.

archetype

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the archetype

Definition at line 46 of file server-directories.txt.

Referenced by apply_builder_window(), and fix_walls().

archetypes

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the archetypes

Definition at line 46 of file server-directories.txt.

artifact

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the artifact

Definition at line 47 of file server-directories.txt.

Referenced by add_one_item(), get_empty_artifact(), and save_object_in_sb().

artifacts

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single artifacts

Definition at line 47 of file server-directories.txt.

Referenced by AssetsManager::archetypeUpdated().

attackmess

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like attackmess

Definition at line 53 of file server-directories.txt.

books

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited books

Definition at line 62 of file server-directories.txt.

can

* envar* is the environment if one that can also be used as an override If both the flag and the envar are the envar takes precedence name flag envar notes confdir conf absolute datadir data CROSSFIRE_LIBDIR absolute localdir CROSSFIRE_LOCALDIR absolute mapdir maps CROSSFIRE_MAPDIR relative to datadir or localdir playerdir playerdir CROSSFIRE_PLAYERDIR relative to localdir templatedir tmpdir CROSSFIRE_TEMPLATEDIR relative to localdir uniquedir uniquedir CROSSFIRE_UNIQUEDIR relative to localdir tmpdir templatedir CROSSFIRE_TMPDIR absolute regions regions unused Paths marked absolute can

Definition at line 26 of file server-directories.txt.

code

Server as a resource for server administrators and developers the server recognizes the following distinct directories The* name* is what it s called in the server code

Definition at line 8 of file server-directories.txt.

contents

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment contents

Definition at line 62 of file server-directories.txt.

Referenced by get_newspaper_content().

datadir

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited etc mapdir Usually maps Always relative to datadir or depending on context Relative to the datadir

Definition at line 69 of file server-directories.txt.

Referenced by assets_collect().

Directories

Server Directories

Initial value:

==================
 
This file documents the various directories used by the server at runtime

Definition at line 2 of file server-directories.txt.

each

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the etc A default install will pack the and treasurelist definitions into a single or trs file each

Definition at line 48 of file server-directories.txt.

Referenced by pack_images().

exists

* envar* is the environment if one exists

Definition at line 9 of file server-directories.txt.

extensions

the server will also quite happily load unpacked files as long as they have the right file extensions

Definition at line 50 of file server-directories.txt.

files

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few files

Definition at line 53 of file server-directories.txt.

Referenced by cfpython_globalEventListener(), and AssetCollector::processFiles().

graphics

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while such as the graphics

Definition at line 46 of file server-directories.txt.

however

however

Definition at line 49 of file server-directories.txt.

Internally

Server as a resource for server administrators and developers Internally

Definition at line 7 of file server-directories.txt.

it

* flag* is the command line flag that can be used to override it

Definition at line 9 of file server-directories.txt.

localdir

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high the contents of player edited etc mapdir Usually maps Always relative to datadir or depending on context Relative to the this is the path to the complete map hierarchy for the server Relative to the localdir

Definition at line 67 of file server-directories.txt.

maps

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live maps

Definition at line 46 of file server-directories.txt.

modify

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to modify

Definition at line 61 of file server-directories.txt.

motd

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific motd

Definition at line 38 of file server-directories.txt.

paths

* envar* is the environment if one that can also be used as an override If both the flag and the envar are the envar takes precedence name flag envar notes confdir conf absolute datadir data CROSSFIRE_LIBDIR absolute localdir CROSSFIRE_LOCALDIR absolute mapdir maps CROSSFIRE_MAPDIR relative to datadir or localdir playerdir playerdir CROSSFIRE_PLAYERDIR relative to localdir templatedir tmpdir CROSSFIRE_TEMPLATEDIR relative to localdir uniquedir uniquedir CROSSFIRE_UNIQUEDIR relative to localdir tmpdir templatedir CROSSFIRE_TMPDIR absolute regions regions unused Paths marked absolute if you contain relative paths

Definition at line 26 of file server-directories.txt.

Paths

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific Paths

Initial value:

=======================
 
confdir
-------
Usually /etc/crossfire.
 
Contains runtime configuration files like the dm_file

Definition at line 32 of file server-directories.txt.

running

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn though Notes on Specific and settings file datadir Usually usr share crossfire Contains data that the server does not need to modify while running

Definition at line 45 of file server-directories.txt.

scores

the server will also quite happily load unpacked files as long as they have the right file which is convenient if you want to edit your maps and archetypes live It also contains a few like which have hard coded names and are not identified by extension localdir Usually var crossfire Modern systems probably want var lib crossfire instead Contains data that the server does need to live apartment high scores

Definition at line 62 of file server-directories.txt.

set

* envar* is the environment if one that can also be used as an override If both the flag and the envar are set

Definition at line 12 of file server-directories.txt.

Referenced by PngLoader::load(), and FacesetWriter::write().

t

in that case they will be relative to whatever the PWD of the crossfire server process is You probably shouldn t

Definition at line 28 of file server-directories.txt.

Referenced by add_book_to_list(), assets_pack(), cast_raise_dead_spell(), change_book(), change_treasure(), check_treasurelist(), command_players(), create_all_treasures(), create_items_path(), create_one_treasure(), create_treasure(), describe_monster(), do_harvest(), do_single_item(), dump_monster_treasure_rec(), dump_types(), find_recipe_for_tool(), find_title(), find_treasure_by_name(), generate_treasure(), get_empty_artifact(), get_empty_book(), get_empty_formula(), get_empty_treasure(), kill_object(), TreasureLoader::load(), TreasureLoader::loadTreasure(), resurrect_player(), set_tick_duration(), and treasure_free().

variable

* envar* is the environment variable

Definition at line 9 of file server-directories.txt.

Referenced by equality_split(), load_races(), TreasureLoader::loadTreasure(), and start_animation().

want

* envar* is the environment if one that can also be used as an override If both the flag and the envar are the envar takes precedence name flag envar notes confdir conf absolute datadir data CROSSFIRE_LIBDIR absolute localdir CROSSFIRE_LOCALDIR absolute mapdir maps CROSSFIRE_MAPDIR relative to datadir or localdir playerdir playerdir CROSSFIRE_PLAYERDIR relative to localdir templatedir tmpdir CROSSFIRE_TEMPLATEDIR relative to localdir uniquedir uniquedir CROSSFIRE_UNIQUEDIR relative to localdir tmpdir templatedir CROSSFIRE_TMPDIR absolute regions regions unused Paths marked absolute if you want

Definition at line 26 of file server-directories.txt.