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