home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tads2os2.zip / READ.TAD < prev    next >
Text File  |  1996-10-15  |  7KB  |  168 lines
  1. TADS, the Text Adventure Development System version 2.2
  2. Copyright (c) 1990, 1996 by Michael J. Roberts.  All rights reserved.
  3.  
  4. This package was prepared October 14, 1996.
  5.  
  6. This software is being distributed as freeware.  You may use and redistribute
  7. it subject to the usual freeeware rules; see LICENSE.TAD for full details.
  8.  
  9.  
  10. Attention Version 1 Users!
  11. --------------------------
  12.  
  13. TADS Version 2 is intended to be compatible with games written for v1.
  14. However, there are a few differences.  If you experience any difficulty
  15. compiling a game that was working with v1, try using the "V1 Compatibility
  16. Mode" options.  You can enable full v1 compatibility mode by placing -1
  17. before your game name:
  18.  
  19.     tc -1 mygame
  20.  
  21. Most v1 games that have problems with v2 need only rename the new "do"
  22. keyword to run with v2; this can be done with these options:
  23.  
  24.     tc -1d _do_ mygame
  25.  
  26.  
  27. Documentation
  28. -------------
  29.  
  30. You should download the TADS Documentation archive, TADS2DOC.ZIP on PC's,
  31. or TADS2DOC.SIT on Macintosh.  This file contains overview documentation
  32. for TADS, as well as the source for "Ditch Day Drifter", a complete sample
  33. game.
  34.  
  35.  
  36. Getting Started
  37. ---------------
  38.  
  39. To get started on the system, install the executables in a directory on your
  40. path, and install the source files (*.T) wherever you please.  Compile "Ditch
  41. Day Drifter" by typing:
  42.  
  43.      tc ditch
  44.  
  45. Be sure that ADV.T is in your current directory.
  46.  
  47. Note that DITCH.T is part of the separate TADS Documentation archive;
  48. you should be able to get this archive from the same place you got the
  49. archive containing the TADS executables.
  50.  
  51. After you have compiled Ditch, run the game by typing:
  52.  
  53.      tr ditch
  54.  
  55. Please read DITCH.DOC for information on playing the game.  This file also
  56. describes many features of the run-time system, including the parser.
  57.  
  58.  
  59. Notes for DOS users
  60. -------------------
  61.  
  62. On PC's, you may edit command lines with the arrow keys and other standard
  63. editing keys.  Review Mode (described in DEEP.DOC) is activated with
  64. function key F1.
  65.  
  66. Saved games are stored in standard DOS files, by default in the current
  67. directory (the directory from which you start the game), so make sure
  68. you have free disk space before you begin playing.
  69.  
  70. If you have limited memory in your PC, you may need to adjust the
  71. compiler's memory usage so it fits.  If the compiler runs out of
  72. memory, it will tell you the amount of memory it is consuming and
  73. suggest that you run again with a lower -m option.  For example,
  74. if the compiler displays a message like this:
  75.  
  76.    *** Note for -m option:
  77.    *** Current cache size is 256000
  78.    ditch.t, line 3501: TADS-1: out of memory
  79.  
  80. you can run again by specifying a smaller size with the -m option:
  81.  
  82.    tc -m 200000 ditch
  83.  
  84. This tells the compiler to restrict its memory usage to 200,000 bytes,
  85. which it does by swapping excess space out to a disk file.  If the
  86. compiler is forced to swap, you can speed it up considerably by moving
  87. the swap file to a RAM disk in extended or expanded memory.  If your
  88. RAM disk is drive D, you can tell TADS to place the swap file on
  89. your RAM disk using the -tf option:
  90.  
  91.    tc -m 200000 -tf d:swap.dat ditch
  92.  
  93.  
  94. DOS Protected-Mode TADS
  95. -----------------------
  96.  
  97. The compiler, runtime, and debugger are available as DOS
  98. protected-mode commands.  The protected-mode versions are only
  99. capable of running on 80286 or newer processors -- they will not work
  100. on XT-type machines (which use 8086 processors).  The protected-mode
  101. versions can access up to 16 megabytes of memory, so they will allow
  102. much larger games; because they will not do as much swapping as the
  103. normal DOS versions, the protected- mode commands are usually much
  104. faster than the normal DOS versions with large games.
  105.  
  106. The protected-mode versions of the executables have the same names as
  107. the normal DOS versions plus an "X":
  108.  
  109.     Component     Normal DOS     Protected-mode
  110.                    Command          Command
  111.     ---------     ----------     --------------
  112.     compiler         tc               tcx
  113.     runtime          tr               trx
  114.     debugger         tdb              tdbx
  115.  
  116. The protected-mode commands work the same as their real-mode
  117. counterparts, and all command line options and arguments are the same
  118. for both versions.
  119.  
  120. The protected-mode commands use the Borland DOS extender software.
  121. This software is copyrighted by Borland and cannot be distributed
  122. except with Borland's permission.  The Borland license allows
  123. redistribution of the DOS extender with software created with a
  124. properly licensed copy of the Borland tools, which allows us to
  125. include the DOS extender software with TADS.  The files making up the
  126. Borland DOS extender are:
  127.  
  128.     dpmi16bi.ovl
  129.     rtm.exe
  130.  
  131. Before running any of the protected-mode commands, you must have
  132. these files in a directory on your DOS PATH.
  133.  
  134. The Borland DOS extender is compatible with most computers based on
  135. 286, 386, 486, or Pentium processors, and works properly with most
  136. memory managers (such as QEMM and EMM386), and with Microsoft Windows
  137. DOS windows when running in 386 Enhanced mode.  By its nature,
  138. though, the DOS extender software is sensitive to the specific
  139. hardware and software configuration of your computer, and may not
  140. work with certain computers, peripherals, or resident software.  If
  141. you experience any problems with the protected-mode versions, try
  142. removing any drivers, TSR's, and other resident software from your
  143. configuration.  Since the DOS extender is developed and maintained by
  144. Borland, not High Energy Software, we will not be able to correct any
  145. incompatibilities or other problems that are caused by the DOS
  146. extender itself.
  147.  
  148. To reduce the size of this archive file, only the normal DOS versions
  149. of the TADS commands are included in the distribution.  You do not
  150. need any additional software to run the normal DOS versions of the
  151. commands, and these versions will run on any IBM or 100% compatible
  152. DOS PC.
  153.  
  154.  
  155. ABOUT HIGH ENERGY SOFTWARE
  156. --------------------------
  157.  
  158. High Energy Software formerly distributed TADS as a shareware system,
  159. but is no longer in business.  Mike Roberts, the developer of TADS,
  160. is now maintaining and distributing the system as freeware.  We have
  161. made an effort to remove references from these files to High Energy
  162. Software and its former telephone and other contact information,
  163. since all of those numbers and addresses are no longer in service.
  164. If we inadvertantly left any such references intact, please disregard
  165. them, since they're oversights.
  166.  
  167.  
  168.