home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 4 / AUCD4.iso / arcade / adventures / sangband / !Sangband / !ReadMe < prev    next >
Text File  |  1997-10-11  |  9KB  |  218 lines
  1. This is the README file for SAngband 0.9.4 (09/24/97)
  2.  
  3. SAngband 0.9.4 is based on Angband 2.8.0 and includes most of the features
  4. from SAngband 0.8.x versions.
  5.  
  6. It also includes changes made in Angband 2.8.1.  This version is
  7. semi-experimental; it is not particularly well-tested (or
  8. well-balanced) and contains some bugs.  Read the file "changes.txt"
  9. for information on changes from earlier versions.
  10.  
  11. Read lib/help/birth.txt for information on skills and talents,
  12. and lib/help/command.txt for information on the new commands.
  13.  
  14. If you've played previous versions, be aware that ']' is now the
  15. command to stop using a shapeshifting spell, and that fenneling works
  16. noticeably differently.
  17.  
  18. === General information ===
  19.  
  20. SAngband is a "graphical" dungeon adventure game using textual characters
  21. to represent the walls and floors of a dungeon and the inhabitants therein,
  22. in the vein of "rogue", "hack", "nethack", and "moria".  There are no
  23. character "classes" in SAngband; characters become more powerful by using
  24. experience to advance "skills."
  25.  
  26. There are extensive ascii "on line help" files in the "lib/help" directory.
  27.  
  28. This version of SAngband *should* run on Macintosh, Windows, Unix
  29. (X11/Curses), Linux (X11/Curses), Acorn, Amiga, various IBM machines, and
  30. others.  However, I've only tested it on Linux with Curses, but I haven't
  31. messed with anything system-specific.
  32.  
  33. See Makefile, h-config.h, and config.h for details on compiling.
  34. See "Makefile.xxx" and "main-xxx.c" for various supported systems.
  35.  
  36. Visit the SAngband Home Page ("http://www.fragment.com/~jl8e/sangband"),
  37. the Angband Home Page ("http://www.voicenet.com/~benh/Angband/"), and 
  38. browse through the Angband newsgroup ("rec.games.roguelike.angband").
  39.  
  40. Send bug reports, suggestions, etc, to Julian Lighton ("jl8e@fragment.com").
  41. I would really like to hear suggestions on adjusting the game balance.
  42.  
  43. === Quick and dirty compilation instructions (for Unix) === 
  44.  
  45. Step 1: Acquire.  Ftp to "export.andrew.cmu.edu:/angband/Variant"
  46.                   Try "bin" and "mget sangband*.tar.gz" and "y"
  47. Step 2: Extract.  Try "gunzip *.gz" then "tar -xvf *.tar"
  48. Step 3: Prepare.  Try "cd sangband*/src", then edit "Makefile"
  49.                   You may also edit "h-config.h" and "config.h"
  50. Step 4: Compile.  Try "make", and then "cd .." if successful
  51. Step 5: Execute.  Try "sangband -uTest" to initialize stuff
  52. Step 6: Play....  Read the "online help" via the "?" command.
  53.  
  54.  
  55. === Special instructions for other systems ===
  56.  
  57. The Macintosh requires that the "lib" folder be in the same folder as
  58. the executable.  Also, note that System 7.5 (and perhaps others) are
  59. brain damaged, and may default to the incorrect folder for opening
  60. savefiles.  Make sure you keep all your savefiles in the proper place,
  61. and if you load a savefile from the wrong place, note that the game
  62. may decide to re-save your savefile in the proper place when you quit.
  63. === Directory "src" ===
  64.  
  65. The "src" directory contains the complete set of source files.
  66.  
  67. The "main-???.c" and "Makefile.???" allow compilation on various systems.
  68.  
  69. Some of these systems (Macintosh, Windows) require "extra" files, most of
  70. which are located elsewhere (except for the "A-mac-h.*" Macintosh files).
  71.  
  72.  
  73. === Directory "lib" ===
  74.  
  75. The "lib" directory contains all of Angband's special sub-directories.
  76.  
  77.  
  78. === Directory "lib/apex" ===
  79.  
  80. The "lib/apex" directory contains the "high score" files.
  81.  
  82. The "scores.raw" file contains the "high score" table, in a "semi-binary"
  83. form,
  84. that is, all the bytes in the file are normal ascii values, but this includes
  85. the special "nul" or "zero" byte, which is used to separate and pad records.
  86. You should probably not attempt to modify this file with a normal text
  87. editor.
  88. This file should be (more or less) portable between different platforms.  It
  89. must be present (or creatable) for the game to run correctly.
  90.  
  91.  
  92. === Directory "lib/data" ===
  93.  
  94. The "lib/data" directory contains various special binary data files.
  95.  
  96. The files 'f_info.raw', 'k_info.raw', 'a_info.raw', 'e_info.raw',
  97. 'r_info.raw',
  98. and 'v_info.raw' are binary image files constructed by parsing the ascii
  99. template files in "lib/edit", described below.  These files are required,
  100. but can be created by the game if the "lib/edit" directory contains the
  101. proper files, and if the game was compiled to allow this creation.
  102.  
  103.  
  104. === Directory "lib/edit" ===
  105.  
  106. The "lib/edit" directory contains various special ascii data files.
  107.  
  108. The files 'f_info.txt', 'k_info.txt', 'a_info.txt', 'e_info.txt',
  109. 'r_info.txt',
  110. and 'v_info.txt' are ascii template files used to construct the binary image
  111. files in "lib/data", described above.  These files describe the "terrain
  112. features", "object kinds", "artifacts", "ego-items", "monster races", and
  113. "dungeon vaults", respectively.
  114.  
  115. The ascii template files are easier to edit than hard-coded arrays, and also
  116. prevent compilation errors on some machines, and also shrink the size of the
  117. binary executable, and also provide a user-readible spoiler file of sorts.
  118.  
  119. These files are optional if the game is distributed with pre-created
  120. binary raw files in "lib/data".
  121.  
  122.  
  123. === Directory "lib/file" ===
  124.  
  125. The "lib/file" directory contains various special ascii data files.
  126.  
  127. The 'news.txt' file is displayed to the user when the game starts up.  It
  128. contains basic information such as my name and email address, and the names
  129. of some of the people who have been responsible for previous versions of
  130. Angband.  You may edit this file (slightly) to include local "site specific"
  131. information such as who compiled the local executable.  You should refer the
  132. user to a special "online help" file, if necessary, that describes any local
  133. modifications in detail.  The first two lines of this file should be blank,
  134. and only the next 20 lines should contain information.
  135.  
  136. The 'dead.txt' file is displayed to the user when the player dies.  It
  137. contains a picture of a tombstone which is filled in with interesting
  138. information about the dead player.  You should not edit this file.
  139.  
  140. The optional file 'wizards.txt' may be used to specify which users may enter
  141. 'wizard' mode.  A missing file provides no restrictions, and an empty file
  142. prevents everyone from entering 'wizard' mode.  This file is only used on
  143. multi-user machines, otherwise there are no restrictions.
  144.  
  145. The optional file 'time.txt' may be used to restrict the "times" at which
  146. the game may be played, by providing specification of which hours of each day
  147. of the week are legal for playing the game.  See 'files.c' for more details.
  148. A missing file provides no restrictions, and an empty file will, by default,
  149. forbid the playing of the game from 8am-5pm on weekdays.  This file is only
  150. used on multi-user machines, and only if CHECK_TIME is defined, otherwise,
  151. there are no restrictions.
  152.  
  153. The optional file 'load.txt' may be used to restrict the "load" which
  154. the game may impose on the system.  See 'files.c' for more details.  A
  155. missing file provides no restrictions, and an empty file will, by
  156. default, restrict the "current load" to a maximal value of 100*FSCALE.
  157. This file is only used on multi-user machines, and only if CHECK_LOAD
  158. is defined, otherwise, there are no restrictions.
  159.  
  160.  
  161. === Directory "lib/help" ===
  162.  
  163. The "lib/help" directory contains the "online help" files.
  164.  
  165. This directory is used to search for normal "on line help" files.
  166.  
  167.  
  168. === Directory "lib/info" ===
  169.  
  170. The "lib/info" directory (optional) contains the "spoiler" files.
  171.  
  172. This directory is used to search for any "on line help" file that cannot
  173. be found in the "lib/help" directory.
  174.  
  175. The user may "redirect" this directory to point at any available directory.
  176.  
  177. Note that the default "help.hlp" file allows the "9" key to access a help
  178. file called "spoiler.hlp", and allows the "0" key to access "user.hlp".
  179.  
  180. These special help files can thus be placed in the user's own "info"
  181. directory to allow the on line help to access his files.
  182.  
  183.  
  184. === Directory "lib/save" ===
  185.  
  186. The "lib/save" directory contains "savefiles" for the players.
  187.  
  188. Each savefile is named "NNN" where "NNN" is the name of the savefile, or,
  189. on some machines, the name of the character, or, on multi-user machines,
  190. "UUU.NNN", where "UUU" is the player uid and "NNN" is the savefile name.
  191.  
  192. The savefiles should be portable between systems, assuming that the
  193. appropriate renaming is perfomed, and any file "type" information is
  194. specified (for the Macintosh).
  195.  
  196.  
  197. === Directory "lib/user" ===
  198.  
  199. The "lib/user" directory contains the "user pref files", if any.
  200.  
  201. In general, these files are used to "customize" aspects of the game for
  202. a given site or a given player.  These files can define "macros" (which
  203. allow a single keypress to perform a complex action), set options (which
  204. affect how the game will handle various situations), and specify visual
  205. mappings for various monsters, objects, or terrain features.
  206.  
  207. See "files.c" for more information on the proper "format" of these files.
  208.  
  209.  
  210. === Directory "lib/xtra" ===
  211.  
  212. The "lib/xtra" directory contains special system files, if any.
  213.  
  214.  
  215. --- Julian Lighton ---
  216.  
  217. (original by Ben Harrison)
  218.