.TOPIC:
VBBS Doors Documentation

                                     VBBS 6.12 Documentation -- 15-A-1


         ͻ
          CHAPTER 15  ANNEX A          VBBS DOORS DOCUMENTATION          
         ͼ

         GENERAL INFORMATION 
         
   
         1 - Dropfiles

                Dropfiles (DF) are the link between the BBS and the game 
         itself.  A DF contains all of the required info for the game to 
         operate properly.  This includes the user's "handle" (so he al-
         ways uses the same slot in the game), the user's COM port & speed
         (so the game knows where to send the data), and other miscellan-
         eous info - the BBS name, sysop name, user's time remaining (on 
         the BBS), etc.

         Here is a list of many of the common dropfile formats:

                Types                   VBBS Supported?
           -----------------            ---------------
             CALLINFO.BBS                    No
                CHAIN.TXT                    Yes
                 DOOR.SYS                    Yes
             DORINFOx.DEF                    Yes
              PCBOARD.SYS                    No
              SFDOORS.DAT                    No

                At the present time VBBS supports the CHAIN.TXT, DORINFOx.DEF
          and DOOR.SYS dropfiles.  They are fairly simple to use; the only one
          needing an extended explanation is the DORINFOx.DEF.  All the drop-
          files are created in your \VBBS directory.

                The 'x' in DORINFOx.DEF is the node number that the user is 
          logged in on.  On a single-line system this will always be a '1',
          the normal local node would be a '0', and node 2 would be a '2'.
          Many of the newer games that are coming out allow for multiple 
          players in the game at the same time, and some even allow inter-
          action between the players.  Almost all of these games require 
          the DORINFOx.DEF dropfile.

                The DOOR.SYS dropfile is a fairly generic dropfile accessible
         to many games and is VERY common.   It requires no special work to 
         use with a game.  The CHAIN.TXT dropfile is used predominantly by 
         WWIV-based doors, and most can be used with VBBS (see section 3.3 
         for more information.)


         2 - FOSSIL Drivers

                FOSSIL drivers are external TSR's that handle carrier de-
         tection routines for programs that cannot do it themselves.  You
         do not HAVE to use a FOSSIL driver for all games, so you do not
         have to load one at start-up (unless your modem configuration 
         requires one.)  Sometimes they are required if you are using a 
         high-speed modem, but this DOES vary.

                                     VBBS 6.12 Documentation -- 15-A-2

                The two most commonly used FOSSIL drivers are BNU and X00.
         Both allow installation before running a door and removal afterwards.
         See section 4.2 for information or where you can get these pro-
         grams. You will want to go through the documentation files on the 
         FOSSIL driver for specific installation information, as the setup
         varies widely based on the hardware used.


         Preparation, Installation, and Execution
         

         1 - Game Files

                Installing the game onto your system is the first step to-
         wards getting it to work.  The first thing you should do when you 
         get a new game is unZIP/deARJ/unPAK/whatever the compressed file
         is into its own directory.  Then load up your favorite text edi-
         tor/viewer and read the sysop documentation.  Almost all ques-
         tions can be answered with the docs included with the games.
         While you are reading, take note of the following information:

         Installation - does this program self-install?
                      - does this program need to be in a special
                        directory to run?
                      - does this program have a configuration file
                        that needs to be made / altered?
                      - how do you initialize the game files?
         Dropfiles    - does it use one of the 3 supported by VBBS
                        or does it require a special dropfile?
         FOSSIL Driver- Is one needed for this program to run?
         Command Line - Quite often there are MANY switches that
                        can be used on the command line. Make SURE
                        that you note ALL the possible switches.
                      - Major switches to look for are:
                            Dropfile Type              Dropfile Path
                            FOSSIL (Y/N)               Node Number Info.
                            Configuration Filename     Local Play Mode

                Before you continue, make sure the game will support one 
         of the three dropfiles that VBBS supports (either DOOR.SYS, 
         DORINFOx.DEF, or CHAIN.TXT.)  If it does not then there are two 
         other ways you can get the game to run with your BBS.

         1> Get a Door Converter program - these programs allow you to
            take a dropfile that you already have (ie DOOR.SYS) and run 
            it through the converter to produce a different dropfile for-
            mat (see section 3.2 for more detailed information).

         2> Some games allow you to create your own dropfile for use with
            the game.  If it is possible to do so then all you need to do
            is write down the information that has to appear in the file
            and the order it must appear.  You can then either write up a
            script or a batch file to create the new dropfile for the game.

                                     VBBS 6.12 Documentation -- 15-A-3


                If neither of these options are available then place the game
         on a floppy for storage and check to see if any local (or network)
         sysops can give you a hand. The most important rule when setting
         up a game is 'Ask Lots Of Questions.'  If you cannot find the an-
         swers in the docs, then you NEED to ask someone else. Do not give
         up on the game if it does not seem to work when it is first in-
         stalled, many games require a bit of fine-tuning to match your 
         specific system setup.

                At this point run any installation program (if supplied) 
         and fill in the required information.  Remember to write down any
         information that the program gives you during the installation.

                Most doors require you to modify a configuration file.  You
         can do this with your favorite text editor and make any changes
         required.  Note: Make a back-up copy of this file before you make
         the changes!  These changes normally entail inserting your BBS's
         name, the sysop's name, any file paths that don't match the de-
         faults, etc. If the program allows multi-line use and requires a
         separate file for the configuration of each line, then make sure
         to make as many copies as you need (changing the filename) and 
         then edit in the information that needs to be different between 
         each configuration file.

                Once the program is installed, you should perform initial-
         ization of the game files (if that is required) before continuing
         on to the next step.  This will allow you to immediately go into 
         the game to see if you have everything set up properly.  If the 
         game has a 'LOCAL' mode, try to run it at this point.  This will 
         allow you to test for any bugs in the configuration as far as the
         game files are concerned.  After the 'local' bugs are taken care 
         of you will then want to move on to the next section.  It is re-
         commended that you do not make the door open to all your users 
         until you have had a friend (or fellow sysop) call from remote
         to test the modem end of it.


         2 - Batch Files

                The single most important part of getting a door to run is
         having the correct batch file setup.   Not all games require a 
         batch file to run, but we strongly recommend that you do use them 
         for every door. It makes it easier to find problems, and allows 
         far more versatility. You may also be required to create batch 
         files for running the nightly maintenance for the game.  Both 
         files are covered here.

             A - Game Batch Files

                This is where the information you took down on the command
         line comes in handy.  You need to determine what switches will be
         required, and you will also have to discern if you need more than
         one batch file.

                                     VBBS 6.12 Documentation -- 15-A-4


         Here is an example batch file (most will be similar in format):

         DUMBGM.BAT

                Line 1-> @echo off
                Line 2-> c:
                Line 3-> cd c:\vbbs\games\dumbgame
                Line 4-> dumbgame /pc:\vbbs\ dumbgm1.cfg
                Line 5-> cd c:\vbbs

         Line 1 -> Not required, turns off screen output of the batch
                   file. Note: If you are not using DOS 5.0 you cannot
                   use the @ symbol (so the line would read 'echo off')

         Line 2/3->Just a precaution to make absolutely SURE you are on
                   the correct drive and in the right directory.  Not
                   required, but a GOOD thing to do in ALL batch files.

         Line 4 -> Actual game command line.  This game requires the
                   program name followed by a '/p' and the path to your
                   dropfile (which is ALWAYS the \VBBS directory.) and
                   then the name of the configuration file it is going
                   to use (if this game was run on node 2 the config file
                   would be dumbgm2.cfg)

         Line 5 -> This is just another 'make sure' line to restore the
                   system to the right directory.  If you do NOT return to
                   the \VBBS directory after running an external program
                   you will have empty files and CONTROL.DAT files popping
                   up all over your hard drive.  These files are harmless
                   and can be deleted, but they are a pain.

                While most batch files will contain more 'meat' they will
         usually follow the same basic structure.  Again, refer to your sysop
         docs that came with the game for more detailed information.

                A final note on batch files.  If a door requires a differ-
         ent command line when being run off of different nodes (hence
         multiple batch files) you should give the batch file a name of 1
         to 7 characters followed by the number of the node that the batch
         file is for.  The command to run the game would then be the file-
         name followed by a %1.  For example, the command line 

               'C:\VBBS\DUMBGM%1' 

         would run the files as follows:

                User on Node 0  --- Filename: DUMBGM0.BAT
                User on Node 1  --- Filename: DUMBGM1.BAT
                User on Node 4  --- Filename: DUMBGM4.BAT

                Some games that require you to use a FOSSIL driver and have a
         'local' switch will require a different batch file for remote and
         local play.  If a game does require a separate file for local play
         (and it does NOT use a dropfile to do so) you may NOT be 

                                     VBBS 6.12 Documentation -- 15-A-5


         able to do a <L>og-in Local from the WFC screen because the pro-
         gram will not detect a carrier and then exit.  That style of game
         will require you to use the local node (Node 0) to play.


             B - Maintenance Batch Files

                Some games require that you run a special program at the
         end of each day.  These programs do things like updating high 
         score files, maintenance on the game universe, and sometimes 
         making backups of the data files.  Any game that requires such
         maintenance will list the command line information in their re-
         spective doc files.  All you need to do is create a batch file 
         resembling your game batch file, except that it will contain the
         maintenance command line.  At this point you have two ways to 
         implement the nightly maintenance:  either set it up as an indi-
         vidual nightly event or make a master batch file that runs all of
         your nightly maintenance at one time.

                No matter which way you choose to do it, you must first 
         create the maintenance file.  All you have to do is create a
         batch file following the same structure as your game batch, but
         using the command line that the game docs require for the main-
         tenance portion.  If you are going to run each individually then
         you are done with file work at this point.
    
                If you wish to run all of your maintenance at once, then you
         should take all of your maintenance batch files and place them 
         all into one BIG batch file.

                At this point you need to go to your \VBBS directory and run
         the VCONFIG program.  Select option '8. Events Configuration' and you
         will be shown a screen like this:

                ## Time  Last Run  Command line

                A)dd Event E)dit Event Esc) Quit

         Select [A]dd Event and the cursor will be placed under the Time 
         section of the first blank line.  Enter the time that you wish to
         run the batch file and remember it is in Military Time (00:01 to 
         23:59.)  The last run section should be left blank by just hit-
         ting [Enter] at this point.  The command line is where you type 
         the complete path and filename to the batch file you wish to run.
         If you are running each file individually you will need to add 
         one new event for each file, although it is best to only use one
         large file for maintenance because each time it runs an event it
         has to reload the BBS and initialize the modem, which is just
         extra work for the system to do.  If you have any questions on 
         events then just see  EVENTS Configuration for more information.        

                                     VBBS 6.12 Documentation -- 15-A-6


         3 - Interfacing with the BBS

                And now we get to the fun part -- actually installing the
         games into your BBS.  There are 3 different ways you can load a 
         door; from the VBBS door config, from a script, or from a func-
         tion block.  Each has its own merits and each will be covered in
         turn.

             A - VBBS Door Configuration Menu

                VBBS comes complete with a built-in door handling area.
         The door area places all the games in one section, allows you to
         place certain restrictions on access, and gives the option for 
         using a credit system.  It also offers the easiest setup of the
         three methods:

            Load up VCONFIG.EXE from the \VBBS directory.
            Enter the VCONFIG section 'A. Doors Configuration.'
            Select [F1] to add a 'New Game' line to the menu.
            Move the highlight bar over the 'New Game' line and hit 
                [ENTER].

            You will now see the following screen:

                        1. Program Name: New Game
                        2. Command Line:
                        3. Security Lvl: 255
                        4. Access Flag:
                        5. Single User:  Yes
                        6. Credit Cost:  0

                        D)elete This Entry

                        [ESC] to quit

         1. Program Name: -> This is what the user will see when he enters
                             your doors area.
         2. Command Line: -> This is what you will use to run the game. If
                             you are using a batch file, all you need to 
                             have is the COMPLETE path to the batch file 
                             and the batch filename (no extension).  If
                             the program has a different batch file for
                             each NODE on your BBS then the batch file 
                             name would be listed like this:

                                 C:\VBBS\BATCH\DUMBGM%1

                             The %1 tells VBBS to place the node # at the 
                             end of the filename, thereby using the proper
                             batch file for each node.
         3. Security Lvl: -> This is the minimum security level (SL) nee-
                             ded to play this game.  It is set to 255 by 
                             default.  You should leave it at that until 

                                     VBBS 6.12 Documentation -- 15-A-7


                             you are ready to have it tried from remote.
                             
         4. Access Flag:  -> This is the access flag required to play this
                             game.  NOTE: Access flags (also called "H
                             flags") are the flags that are set in the
                             user editor by pressing the [H] key.  They
                             are NOT the general flags.  If this field
                             is blank then anyone with the proper SL (or 
                             higher) can access this game.  If this has a
                             letter in it (and it can use from A to Z)
                             then the user must ALSO have the flag ON 
                             (listed in his Uedit screen).  This is use-
                             ful for games that you only want certain 
                             people to have access to, including game edi-
                             tors and such.                            
         5. Single User:  -> Set to YES if only one person can be playing
                             at once, set to NO if it is a multi-player 
                             game.  Most multi-player games require that
                             DOS's SHARE is loaded into memory before they
                             can be run.  If this is the case you will 
                             need to add it to your AUTOEXEC.BAT file.
         6. Credit Cost:  -> This allows you to set an individual cost in
                             credits per game.                              

             B - Script Installation

         Script : Any program created using VBBS' script language.
                  All scripts have the .V extension, are located in the
                  script directory (see  PATHS Configuration)
                  and are compiled with VCOM.EXE.  Remember that any time 
                  you make changes to a script, you MUST recompile it.

                Installing in a script can be simple or complex, depending
         on the type of setup you would like to have.  Due to space con-
         straints, only the actual running of a single door from within a
         script will be covered.
                For running more than one door, you would need a script
         for each door.

         *** Special Note ***
        
         Before you attempt to create the script you SHOULD read through
         the script documentation to become familiar with script commands.

         When setting up a door from within a script you need to decide
         how you would like to run, for lack of a better term, the 'loop
         stop'.  When you exit a door that was loaded from a script, the
         system returns to the first line of the script, thereby creating
         an endless loop.  To avoid this, you have one of two options:

                                     VBBS 6.12 Documentation -- 15-A-8


         use either an $Extra variable or a $Flag.  Both formats will be
         covered here.

         When using an $Extra variable:

         DUMBGAME.V
    
         test $extra2 = DumbGame exitgame        <--- This line tests to 
                                                      see if they just re-
                                                      turned from the game.
         setextra 2 "DumbGame"                   <--- This sets the 'loop
                                                      stop'.
         $gametoplay = "c:\vbbs\batch\dumbgm%1"  <-These lines run the ac-
                                                   tual door.
         door $gametoplay                       <-Remember that the %1 is
                                                  the node number VBBS adds
                                                  to the command line. If
                                                  you do NOT need to have 
                                                  multiple batch files,
                                                  then do not use the %1.
         # exitgame                             <--- These last lines turn
         $blnk = " "                                 off the 'loop stop'
         setextra 2 $blnk                            so the user can play
                                                     the game again.
         exit start                             <--- This is the line that
                                                     sends the user back to
                                                     the function block 
                                                     that he/she came from.

         When using a $Flag

         $q = $flags instr N               <--- These two lines do the same
         testval $q <> 0 exitgame               thing that the 'test' line
                                                above does.
         setflags N on                     <--- This turns on the 'loop 
                                                stop'
         $gametoplay = "c:\vbbs\batch\dumbgm%1" <--- as same commands above
         door $gametoplay                       <---
         # exitgame
         setflags N off                         <--- Turns 'loop stop' off
         exit start                             <--- as same command above

                You will need to run VCOM to compile the scripts you have
         written into code that VBBS can use.  You compile by using the command
         line

                VCOM <script name> 

         while at the DOS prompt and in your scripts directory.  If there
         are any errors it will let you know.  The compiler aborts after
         the first error, so there may be more than one.  Lastly, go into

                                     VBBS 6.12 Documentation -- 15-A-9


         your function block (START.FB in the examples above) and add the
         following line on any but the first two lines in the .FB file:

                Z 001 2 Dumbgame
                |  |  |   ^------This is the script name, NO extension
                |  |  ^----------This is the code to tell VBBS it is run-
                |  |              ning a script
                |  ^-------------This is the SL to be able to use the key
                |                 (and run the script).
                ^----------------This is the key to press at the menu to
                                 load and run the script.

             C-Function Block Installation

         Function Block: File containing the commands for each menu of the
                         BBS.  All FB's have the extension .FB and are 
                         placed in the script directory (see VBBS560.DOC
                         -- PATHS Configuration for more info.)

                All you need to do is select the function block that you 
         wish to add the game to, pull up the .FB with your text editor 
         and add the command using the following format.
    
         Note: Do NOT place this command on the 1st or 2nd line of the
               function block, as those are reserved for other info.

         Z 001 4 c:\vbbs\batch\dumbgm%1
         |  |  |   ^------This is the complete path to the batch file 
         |  |  |          and the filename to be run.
         |  |  ^----------This is the code to tell VBBS it is running a 
         |  |             command that it needs to shrink the BBS out of
         |  |             memory for it to run.
         |  ^-------------This is the SL to be able to use the key (and
         |                run the door.)
         ^----------------This is the key to press at the menu to load 
                          and run the door.

                If you wish to create a separate function block just for 
         games, then you will need to create a new set of menus for it as
         well as create the .FB file.  For specific information read the
         VSCRIPT appendix.

                                     VBBS 6.12 Documentation -- 15-A-10


         Programs and Utilities
         


         1 - DoorWay

                DoorWay is a program written by Marshall Dudley to assist
         in the setting up and running of almost ANY program through a 
         modem.  There are many different ways to use DoorWay, but the 
         single most common use is to access the DOS prompt from a remote
         computer.  Here is a simple setup for using DOORWAY.EXE for this
         purpose.  NOTE: The DoorWay files come compressed and include
         the DOORWAY.DOC file explaining all the switches used.  You will
         need to do some fine-tuning with ANY program that you set up
         using the DOORWAY.EXE, so keep a copy of the doc file handy!!

         1> Get a copy of DoorWay v2.05 or higher and place the main
            executable file (DOORWAY.EXE) either in your path or directly
            into your \VBBS directory.  (The latter is best, however.)

         2> Load up your SYSOP.FB file and add the following command line
            to it:

                A 255 4 SHELL.BAT
                ^------------------Use any character not already in
                                   the SYSOP.FB.

         3> In your \VBBS directory create this batch file:

                SHELL.BAT
         
         Line 1 -> @echo off
         Line 2 -> DOORWAY SYS /G:ON /V:B^U /M:1000 /B:MSZ /C:DOS

                The program has many useful applications, and can often
         make the difference in whether you can get a game to run on your
         BBS or not. Just remember, DoorWay allows ANY program to be run
         as a door; it does not have to be a program written specifically
         for a BBS.


         2 - DoorMaster

                DoorMaster(DM) is a program written by Michael P. Otto to
         convert the various dropfile formats into any of the other for-
         mats. It supports the dropfiles created by 52 different software
         packages (see the DM docs for the actual listing.)  Use of this
         program will allow you to use a game that requires a dropfile 
         format that is not currently supported by VBBS directly (like 
         WildCat 2.x's CALLINFO format.)  You will need to read the docu-
         mentation for the actual command lines as the program has a very
         extensive set of commands available.

                                     VBBS 6.12 Documentation -- 15-A-11

         3 - VReturn/WWIVDoor

         DOS Interrupts: Codes required by certain games to function.
                         These games were written as WWIV doors and 
                         cannot be run on VBBS without a program called
                         VRETURN (see below for more information on 
                         VRETURN).  NOTE: This only applies to games that
                         require the CHAIN.TXT dropfile to run.  VBBS
                         supports many common dropfile formats and almost
                         all door programs give you options for the type
                         dropfile to place in the configuration during
                         setup or installation.


                VRETURN is a program used to intercept the calls to the
         DOS interrupts and allow the game to run without actually using
         the interrupts.  VRETURN is available to any registered WWIV 
         sysop, although there is a version that is not based on the WWIV
         code that is being written at this time (check any local Vir-
         tualNet BBS for information on this program).

                WWIVDoor is an accessory program to VRETURN that allows
         easier use of all WWIV-style doors.  It automatically calls on 
         VRETURN to handle the DOS interrupts and also handles any local
         logins to bypass the carrier detection phase of the game being 
         used.  WWIVDoor is written by Scott C. Duensing and includes all
         the general information you will need to run any of the various
         WWIV-style doors using this program.


         4 - Virtual ToolKit

                The Virtual ToolKit is a programming assistant for use 
         in the writing of single or multi-node games for use with VBBS.
         The ToolKit is presently available for VBBS-DOS and a special
         version will soon be available for use with VBBS-OS/2.  There 
         are very few games written specifically for OS/2, so this new 
         VTK will open up some opportunities for all you game programmers
         out there.  The VTK's are available only thru the VBBS author;
         please see the Registration Form for more info.

                                     VBBS 6.12 Documentation -- 15-A-12

         Miscellaneous Information
         

         1 - Enhancements

                There are many different scripts and source modifications
         written to improve the versatility of the on-line games area. The
         changes that are made with these 'programs' include multiple game
         topics, special restricted areas, and other visual changes and 
         improvements.

                Other enhancements that you can use include modifying your
         batch files to create lists of games played.  You can copy the 
         games' high-score files into your text directory to create entire
         bulletin sections that are made up of your game scores.

         

                Well, that is all you should need to get almost ANY game 
         up and running with VBBS.  Almost ALL problems you will run into
         are either an error in a command line or a software/hardware in-
         compatibility (which are usually fixable with a FOSSIL driver).
         We can not say it often enough or loud enough --

                            ALWAYS READ THE DOCS!!! 

         We all hate the time it takes, but it will save you LOTS of head-
         aches later on down the BBSing road.  It is a good habit to have,
         and it pays out some serious dividends as well.
 
         


