| 1 |
The "lib" directory contains all of Angband's special sub-directories. |
|---|
| 2 |
|
|---|
| 3 |
|
|---|
| 4 |
=== Directory "lib/apex" === |
|---|
| 5 |
|
|---|
| 6 |
The "lib/apex" directory contains the "high score" files. |
|---|
| 7 |
|
|---|
| 8 |
The "scores.raw" file contains the "high score" table, in a "semi-binary" form, |
|---|
| 9 |
that is, all the bytes in the file are normal ascii values, but this includes |
|---|
| 10 |
the special "nul" or "zero" byte, which is used to separate and pad records. |
|---|
| 11 |
You should probably not attempt to modify this file with a normal text editor. |
|---|
| 12 |
This file should be (more or less) portable between different platforms. It |
|---|
| 13 |
must be present (or creatable) for the game to run correctly. |
|---|
| 14 |
|
|---|
| 15 |
|
|---|
| 16 |
=== Directory "lib/bone" === |
|---|
| 17 |
|
|---|
| 18 |
The "lib/bone" directory is currently unused. |
|---|
| 19 |
|
|---|
| 20 |
|
|---|
| 21 |
=== Directory "lib/data" === |
|---|
| 22 |
|
|---|
| 23 |
The "lib/data" directory contains various special binary data files. |
|---|
| 24 |
|
|---|
| 25 |
The *.raw files are binary image files constructed by parsing the ascii |
|---|
| 26 |
template files in "lib/edit", described below. These files are required, |
|---|
| 27 |
but can be created by the game if the "lib/edit" directory contains the |
|---|
| 28 |
proper files, and if the game was compiled to allow this creation. |
|---|
| 29 |
|
|---|
| 30 |
|
|---|
| 31 |
=== Directory "lib/edit" === |
|---|
| 32 |
|
|---|
| 33 |
The "lib/edit" directory contains various special ascii data files. |
|---|
| 34 |
|
|---|
| 35 |
The *.txt files are ascii template files used to construct the binary image |
|---|
| 36 |
files in "lib/data", described above. These files describe the "terrain |
|---|
| 37 |
features", "object kinds", "artifacts", "ego-items", "monster races", and |
|---|
| 38 |
"dungeon vaults", "player races", "player classes", and many other things. |
|---|
| 39 |
|
|---|
| 40 |
The ascii template files are easier to edit than hard-coded arrays, prevent |
|---|
| 41 |
compilation errors on some machines, and also shrink the size of the binary |
|---|
| 42 |
executable, and also provide a user-readable spoiler file of sorts. |
|---|
| 43 |
|
|---|
| 44 |
These files should not be modified unless you know exactly what you are doing. |
|---|
| 45 |
|
|---|
| 46 |
These files are optional if the game is distributed with pre-created |
|---|
| 47 |
binary raw files in "lib/data". |
|---|
| 48 |
|
|---|
| 49 |
|
|---|
| 50 |
=== Directory "lib/file" === |
|---|
| 51 |
|
|---|
| 52 |
The "lib/file" directory contains various special ascii data files. |
|---|
| 53 |
|
|---|
| 54 |
The 'news.txt' file is displayed to the user when the game starts up. It |
|---|
| 55 |
contains basic information such as my name and email address, and the names |
|---|
| 56 |
of some of the people who have been responsible for previous versions of |
|---|
| 57 |
Angband. You may edit this file (slightly) to include local "site specific" |
|---|
| 58 |
information such as who compiled the local executable. You should refer the |
|---|
| 59 |
user to a special "online help" file, if necessary, that describes any local |
|---|
| 60 |
modifications in detail. The first two lines of this file should be blank, |
|---|
| 61 |
and only the next 20 lines should contain information. |
|---|
| 62 |
|
|---|
| 63 |
The 'dead.txt' file is displayed to the user when the player dies. It |
|---|
| 64 |
contains a picture of a tombstone which is filled in with interesting |
|---|
| 65 |
information about the dead player. You should not edit this file. |
|---|
| 66 |
|
|---|
| 67 |
The optional file 'time.txt' may be used to restrict the "times" at which |
|---|
| 68 |
the game may be played, by providing specification of which hours of each day |
|---|
| 69 |
of the week are legal for playing the game. See 'files.c' for more details. |
|---|
| 70 |
A missing file provides no restrictions, and an empty file will, by default, |
|---|
| 71 |
forbid the playing of the game from 8am-5pm on weekdays. This file is only |
|---|
| 72 |
used on multi-user machines, and only if CHECK_TIME is defined, otherwise, |
|---|
| 73 |
there are no restrictions. |
|---|
| 74 |
|
|---|
| 75 |
These files should not be modified unless you know exactly what you are doing. |
|---|
| 76 |
|
|---|
| 77 |
|
|---|
| 78 |
=== Directory "lib/help" === |
|---|
| 79 |
|
|---|
| 80 |
The "lib/help" directory contains the "online help" files. |
|---|
| 81 |
|
|---|
| 82 |
This directory is used to search for normal "online help" files. |
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 |
=== Directory "lib/info" === |
|---|
| 86 |
|
|---|
| 87 |
The "lib/info" directory contains the "online spoiler" files. |
|---|
| 88 |
|
|---|
| 89 |
This directory is used to search for any "online help" file that cannot |
|---|
| 90 |
be found in the "lib/help" directory. |
|---|
| 91 |
|
|---|
| 92 |
This directory is empty by default. Many people use this directory for |
|---|
| 93 |
"online spoiler files", many of which are available. |
|---|
| 94 |
|
|---|
| 95 |
Note that the default "help.hlp" file allows the "9" key to access a help |
|---|
| 96 |
file called "spoiler.hlp", and allows the "0" key to access "user.hlp". |
|---|
| 97 |
|
|---|
| 98 |
These special help files can thus be placed in the user's own "info" |
|---|
| 99 |
directory to allow the on line help to access his files. |
|---|
| 100 |
|
|---|
| 101 |
|
|---|
| 102 |
=== Directory "lib/save" === |
|---|
| 103 |
|
|---|
| 104 |
The "lib/save" directory contains "savefiles" for the players. |
|---|
| 105 |
|
|---|
| 106 |
Each savefile is named "NNN" where "NNN" is the name of the character, or, |
|---|
| 107 |
on some machines, the name of the character, or, on multi-user machines, |
|---|
| 108 |
"UUU.NNN", where "UUU" is the player uid and "NNN" is the character name. |
|---|
| 109 |
|
|---|
| 110 |
The savefiles should be portable between systems, assuming that the |
|---|
| 111 |
appropriate renaming is perfomed. |
|---|
| 112 |
|
|---|
| 113 |
|
|---|
| 114 |
=== Directory "lib/pref" === |
|---|
| 115 |
|
|---|
| 116 |
The "lib/user" directory contains the "user pref files", if any. |
|---|
| 117 |
|
|---|
| 118 |
In general, these files are used to "customize" aspects of the game for |
|---|
| 119 |
a given site or a given player. |
|---|
| 120 |
|
|---|
| 121 |
See "src/files.c" for information on the proper "format" of these files. |
|---|
| 122 |
|
|---|
| 123 |
|
|---|
| 124 |
=== Directory "lib/xtra" === |
|---|
| 125 |
|
|---|
| 126 |
The "lib/xtra" directory contains special system files, if any. |
|---|
| 127 |
|
|---|
