home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Spiele Shareware / os2games.iso / os2games / advent / nethack / readme.os2 < prev    next >
Encoding:
Text File  |  1993-02-02  |  9.8 KB  |  218 lines
  1.                Installing NetHack 3.1.0 Binary for the OS/2
  2.                ============================================
  3.                       (last revision:  Feb 2, 1993)
  4.  
  5. 1. Unpacking the archive
  6. ------------------------
  7.  
  8. The NetHack binary and the auxiliary files required to run the game are
  9. contained in this archive, NH310OS2.EXE.  The original format of this archive
  10. is a family mode self-extracting archive created by PKZIP version 1.02, but
  11. it is possible that some other archive format (ZIP, ZOO, ARJ, LZH, ...) was
  12. used depending on where you got this file.  The following unpacking
  13. instructions assume the original format.  Of course, if you have already
  14. unpacked the thing and are reading this file from the archive itself, they
  15. needn't concern you :-)
  16.  
  17. The size of NH310OS2.EXE is 799639 bytes, which means that it does not fit on
  18. one 720 KB floppy disk.  It is assumed (hoped) that no such OS/2 system
  19. exists that would have a low density floppy drive as its only transferrable
  20. mass medium.  If problems arise with this, however, DOS and OS/2 BACKUP /
  21. RESTORE commands can be used to split the file on two low density floppies
  22. while transferring it across systems.
  23.  
  24. To unpack the archive, create the directory where you want the game to be
  25. installed and go to that directory.  Then type, e.g., "a:\nh310os2", if
  26. installing from a floppy disk in drive `a'.  If you feel suspicious about
  27. running self-extracting archives (especially in DOS), you can also unzip the
  28. archive manually by typing "pkunzip a:\nh310os2.exe".
  29.  
  30. The following files will be created in the game directory:
  31.  
  32.     file:           size:   synopsis:
  33.  
  34.     NETHACK.EXE    1083671  NetHack executable
  35.     NETHACK.CMD        115  command file for starting NetHack under PM/WPS
  36.     NETHACK.ICO        888  NetHack icon for PM/WPS
  37.     DUNGEON           1646  dungeon file
  38.     *.LEV           varies  special level files (88 files)
  39.     CMDHELP           4752  help file
  40.     HELP              8627      - " -
  41.     HH                4588      - " -
  42.     OPTHELP           6713      - " -
  43.     WIZHELP            323      - " -
  44.     HISTORY           5056  NetHack history file
  45.     LICENSE           5071  NetHack license
  46.     QUEST.DAT        78632  data file
  47.     ORACLES           6316      - " -
  48.     DATA             26925      - " -
  49.     RUMORS           41189      - " -
  50.     OPTIONS            674      - " -
  51.     NETHACK.CNF       4678  game configuration file
  52.     TERMCAP           5555  terminal configuration file
  53.     GUIDEBOO.TXT     73433  NetHack guidebook in ASCII format
  54.     GUIDEBOO.TEX     61996      - " -         in LaTeX format
  55.     RECOVER.EXE      10399  crash recovery utility
  56.     RECOVER.MAN       4575  documentation for the above in ASCII format
  57.     README.OS2       10014  this file
  58.  
  59. The entire distribution includes 111 files and requires approximately 1.7 MB
  60. of free disk space.
  61.  
  62. Since NH310OS2.EXE is a family mode program, the installation procedure can
  63. be carried out either in DOS or OS/2.  However, the binary itself will run
  64. only in OS/2.
  65.  
  66.  
  67. 2. Playing the game
  68. -------------------
  69.  
  70. The following startup options are available for NetHack in OS/2:
  71.  
  72.     -d dir              switch to directory "dir" before starting the game
  73.     -n                  don't display NEWS file if one exists
  74.     -[ABCEHKPRSTVW]     set the player role according to the letter
  75.     -u name             set the player name to "name"
  76.     -X                  start the game in non-scoring explore mode
  77.     -D                  start the game in debug (wizard) mode (player name
  78.                         "wizard" must be supplied earlier on the command line
  79.                         or otherwise normal explore mode is started)
  80.     -r                  don't use RAM disk
  81.     -ibm                use IBM character graphics
  82.     -s                  print out the list of your scores (must be the first
  83.                         option specified)
  84.     -?                  print out help about startup options
  85.  
  86. When the game is played for the first time, one additional file, RECORD, is
  87. created for the game's scoring records.  If an old record file already
  88. exists, it will be used instead.
  89.  
  90. Old saved games (*.SAV) or bones files (BONES*.*) from previous versions of
  91. NetHack should be deleted, since they will not work with the newest version.
  92.  
  93. If an environment variable "TERM" is set, NetHack will search the TERMCAP
  94. file for a matching entry of appropriate ANSI terminal control sequences.
  95. Otherwise, preset defaults are used.  Note that ANSI must be set ON in the
  96. OS/2 session where NetHack is run.
  97.  
  98. You will have to edit NETHACK.CNF file to make it reflect your directory
  99. setup as well as your personal preferences regarding game options.  See
  100. the guidebook for more details.
  101.  
  102. If you'll be running NetHack from a different subdirectory, you may want to
  103. do "set HACKDIR=c:\games\nh31" (or whatever directory you want to use).  Add
  104. it to your config.sys, if you'll be playing often.  Alternatively you can set
  105. it in NETHACK.CNF.
  106.  
  107. You can also create a special NetHack entry in your Presentation Manager /
  108. Workplace Shell desktop.  This will use the included NetHack icon.  The
  109. following is a sample program description for OS/2 1.3 desktop, but it's
  110. very similar in OS/2 2.0:
  111.  
  112.     Program title:          NetHack 3.1
  113.     Path and file name:     c:\games\nh31\nethack.cmd
  114.     Parameters:
  115.     Working directory:      c:\games\nh31
  116.     Program type:           OS/2 Full screen
  117.  
  118. Naturally you must fill in your own game directory and parameters if you want
  119. to set any.  The program type can be either OS/2 Full screen or OS/2
  120. Windowed.  Note that you should set the executable path to use the command
  121. file NETHACK.CMD.  This file generates an extra pause after the program exit,
  122. because otherwise you wouldn't get to see the high score list upon quitting
  123. due to PM/WPS automatically closing the program window.  When starting
  124. NetHack normally from OS/2 command prompt, the command processor starts
  125. NETHACK.EXE instead, so no extra pause is generated.
  126.  
  127. If file named NEWS exists in the game directory, it will be printed on screen
  128. upon startup.  This allows the game administrator to distribute game specific
  129. news and announcements to other players.  Although OS/2 is basically a single
  130. user system, this feature is supported in this binary.
  131.  
  132. Wizard mode password is "wizard" and the command sequence to enter it is thus
  133. "nethack -uwizard -D".  Note that wizard mode is really intended for
  134. debugging only, and using it gets boring fast.  Standard explore mode should
  135. be quite sufficient for all game practicing.
  136.  
  137. In case of game crashes due to segmentation faults or otherwise, the bundled
  138. game recovery utility RECOVER.EXE is available.  See RECOVER.MAN for details.
  139.  
  140.  
  141. 3. Information about this binary
  142. --------------------------------
  143.  
  144. For the technically oriented, some information about the binary:  This
  145. executable is a 16 bit OS/2 text mode window-compatible application, and it
  146. was created using Microsoft C 6.0A under IBM OS/2 1.3 Extended Edition.  It
  147. has also been tested under IBM OS/2 1.1 EE and OS/2 2.0 using FAT file
  148. system, but not under any other version.  However, it should run properly in
  149. all existing versions of OS/2 with either FAT or HPFS file system.  The
  150. reason why this executable format was chosen was to maximize portability
  151. across platforms.  Besides, NetHack is one of those programs that don't enjoy
  152. any real performance boost when compiled into a true 32 bit application in
  153. OS/2 2.0.
  154.  
  155. The following flags were used in the compile:
  156.  
  157.     /AL /O /Gs /G2 /Gt10 /Zp1 /FPi
  158.  
  159. and in the linking:
  160.  
  161.     /stack:8192 /seg:1024
  162.  
  163. Refer to MSC documentation for explanations.  8087 emulation libraries were
  164. used (LLIBCEP.LIB), so the game will run with or without a 80x87 math
  165. coprocessor.  As mentioned above, the game is also window-compatible, which
  166. means that it will run in a text window under Presentation Manager /
  167. Workplace Shell.
  168.  
  169. The following game features were compiled in:
  170.  
  171.     POLYSELF, SOUNDS, SINKS, WALLIFIED_MAZE, REINCARNATION, KOPS, ARMY,
  172.     SEDUCE, WALKIES, TOURIST, TUTTI_FRUTTI, MUSE, MULDGN, ELBERETH,
  173.     EXPLORE_MODE, REDO, COM_COMPL, CLIPPING, EXP_ON_BOTL, SCORE_ON_BOTL,
  174.     WIZARD
  175.  
  176. i.e., everything.  The following system features were defined:
  177.  
  178.     NEWS, INSURANCE, VISION_TABLES, MFLOPPY, RANDOM, SHELL, TERMLIB,
  179.     ANSI_DEFAULT, TEXTCOLOR
  180.  
  181. To find out exactly what these all mean, you'll have to consult the NetHack
  182. source code.  Suffice it to say, they provide for the maximum functionality
  183. in most cases.
  184.  
  185. A few critical post-release bugfixes have been applied:
  186.  
  187.     - Polymorphing into a very small creature (like killer bee) produced a
  188.       segmentation fault.
  189.     - Trying to drop all items (by answering 'a' to the prompt) when carrying
  190.       only gold produced a segmentation fault.
  191.     - Kicking a monster while levitating produced a segmentation fault.
  192.     - Throwing Mjollnir at a wall produced a segmentation fault.
  193.  
  194. Any remaining bugs should be considered features of the initial release.  The
  195. above fixes are naturally also included in the next release of NetHack 3.1.
  196.  
  197.  
  198. 4. Additional information
  199. -------------------------
  200.  
  201. The full source code for NetHack 3.1.0 can be obtained via anonymous ftp from
  202. ftp.uu.net, gnu.ai.mit.edu, linc.cis.upenn.edu, and from several other
  203. archive sites.
  204.  
  205. NetHack 3.1.0 is free but copyrighted - see LICENSE file for details on what
  206. you may and may not do with this program.
  207.  
  208. Queries concerning this packaging in particular should be addressed to:
  209.  
  210.     thakulin@hila.hut.fi                (Timo Hakulinen)
  211.  
  212. and the game in general to:
  213.  
  214.     nethack-bugs@linc.cis.upenn.edu     (NetHack development team)
  215.  
  216. Last but nor least:  When transferring NH310OS2.EXE either via ftp, kermit or
  217. whatever file transfer utility, remember to use BINARY mode.
  218.