 ________                   __            __________                
 \_____  \   __ __ _____   |  | __  ____  \______   \ __ __   ____  
  /  / \  \ |  |  \\__  \  |  |/ /_/ __ \  |       _/|  |  \ /    \ 
 /   \_/.  \|  |  / / __ \_|    < \  ___/  |    |   \|  |  /|   |  \
 \_____\ \_/|____/ (____  /|__|_ \ \___  > |____|_  /|____/ |___|  /
        \__>            \/      \/     \/         \/             \/ 
							 Version 1.9

GENERAL INFORMATION
-------------------
Title	    : QuakeRun
Description : Front end for Quake and Quake2 
              with easy to make plugins and builtin Genclasses 
              support
              This program will not write anything to the 
              registry =)
Version     : 1.9
Date        : June 23, 1998
Author      : Sebastian "GeN" Bentler
E-mail      : gen@telefragged.com
Web Site    : http://www.telefragged.com/genclasses/
Credits     : SpArK, Gonzo, Dirty and Stalin for testing
Greetings to: All the testers, Sonic, hunTer-o1, HotDoc, 
	      and everyone I forgot...

INSTALLATION
------------
Unzip this file somewhere and run the program. If you have never run
it before you should set your Quake, Quake2 and QuakeRun directory
in the settings menu. Otherwise QuakeRun will not work properly.

If you get an "unexpected error blahblah" or a "wrong version of
runtime dll" error then you have to install the Visual Basic 5.0
runtime dlls (vbrun50.zip). Vbrun50.zip is available for download at:

ON PLUG-INS
----------
I have included the ability to use plug-ins with QuakeRun because there 
are just too much patches out there to hard-code all of them.
Though QuakeRun supports easy-to-make plug-ins the mod makers 
themself or even fans of the mod can make an easy and efficient 
frontend for the mod.
However you can edit the .qrp files with a simple text-editor
like Notepad which is included with Windows or the editor which
is included with MSDOS.
I have included a Dapak plug-in which should be an good example for
making plug-ins for QuakeRun. A look at it will mostlikely
more informative than this whole description =).
For more plug-ins visit the Genclasses homepage 
(http://www.telefragged.com/genclasses/).
If you have any suggestions for controls (see below) I should add
because you need it for your plug-in or just because it would be
cool then drop me a line (gen@telefragged.com).

It works like this:
-------------------
All you see in QuakeRun consists of controls.
the "Modification:" text in the general settings, the dropdown menu
below this text etc.
And all the controls have specific variables defining their appearence
and function. By writing a plug-in you are able to create some types
of controls in QuakeRun (see below for a list of controls, their 
variables and some examples).

To assign a value to a variable (like name, height, etc) of a control you 
should write:
  variable:value
A control is followed by
  {
then you define the variables and then you close the control with
  }

(ie.
label
{
  name:blah
  xpos:120
  ypos:2140
  width:860
  height:255
}
)

Basically a plugin looks like this:

QuakeRunPlugin
{
  name:Name of the plugin
  control
  control
  ...
}

QuakeRun will recognize the following controls:

--------------------------------------------------------------------------------------------

label
  name - the text of the label
  xpos - the x-position of the label
  ypos - the y-position of the label
  height - the height of the label
  width - the width of the label
Quakerun supports up to 24 labels.

a label is for example the text "Modification:" in the General 
settings of QuakeRun

--------------------------------------------------------------------------------------------

checkbox
  name - the text of the checkbox
  xpos - the x-position of the checkbox
  ypos - the y-position of the checkbox
  height - the height of the checkbox
  width - the width of the checkbox
  help - the help text displayed if the user waits with the
         mouse over the checkbox
  commandifchecked - the command added to the commandline
                     (without +, instead of "+timelimit 60"
                     write "timelimit 60") if the checkbox
                     is checked
  checked - use without any value; if this is added then the
            checkbox is checked by default

a checkbox is for example the "Multiplayer game" option in the 
Type of game settings of QuakeRun
Quakerun supports up to 20 checkboxes.

--------------------------------------------------------------------------------------------

optionbutton
  name - the text of the optionbutton
  xpos - the x-position of the optionbutton
  ypos - the y-position of the optionbutton
  height - the height of the optionbutton
  width - the width of the optionbutton
  help - the help text displayed if the user waits with the
         mouse over the optionbutton
  commandifchecked - the command added to the commandline
                     (without +, instead of "+timelimit 60"
                     write "timelimit 60") if the option-
                     button is checked
  checked - use without any value; if this is added then the
            optionbutton is checked by default
  link - a text or number "linking" this optionbutton to 
         other optionbuttons with the same text or number

an optionbutton is for example the "Spawn server" and 
"Connect to server" option in the Type of game settings of 
QuakeRun. Both would have the same link value.
Quakerun supports up to 10 optionbuttons.

--------------------------------------------------------------------------------------------

combobox
  name - the current text of the combobox
  xpos - the x-position of the combobox
  ypos - the y-position of the combobox
  height - the height of the combobox
  width - the width of the combobox
  help - the help text displayed if the user waits with the
         mouse over the combobox
  command - the command added to the commandline (without +, 
            instead of "+timelimit 60" write "timelimit 60");
            if you use ST$ in the command then this will be
            replaced with the current text of the combobox
            (so if you want to set teamplay to the value
             displayed in the box the command would be:
             "teamplay ST$")
  list - a text added to the dropdown menu of the combobox;
         the maximum number of items in the dropdown menu is 10

a combobox is for example the item below the "Modification:" 
label in the general settings of 
QuakeRun. To get the "None" into the dropdown menu you would
write:
list:None
for a further text in the dropdown menu you would then write:
list:blah
you may repeat this up to ten times
Quakerun supports up to 8 comboboxes.

--------------------------------------------------------------------------------------------

flagwindow
  name - the caption of the flagwindow
  help - the help text displayed if the user waits with the
         mouse over the flagwindow
  command - the variable which should be set to the value
            defined by the flags (for altering the deathmatch
            flags of Quake2 this would be "dmflags")
  flagbox - a "subcontrol" of the flagwindow =); 
            it is a checkbox basically
    name - the text of the flagbox
    xpos - the x-position of the flagbox
    ypos - the y-position of the flagbox
    height - the height of the flagbox
    width - the width of the flagbox
    help - the help text displayed if the user waits with the
           mouse over the flagbox
    checked - use without any value; if this is added then the
              flagbox is checked by default
    numberifchecked - the number that is added to the by the 
                      command of the flagwindow defined variable
                      if the flagbox is checked; for the weapons
                      stay flag of the Quake2 deathmatch flags
                      this would be "4"
  button - a subcontrol of the flagwindow, too
           it is like a the "Browse..." button in the general
           settings menu and brings up the flagwindow if clicked
           with the mouse
    name - the text of the button
    xpos - the x-position of the button
    ypos - the y-position of the button
    height - the height of the button
    width - the width of the button
    help - the help text displayed if the user waits with the
           mouse over the button

the window that appears if you click the "DMFlags..." button
in the Type of game settings of QuakeRun is similar to a flag
window.
Quakerun supports up to 2 flagwindows with up to 20 flagboxes
and (of course) only 1 button (would be DMFlags in this 
example).

--------------------------------------------------------------------------------------------

info
  name - the name of the plug-in
  line - a text line of the about text of the plug-in
         if you want to write in the about text:
           the blah plug-in is (c) 1998 by
           GeN
         then you would write:
           line:the blah plug-in is (c) 1998 by
           line:GeN
         you can write many, many lines... so what about
         a story for your plug-in =)
  picture - the picture displayed in the "about plug-in..."
            window; should be in BMP, PCX or GIF format;
            should be 85*85 pixels to fit the picture box
            size precisely

--------------------------------------------------------------------------------------------

COPYRIGHT/PERMISSIONS
---------------------
This program is Copyright (c)1998, Sebastian Bentler.
I am not responsible for any damage this program may cause to your
system or to yourself.

You may distribute this program as long as you include this text 
file untouched AND E-mail me to notify me what you are doing 
with it AND distribute it without any charge.

BUT you MAY NOT distribute this program on any electronic
format without a written permission of me, Sebastian Bentler.
