=========================================================================
                     THE BOT JOHNNY PROFILE MANAGER
                        (c) 1998 John Carpenter
                           Version 1.72 beta
=========================================================================
                        http://jb.quake2.co.uk/
                          semprini@buttle.com
=========================================================================
                              INSTRUCTIONS
=========================================================================


---INTRODUCTION

Profile Manager is a companion program to BotJohnny.  It is designed to
allow you to quickly and easily rename and delete profiles and also edit
more advanced areas of the program.  It is probably a good idea to be
familiar with BotJohnny before using this.

WARNING - it is not a good idea to rename or delete the profile currently
in use by BotJohnny.

You are also not given an option to rename a bot.  This is because the name
of each bot is used by the profiles to identify it and if you rename a bot
it would confuse all the profiles using it.


---INSTALLATION

The version you have probably came with BotJohnny so requires no further
installation.  However, if you downloaded this separately, for some reason,
then just copy the contents of this archive (PMHelp.txt and
ProfileManager.exe) into the main BotJohnny program folder.


---STARTING PROFILE MANAGER

Profile Manager is completely independent to BotJohnny, so you can either
just run it as you would a normal Windows program, or you can click the
"Profile" button at the top left of BotJohnny.


---THE MAIN SCREEN

The main screen gives you two lists with various buttons in-between (and
underneath).

The AVAILABLE PROFILES list, on the left gives you a list of all profiles
that have been created with BotJohnny.  To rename a profile, click it, then
click the "Rename" button at the bottom of the list.  You will then
be asked to type in the new name.  Do this then click OK.  To delete a profile,
click it, then click the "Delete" button at the bottom of the list.
You will be asked if you are sure and, if so, the entire profile will be
completely deleted.  DO NOT DELETE *ALL* YOUR PROFILES.

Click "QUIT" to exit Profile Manager.

Click "ABOUT" to see the version number.

Click "INSTRUCTIONS" to see this file.

The other buttons in-between these lists are described in full shortly.

The checkbox marked "SHOW PROFILES FOR SELECTED BOT ONLY" allows you to
choose a bot from the list on the right and see all the profiles that
use it.  If you have a lot of profiles, this may be quite slow.

The list on the right shows all BOTS CURRENTLY RECOGNISED by BotJohnny.
You can double click one to edit it (or click it then click "Edit").  See
below for more information.

You can also delete one if you like (not recommended, but it's up to you..!)
by clicking it, then clicking "Delete" at the bottom of the list.

Alternatively, you can add a new one by clicking the ADD button.  You will
be asked to type in the name for the bot and you can also optionally choose
an existing bot to base the settings on.  If you do this, all files from the
existing bot will be copied across for the new bot to use.  This is a good
idea otherwise you will have to manually copy across the various files into
the new bot's folder.  When you do this, it will automatically bring up the
bot setup editor.


---EDITING A BOT

Editing a bot gives you a little window with a few tabs on it.  Well, surely
that's all the help you need!?

Oh, alright.  The tabs are described below.  When you're happy, click OK
to save the changes or CANCEL if you want to abandon them.


CHAT FILE

From here you can edit the kind of chat file the bot uses.

"None" sets that the bot doesn't use a chat file.  (Or at least it doesn't use
a type supported by BotJohnny).

"Eraser style bot file" uses the chat file format used by Eraser.

"Individual text files" means the bot chat works in the same way as CRbot's
bot chat, in that you have a series of text files, one for each "category"
of chat.  If you select this, you must then specify the names of the text
files.  Click "add" on the left, type in the name of the file and click OK.
Keep doing that until the list has all the files you want to be able to
edit.  (Click a file, then "delete" to get rid of it).  NOTE, if the chat
type is set to this, the files are edited DIRECTLY from the bot's own
folder.


FILE COPYING

Choose how each of the six files supported by BotJohnny are copied.  This
actually sets the default for each profile.  The profiles can, themselves,
have different settings here.

For each type of file you are allowed to choose the folder you wish it to
be copied into.  (Leave this blank if you want to specify the path in the
filename).  Beside this, type in the filename you want it to be saved as.

See the BotJohnny instructions for MORE ADVANCED CONFIGURATION for more
information.  Be aware that the CHAT file is for Eraser style chat only.
(So if the bot doesn't support this, then you will probably want to
leave this file blank).

Underneath this you can choose what happens to the custom AUTOEXEC file,
whether it's copied like a normal file, or whether it's added to the
LAUNCHER.CFG or BJ.CFG files.



PATHS AND AUTOEXEC

You can choose which GAME this bot uses.  You set up the default paths
for each game separately (see "Edit Game Paths" from the main menu).

Underneath this type in the name of the sub-folder where the bot resides.
(Eg "Eraser").

You then come across the "Map Routes Sub-Folder".  This specifies the
location where the bot stores its map routing files.  This is a sub-folder
of where the bot resides.  If you leave it blank, then the routes are stored
in the bot's folder.  (So if this was set to "routes" for Eraser, the full
path used by the program would be something like "c:\quake2\eraser\routes")

The "Map Routes Filter" specifies how the program finds which files are
for the map routes.  Put a "*" (asterisk) symbol where you want the name
of the map to be inserted.  For example, for Eraser you would have this
set to "*.zipped".  If there is more than one possibility for the file,
separate the filters by semi-colons.  For example:

*.zipped;*.zip;*.rtz;*.rt2

Click "Edit the AutoExec Wizard Commands" button to get to the...
autoexec wizard commands editor... see below..



SKILL LEVELS

Each bot can have its own list of skill levels.  Choose whether you want
to use the in-built Eraser skill levels (these range from 0 to 3 and have
my own custom names).

Or, you can "use skills list (left)".  If you do this you will need to type
in the skill names yourself.  At the top choose type in the starting
skill level.  This is the value of the first skill in the list.  (Usually 0
(zero) but it can be 1 or anything you like).

Next, you need to type the skills into the list.  You can have as many as
you like.  The nearer the top of the list the skill is, the easier it is.

To ADD a skill level to the list, click ADD then type in the name of the
skill to add then click OK.

To REMOVE a skill level from the list, click it then click REMOVE.

To EDIT a skill level, double click it, then type in the new name for it
and slap OK.

You can move a skill level up and down the list by clicking it then
clicking the "Move Up" and "Move Down" buttons.



---EDIT GAMES PATHS

Click "Edit Game Paths" to bring up the... game paths editor..  This shows
you a list of available games.  For the time being this will probably just
show "Quake2" which is automatically created the first time you run version
1.7 of BotJohnny.  (Note, if you are upgrading from an older version of
BotJohnny, you must run BotJohnny itself before doing this)
In theory, it should be able to cope with most other games that use the
iD method of console and command-line.

The paths here are only used when you create a new profile.  These are
default settings only.  Each profile can have its own paths,
filenames and so on independently.

Click ADD if you want to create a new game.  Then type in the name of the
game you wish to add.

Click a game, then click DELETE to, well, delete a game from the list.
IF YOU DO THIS, MAKE SURE THE GAME IS NOT IN USE BY ANY OF THE BOT
PLUG-INS OR YOU COULD STUFF THINGS UP A BIT.

Click the game, then click EDIT (or double click the game) to edit it
(see in a second).

Again, you can't edit the name of the game because this is used by
the bots.

Click OK to get out of this bit.


GAME EDITOR

Click any buttons marked "..." to use a file requester to help you
choose the path.

These options have been divided up into "Paths" and "Advanced" tabs to
make this clearer.  "Paths" stores the most commonly used path names
that you might want to change, whereas "Advanced" is for paths and files
that will only be of interest to some.

THE PATHS TAB

LOCATION OF GAME EXE FILE : this is the path where the game's "exe" file
is kept.  (Eg "c:\quake2\")

NAME OF GAME EXE FILE : this is the name of the "exe" file used to run the
game.  (Eg "quake2.exe")

LOCATION OF MAPS : this is the full path to where the maps are kept.
(Eg "c:\quake2\baseq2\maps")

OPTIONAL CD DATA PATH : well, this is an optional path to where the CD
data is held, obviously.. you can leave this blank to omit it.

LOCATION OF MODELS : the path to where the models are kept.

THE ADVANCED TAB

LOCATION OF MAPS README : this may well be the same as the maps path,
but it is the folder where the Readme for a map BSP file may be found.
(In my case I have created a sub-folder of my baseq2\maps foldler called
"info" and I copy all the readme's in there)

SKIN FILE FILTER : in each model's folder this tells BotJohnny how to
find out which skins it can display in the skin requester.  The default
is "_i.pcx".  This means that any files ending in "_i.pcx" are proper
skins for the plug-in player models.

LAUNCH BATCH FILE : if you want to use a batch file when you launch
(for example to store various 3dfx environment variables) type the name
of the file here.  ** DO NOT INCLUDE THE COMMAND TO LAUNCH QUAKE2 HERE **
BotJohnny will take this file and add the launch command below so that you
get all the proper command-line syntax in.

MODEL NAME TO DISPLAY : when you click "View Model" in the BotJohnny
model examiner it will try to show you this model in the specified
(or default) model viewer program.  For Quake2 this should probably
always read "tris.md2".

HOW TO START THE GAME : this allows you to change the type of window
used when the game is started.  It is very unlikely that you will
ever need to change this.  The default settings is "Hidden".

LAUNCH DIRECTLY FROM BATCH FILE?  If this is checked, BotJohnny
creates its own batch file which consists of yours plus the command-line
and then executes that.  If this is unchecked, BotJohnny executes
your batch file (directly), waits for it to be exited, and then
launches Quake2 as normal.

MAKE SURE SAMPLE IS FINISHED BEFORE LAUNCHING?  This only makes a difference
if a sample has been chosen from within BotJohnny.  Normally this option is not
checked and Quake2 will play the sample and launch more or less simultaneously.
If this is checked, the sample will be played and BotJohnny will wait until it
has completely finished before launching.


---SEX EDITOR

Not even remotely as interesting as it sounds.  This allows you to specify
whether a game model is male or female.  This is currently only implemented
because the Famkebot, when it spawns a named bot, requires the bot's sex to
be present also.

BotJohnny presumes that all models are male unless told otherwise.  This is
not a sexist thing, it's just because most models genuinely ARE male.

Anyway, this brings up a list of male and female models.  The male models show
all models installed on your system minus all ones in the female list (which is
the contents of your "female.cfg" file).  Each game can have its own female file.
To change which game's file you are editing, choose it from the combo box at
the top of the window.

Double click a model to give it a quick sex change.  Either that or you can drag
and drop the models between the two lists.

Then click OK to save, CANCEL to abort.  NOTE - currently changing game does NOT
save the list and you will lose changes.


---CUSTOM MAP LISTS

The Custom Map List editor allows you to manually edit any custom map lists,
or add your own.  An easier way to do this is to use the PAK FILE EXAMINER
from within BotJohnny which will create the list automatically from a "pak"
file.  However, it has been pointed out to me that you can create your own
maps lists even if the maps are in the list already.  This way you can group
maps together, for example "One on One Deathmatch Arenas" and "Large Maps
for 15 or more players" etc.

NOTE that in this editor, when you change to a different map list or click
the "close" button, the map lists are SAVED.  If you do not want to save
the list click REVERT to restore it to how it was at the last save.

Also note that as of version 1.7 you can use BotJohnny itself to edit
all the maps and you may prefer to do it from there.

Firstly you should choose the name of the game you wish to edit from the
combo box at the top.  Underneath this, choose the category you wish to
edit.  To add a new category click "New" then type in the name of the list.
To completely erase a map choose it then click "REMOVE".  To change the
name of the category, click "RENAME", then type in the new name and click
OK.  Note, if you try to give the map a name that is in use by another
category you will get an error. 

When you choose a map list, you will see a list of all the maps beneath it.
Each map comes with its proper name (eg "q2ctf1") and its full title (eg
"McKinley Revival")

To edit a map, double click it (or click it then click "Edit").  You can then
choose to change the name and title of the map.  (Note, clicking "Get"
will bring up the requester described below.  Double click a map, or click
it then click "Select This Map" and it will use it as the map's name.)

To delete it, click it then click "Delete".

To add a new map, click a map name, then click "add", type in the name
of the new map, then click OK.  The map will be added above the clicked
map name.  (Or at the end of the list if no maps are selected).

To move a map up or down the list, click it then click the "Up" and
"Down" buttons.

To quickly rename a map, click its name once, wait, then click it again
and you can type in the new name.  (You can't change the title this way,
however)

Clicking "GET" will bring up a big list of maps.  BotJohnny scans your
Quake2 folder, your "baseq2" folder and your ACE, CRbot and Eraser
folders for all PAK files and adds the contents to this list.  It also
lists all your custom Quake2 maps.  Simply double click a map (or click it
then click "Add to Maps List" and it will be added either to the end of
the maps list or just after the currently selected map (if there is one)
Click CLOSE when you have finished here.  (You can keep this open when
changing maps if you like, but it's probably not a good idea to keep it
up when the Custom Maps Editor window has been closed)

Click REVERT to undo changes.

Click CLOSE to close this window (saving changes).



---THE AUTOEXEC WIZARD COMMANDS EDITOR

Each plug-in bot can have its own list of commands for the BotJohnny
AutoExec wizard.

When you edit a profile, go to to the "Paths and AutoExec" tab, and
click the "Edit the AutoExec Wizard Commands" button, you will see this
editor.

If the current bot plug-in does not have its own list of autoexec
commands, it will give you the option of using the default set.

You will then see a list of all the commands.  If you right click
a command you will get a little menu allowing you to EDIT it,
DELETE it, MOVE it UP or DOWN or ADD a new command.

If you edit a command or add a new one, another little window will pop
up containing the command and its description.  The command is what
will get executed in the Quake2 console.  The description is simply
some help for the user when they see it in the list.  Edit it as much
as you like then click OK to keep the changes or CANCEL not to.

Back in the main editor, clicking OK will save your new list and
CANCEL will abandon all changes.


---COMMAND-LINE PARAMETERS

Note - Parameters you supply only need quotes if they contain a space,
       otherwise they are optional.
	   
	   You can only bring up one editor at a time.


Syntax:  GAME="<name of game>"
Example: c:\program manager\botjohnny\ProfileManager.exe GAME="Quake2"

This brings up the Game Path editor window for the specified game.  (In
the example, Quake2).  When this window is closed, the program exits.


Syntax:  BOT="<name of bot>"
Example: c:\program manager\botjohnny\ProfileManager.exe BOT="Eraser"

This brings up the Bot Setup editor window as if you had chosen it from
the list on the right of the main window and clicked Edit.  This allows
you to change various bits like the chat file format, game used,
routing information, skill levels, file copying etc.  You can also
get to the game editor from here.  However, once this window is
closed the program exits.


Syntax:  CUSTOMMAPS
Example: c:\program manager\botjohnny\ProfileManager.exe CustomMaps

This brings up the Custom Maps editor without the need to go through
the main program menu.


Syntax: FONTNAME="<name of font to use>"
Example: c:\program manager\botjohnny\ProfileManager.exe FONTNAME="Times New Roman"
This forxes all controls in the program to use the specified font name.  See the
BotJohnny instructions file for more information.


Syntax: FONTSIZE="<font size>"
Example: c:\program manager\botjohnny\ProfileManager.exe FONTSIZE=8
or:      c:\program manager\botjohnny\ProfileManager.exe FONTSIZE=8 FONTNAME="MS Sans Serif"

Forces all controls in the program to use the same size of font.  If you set this
higher than the normal font size (10) you may find that parts of words get chopped off.
See the BotJohnny instructions file for more information.


---CREDITS

Profile Manager (c) 1998 John Carpenter

Thanks also to Josh Holdway (author of QuickStart) for a useful bug report!

This program is designed to be distributed alongside BotJohnny, however it
may be distributed in its own right if you feel that this is necessary.

Please see the BotJohnny readme file for full credits, disclaimers and
distribution requirements.


---VERSION HISTORY

VERSION 1.72

x  Deathmatch Flags editor has been written in anticpation of new deathmatch
   flag format in BotJohnny


VERSION 1.71 beta

x  GET button now brings up the correct list from the Custom Map Editor
   (thanks bod!)
x  Drag and drop sex now brings up the "Stop" sign when you are over something
   you can't drop over
x  Pressing F2 in any text box will bring up the "Zoom" box just like in BotJohnny
x  FONTSIZE and FONTNAME command-line options have been added just like BotJohnny


VERSION 1.7 beta

x  Re-written Custom Map List Editor for new format
x  New option to set path to Map Readme file in Game Path Editor
x  Tabified Game Paths Editor
x  Loads of internal changes made to coincide with path changes in BotJohnny
x  Option to change Game being edited in Sex Editor and Custom Maps Editor


VERSION 1.61

x  Path selector is now resizable.  (And yes that is it..)


VERSION 1.6

x  Option added to allow you to Bot Config Editor allowing you to either use
   Eraser style btos config file or the bot template.


VERSION 1.53

x  Error handling has been tightened up considerably all over.
x  Drag and Drop Sex Editing... cor!
x  Sex Editor is now resizable
x  Game Path Editor is now resizable


VERSION 1.52

x  Options to specify location of "Special Skins Folder" (for bots which need
   to have their own versions of skins and models) and "Readme file" (if
   this is blank, it will be guessed.)
x  Option to set that instead of adding the command-line to the end of the batch
   file, BotJohnny will wait for the batch file to be exited before launching
   itself.
x  Option to rename a map category
x  Option to ensure that the sample finishes playing before Quake2 is launched
   (put in so that if, for some reason, there are any conflicts with sound, you
   can sort them out, but usually Quake2 might as well be loading while the sample
   plays)
x  Small bug fix which could cause PM to fall over if you tried to use the Sex
   Editor before a game was created.
x  "Show profiles for selected bot only" should now work
x  When you edit a batch file, notepad now gets the focus..!
x  Adding a new bot based on another bot now copies the files properly
x  "AutoExec Wizard" options now moved onto "Chat" tab
x  Option to include default model


VERSION 1.51

x  Several improvements made to Custom Maps List Editor:
   - NEW button now works
   - REMOVE button to delete a whole map list
   - GET button which displays a list the contents of all PAK files plus
     your custom maps and allows you to easily add them to the maps list.
x  New command line added.  Just put "CustomMaps" on the command-line and it
   will bring up the Custom Map editor.
x  Option added to Game Paths Editor to specify how the game is started (ie
   the window type).  This was added as an experiment to help prevent the
   "black screen bug".. (Shudder..!)

VERSION 1.5

x  Version number for Profile Manager changed so that it matches that of BotJohnny.
x  You can now choose the batch file you wish to run from the Game Paths
   Editor.
x  You can now edit the Game paths directly from the bot by clicking the
   new "Edit" button
x  Two command lines have been added:
   - GAME="name of game"
   - BOT="name of bot"
   See above.  These were added so that this program could be better integrated
   into BotJohnny.
x  Removed the "Update Paths" button to fit in with new BotJohnny 1.5 set up.
x  Option to edit the name of the model to view (when you examine a model in
   BotJohnny) in the Game Paths Editor.  The default is "TRIS.MD2".
x  When you change the Quake2 location, it will change the location of maps
   and models automatically (providing the game is set to QUAKE2.EXE)
x  When you add a new bot, you can choose to base the new one on an existing bot.
   If you do this, all files for this bot will be copied across.  This makes
   adding a new bot so much easier and less fiddly.
  


VERSION 1.2

x  New keyboard shortcuts in autoexec wizard editor - CTRL+U to move item up,
   CTRL+D to move item down, DEL to delete item and ENTER to edit item.
x  You can now set the map route sub-folder and filter
x  Option to view only profiles for the selected bot
x  Option to update all profiles for each bot to use the default paths


VERSION 1.1

x  This instruction file has been written
x  Custom Map List Editor has been added
x  Skill levels can be edited by double clicking
x  AutoExec Wizard Commands Editor has been added
