home *** CD-ROM | disk | FTP | other *** search
/ Mega Top 1 / os2_top1.zip / os2_top1 / APPS / SPEL / NH3130OS / README.OS2 < prev    next >
Text File  |  1993-07-28  |  12KB  |  265 lines
  1.                Installing NetHack 3.1.3 Binary for the OS/2
  2.                ============================================
  3.                       (last revision:  Jul 28, 1993)
  4.  
  5.  
  6. 0. What is NetHack
  7. ------------------
  8.  
  9. NetHack is a dungeons and dragons type of computer game, where the incentive
  10. is to retrieve the mythical artifact, The Amulet of Yendor, from the depths
  11. of the dungeon.  On the way the player will encounter and sometimes fight
  12. numerous inhabitants of the dungeon, stumble into traps, collect (sometimes
  13. magical) items to help his / her journey etc.  A map of the current dungeon
  14. level is displayed on the screen together with various statistics about the
  15. player's chosen role character.  For a more complete overview of NetHack see
  16. the game guidebook included in this package.
  17.  
  18.  
  19. 1. Unpacking the archive
  20. ------------------------
  21.  
  22. The NetHack binary and the auxiliary files required to run the game are
  23. contained in this archive, usually either NH313OS2.EXE or NH313OS2.ZIP.  The
  24. former archive format is a family mode self-extracting archive created by
  25. PKZIP version 1.02, and the latter a straight ZIP format by PKZIP 2.04.  It
  26. is also possible that some other archive format (ZOO, ARJ, LZH,...) was used
  27. depending on where you got this file.  Some archive sites may prefer other
  28. more compact packaging formats.  The following unpacking instructions assume
  29. one of the original formats.  Of course, if you have already unpacked the
  30. thing and are reading this file from the archive itself, they needn't concern
  31. you :-).
  32.  
  33. 1.1. The self extracting archive
  34. --------------------------------
  35.  
  36. The size of NH313OS2.EXE is 818946 bytes, which means that it does not fit on
  37. one 720 KB floppy disk.  It is assumed (hoped) that no such OS/2 system
  38. exists that would have a low density floppy drive as its only transferrable
  39. mass medium.  If problems arise with this, however, DOS and OS/2 BACKUP /
  40. RESTORE commands can be used to split the file on two low density floppies
  41. while transferring it across systems.
  42.  
  43. To unpack the archive, create the directory where you want the game to be
  44. installed and go to that directory.  Then type, e.g., "a:\nh313os2", if
  45. installing from a floppy disk in drive `a'.  If you feel suspicious about
  46. running self-extracting archives (especially in DOS), you can also unzip the
  47. archive manually by typing "pkunzip a:\nh313os2.exe".
  48.  
  49. Since NH313OS2.EXE is a family mode program, the installation procedure can
  50. be carried out either in DOS or OS/2.  However, the binary itself will run
  51. only in OS/2.
  52.  
  53. 1.2. The ZIP-archive
  54. --------------------
  55.  
  56. The size of NH313OS2.ZIP is 714198 bytes, which goes just below the 720 KB
  57. limit, but the downside is that PKZIP 2.0 isn't available for OS/2 yet.
  58. Furthermore, it cannot produce self extracting archives for OS/2.  There are
  59. compatible ZIP-utilities available which can be used to unpack the game,
  60. though, and it is naturally always possible to use DOS version of the
  61. product for the purpose.
  62.  
  63. 1.3. The archive contents
  64. -------------------------
  65.  
  66. The following files will be created in the game directory:
  67.  
  68.     file:           size:   synopsis:
  69.  
  70.     NETHACK.EXE    1111883  NetHack executable
  71.     NETHACK.CMD        115  command file for starting NetHack under PM/WPS
  72.     NETHACK.ICO        888  NetHack icon for PM/WPS
  73.     DUNGEON           1646  dungeon file
  74.     *.LEV           varies  special level files (88 files)
  75.     CMDHELP           4874  help file
  76.     HELP              8656      - " -
  77.     HH                4635      - " -
  78.     OPTHELP           6894      - " -
  79.     WIZHELP            323      - " -
  80.     HISTORY           5223  NetHack history file
  81.     LICENSE           5071  NetHack license
  82.     QUEST.DAT        80039  data file
  83.     ORACLES           6074      - " -
  84.     DATA             27628      - " -
  85.     RUMORS           40878      - " -
  86.     OPTIONS            722      - " -
  87.     NETHACK.CNF       5150  game configuration file
  88.     TERMCAP           5555  terminal configuration file
  89.     GUIDEBOO.TXT     75500  NetHack guidebook in ASCII format
  90.     GUIDEBOO.TEX     63543      - " -         in LaTeX format
  91.     RECOVER.EXE      10399  crash recovery utility
  92.     RECOVER.MAN       4575  documentation for the above in ASCII format
  93.     README.OS2       12102  this file
  94.  
  95. The entire distribution includes 111 files and requires approximately 1.8 MB
  96. of free disk space.
  97.  
  98.  
  99. 2. Playing the game
  100. -------------------
  101.  
  102. The following startup options are available for NetHack in OS/2:
  103.  
  104.     -d dir              switch to directory "dir" before starting the game
  105.     -n                  don't display NEWS file if one exists
  106.     -[ABCEHKPRSTVW]     set the player role according to the letter
  107.     -u name             set the player name to "name"
  108.     -X                  start the game in non-scoring explore mode
  109.     -D                  start the game in debug (wizard) mode (player name
  110.                         "wizard" must be supplied earlier on the command line
  111.                         or otherwise normal explore mode is started)
  112.     -r                  don't use RAM disk
  113.     -ibm                use IBM character graphics
  114.     -s                  print out the list of your scores (must be the first
  115.                         option specified)
  116.     -?                  print out help about startup options
  117.  
  118. When the game is played for the first time, one additional file, RECORD, is
  119. created for the game's scoring records.  If an old record file already
  120. exists, it will be used instead.
  121.  
  122. Old saved games (*.SAV) or bones files (BONES*.*) from previous versions of
  123. NetHack should be deleted, since they will not work with the newest version.
  124.  
  125. If an environment variable "TERM" is set, NetHack will search the TERMCAP
  126. file for a matching entry of appropriate ANSI terminal control sequences.
  127. Otherwise, preset defaults are used.  Note that ANSI must be set ON in the
  128. OS/2 session where NetHack is run.
  129.  
  130. You will have to edit NETHACK.CNF file to make it reflect your directory
  131. setup as well as your personal preferences regarding game options.  See
  132. the guidebook for more details.
  133.  
  134. If you'll be running NetHack from a different subdirectory, you may want to
  135. do "set HACKDIR=c:\games\nh31" (or whatever directory you want to use).  Add
  136. it to your config.sys, if you'll be playing often.  Alternatively you can set
  137. it in NETHACK.CNF.
  138.  
  139. You can also create a special NetHack entry in your Presentation Manager /
  140. Workplace Shell desktop.  This will use the included NetHack icon.  The
  141. following is a sample program description for OS/2 1.3 desktop, but it's
  142. similar in OS/2 2.0:
  143.  
  144.     Program title:          NetHack 3.1
  145.     Path and file name:     c:\games\nh31\nethack.cmd
  146.     Parameters:
  147.     Working directory:      c:\games\nh31
  148.     Program type:           OS/2 Full screen
  149.  
  150. Naturally you must fill in your own game directory and parameters if you want
  151. to set any.  The program type can be either OS/2 Full screen or OS/2
  152. Windowed.  Note that you should set the executable path to use the command
  153. file NETHACK.CMD.  This file generates an extra pause after the program exit,
  154. because otherwise you wouldn't get to see the high score list upon quitting
  155. due to PM/WPS automatically closing the program window.  When starting
  156. NetHack normally from OS/2 command prompt, the command processor starts
  157. NETHACK.EXE instead, so no extra pause is generated.
  158.  
  159. If file named NEWS exists in the game directory, it will be printed on screen
  160. upon startup.  This allows the game administrator to distribute game specific
  161. news and announcements to other players.  Although OS/2 is basically a single
  162. user system, this feature is supported in this binary.
  163.  
  164. Wizard mode password is "wizard" and the command sequence to enter it is thus
  165. "nethack -uwizard -D".  Note that wizard mode is really intended for
  166. debugging only, and using it gets boring fast.  Standard explore mode should
  167. be quite sufficient for all game practicing.
  168.  
  169.  
  170. 3. Recovering a crashed game
  171. ----------------------------
  172.  
  173. In case the game crashes due to segmentation faults or otherwise, an included
  174. game recovery utility RECOVER.EXE is available.  File RECOVER.MAN contains
  175. general information about this program.  Operation of RECOVER.EXE in this
  176. package differs from other systems in such a way that the base name for the
  177. level files is always LEVELS.  I.e., in order to recover a crashed game, go
  178. to the directory where the level files are and invoke the program by saying
  179. "recover levels".  A save file with your player name (e.g., JOE.SAV) should
  180. be created in that directory and the level files deleted in the process.
  181. Note that if you are using a ramdisk to store the levels during game, a power
  182. failure will wipe the game out permanently.  If you are afraid of that, don't
  183. define the RAMDISK parameter in NETHACK.CNF.  For the recovery to be possible
  184. the checkpoint option in NetHack must be on during game (it is by default
  185. unless explicitly turned off).
  186.  
  187.  
  188. 4. Information about this binary
  189. --------------------------------
  190.  
  191. For the technically oriented, some information about the binary:  This
  192. executable is a 16 bit OS/2 text mode window-compatible application, and it
  193. was created using Microsoft C 6.0A under IBM OS/2 1.3 Extended Edition.  It
  194. has also been tested under IBM OS/2 1.1 EE and OS/2 2.0 using FAT file
  195. system, but not under any other version.  However, it should run properly in
  196. all existing versions of OS/2 with either FAT or HPFS file system.  The
  197. reason why this executable format was chosen was to maximize portability
  198. across platforms.  Besides, NetHack is one of those programs that don't enjoy
  199. any real performance boost when compiled into a true 32 bit application in
  200. OS/2 2.x.
  201.  
  202. The following flags were used in the compile:
  203.  
  204.     /AL /O /Gs /G2 /Gt10 /Zp1 /FPi
  205.  
  206. and in linking:
  207.  
  208.     /stack:8192 /seg:1024
  209.  
  210. Refer to MSC documentation for explanations.  8087 emulation libraries were
  211. used (LLIBCEP.LIB), so the game will run with or without an 80x87 math
  212. coprocessor.  As mentioned above, the game is also window-compatible, which
  213. means that it will run in a text window under Presentation Manager /
  214. Workplace Shell.
  215.  
  216. The following game features were compiled in:
  217.  
  218.     POLYSELF, SOUNDS, SINKS, WALLIFIED_MAZE, REINCARNATION, KOPS, ARMY,
  219.     SEDUCE, WALKIES, TOURIST, TUTTI_FRUTTI, MUSE, MULDGN, ELBERETH,
  220.     EXPLORE_MODE, REDO, COM_COMPL, CLIPPING, EXP_ON_BOTL, SCORE_ON_BOTL,
  221.     WIZARD
  222.  
  223. i.e., everything.  The following system features were defined:
  224.  
  225.     NEWS, INSURANCE, VISION_TABLES, MFLOPPY, RANDOM, SHELL, TERMLIB,
  226.     ANSI_DEFAULT, TEXTCOLOR
  227.  
  228. To find out exactly what these all mean, you'll have to consult the NetHack
  229. source code.  Suffice it to say, they provide for the maximum functionality
  230. in most cases.
  231.  
  232.  
  233. 5. Release history
  234. ------------------
  235.  
  236.     Version:            Date:       File(s):        Comments:
  237.  
  238.     3.1.0 (initial)     Feb 2, 93   NHOS2310.EXE    PKZIP 1.02 self extract
  239.     3.1.1               Mar 15, 93  NHOS2311.EXE        - " -
  240.     3.1.2                                           Not publicly released
  241.     3.1.3 (current)     Jul 28, 93  NHOS2313.EXE    PKZIP 1.02 self extract
  242.                                     NHOS2313.ZIP    PKZIP 2.04
  243.  
  244.  
  245. 6. Additional information
  246. -------------------------
  247.  
  248. The full source code for NetHack 3.1.3 can be obtained via anonymous ftp from
  249. ftp.uu.net, gnu.ai.mit.edu, linc.cis.upenn.edu, and from several other
  250. archive sites.
  251.  
  252. NetHack 3.1.3 is free but copyrighted - see LICENSE file for details on what
  253. you may and may not do with this program.
  254.  
  255. Queries concerning this packaging in particular should be addressed to:
  256.  
  257.     thakulin@hadron.hut.fi              (Timo Hakulinen)
  258.  
  259. and the game in general to:
  260.  
  261.     nethack-bugs@linc.cis.upenn.edu     (NetHack development team)
  262.  
  263. Last but nor least:  When transferring the archive either via ftp, kermit or
  264. whatever file transfer utility, remember to use BINARY mode.
  265.