readme_angband

   1 This is the README file for Angband 2.8.1 (03/04/97)
   2 [Meaning it might not apply for Zangband in all respects, of course... (TY)]
   3
   4 Angband 2.8.1 is a semi-stable official release incorporating all of the
   5 improvements added since Angband 2.7.8.  Any bugs found in Angband 2.8.1
   6 will be fixed in Angband 2.8.2, the next stable official release.
   7
   8 See the Official Angband Home Page "http://www.phial.com/angband/"
   9 for more information about exactly what has changed recently.
  10
  11 === General information ===
  12
  13 Angband is a "graphical" dungeon adventure game using textual characters
  14 to represent the walls and floors of a dungeon and the inhabitants therein,
  15 in the vein of "rogue", "hack", "nethack", and "moria".
  16
  17 There are extensive ascii "on line help" files in the "lib/help" directory.
  18
  19 This version of Angband will run on Macintosh, Windows, Unix (X11/Curses),
  20 Linux (X11/Curses), Acorn, Amiga, various IBM machines, and many others...
  21
  22 See Makefile, h-config.h, and config.h for details on compiling.
  23 See "Makefile.xxx" and "main-xxx.c" for various supported systems.
  24
  25 Visit the Angband Home Page ("http://www.phial.com/angband/"),
  26 and browse through the Angband newsgroup ("rec.games.roguelike.angband").
  27
  28 Send bug reports, suggestions, etc, to Ben Harrison ("benh@phial.com").
  29
  30
  31 === Quick and dirty compilation instructions (for Unix) ===
  32
  33 Step 1: Acquire.  Ftp to "export.andrew.cmu.edu:/angband/Source"
  34                   Try "bin" and "mget angband*.tar.gz" and "y"
  35 Step 2: Extract.  Try "gunzip *.gz" then "tar -xvf *.tar"
  36 Step 3: Prepare.  Try "cd angband*/src", then edit "Makefile"
  37                   You may also edit "h-config.h" and "config.h"
  38 Step 4: Compile.  Try "make", and then "cd .." if successful
  39 Step 5: Execute.  Try "angband -uTest" to initialize stuff
  40 Step 6: Play....  Read the "online help" via the "?" command.
  41
  42
  43 === Special instructions for other systems ===
  44
  45 The IBM requires extraction with "pkunzip -d" to create subdirectories.
  46
  47 The Macintosh requires that the "lib" folder be in the same folder as
  48 the executable.  Also, note that System 7.5 (and perhaps others) are
  49 brain damaged, and may default to the incorrect folder for opening
  50 savefiles.  Make sure you keep all your savefiles in the proper place,
  51 and if you load a savefile from the wrong place, note that the game
  52 may decide to re-save your savefile in the proper place when you quit.
  53
  54
  55 === Upgrading from older versions or other platforms ===
  56
  57 If you have been playing Angband on a different platform, or with an older
  58 version of Angband, it may be possible to "upgrade" to Angband 2.8.X, keeping
  59 your old savefiles, high score list, and other files, instead of starting over.
  60
  61 Angband 2.8.X uses a platform independant file format for the binary files
  62 that store information about games in progress, known as "savefiles".  Also,
  63 Angband 2.8.X is able to translate savefiles from any version of Angband from
  64 Angband 2.5.1 on.  Unfortunately, pre-2.5.1 savefiles are not usable, since
  65 they used a system specific savefile format, and did not have an official
  66 definition, and sometimes include assumptions that are no longer valid.  To
  67 use an old savefile, simply copy it into the "lib/save" directory, changing
  68 the name of the savefile (if necessary) to satisfy the requirements of the
  69 platform you are using.  In general, the savefile should be named "UUU.NNN"
  70 or "NNN" where "UUU" is the userid of the player (on "multiuser" systems),
  71 and "NNN" is the name of the "character" in the savefile.  Note that only
  72 "multiuser" platforms use the "UUU.NNN" form, and the "period" is required.
  73
  74 Angband 2.8.X uses a platform independant (?) file format for the binary
  75 file used to store the high score list.  This file may be moved between
  76 platforms (if needed) or copied from older versions (Angband 2.7.4 or later).
  77 Angband 2.8.X uses a high score file called "scores.raw", which is kept in
  78 the "lib/apex" directory.  Older versions kept the "scores.raw" file in the
  79 "lib/data" directory, along with several other version specific files.
  80
  81 Angband 2.8.X uses a platform independant file format for the ascii files
  82 used to store information about dead players, which is used to help create
  83 "player ghosts" in the dungeon.  If necessary, these files, which are kept
  84 in the "lib/bone" directory, may be copied from older versions, as long as
  85 you make sure that they are renamed as "bone.XXX" where XXX is the level on
  86 which the dead player died, and that every line in the file is "complete".
  87 It is also possible to delete the contents of the "lib/bone" directory at
  88 any time, which will prevent the creation of player ghosts.  Currently,
  89 these files are not actually used by the game.
  90
  91 Angband 2.8.X uses a set of ascii "configuration files" which are kept in the
  92 "lib/file" directory (see below).  Certain of these files may be taken from
  93 older versions, though most are optional for the most common configurations.
  94
  95 Angband 2.8.X uses a set of ascii "user pref files" which are kept in the
  96 "lib/user" directory.  Some of these files are usable on multiple platforms,
  97 but in general they are restricted to a single platform.  In general, "pref"
  98 files from older versions may be used with Angband 2.8.X, by moving them to
  99 the "lib/user" directory from the old "lib/pref" or "lib/pref-*" directories,
 100 but note that some important changes have been made in Angband 2.8.X, and, for
 101 example, old "pref" files which change the "attr/char" definitions of "terrain"
 102 features such as walls or doors must be changed to use the new methods.  Make
 103 sure to put comments in your "user pref files" describing the purpose and the
 104 proper platform for your files, to facilitate future upgrades.
 105
 106
 107 === Directory "src" ===
 108
 109 The "src" directory contains the complete set of source files.
 110
 111 The "main-???.c" and "Makefile.???" allow compilation on various systems.
 112
 113 Some of these systems (Macintosh, Windows) require "extra" files, most of
 114 which are located elsewhere (except for the "A-mac-h.*" Macintosh files).
 115
 116
 117 === Directory "lib" ===
 118
 119 The "lib" directory contains all of Angband's special sub-directories.
 120
 121
 122 === Directory "lib/apex" ===
 123
 124 The "lib/apex" directory contains the "high score" files.
 125
 126 The "scores.raw" file contains the "high score" table, in a "semi-binary" form,
 127 that is, all the bytes in the file are normal ascii values, but this includes
 128 the special "nul" or "zero" byte, which is used to separate and pad records.
 129 You should probably not attempt to modify this file with a normal text editor.
 130 This file should be (more or less) portable between different platforms.  It
 131 must be present (or creatable) for the game to run correctly.
 132
 133
 134 === Directory "lib/bone" ===
 135
 136 The "lib/bone" directory contains special "player ghost" template files.
 137
 138 The files in this directory have filenames of the form "bone.NNN" where
 139 "NNN" is the level on which the player died.  They contain information
 140 about the dead player, currently, one line each for the player name,
 141 maximum hitpoints, race, and class.  These files are probably portable,
 142 and are probably compatible with older bone files, if those files are
 143 renamed, and a final newline is added for compatibility.  Actually,
 144 only the "player name" from these files is actually used.
 145
 146
 147 === Directory "lib/data" ===
 148
 149 The "lib/data" directory contains various special binary data files.
 150
 151 The files 'f_info.raw', 'k_info.raw', 'a_info.raw', 'e_info.raw', 'r_info.raw',
 152 and 'v_info.raw' are binary image files constructed by parsing the ascii
 153 template files in "lib/edit", described below.  These files are required,
 154 but can be created by the game if the "lib/edit" directory contains the
 155 proper files, and if the game was compiled to allow this creation.
 156
 157
 158 === Directory "lib/edit" ===
 159
 160 The "lib/edit" directory contains various special ascii data files.
 161
 162 The files 'f_info.txt', 'k_info.txt', 'a_info.txt', 'e_info.txt', 'r_info.txt',
 163 and 'v_info.txt' are ascii template files used to construct the binary image
 164 files in "lib/data", described above.  These files describe the "terrain
 165 features", "object kinds", "artifacts", "ego-items", "monster races", and
 166 "dungeon vaults", respectively.
 167
 168 The ascii template files are easier to edit than hard-coded arrays, and also
 169 prevent compilation errors on some machines, and also shrink the size of the
 170 binary executable, and also provide a user-readible spoiler file of sorts.
 171
 172 These files are optional if the game is distributed with pre-created
 173 binary raw files in "lib/data".
 174
 175
 176 === Directory "lib/file" ===
 177
 178 The "lib/file" directory contains various special ascii data files.
 179
 180 The 'news.txt' file is displayed to the user when the game starts up.  It
 181 contains basic information such as my name and email address, and the names
 182 of some of the people who have been responsible for previous versions of
 183 Angband.  You may edit this file (slightly) to include local "site specific"
 184 information such as who compiled the local executable.  You should refer the
 185 user to a special "online help" file, if necessary, that describes any local
 186 modifications in detail.  The first two lines of this file should be blank,
 187 and only the next 20 lines should contain information.
 188
 189 The 'dead.txt' file is displayed to the user when the player dies.  It
 190 contains a picture of a tombstone which is filled in with interesting
 191 information about the dead player.  You should not edit this file.
 192
 193 The optional file 'wizards.txt' may be used to specify which users may enter
 194 'wizard' mode.  A missing file provides no restrictions, and an empty file
 195 prevents everyone from entering 'wizard' mode.  This file is only used on
 196 multi-user machines, otherwise there are no restrictions.
 197
 198 The optional file 'time.txt' may be used to restrict the "times" at which
 199 the game may be played, by providing specification of which hours of each day
 200 of the week are legal for playing the game.  See 'files.c' for more details.
 201 A missing file provides no restrictions, and an empty file will, by default,
 202 forbid the playing of the game from 8am-5pm on weekdays.  This file is only
 203 used on multi-user machines, and only if CHECK_TIME is defined, otherwise,
 204 there are no restrictions.
 205
 206 The optional file 'load.txt' may be used to restrict the "load" which the game
 207 may impose on the system.  See 'files.c' for more details.  A missing file
 208 provides no restrictions, and an empty file will, by default, restrict the
 209 "current load" to a maximal value of 100*FSCALE.  This file is only used on
 210 multi-user machines, and only if CHECK_LOAD is defined, otherwise, there are
 211 no restrictions.
 212
 213
 214 === Directory "lib/help" ===
 215
 216 The "lib/help" directory contains the "online help" files.
 217
 218 This directory is used to search for normal "on line help" files.
 219
 220
 221 === Directory "lib/info" ===
 222
 223 The "lib/info" directory (optional) contains the "spoiler" files.
 224
 225 This directory is used to search for any "on line help" file that cannot
 226 be found in the "lib/help" directory.
 227
 228 The user may "redirect" this directory to point at any available directory.
 229
 230 Note that the default "help.hlp" file allows the "9" key to access a help
 231 file called "spoiler.hlp", and allows the "0" key to access "user.hlp".
 232
 233 These special help files can thus be placed in the user's own "info"
 234 directory to allow the on line help to access his files.
 235
 236
 237 === Directory "lib/save" ===
 238
 239 The "lib/save" directory contains "savefiles" for the players.
 240
 241 Each savefile is named "NNN" where "NNN" is the name of the savefile, or,
 242 on some machines, the name of the character, or, on multi-user machines,
 243 "UUU.NNN", where "UUU" is the player uid and "NNN" is the savefile name.
 244
 245 The savefiles should be portable between systems, assuming that the
 246 appropriate renaming is perfomed, and any file "type" information is
 247 specified (for the Macintosh).
 248
 249
 250 === Directory "lib/user" ===
 251
 252 The "lib/user" directory contains the "user pref files", if any.
 253
 254 In general, these files are used to "customize" aspects of the game for
 255 a given site or a given player.  These files can define "macros" (which
 256 allow a single keypress to perform a complex action), set options (which
 257 affect how the game will handle various situations), and specify visual
 258 mappings for various monsters, objects, or terrain features.
 259
 260 See "files.c" for more information on the proper "format" of these files.
 261
 262
 263 === Directory "lib/xtra" ===
 264
 265 The "lib/xtra" directory contains special system files, if any.
 266
 267
 268 --- Ben ---
 269