home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 7 Games / 07-Games.zip / angband.zip / README < prev    next >
Text File  |  1998-02-08  |  12KB  |  282 lines
  1.  
  2.  
  3.               **************************************************
  4.               **   Angband 2.8.3   **   The Pits of Angband   **
  5.               **************************************************
  6.  
  7.            Based on Moria:   Copyright (c) 1985 Robert Alan Koeneke
  8.                and Umoria:   Copyright (c) 1989 James E. Wilson
  9.  
  10.                        Angband 2.0 - 2.4 - 2.6.2 by:
  11.                    Alex Cutler, Andy Astrand, Sean Marsh,
  12.                  Geoff Hill, Charles Teague, Charles Swiger
  13.  
  14.                Angband 2.8.3:  Copyright (c) 1997 Ben Harrison
  15.  
  16.          Send comments, bug reports, and patches, to "benh@phial.com"
  17.         Visit the Angband Home Page at "http://www.phial.com/angband/"
  18.       Browse the Angband newsgroup at "news:rec.games.roguelike.angband"
  19.     Read the online help files, especially "general.txt" and "version.txt"
  20.    Angband is available for Unix, X11, DOS, Windows, Macintosh, Amiga, etc.
  21.  
  22.  
  23.  
  24. === General Info ===
  25.  
  26. This is the README file for Angband 2.8.3 (1998-02-09)
  27.  
  28. Angband is a "graphical" dungeon adventure game using textual characters
  29. to represent the walls and floors of a dungeon and the inhabitants therein,
  30. in the vein of "rogue", "hack", "nethack", and "moria".
  31.  
  32. There are some ascii "on line help" files in the "lib/help" directory.
  33.  
  34. Angband 2.8.3 is a stable official release incorporating all the changes
  35. and improvements added since the last official release (Angband 2.7.8).
  36.  
  37. See the Official Angband Home Page "http://www.phial.com/angband/" for
  38. a list (mostly complete) of what has changed in each recent version.
  39.  
  40. See the various Angband ftp sites (including "export.andrew.cmu.edu" and
  41. "ftp.cis.ksu.edu") for the latest files, patches, and executables.
  42.  
  43. Contact Ben Harrison ("benh@phial.com") to report any bugs or to make any
  44. suggestions.  Use the newsgroup "rec.games.roguelike.angband" to ask any
  45. general questions about the game, including compilation question.
  46.  
  47. This version of Angband will run on Macintosh, Windows, Unix (X11/Curses), 
  48. Linux (X11/Curses), Acorn, Amiga, various DOS machines, and many others...
  49.  
  50. See Makefile, h-config.h, and config.h for details on compiling.
  51. See "Makefile.xxx" and "main-xxx.c" for various supported systems.
  52.  
  53.  
  54. === Quick and dirty compilation instructions === 
  55.  
  56. For many platforms (including Macintosh and Windows), a "pre-compiled"
  57. archive is available, which contains everything you need to install and
  58. play Angband.  For other platforms, including most UNIX systems, you must
  59. compile the source code yourself.  Try the following non-trivial steps:
  60.  
  61. Step 1: Acquire.  Ftp to "export.andrew.cmu.edu:/angband/Source"
  62.                   Try "bin" and "mget angband*.tar.gz" and "y"
  63. Step 2: Extract.  Try "gunzip *.gz" then "tar -xvf *.tar"
  64. Step 3: Prepare.  Try "cd angband*/src", then edit "Makefile"
  65.                   You may also edit "h-config.h" and "config.h"
  66. Step 4: Compile.  Try "make", and then "cd .." if successful
  67. Step 5: Execute.  Try "angband -uTest" to initialize stuff
  68. Step 6: Play....  Read the "online help" via the "?" command.
  69.  
  70. Of course, if you have a compiler, you can compile a (possibly customized)
  71. executable on almost any system.  You will need the "source archive" (as
  72. above), which contains the standard "src" and "lib" directories, and for
  73. some platforms (including Macintosh and Windows), you will also need an
  74. appropriate "extra archive", which contains some extra platform specific
  75. files, and instructions about how to use them.  Some "extra archives" may
  76. be found at the ftp site (including "/angband/Macintosh/ext-mac.sit.bin"
  77. and "/angband/Windows/ext-win.zip"), but be sure that you get a version
  78. of the "extra archive" designed for Angband 2.8.2.
  79.  
  80.  
  81. === Special instructions for certain platforms ===
  82.  
  83. The Macintosh requires that the "lib" folder be in the same folder as
  84. the executable.  Also, note that System 7.5 (and perhaps others) are
  85. brain damaged, and may default to the incorrect folder for opening
  86. savefiles.  Make sure you keep all your savefiles in the proper place,
  87. and if you load a savefile from the wrong place, note that the game
  88. may decide to re-save your savefile in the proper place when you quit.
  89. If you move the "lib" folder (or any ancestor folder) while a game is
  90. in progress, you may not be able to save your game.  To use a savefile
  91. from another platform (or really old version of Angband) you must use
  92. the "Import..." menu command instead of the "Open..." menu command.
  93.  
  94. Some archive generation programs refuse to handle empty directories,
  95. so special "fake" files with names like "DELETEME.TXT" may have been
  96. placed into certain directories to avoid this problem.  You may safely
  97. delete these files if you so desire.
  98.  
  99.  
  100. === Upgrading from older versions (and/or other platforms) ===
  101.  
  102. If you have been using an older version of Angband (and/or playing on a
  103. different platform), you can "upgrade" (or "sidegrade") to Angband 2.8.X,
  104. bringing your old savefiles, high score list, and other files with you.
  105.  
  106. Angband 2.8.X uses a platform independant file format for the binary files
  107. that store information about games in progress, known as "savefiles", and
  108. is able to translate savefiles from all known versions of Angband.  To use
  109. an "old" savefile, simply copy it into the "lib/save" directory, changing
  110. the name of the savefile (if necessary) to satisfy the requirements of the
  111. platform you are using.  In general, the savefile should be named "UUU.NNN"
  112. or "NNN" where "UUU" is the userid of the player (on "multiuser" systems),
  113. and "NNN" is the name of the "character" in the savefile.  Note that only
  114. "multiuser" platforms use the "UUU.NNN" form, and the "dot" is required.
  115.  
  116. Angband 2.8.X uses a platform independant file format for the binary file
  117. used to store the high score list.  This file is named "scores.raw".  To
  118. use an "old" high score list, simply copy it into the "lib/apex" directory.
  119.  
  120. Angband 2.8.X uses a set of special ascii "configuration files" which are
  121. kept in the "lib/file" directory.  These files should not be modified (or
  122. imported from older versions) unless you know exactly what you are doing,
  123. but often you can use "old" versions of these files with little trouble.
  124.  
  125. Angband 2.8.X uses a set of ascii "user pref files" which are kept in the
  126. "lib/user" directory.  Most of these files can only be used on a small set
  127. of platforms, and may need slight modifications when imported from older
  128. versions.  Note that only some of these files are auto-loaded by the game.
  129.  
  130.  
  131. === Directory "src" ===
  132.  
  133. The "src" directory contains the complete set of "standard" source files.
  134.  
  135.  
  136. === Directory "lib" ===
  137.  
  138. The "lib" directory contains all of Angband's special sub-directories.
  139.  
  140.  
  141. === Directory "lib/apex" ===
  142.  
  143. The "lib/apex" directory contains the "high score" files.
  144.  
  145. The "scores.raw" file contains the "high score" table, in a "semi-binary" form,
  146. that is, all the bytes in the file are normal ascii values, but this includes
  147. the special "nul" or "zero" byte, which is used to separate and pad records.
  148. You should probably not attempt to modify this file with a normal text editor.
  149. This file should be (more or less) portable between different platforms.  It
  150. must be present (or creatable) for the game to run correctly.
  151.  
  152.  
  153. === Directory "lib/bone" ===
  154.  
  155. The "lib/bone" directory is currently unused.
  156.  
  157.  
  158. === Directory "lib/data" ===
  159.  
  160. The "lib/data" directory contains various special binary data files.
  161.  
  162. The files 'f_info.raw', 'k_info.raw', 'a_info.raw', 'e_info.raw', 'r_info.raw',
  163. and 'v_info.raw' are binary image files constructed by parsing the ascii
  164. template files in "lib/edit", described below.  These files are required,
  165. but can be created by the game if the "lib/edit" directory contains the
  166. proper files, and if the game was compiled to allow this creation.
  167.  
  168.  
  169. === Directory "lib/edit" ===
  170.  
  171. The "lib/edit" directory contains various special ascii data files.
  172.  
  173. The files 'f_info.txt', 'k_info.txt', 'a_info.txt', 'e_info.txt', 'r_info.txt',
  174. and 'v_info.txt' are ascii template files used to construct the binary image
  175. files in "lib/data", described above.  These files describe the "terrain
  176. features", "object kinds", "artifacts", "ego-items", "monster races", and
  177. "dungeon vaults", respectively.
  178.  
  179. The ascii template files are easier to edit than hard-coded arrays, and also
  180. prevent compilation errors on some machines, and also shrink the size of the
  181. binary executable, and also provide a user-readible spoiler file of sorts.
  182.  
  183. These files should not be modified unless you know exactly what you are doing.
  184.  
  185. These files are optional if the game is distributed with pre-created
  186. binary raw files in "lib/data".
  187.  
  188.  
  189. === Directory "lib/file" ===
  190.  
  191. The "lib/file" directory contains various special ascii data files.
  192.  
  193. The 'news.txt' file is displayed to the user when the game starts up.  It
  194. contains basic information such as my name and email address, and the names
  195. of some of the people who have been responsible for previous versions of
  196. Angband.  You may edit this file (slightly) to include local "site specific"
  197. information such as who compiled the local executable.  You should refer the
  198. user to a special "online help" file, if necessary, that describes any local
  199. modifications in detail.  The first two lines of this file should be blank,
  200. and only the next 20 lines should contain information.
  201.  
  202. The 'dead.txt' file is displayed to the user when the player dies.  It
  203. contains a picture of a tombstone which is filled in with interesting
  204. information about the dead player.  You should not edit this file.
  205.  
  206. The optional file 'wizards.txt' may be used to specify which users may enter
  207. 'wizard' mode.  A missing file provides no restrictions, and an empty file
  208. prevents everyone from entering 'wizard' mode.  This file is only used on
  209. multi-user machines, otherwise there are no restrictions.
  210.  
  211. The optional file 'time.txt' may be used to restrict the "times" at which
  212. the game may be played, by providing specification of which hours of each day
  213. of the week are legal for playing the game.  See 'files.c' for more details.
  214. A missing file provides no restrictions, and an empty file will, by default,
  215. forbid the playing of the game from 8am-5pm on weekdays.  This file is only
  216. used on multi-user machines, and only if CHECK_TIME is defined, otherwise,
  217. there are no restrictions.
  218.  
  219. The optional file 'load.txt' may be used to restrict the "load" which the game
  220. may impose on the system.  See 'files.c' for more details.  A missing file
  221. provides no restrictions, and an empty file will, by default, restrict the
  222. "current load" to a maximal value of 100*FSCALE.  This file is only used on
  223. multi-user machines, and only if CHECK_LOAD is defined, otherwise, there are
  224. no restrictions.
  225.  
  226. These files should not be modified unless you know exactly what you are doing.
  227.  
  228.  
  229. === Directory "lib/help" ===
  230.  
  231. The "lib/help" directory contains the "online help" files.
  232.  
  233. This directory is used to search for normal "online help" files.
  234.  
  235.  
  236. === Directory "lib/info" ===
  237.  
  238. The "lib/info" directory contains the "online spoiler" files.
  239.  
  240. This directory is used to search for any "online help" file that cannot
  241. be found in the "lib/help" directory.
  242.  
  243. This directory is empty by default.  Many people use this directory for
  244. "online spoiler files", many of which are available.
  245.  
  246. Note that the default "help.hlp" file allows the "9" key to access a help
  247. file called "spoiler.hlp", and allows the "0" key to access "user.hlp".
  248.  
  249. These special help files can thus be placed in the user's own "info"
  250. directory to allow the on line help to access his files.
  251.  
  252.  
  253. === Directory "lib/save" ===
  254.  
  255. The "lib/save" directory contains "savefiles" for the players.
  256.  
  257. Each savefile is named "NNN" where "NNN" is the name of the character, or,
  258. on some machines, the name of the character, or, on multi-user machines,
  259. "UUU.NNN", where "UUU" is the player uid and "NNN" is the character name.
  260.  
  261. The savefiles should be portable between systems, assuming that the
  262. appropriate renaming is perfomed.
  263.  
  264.  
  265. === Directory "lib/user" ===
  266.  
  267. The "lib/user" directory contains the "user pref files", if any.
  268.  
  269. In general, these files are used to "customize" aspects of the game for
  270. a given site or a given player.
  271.  
  272. See "src/files.c" for information on the proper "format" of these files.
  273.  
  274.  
  275. === Directory "lib/xtra" ===
  276.  
  277. The "lib/xtra" directory contains special system files, if any.
  278.  
  279.  
  280. --- Ben ---
  281.  
  282.