home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / TJYARD10.ZIP / JUNKYARD.DOC < prev    next >
Encoding:
Text File  |  1994-09-17  |  16.8 KB  |  413 lines
  1.  
  2.  
  3.                        ============================
  4.                                 JunkYard!
  5.                        ============================
  6.                        COPYRIGHT 1994 T&J Software
  7.                            ALL RIGHTS RESERVED
  8.  
  9.         One of the T&J Software Collection of multi-BBS door programs.
  10.            Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,
  11.                UltraBBS, Telegard, TriBBS, and Remote Access.
  12.  
  13.                     VERSION 1.00     September 18, 1994
  14.  
  15.                                    By
  16.  
  17.                             Tom & Jane Wildoner
  18.                              397 West Broadway
  19.                               Jim Thorpe, PA
  20.                                   18229
  21.                             VOICE (717)325-9480
  22.                    *between 6:00 & 8:00 p.m. Eastern Time
  23.  
  24.                                   From
  25.  
  26.                                The T&J BBS
  27.                             (717)325-9481 14.4
  28.                             (717)325-4369 28.8
  29.                         1200/2400/9600/19200/38400
  30.                                24 Hours/Day
  31.                     INTERNET: tom.wildoner@channel1.com
  32.  
  33. LATEST VERSION:
  34. ~~~~~~~~~~~~~~~
  35. Please call the T&J BBS for the latest version of this program.
  36.  
  37. LEGALITIES:
  38. ~~~~~~~~~~~
  39. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  40. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY
  41. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  42. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS
  43. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING
  44. OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY. ONCE REGISTERED, ANY
  45. DISTRIBUTION OF THE REGISTERED KEY WILL INVALIDATE YOUR KEY IN ALL FUTURE
  46. VERSIONS OF THIS PROGRAM AND NO PRODUCT SUPPORT WILL BE GIVEN. DISTRIBUTING
  47. A REGISTERED KEY FILE WILL ALSO BRING ABOUT CRIMINAL CHARGES.
  48.  
  49. DISTRIBUTION:
  50. ~~~~~~~~~~~~~
  51. You may make this file available for downloading from your BBS or you may
  52. upload it to any BBS of your choice, provided that you do not make any
  53. changes to the contents of the archive (ZIP file). The archive and its
  54. individual contents may not be used by any service that charges any money
  55. whatsoever, without the written permission of the author. Pay boards (BBS)
  56. may carry the unregistered demo version for distribution purposes.
  57.  
  58. PROGRAM DESCRIPTION:
  59. ~~~~~~~~~~~~~~~~~~~~
  60. Welcome to JunkYard! by T&J Software
  61.  
  62. JunkYard is a game of scrounging landfills looking for items to sell. You
  63. may hire workers to help you search, attack other players, and much more.
  64. Some items we will not discuss as it will take away from the game (random
  65. events, special items you may find, etc.).
  66.  
  67. Please read the JUNKYARD.HLP file for a complete description of this
  68. door!
  69.  
  70. NOTE:
  71. ~~~~~
  72. When you register, you will receive a JUNKYARD.KEY file. Your users
  73. are only allowed FIVE scrounges per day and can only enter the door ONE
  74. time per day until registered. Also, the JunkYard Lottery program
  75. (JYLOT.EXE) will only function with a registered version. The entire
  76. door can be configured to your particular taste after registering.
  77.  
  78. FEATURES:
  79. ~~~~~~~~~
  80.            --- Desqview Aware.
  81.            --- COM0-15 support and non-standard IRQ's.
  82.            --- Colorful ANSI screens.
  83.            --- Chat function with automatic screen redraw.
  84.            --- Drop to DOS with automatic screen redraw.
  85.            --- NO BRUN module needed for play.
  86.            --- BETA tested on many different boards.
  87.            --- Will return to BBS on dropped carrier.
  88.            --- Will TIMEOUT a player after 5 minutes of no activity.
  89.            --- Use of HOT KEYS while in the door.
  90.            --- Support BBS available.
  91.            --- TOP 10 bulletins.
  92.            --- SysOp configurable.
  93.  
  94. INSTALLATION:
  95. ~~~~~~~~~~~~~
  96. Run the JUNKUTIL.EXE program for easy setup! Here are the menu choices
  97. in the JUNKUTIL.EXE program file:
  98.  
  99. 1. Reset the Door.  > Use this option before initially playing the
  100.                     > door on your BBS. This will reset the entire
  101.                     > door.
  102.  
  103. 2. Make you         > Use this option to make your JUNKYARD.CFG file.
  104.    JUNKYARD.CFG.    > If you are experienced at setting up doors, just
  105.                     > use a text editor to modify the current .CFG
  106.                     > file.
  107.  
  108. 3. Make your        > This option will walk you through the setup of
  109.    SYSOP.CFG file.  > the SYSOP.CFG files and will include items to
  110.                     > customize the door, bulletin paths, etc. I
  111.                     > highly suggest using the utility program to do
  112.                     > this.
  113.  
  114. 4. QUIT.            > This exits the JunkYard Utility Program.
  115.  
  116. 5. Make-Up Days/    > This options lets you configure make-up days,
  117.    Banking.         > and the number of scrounges that can be
  118.                     > kept in the bank.
  119.  
  120. 6. Add Items.       > This option allows you to add your own items
  121.                     > into the JunkYard database (JUNK.DAT). I would
  122.                     > suggest backing up this file prior to playing
  123.                     > with it! You will prompted for an item name
  124.                     > and the items value. If will sacn the database
  125.                     > for duplicates.
  126.  
  127. 7. Evaluate the     > This option evaluates the JunkYard database. It
  128.    Database.        > analyze the break down of items by price and
  129.                     > tell you the percentage of those items in the
  130.                     > database. This way, you can add items of a
  131.                     > certain value to increase the likeliness of
  132.                     > finding that type of object.
  133.  
  134. 8. Give Special     > This option allows you to give "special" items
  135.    Item.            > to the player of your choice.
  136.  
  137. 9. View Players.    > This is a player viewer (not editor). The editor
  138.                     > will be released on a later date.
  139.  
  140. 10. Reset Scores.   > This option resets the high score file and last
  141.                     > month's high score.
  142.  
  143.  
  144. CONFIGURATION: (Your JUNKYARD.CFG file)
  145. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  146. ** PLEASE CONSULT YOUR OWN BBS DOCUMENTATION FOR SPECIFICS!!!! **
  147.  
  148. Example configuration file for PCBOARD.SYS
  149. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  150. C:\PCB\PCBOARD.SYS  <=-  (Full pathname of your PCBOARD.SYS file)
  151. T&J Software        <=-  (Change this to your BBS name)
  152. Tom                 <=-  (The Sysop's first name)
  153. Wildoner            <=-  (The Sysop's last name)
  154.  
  155. Example configuration file for USERS.SYS
  156. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  157. C:\PCB\USERS.SYS    <=-  (Full pathname of your USERS.SYS file)
  158. T&J Software        <=-  (Change this to your BBS name)
  159. Tom                 <=-  (The Sysop's first name)
  160. Wildoner            <=-  (The Sysop's last name)
  161.  
  162. Example configuration file for DOOR.SYS
  163. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  164. C:\BBS\DOOR.SYS     <=-  (Full pathname of your DOOR.SYS file)
  165. T&J Software        <=-  (Change this to your BBS name)
  166. Tom                 <=-  (The Sysop's first name)
  167. Wildoner            <=-  (The Sysop's last name)
  168.  
  169. Example configuration file for CALLINFO.BBS
  170. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  171. C:\BBS\CALLINFO.BBS <=-  (Full pathname of your CALLINFO.BBS file)
  172. T&J Software        <=-  (Change this to your BBS name)
  173. Tom                 <=-  (The Sysop's first name)
  174. Wildoner            <=-  (The Sysop's last name)
  175.  
  176. Example configuration file for DORINFOx.DEF
  177. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  178. C:\BBS\DORINFOx.DEF <=-  (Full pathname of your DORINFOx.DEF file
  179.                           where 'x' is the BBS Node number.
  180. T&J Software        <=-  (Change this to your BBS name)
  181. Tom                 <=-  (The Sysop's first name)
  182. Wildoner            <=-  (The Sysop's last name)
  183.  
  184. Example configuration file for SFDOORS.DAT
  185. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  186. C:\BBS\SFDOORS.DAT  <=-  (Full pathname of your SFDOORS.DAT file)
  187. T&J Software        <=-  (Change this to your BBS name)
  188. Tom                 <=-  (The Sysop's first name)
  189. Wildoner            <=-  (The Sysop's last name)
  190.  
  191. Example configuration file for GTUSER.BBS
  192. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  193. C:\BBS\GTUSER.BBS   <=-  (Full pathname of your GTUSER.BBS file)
  194. T&J Software        <=-  (Change this to your BBS name)
  195. Tom                 <=-  (The Sysop's first name)
  196. Wildoner            <=-  (The Sysop's last name)
  197. 1                   <=-  (COM port number - defaults to 1)
  198. 1                   <=-  (Node number - defaults to 1)
  199.  
  200. Example Batch File
  201. ~~~~~~~~~~~~~~~~~~
  202. A sample batch file similar to the following:
  203.    ECHO OFF
  204.    CD\DOORS\JUNKYARD        <=- Switch to the door's Directory.
  205.    JUNKYARD JUNKYARD.CFG    <=- Execute the door program and pass the
  206.                                 configuration filename to the program.
  207.    CD\PCB                   <=- Go back to PCB DIR when user exits door.
  208.    BOARD                    <=- Restart BBS.
  209.  
  210. This Door is multi-node  compatible so you may run more than 1 node from
  211. the same .CFG file provided the path to your system file (DORINFOx.DEF,
  212. CALLINFO.BBS, etc) is exactly the same unless you are using environment
  213. variables, (q.v.)
  214.  
  215. Environment Variables
  216. ~~~~~~~~~~~~~~~~~~~~~
  217. PCBoard automatically creates the %PCBDRIVE% & %PCBDIR% environment
  218. variables. Non-PCBoard systems may also use these variables by including
  219. the following in either your BBS batch or AUTOEXEC.BAT
  220.   SET PCBDRIVE=C:               <- Drive letter of your BBS files
  221.   SET PCBDIR=\BBSDIR            <- Path to your BBS files
  222. Then in your Door .CFG file instead of putting C:\BBSDIR\DOOR.SYS, you
  223. would put %PCBDRIVE%%PCBDIR%\DOOR.SYS. This allows you to use just one
  224. .CFG file for multi-node operation!
  225.  
  226. To specify a non-standard IRQ, put the IRQ number after the .CFG on the
  227. command line.  For example:
  228.  
  229.      JUNKYARD JUNKYARD.CFG /5
  230. or using the PCBDRIVE procedure:   SET IRQ=5   and use
  231.      JUNKYARD JUNKYARD.CFG /%IRQ%
  232.  
  233. This tells the program to use IRQ 5 instead of the standard IRQ.
  234.  
  235.   Had reports of conflicts when using non-standard IRQ's on Novell/Netware
  236.  systems. Seems Novell also uses the / character so something went screwy
  237.  somewhere. So I added the * (asterisk) which may be used instead of the /
  238.  in case of a conflict. In other words, /%IRQ% and *%IRQ% will both work
  239.  and are interchangeable.
  240.  
  241. When specifying the location of the system file on line 1 of the doors .CFG
  242. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  243. and %wcnodeid%. Some examples:
  244.  PCBoard: 
  245.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  246.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  247.  
  248.  Wildcat!:
  249.    DOOR.SYS in C:\Wildcat\wcwork\NODE1
  250.                         - C:\wildcat\wcwork\node%wcnodeid%\door.sys
  251.  
  252. Non-PCBoard systems may use the PCB environment variables by setting them
  253. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  254.  SET PCBDRIVE=C:
  255.  SET PCBDIR=\BBSDIR
  256.  SET PCBNODE=1
  257.  
  258. Fossil Driver Support
  259. ~~~~~~~~~~~~~~~~~~~~~
  260. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  261. Fossil driver instead of the standard COM ports, just put /FD on the command
  262. line when running the door. For example:
  263.      MYDOOR MYDOOR.CFG /FD
  264. indicates that a Fossil driver is present and should be used. If no Fossil
  265. driver is detected, DoorFrame will print a message to that effect and exit
  266. the door gracefully.
  267.  
  268. Sysop Keys
  269. ~~~~~~~~~~
  270. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  271.          written to DOOR.SYS and USERS.SYS
  272. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  273.          and/or written to DOOR.SYS and USERS.SYS
  274. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  275. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  276.          and/or written to DOOR.SYS and USERS.SYS
  277. F8    -  Returns the caller involuntarily to the BBS.
  278. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  279.          and/or written to DOOR.SYS and USERS.SYS
  280. F10   -  Activates SysOp CHAT mode within the DOOR.
  281. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  282. UP    -  Give the caller extra time while in the DOOR.  
  283. DN    -  Subtract time from the caller while in the DOOR. 
  284. HOME  -  HELP key for Status Line options.
  285. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  286. ALT-X -  PCBoard will exit after current caller logs off. Value is
  287.          passed to PCBoard. Not available on non-PCBoard systems.
  288.  
  289. SYSOP.CFG FILE:
  290. ~~~~~~~~~~~~~~~
  291. Here is a breakdown of the SysOp configuration options which will be
  292. found in the SYSOP.CFG file. Remember, you can setup this file easily
  293. with the JUNKUTIL program!
  294.  
  295. C:\WC30\BULL99.SCR
  296. C:\WC30\BULL99.BBS
  297. Y
  298. 3
  299. 5
  300. 10
  301. 10
  302. 5
  303. 10
  304. 10000
  305.  
  306. LINE 1: Color bulletin PATH and FILENAME or NONE. If you select NONE
  307.         bulletin is still created for door purposes, but not created
  308.         for the BBS bulletins.
  309. LINE 2: Mono bulletin PATH and FILENAME or NONE
  310. LINE 3: Y-Reset at end of month N-Let the game continue!
  311. LINE 4: Number of times a person may enter the door per day.
  312. LINE 5: Number of searches per day they can make for helpers.
  313. LINE 6: Maximum number of helpers at one time.
  314. LINE 7: Number of attacks per day.
  315. LINE 8: Interest on BANKED Scrounges (or 0).
  316. LINE 9: Maximum number of times caught before you are locked out
  317.         of a store.
  318. LINE 10: Maximum number of shares that any one player may buy in the
  319.          JunkYard stock exchange.
  320.  
  321. PLAYER HELP:
  322. ~~~~~~~~~~~~
  323. A file is included called JUNKYARD.HLP -- feel free to zip this file
  324. up and place it on your board for your users to download! This file is
  325. also used inside the door, so don't delete it!
  326.  
  327. OTHER PROGRAMS:
  328. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  329. The JunkYard Dog and JunkYard Lottery program are run from the command
  330. line by typing JYDOG and JYLOT respectively. They must be run from the
  331. JUNKYARD home directory. I would suggest running each program nightly
  332. as part of your maintenance routines. Each program on takes a few
  333. seconds to run.
  334.  
  335. The JunkYard Dog Program:
  336. ~~~~~~~~~~~~~~~~~~~~~~~~~
  337. The JunkYard Dog! The JunkYard Dog program is included in this ZIP
  338. file as JYDOG.EXE. Simply run this once per night to activate this
  339. option. The JunkYard Dog will pick on the top player (if there are
  340. less than 10 players in the game). If there are more than 10 players,
  341. the dog will randomly select players to attack. The dog does the
  342. following:
  343.  
  344.                    Kills all the players helpers.
  345.                                -or-
  346.                   Steals the highest valued item.
  347.                                -or-
  348.    Steals some cash, followed by giving the cash to another player.
  349.  
  350. Notes will be sent to the players affected by such attacks. All
  351. actions are also listed in the JUNKYARD.LOG file for your viewing
  352. pleasure. <G>
  353.  
  354. The JunkYard Lottery Program:
  355. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  356. Another program distributed with JunkYard is the JunkYard Lottery
  357. Program. It is included in the main ZIP file as JYLOT.EXE.
  358.  
  359. NOTE: This external program will ONLY run once you register the door.
  360.  
  361. The JunkYard Lottery Program removes ONE banked scrounge from each
  362. player who has scrounges banked. It tallies the collected scrounges and
  363. then picks a random winner of the collected scrounges. All winning are
  364. deposited into the players bank account (yes, they can go over the
  365. banking limit when they win).
  366.  
  367. A note is left to each player stating that a scrounge was subtracted.
  368. A note is left to the winner and on the Graffitti Wall stating the
  369. winners name and how many scrounges they won.
  370.  
  371. The winner is also listed in the JUNKYARD.LOG file.
  372.  
  373. THE FUTURE:
  374. ~~~~~~~~~~~
  375. More programs will be developed as time permits including a ROBOTS
  376. program (similar to Robots for Bordello). Suggestion? Comments? Please
  377. let us know!
  378.  
  379. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  380.  
  381. MAINTENANCE:
  382. ~~~~~~~~~~~~
  383. After the initial setup, no maintenance will be required unless you
  384. want to reset the door from scratch. The door will reset with the
  385. first player of a new month (if toggled).
  386.  
  387. PLAYING LOCALLY:
  388. ~~~~~~~~~~~~~~~~
  389. Just type JUNKYARD LOCAL
  390. Logon with the name of: SYSOP
  391.  
  392. FUTURE VERSIONS:
  393. ~~~~~~~~~~~~~~~~
  394. Let us know what you would like to see added or changed!
  395.  
  396. COMMENTS & QUESTIONS & HELP:
  397. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  398. If you have problems please consult the file TJHELP.TXT first, this
  399. may help you out!
  400.  
  401. VERSION HISTORY:
  402. ~~~~~~~~~~~~~~~~
  403. See the HISTORY.TXT file for information on the history of the game
  404. and the new options in the current version!
  405.  
  406. REGISTERING:
  407. ~~~~~~~~~~~~
  408. That's all there is to it! If you have any problems or questions
  409. please feel free to call the T&J BBS at (717)325-9481. You may also
  410. reach us on the Internet at tom.wildoner@channel1.com
  411.  
  412. See the enclosed registration form for ordering!  (REGISTER.TXT)
  413.