home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / BBS_GAME / PLANTRAN.ZIP / PLANTRAN.DOC < prev    next >
Text File  |  1994-02-06  |  9KB  |  220 lines
  1.                     VGA Planets Online Host Interface       
  2.                    Copyright 1993-1994  Stanley Fleury
  3.                    A Land Of Rape And Honey Production
  4.                      from
  5.                      The Land Of Rape And Honey BBS
  6.                           (504) 466-7764 14.4k
  7.                             FIDOnet  1:396/53
  8.                             ITCnet 85:845/100
  9.  
  10.  
  11.   Welcome to the VGA Planets Online Host Interface v2.0. This is the second
  12. public release, v2.0. After releasing v1.0 I realized how much the interface
  13. was lacking. Sure, it was good for players to transfer their packets, but
  14. that was about it. We have now incorporated many new features and made the
  15. interface a little more user friendly (for the user and the sysop).
  16.  
  17.   * Players can send private messages through the interface similar 
  18.     in the way VGA Planets handles messages. Using the interface
  19.     avoids the delay of waiting to the next time the turns are 
  20.     compiled to receive incoming messages. Players can send to
  21.     another player or universally. Players can also reply to
  22.     messages that they have received.
  23.  
  24.   * Players can resign from the game and users who are not playing
  25.     can automatically join the game by entering into a player slot
  26.     that is not active.
  27.  
  28.   * Users and Players can view a screen showing who has done what this
  29.     turn, how many turns they have played, and the last time they 
  30.     played.
  31.  
  32.   * Players are removed from the interface if they do not upload a packet
  33.     within a specified ammount of days. This allows other users to join
  34.     the game instead of leaving a player race dorment.
  35.  
  36.   * All activity in the interface is logged to a file. You will know
  37.     who and when entered the interface, what they did, and when they 
  38.     left.
  39.  
  40.   * Uses external ZModem protocol for all transfers. You do not 
  41.     need to know how to configure Zmodem. All that is taken care of
  42.     from within plantran.exe.
  43.  
  44.   * Interested users have the option to download the VGA Planets
  45.     archive from inside the interface. This can be used as an 
  46.     incentive to take a look at the game (since the download
  47.     will be free of ratios <g>).
  48.  
  49.   * Players are only able to download their pre-specified packets.
  50.     This way, no one can download someone elses packets without 
  51.     logging onto your system as them.
  52.  
  53.   * No matter what the player uploads it will be named to their
  54.     assign *.trn packet name. This makes the game 100% secure. 
  55.     Players will not be able to upload a packet with someone
  56.     elses player name.
  57.  
  58.   * Players may overwrite their *.trn files if they made a mistake 
  59.     such as uploading yesterdays file.
  60.     
  61.   * Scores are viewable from within the interface. Scores include 
  62.     last date the host program was run. This will make it easier
  63.     for players to see if the host program has run.  
  64.  
  65.   * All screens are configurable to fit your tastes. This will make
  66.     the interface fit your own system instead of looking like 
  67.     an alien artifact and out of place.
  68.  
  69.   * Interace supports ANSI and ASCII. All screens and menus can be 
  70.     saved in ANS and ASC format.
  71.  
  72.   * Non-Playing users can enter the interface and view scores.
  73.  
  74.   * Option on menu to tell users about VGA Planets and how to play
  75.     the game. This is also an external file that can be modified 
  76.     by the sysop.
  77.  
  78.   
  79. INSTALATION
  80. ~~~~~~~~~~~
  81.  
  82.       1 - Create a directory to place all the VGA Planets Online Host
  83.           Interface files into. This directory should be different 
  84.           from your VGA Planets game directory.
  85.  
  86.       2 - Copy/Uncompress of the interface files into that directory.
  87.   
  88.       3 - Run 'plancfg.exe reset' to setup the interface. You will be 
  89.           asked for the following information. If you are unable to 
  90.           put in any valid information just leave it blank and you will
  91.           be able to go back to it at a later time. 
  92.  
  93.             a) Path and Name of your Zmodem protocol 
  94.                 ie) c:\protocol\dsz.exe
  95.                     c:\protocol\dsz.com
  96.                     d:\ptot\gsz.exe
  97.  
  98.             b) Path and Name of your VGA Planets Archive
  99.                 ie) c:\bbs\download\online\vplan30f.zip
  100.  
  101.             c) Path to your VGA Planets game directory
  102.                 ie) c:\bbsgames\planets\
  103.                 ie) c:\vgaplan\
  104.        
  105.             d) Number of inactive days until a player is removed
  106.                 ie) 14
  107.         ie) 21
  108.  
  109.       4 - You will then be shown a listing of eleven player slots.
  110.  
  111.             ## Alias/Name        Plays Active         File
  112.             1  NOT USED          0     No             PLAYER1 
  113.             2  NOT USED          0     No             PLAYER2
  114.             3  NOT USED          0     No             PLAYER3
  115.             4  NOT USED          0     No             PLAYER4
  116.             ect                           
  117.    
  118.           You can now begin to fill in all of your VGA Planets players.
  119.           Once a player is entered into the interface their account is
  120.       flagged as active. If they resign or do not play for XX days
  121.           the account will be marked inactive and someone else will be
  122.           able to play. You can manually mark an account as inactive
  123.       play blanking the Alias/Name field.      
  124.  
  125.       5 - Once you have completed entering all your players into the 
  126.           interface you will need to create a batch file that looks 
  127.           something like this : 
  128.                        
  129.                  @echo off
  130.                  copy c:\bbs\door.sys c:\bbsgames\plantran\door.sys
  131.                  cd \bbsgames\plantran
  132.                  plantran.exe
  133.  
  134.       6 - You should now create a batch file to run the host program.
  135.           Be sure to include plantran.exe -n everytine host.exe is
  136.           run. This will reset a few variables inside the interface
  137.           so it knows that a turn has begun. Your batch file should 
  138.           look something like this : 
  139.  
  140.          @echo off
  141.                  cd \bbsgames\plantran
  142.                  plantran.exe -n
  143.                  cd \vgaplan
  144.                  host.exe     
  145.  
  146.       7 - Now you are ready to go. Just install a door into your 
  147.           bbs program to create door.sys and run your batch file 
  148.           everytime a users enters the interface.
  149.  
  150.  
  151. Files Included 
  152. ~~~~~~~~~~~~~~
  153.     Main1.Ans + Main1.Asc       - These are the main menu files for users
  154.                                   who are playing in the current game.
  155.  
  156.     Main2.Ans + Main2.Asc       - Main menu files for those who are not 
  157.                                   playing in this game.
  158.  
  159.     Planets.Ans + Planets.Asc   - These are displayed after a user enters
  160.                                   into the interface.
  161.  
  162.     Resign.Ans + Resign.Asc     - This file is shown to users who select
  163.                       the resign option. This should tell
  164.                   them what suicide really means. <g>
  165.  
  166.     Gameinfo.ans + Gameinfo.asc - This makes for a nice place to include 
  167.                   information on when turns are running
  168.                   and the setup of the game currently 
  169.                   running.
  170.  
  171.     Info.Txt                    - Information file showing information 
  172.                                   about Vga Planets or how to play the
  173.                                   Vga Planets.
  174.  
  175.     Plancfg.Exe                 - Interface configuration program.
  176.  
  177.     Plantran.Exe                - File to run when users enter into 
  178.                                   the interface. Requires door.sys.
  179.  
  180.     Plantran.Doc                - This documentation.
  181.  
  182.     Register.Txt                - Information on register this interface.
  183.  
  184.     Plantran.Reg                - Registraion configuration file. This can
  185.                                   be edited one you have recieved your 
  186.                                   registration code.
  187.  
  188. Files Created By Plancfg.Exe
  189. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  190.     Vgatran1.cfg              - Configuration file containing path
  191.                                 and protocol information.
  192.  
  193.     Vgatran2.cfg              - Configuration file containing players
  194.                                 information.
  195.           
  196.     Messages.dat          - This file contains all private messages
  197.                 that are sent through teh interface.
  198.  
  199.     Plantran.log          - This is a viewable text file containing
  200.                 all information concerning player usage
  201.                 inside the interface.
  202.  
  203. Registration Agreement
  204. ~~~~~~~~~~~~~~~~~~~~~~
  205.    This package is a shareware product. You are licensed to use this 
  206.    product for thirty days. If you do not register after thirty you
  207.    must cease to use this product. Registration is only $5, and that 
  208.    includes all future updates. 
  209.   
  210. Credits
  211. ~~~~~~~
  212.    I would like to thank the following for making my first large 
  213.    programming project possible.
  214.   
  215.    Stan Towns, James Fugler, Jayson Adair, Mike Ladner, April Burchett,
  216.    and many others who have run tests for me at 3 am in the morning or
  217.    called to bitch me out when somethign goes wrong.
  218.  
  219.  
  220.