home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / EXCAL09D.ZIP / README.DOC < prev    next >
Text File  |  1994-12-05  |  17KB  |  368 lines
  1. WELCOME TO EasySoft's EXCALIBER v0.9c!
  2.  
  3. This program is distributed "as-is" with no guarantee or warranty of any
  4. kind.  Please copy and distribute this version freely.  You must,
  5. however, keep all of the files with the program files in tact.
  6. (Including this file.)  This file or any other files may not be modified
  7. in anyway without the express written permission of EasySoft.
  8.  
  9. This is a beta shareware release version of Excaliber.  It has been
  10. initially tested on a Wildcat 3.9M system and found to operate well.  If
  11. you do find bugs or problems with the program, please notify me using
  12. the form at the end of this document.  I am also interested in adapting
  13. Excaliber to work with other BBS packages that don't support door.sys,
  14. so send all modification requests using the bug form.
  15.  
  16. EXCALIBER DESCRIPTION:
  17.  
  18. Excaliber is a multi-player door game designed to be run on Wildcat 3.x
  19. bulletin board systems.  It can, however, be run on any BBS that
  20. supports the DOOR.SYS standard for running external programs (doors)
  21. from your system.
  22.  
  23. Excaliber is won by a player successfully retrieving Excaliber from
  24. the stone that holds it.  The game is locked at this point and must
  25. be restarted.  Excaliber will inform any players that attempt to log
  26. on that the game has been solved and that they should notify the SysOp
  27. that it needs to be restarted.  The file hall.log will now hold the user's
  28. name that solved it for players to read during later games.  This file
  29. can only be reset from within the [U]tilities section of the setup 
  30. utility.
  31.  
  32. SETTING UP EXCALIBER:
  33.  
  34. It is relatively easy to set up.  I have included a sample batch file for
  35. Wildcat that is to be run from the \wcwork\nodeX (X being the node which
  36. the program will be run from.  Multiple nodes are supported.) work
  37. directory.  Run from this directory, it is acceptable for multi-node
  38. systems.  If you are only running one node, you can run this batch file
  39. from Wildcat's root directory with a .bat extension.  The file name is
  40. door#.bat (for single node) or door#.run (for multiple nodes) and the #
  41. must always indicate which door program it is in your menu system.  Its
  42. contents are explained in detail here:  (Note:  I have run Excaliber in
  43. this example using the Doorway.  Any similar program that directs
  44. screen output may be used.  I highly recommend Doorway.)
  45.  
  46. BATCH FILE DESCRIPTION:
  47.  
  48. copy c:\wc30\wcwork\node1\door.sys c:\excal
  49. │
  50. └────This line simply copies the door.sys for the player from the work
  51.      directory to Excaliber's directory.  Adjust accordingly depending
  52.      on your system configuration.
  53.  
  54. c:\wc30\doorway sys /*:X^M /b:mz /v:d /cd /p:c:\excal\excal.exe
  55. │               │   │      │     │    │   │
  56. │               │   │      │     │    │   └────This is where the
  57. │               │   │      │     │    │        Excaliber program files
  58. │               │   │      │     │    │        can be found.
  59. │               │   │      │     │    │
  60. │               │   │      │     │    └────This forces the your computer
  61. │               │   │      │     │         to change directory into
  62. │               │   │      │     │         Excaliber's root directory.
  63. │               │   │      │     │         This is required for the
  64. │               │   │      │     │         reading of data files.
  65. │               │   │      │     │
  66. │               │   │      │     └────This causes doorway to do direct
  67. │               │   │      │          screen writes.  This is required
  68. │               │   │      │          by Turbo BASIC.
  69. │               │   │      │
  70. │               │   │      └────This forbids doorway from writing to the
  71. │               │   │           25th line.
  72. │               │   │
  73. │               │   └────This tells doorway to use this string if the
  74. │               │        user hangs up on the door game while on line.
  75. │               │        Excaliber will recognize this as the user having
  76. │               │        hung up and automatically save statistics
  77. │               │        before releasing control back to the BBS.
  78. │               │
  79. │               └────Tells doorway that door.sys file is utilized.
  80. │
  81. └────Path where doorway.exe can be found.
  82.  
  83. del c:\excal\door.sys
  84. │
  85. └────This line cleans up after Excaliber by deleting door.sys from
  86.      Excaliber's root directory.
  87.  
  88. This batch file will let you safely use Excaliber in your BBS
  89. environment.
  90.  
  91. INSTALLING EXCALIBER:
  92.  
  93. Unzip the excal.zip file.  The following files will break out of the
  94. .zip file:
  95.  
  96. Filename:       Description:
  97.  
  98. excal.exe       Main excaliber program file.
  99. setup.exe       Setup program.  Includes edit user utilities.
  100. maint.exe       Daily maintenance file.  Run nightly.
  101. excal.hlp       Excaliber internal help file.
  102. main.mnu        Excaliber main menu.
  103. hall.log        Hall of honor.
  104. readme.doc      This document.
  105. door1.run       Sample batch file.
  106. maint.bat       Sample batch file for maintenance program.
  107. excal-x.ans     Various ANSI files.
  108.  
  109.  
  110. After unzipping all of the files, placing Excaliber in its own directory
  111. and modifying the door#.xxx file for you system - run setup.exe.  Select
  112. the menu option [S]etup/Restart Excaliber.  All system files will be
  113. started.  Note:  Additional files will be created in your directory.
  114. You can now run Excaliber from your BBS environment.  (Note:
  115. Excaliber will record a file not found error if attempted to be run
  116. without a door.sys present.  If you feel the need to test Excaliber
  117. outside of your BBS environment, use a text editor to create a temporary
  118. door.sys.  You need only enter enough lines to get to the user's real
  119. name as this is the ONLY variable that Excaliber uses from door.sys.)
  120.  
  121. For help with the game, view the help file from within Excaliber.
  122.  
  123. MULTI-NODE USE:
  124.  
  125. While Excaliber will not accept multiple players at one time it does
  126. recognize when another player from a different node is attempting to
  127. enter Excaliber and informs them that the game is already in use by
  128. another node and for them to try back later.  In this sense, Excaliber
  129. is multi-node aware.
  130.  
  131. NOTE:  For Novel users, Excaliber must be placed in a common directory
  132. for this feature to work.  In other words, Excaliber cannot be placed on
  133. the C:\ drives of each workstation, but rather on a network drive of
  134. which all workstations can access at the same time.
  135.  
  136. EXCALIBER MAINTENANCE FEATURE:
  137.  
  138. Excaliber includes a built-in maintenance feature.  Just set up the
  139. program maint.exe to be run nightly in your BBS maintenance run.  This
  140. program updates turns and gives interest to all bank accounts.
  141.  
  142. I have included a sample batch file for this to be setup in Wildcat's
  143. Event Management feature.  This batch file utilizes Doorway for screen
  144. output.
  145.  
  146. EXCALIBER SETUP/UTILITY PROGRAM:
  147.  
  148. The setup program is where you, the SysOp, can adjust various features
  149. of the game.  I will briefly explain each menu option here.
  150.  
  151. [S]etup/Restart Excaliber:  Use this when initially setting up or when 
  152. restarting Excaliber.
  153.  
  154. [U]tilties:  Use to edit players statistics and restart Hall of Fame.
  155.  
  156. [M]aintenance Log View/Reset:  Allows to view the Maintenance log and
  157. then reset if so desired.
  158.  
  159. [E]rror Log View/Reset:  Same as above.
  160.  
  161. [P]layer Log View/Reset:  Same as above.
  162.  
  163. [R]eset Game Lock Feature:  If game is locked due to an error this is
  164. the only way the game will become unlocked.  This gives you the
  165. opportunity to figure out the game's problem before you get flooded with
  166. mail due to the error.
  167.  
  168. [C]hange Land Available:  Due to the fact that this game is in beta
  169. stage, I'm not sure the optimal value for land.  I wanted to limit the
  170. amount of land to make the game more interesting.  You might have to
  171. adjust this figure.  If you have any suggestions on this one after an
  172. entire game is played out please let me know.
  173.  
  174. [I]nformation on Registration:  Just as it says.
  175.  
  176. [Q]uit:  Leave setup.
  177.  
  178. ERROR HANDLING:
  179.  
  180. In the event of an error, Excaliber will note the time and date of the
  181. error along with the BASIC error number in a .log file.  You can view
  182. the log file by using the setup utility.
  183.  
  184. Excaliber will also leave the game locked to the end user until you can
  185. solve the problem.  The user will get a message that the game is in use
  186. by another node until the Game Lock has been reset by the setup utility.
  187.  
  188. Common Error Codes are as follows:
  189.  
  190. Error#  Error Text              Resolution
  191.  
  192. 5       Illegal Function Call   Excaliber's variables are getting too
  193.                                 large.  You may have to restart the
  194.                                 game.  (Please notify me.)
  195.  
  196. 6       Overflow                Same as above.
  197.  
  198. 7       Out of memory           Same as above.
  199.  
  200. 53      File Not Found          A file has been corrupted or deleted.
  201.                                 Find out which file and correct.
  202.                                 NOTE:  If you are attempting to run
  203.                                 Excaliber from the DOS Command Line
  204.                                 this error will appear.  It indicates
  205.                                 that a door.sys file is not found.
  206.  
  207. 57      Device I/O Error        Your disk is not responding to load or
  208.                                 save commands.  Check disk.
  209.  
  210. 72      Disk Media Error        Same as above.
  211.  
  212. MAINTENANCE HISTORY:
  213.  
  214. Version 0.9d (Beta/Shareware) - Released: 12/05/94
  215.  
  216. 1. Fixed bug which caused the player records to be saved with all null
  217.    values if a user hung up on the game while the opening ANSI screen 
  218.    was being displayed.
  219.  
  220. Version 0.9c (Beta/Shareware) - Released: 11/10/94
  221.  
  222. 1. Added [99]Delete Current User option in setup program.
  223.  
  224. 2. Added ability for SysOp to purge all .log files.
  225.  
  226. 3. Added documentation for setup program.
  227.  
  228. Version 0.9b (Beta/Shareware) - Released: 10/28/94
  229.  
  230. 1. Added ability to view Hall of Fame Log.
  231.  
  232. 2. Fixed bug which let the Serfs revolt more than once if taxes were higher
  233.    than 35%.
  234.  
  235. 3. Fixed bug in which the game reported a player was protected by the new
  236.    user treaty but the player position was empty.  Excaliber now reports
  237.    that the player position is empty.
  238.  
  239. 4. Added various ANSI screens.  (ANSI.SYS driver is required for this 
  240.    feature to work since I am shelling to DOS and using the 'type' command.
  241.    If you prefer not to use ANSI.SYS, you'll have to and may modify
  242.    the .ans files to hold only pure text.  You must, however, include
  243.    the name of the game and credit myself as the programmer.)
  244.  
  245. 5. Made for/next loops quicker for slower machines.
  246.  
  247. 6. Improved Main Menu.
  248.  
  249. UPCOMING VERSION 1.0 FEATURES: (Registered Users Only!)
  250.  
  251. 1. Ability to purchase mercenaries for protection before leaving the 
  252.    game.
  253.  
  254. 2. Players will be able to use spies to find out about enemy strengths
  255.    and weaknesses.
  256.  
  257. 3. Players will have E-Mail capabilities within the confines of
  258.    Excaliber.
  259.  
  260. REPORTING BUGS:
  261.  
  262. To report bugs please fill out the following form and mail them to the
  263. address at the bottom of this document.
  264.  
  265. ┌────────────────────────┬──────────────────────────────────────────┐
  266. │ Date:                  │ Name:                                    │
  267. ├────────────────────────┼──────────────────────────────────────────┤ 
  268. │ BBS #:                 │ BBS Name:                                │
  269. ├────────────────────────┴──────────────────────────────────────────┤ 
  270. │ Describe bug/incompatibility:                                     │
  271. ├───────────────────────────────────────────────────────────────────┤ 
  272. │                                                                   │
  273. ├───────────────────────────────────────────────────────────────────┤ 
  274. │                                                                   │
  275. ├───────────────────────────────────────────────────────────────────┤ 
  276. │ At what point did bug occur:                                      │
  277. ├───────────────────────────────────────────────────────────────────┤ 
  278. │                                                                   │
  279. ├───────────────────────────────────────────────────────────────────┤ 
  280. │                                                                   │
  281. ├───────────────────────────────────────────────────────────────────┤ 
  282. │ Condition of system after bug:                                    │
  283. ├───────────────────────────────────────────────────────────────────┤ 
  284. │                                                                   │
  285. ├───────────────────────────────────────────────────────────────────┤ 
  286. │                                                                   │
  287. ├───────────────────────────────────────────────────────────────────┤ 
  288. │ In your opinion what caused:                                      │
  289. ├───────────────────────────────────────────────────────────────────┤ 
  290. │                                                                   │
  291. ├───────────────────────────────────────────────────────────────────┤ 
  292. │                                                                   │
  293. └───────────────────────────────────────────────────────────────────┘ 
  294.  
  295. REGISTERING EXCALIBER:
  296.  
  297. Version 0.9x will be the only version of Excaliber to be released
  298. into the Shareware market.  To get a non-beta version of Excaliber
  299. send $20.00 check or money order to the below address.  The
  300. non-beta version is due to be ready early 1995.  For your $20.00
  301. you will receive the newest version of Excaliber on diskette
  302. personalized with your BBS information.  You will also be placed
  303. on a mailing list (optional) for future EasySoft door programs.
  304.  
  305. NOTE:  DO NOT send $20.00 for the registered version unless you
  306. have successfully installed version 0.9x first.
  307.  
  308. ┌────────────────────────┬──────────────────────────────────────────┐
  309. │ Date:                  │ Name:                                    │
  310. ├────────────────────────┼──────────────────────────────────────────┤ 
  311. │ BBS #:                 │ BBS Name:                                │
  312. ├────────────────────────┴──────────────────────────────────────────┤ 
  313. │ Address Line 1:                                                   │
  314. ├───────────────────────────────────────────────────────────────────┤ 
  315. │ Address Line 2:                                                   │
  316. ├───────────────────────────────────────────────────────────────────┤ 
  317. │ City:                    State:               Zip:                │
  318. ├───────────────────────────────────────────────────────────────────┤ 
  319. │ Game that you are registering:                                    │
  320. ├───────────────────────────────────────────────────────────────────┤ 
  321. │ Mailing list option:     (  ) Yes    (  ) No                      │
  322. ├───────────────────────────────────────────────────────────────────┤ 
  323. │ Disk Format:             (  ) 3 1/2  (  ) 5 1/4                   │
  324. ├───────────────────────────────────────────────────────────────────┤ 
  325. │ Game Comments:                                                    │
  326. ├───────────────────────────────────────────────────────────────────┤ 
  327. │                                                                   │
  328. ├───────────────────────────────────────────────────────────────────┤ 
  329. │                                                                   │
  330. ├───────────────────────────────────────────────────────────────────┤ 
  331. │                                                                   │
  332. ├───────────────────────────────────────────────────────────────────┤ 
  333. │                                                                   │
  334. ├───────────────────────────────────────────────────────────────────┤ 
  335. │ BBS Software/Version:                                             │
  336. ├───────────────────────────────────────────────────────────────────┤ 
  337. │ How does the game interface with your software:                  │
  338. ├───────────────────────────────────────────────────────────────────┤ 
  339. │                                                                   │
  340. ├───────────────────────────────────────────────────────────────────┤ 
  341. │                                                                   │
  342. └───────────────────────────────────────────────────────────────────┘ 
  343.  
  344. Send all correspondence to:
  345.  
  346.                         Robert Jarrell
  347.                         EasySoft
  348.                         8207 Brisbane
  349.                         Converse, TX 78109
  350.  
  351. Make all checks payable to Robert Jarrell.
  352.  
  353. TECHNICAL SUPPORT:
  354.  
  355. I will be adding BBS support late 1994 early 1995.  Registered users
  356. will be able to upgrade their versions of Excaliber by dialing in and
  357. downloading current files.  There will never be a fee for upgrading a
  358. registered version of any of EasySoft's door programs once initial
  359. registration is completed.  BBS UPDATE:  I now have the phone line in 
  360. and the PC running.  The number is (210) 659-0049.  Expect the board
  361. to be up by the end of November 1994.
  362.  
  363. I am also very active on Wildcat's HQ BBS.  I generally call there
  364. four to five times a week.
  365.  
  366. If all else fails, I can be reached on American Online at user ID 
  367. RLJarrell.  
  368.