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