home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / DOORS / SEAMINE.ZIP / SEAMINE.DOC < prev    next >
Encoding:
Text File  |  1991-07-06  |  16.2 KB  |  333 lines

  1.                                SysOp Documentation for
  2.                                        SEAMINE
  3.                                    by Chris Allen
  4.                                     version 1.30
  5.  
  6.  
  7.           ABOUT THE GAME
  8.  
  9.                SeaMine is a BBS game where the players control submarines
  10.           and move around in an underwater world filled with rocks, ore
  11.           mines, and other players.  The goal is to locate mines, then
  12.           retrieve and sell precious ores.  This creates competition with
  13.           the other players economically and directly in combat.  More
  14.           about the game is in the accompanying SEAMINE.INS file.
  15.  
  16.  
  17.           INSTALLATION
  18.  
  19.           Steps for installation:
  20.  
  21.                1.   Make a directory in which you want to store the
  22.                     program
  23.  
  24.                2.   Extract all the program's files into that directory
  25.  
  26.                3.   Run the SEAMAKE batch file.  This batch file
  27.                     automatically runs the other customization programs. 
  28.                     Or you can run each manually.  The list of
  29.                     customization programs is:
  30.  
  31.                     a.   SEACFG customizes colors, default communication
  32.                          parameters, and playing characteristics such as
  33.                          playing-board dimensions and ore names.
  34.  
  35.                     b.   MAPMAKE creates the initial map data file.  It
  36.                          asks for average depth and maximum rock spread up
  37.                          and down.  You can use the default values by
  38.                          pressing Enter, for a reasonable map.  You can
  39.                          change this file as you want before continuing
  40.                          with the next step.
  41.  
  42.                     c.   SECMAKE generates the game's actual playing
  43.                          board.  SECMAKE reads the text file MAP.DAT which
  44.                          MAPMAKE generates.  These new data files can be
  45.                          edited with the Sector Editor, which is described
  46.                          later in this documentation.
  47.  
  48.                     To run a fast setup using default values, type:
  49.                          seamake default               (all lower case)
  50.  
  51.                     To customize for your own board specifications, such as
  52.                     a different board size or other than the default
  53.                     values, type:
  54.                          seamake custom                (all lower case)
  55.                                                                           2
  56.  
  57.                4.   Optionally, you can run SEAEDIT, the SeaMine Editor, to
  58.                     customize the map now, or later after players have
  59.                     started using the game.
  60.  
  61.                5 .  Install the game in your BBS (see next section)
  62.  
  63.  
  64.           Running From DOS
  65.  
  66.                To run SeaMine from DOS, enter
  67.  
  68.                     SEAMINE 0 0 x <first> <last>
  69.  
  70.           where x is the maximum amount of time to give to the player, and
  71.           <first> and <last> are the first and last names of the player. 
  72.           However, the program also recognizes names that are other than
  73.           two words.  Leaving off all parameters causes the program to
  74.           abort.  Note that the player name is CASE SENSITIVE, meaning the
  75.           game can tell the difference between upper and lower case.  An
  76.           example is:
  77.  
  78.                     SEAMINE 0 0 1000 Chris Allen
  79.  
  80.  
  81.           BBS Installation
  82.  
  83.                SeaMine will run on a WWIV, QBBS, or compatible system. 
  84.           There are basically two methods you can use to install SeaMine,
  85.           because of ongoing development of BBS compatibility.
  86.  
  87.           Method 1:
  88.                The first method is to put in the command to execute
  89.           SeaMine, whether in a menu editor, chain editor, or whatever,
  90.           enter:
  91.  
  92.                <path>SEAMINE.EXE <file type> [filename]
  93.  
  94.           where:
  95.                <path> is the full path to the SeaMine directory
  96.                <file type> is based on your BBS software, as follows:
  97.                     1    :    WWIV system
  98.                     2    :    QBBS system
  99.  
  100.                [filename] is optional, the file to read for caller
  101.                     information.  If left off, the default filename is
  102.                     CHAIN.TXT for WWIV and DORINFO1.DEF for QBBS.
  103.  
  104.           Method 2:
  105.                The second method is left to maintain downward compatibility
  106.           with the first versions of SeaMine.
  107.  
  108.                                                                           3
  109.                For QBBS Installation:
  110.  
  111.                Run Menuedit, and either load the menu which will show
  112.           SeaMine, or create a new menu and add it to the appropriate menu. 
  113.           In the menu item to run the program, specify menu type 7, with
  114.           the optional information as follows:
  115.  
  116.                Name of the game, with the full path to reach it
  117.                Modem comm port (1-4)
  118.                Baud rate
  119.                User's time left this call
  120.                User's first and last name
  121.  
  122.           The format for this with QBBS is:
  123.  
  124.                path\SEAMINE.EXE x *B *T *F *L
  125.  
  126.           where the x is your modem's comm port, generally from 1 to 4.  An 
  127.           example would be:
  128.  
  129.                C:\QBBS\SEAMINE\SEAMINE.EXE 2 *B *T *F *L
  130.  
  131.           for a COM2 system, where the SeaMine program and data files are
  132.           located in the directory "c:\qbbs\seamine".  SeaMine knows to
  133.           look in the directory from which it is called, so you can keep
  134.           your other directories less cluttered.
  135.  
  136.                For WWIV Installation:
  137.  
  138.                Go into the external program editor, and add a program.  In
  139.           the line for the name of the program, include the full path to
  140.           SeaMine, since the program uses this to locate its data files. 
  141.           After the program name, add a "%1" to pass the name of the data
  142.           file written by WWIV, which SeaMine reads for communications
  143.           information.  An example of the program-name line would be:
  144.  
  145.                C:\WWIV\SEAMINE\SEAMINE.EXE %1
  146.  
  147.                Once SeaMine has been installed into your BBS, it should now
  148.           be ready for play.  I suggest that you, the Sysop, run the
  149.           program first, since the first player (player number 0) has
  150.           unlimited time per day.  Also, this player slot will potentially
  151.           be open to receive other features in later versions of the game. 
  152.           Running the game yourself is a good way to check to make sure
  153.           that it is properly installed and works fine.
  154.  
  155.  
  156.                                                                           4
  157.           CUSTOMIZING AND MAINTENANCE
  158.  
  159.           SEACFG
  160.  
  161.                SEACFG is the SeaMine Configuration program.  The main menu
  162.           explains the categories of items to customize, including colors,
  163.           default communication parameters, price control in the Port, and
  164.           miscellaneous options, such as board dimensions, number of ores,
  165.           the names of the ores, and a variety of player time limits,
  166.           controlled by the Sysop.  When you quit out of SEACFG and save
  167.           the data, it writes to the file SEAMINE.CFG.
  168.  
  169.           SEAEDIT
  170.  
  171.                All the editor functions for SeaMine are in one program,
  172.           SEAEDIT.EXE.  SeaEdit contains the player editor and sector and
  173.           mine editor.  The SeaMine Editor lets you: 
  174.  
  175.                  -  Adjust where rocks and ore mines are located
  176.                  -  Choose the number of mines, ores, and production levels
  177.                  -  Create "floating" mines to increase player difficulty
  178.                     and overall ore production
  179.                  -  Create tunnels, caverns, and underground mines
  180.                  -  Edit a player's location, time, credits, ores,
  181.                     fighters, etc.
  182.  
  183.           The editor components are each described below:
  184.  
  185.                Player Editor
  186.  
  187.                The Player Editor allows you to select an existing player
  188.           with the cursor keys, or add a new player with the 'A' key. 
  189.           Once the player is chosen, a screen with all of that player's
  190.           attributes is displayed, and you can again use the cursor keys
  191.           and type changes.  On fields with more than one character, only
  192.           changes ended by pressing Enter are saved.  When you are finished
  193.           editing, press Escape and it will save the player and return to
  194.           the player-selection screen.  Pressing F1 from either screen will
  195.           display an appropriate help screen.
  196.  
  197.                Sector Editor
  198.  
  199.                After you select the Sector Editor, you will be in movement
  200.           mode, and it will display the status for coordinates 1,1,1.  Use
  201.           the arrow keys and the + and - keys to move the current
  202.           coordinates, just as in the game.  The normal numbers on the
  203.           numeric pad move just as in the game, including diagonals. 
  204.           Sector 1,1,1 is in the southwest corner of the top (surface)
  205.           level.  Press F1 in movement mode for a complete list of movement
  206.           keys.  The basic keys are listed at the top of the help screen.
  207.                Once you choose the sector you want to edit, press Enter to
  208.           enter edit mode.  You may then edit the various fields.  If you
  209.                                                                           5
  210.           change the "Mine in sector" field, the lower half of the screen
  211.           will either add or remove more fields, regarding the mine in that
  212.           sector.  Press F1 for more extensive help about the different
  213.           fields.
  214.                When you are finished editing, press Escape and the program
  215.           will save the sector information and return to movement mode.
  216.  
  217.           SEAPACK
  218.  
  219.                SEAPACK is a cleaning program.  After you flag players to be
  220.           deleted, running SEAPACK actually deletes them from the player
  221.           file, and removes all their fighters from the playing board. 
  222.           Currently there is no expiration check for the age of a player's
  223.           record, so an inactive player will remain until manually deleted,
  224.           killed, or the game is reset.  This expiration-date checking will
  225.           be added in an upcoming version.
  226.  
  227.           Other Files
  228.  
  229.                SeaMine keeps an error log, under the filename ERRORS.LOG. 
  230.           This contains the dates and times of certain errors, such as
  231.           carrier loss, necessary files not found, etc.  You might want to
  232.           periodically check this log to make sure that important files
  233.           such as the player instructions file or mine data file can be
  234.           found, though I'm sure the frequent and new players will tell
  235.           you this on their own, too.
  236.  
  237.  
  238.           OTHER GAME INFORMATION
  239.  
  240.                A feature in SeaMine itself is the Chat mode, Alt-C.  The
  241.           Sysop can enter Chat mode at any time.  This causes the game's
  242.           key buffer to be emptied into chat mode, though, which may set
  243.           players back who use macros or script files.  To leave Chat mode,
  244.           simply press Escape, and the player will be returned to the
  245.           point at which Chat mode was originally entered.
  246.                The amount of ore in storage in the mines increase each day
  247.           by the productivity in each ore.  The game increments this at
  248.           the first call of the day, when it recreates the LASTON.DAT file
  249.           and moves the prices in the port through their 30-day cycle.  The
  250.           cycle can be reset at any point simply deleting the PORTINFO.DAT
  251.           file, which will send all prices back to those at the first day
  252.           of play.  If you delete the LASTON.DAT file and run the game,
  253.           then all the mines will have their storage increased by their
  254.           productivity, and the PORTINFO.DAT file will be updated, moving
  255.           the prices through the cycle, just as if the program was being
  256.           run for the first time of the day.
  257.                The game is designed to support up to 32,768 players, so
  258.           there should be no problem with number of players who would want
  259.           to play.
  260.                One feature that has not yet been added to the game is time-
  261.           out detection.  At a prompt in the game, a user has unlimited
  262.                                                                           6
  263.           time to answer.  However, if their time has expired by the time
  264.           they finish answering, they will be returned to the BBS to be
  265.           disconnected.  Built-in time-out and hangup will be added in an
  266.           upcoming version.
  267.  
  268.  
  269.           FILES
  270.  
  271.                The following is a list of the programs and data files that
  272.           exist in the SeaMine directory after the game has been run, and
  273.           whether SeaMine generates the file itself ("gen") or requires
  274.           that it already exists ("req"):
  275.  
  276.           Filename       Gen/Req   Purpose
  277.           ------------   -------   -------
  278.           SEAMINE.EXE    N/A       the game itself
  279.           SEACFG.EXE     N/A       configuration editor, generates
  280.                                    SEAMINE.CFG
  281.           MAPMAKE.EXE    N/A       creates initial map file
  282.           SECMAKE.EXE    N/A       generates SECTORS.DAT and MINES.DAT
  283.           SEAEDIT.EXE    N/A       the combined editors
  284.           SEAPACK.EXE    N/A       cleaning utility for purging deleted
  285.                                    players
  286.           SEAMAKE.BAT    N/A       batch file to help with setup
  287.           SEAMINE.INS    req       player instructions for the game
  288.           SEAMINE.DOC    N/A       SeaMine game documentation
  289.           README.1ST     N/A       quick-installation file
  290.           REGIST.FRM     N/A       registration form for SeaMine
  291.           SECTORS.DAT    req       sector data file, the only data file
  292.                                    that MUST exist
  293.           MINES.DAT      req       mine data file, must exist to use
  294.                                    mines, but the game CAN run without it
  295.           PLAYERS.DAT    gen       player data file
  296.           LASTON.DAT     gen       file containing last date the game was  
  297.                                    played
  298.           PORTINFO.DAT   gen       file containing port prices and current
  299.                                    stage in the price cycle
  300.           SEAMINE.CFG    req       file containing game customizations
  301.           MAP.DAT        N/A       map file created by MAPMAKE and read by
  302.                                    SECMAKE
  303.           SCORES.SEA     gen       scoreboard text file, generated by
  304.                                    SEAMINE
  305.           ERRORS.LOG     gen       error log file made by SeaMine
  306.  
  307.  
  308.           REGISTRATION
  309.  
  310.                If you enjoy this game, have not registered, and would like
  311.           to see the additional features which have been added since this
  312.           version, please print and fill out the accompanying ORDER.FRM
  313.           file and send it and a check for $20 to:
  314.  
  315.                                                                           7
  316.                     Chris Allen
  317.                     SeaMine Registration
  318.                     P.O. Box 19765
  319.                     Raleigh, NC 27619
  320.  
  321.                You will receive a disk with the most current commercial
  322.           version, and will be added to the list to receive notices of
  323.           significant new features.  New features I have in mind for an
  324.           upcoming version include additional lesser ports where players
  325.           can sell their ore, the built-in time-out check, and rogue or
  326.           pirate fighters.  Registered users will also receive support on
  327.           problems with the game, so please include your registration
  328.           number with problem reports for faster response.
  329.                If you have ideas for other features to be added, feel free
  330.           to send them to me at the address above.
  331.                The beta testers and I have enjoyed creating and testing
  332.           this program, and hope you enjoy it, too.
  333.