1 - Introduction

1.1 - Introduction
The Quake ToolKit is a small application which should aid you in your Quake III Arena needs. This application contains several small tools which can be used by skin or model makers, mapmakers, server administrators and Team Players. The Quake ToolKit has a number of features which will be explained in this document.

1.2 - Installation
Just unzip all the files into a directory of your choice. Run toolkit.exe and the configuration screen will automatically show up. Configure all settings to your personal wishes and click OK. The Quake ToolKit is now ready for use. You can select "configure" from the pop-up menu (open by right clicking anywhere in the main window) to change your preferences at any later time.

2 - The Tools

View the Quake Toolkit helpfile for more detailed information on the individual tools. Do right click -> "help" in the main window to view the helpfile, or click on the help buttons marked with a ? in the tool interfaces to jump directly to the tool's chapter in in the helpfile.

2.1 - Arena Creation Tool
This tool enables you to make arena files in a matter of seconds. An arena file defines all the specific settings for your map and will make it appear in the list of maps within Quake III Arena itself.

2.2 - Bot Maker
The bot maker is an easy to use tool which creates the nescessary bot files for your own bot-design. Botfiles are a number of scriptfiles which contain information about the behaviour, weapon preferences, weapon skills, personality stuff, chatlines and more about the bot. With the Bot Maker, you can configure each little aspect of the bot, and let the ToolKit do all the hard scripting work for you. The Bot Maker was designed with user friendlyness in mind. Unlike a lot of other bot-making software, the Quake ToolKit doesn't use the internal game-terms, but simple,
easy to understand english descriptions of what everything is. You don't have to be a programmer to understand how bots are scripted anymore. It's easy for even the newest Quake player.

2.3 - Map Compiler GUI
This tool can be compared to the well known development tool Q3Build.With the Compiler GUI you can select a .map file, choose what compiling processes you will run (bsp, vis and light) and what flags you whish to use. Press the compile button and compiling starts without all the dos commandline mess.

2.4 - Profile Manager
If you're one of those people that have to share one computer (and Quake3 installation) with someone else, then this is the tool for you. The Profile Manager allows you to create seperate profiles for different persons (or maybe you'd like to use different setups on the same machine). The Profile Manager stores each seperate profile (or in other words, each seperate renamed q3config.cfg file) in the profile folder located in the Quake ToolKit installation folder. When you click the 'launch' button, the currently selected (active) profile will be copied to your baseq3 folder (overwriting the current one!!) and Q3A will be launched, using the settings stored in the q3config.cfg file that just has been copied. If you've changed any settings (or just completed another map on nightmare) then quit Q3A and click the 'save' button to save your settings. A copy (or rather a back-up) will be made of the current q3config in the baseq3 folder and that copy will be renamed and again be placed in the Toolkit's profiles folder.

2.5 - Random Team Generator
This handy little tool was written by SithLord, a good friend of mine. The RTG was not intended to be an internal part of the Quake ToolKit, but I and SithLord decided to merge the programmed code of both applications into one package so the RTG is a part of the ToolKit. With the RTG you can enter a number of players, and create random teams with those players. This way you'll never again have to fight about who's with who on what team. The RTG decides for you. And if you have a clan with more than 50 players, don't worry, you can save the player lists wherever you want, saving you a lot of trouble, time and sore fingers. I have included two lists for the RTG in the RTG Lists folder located in the ToolKit installation folder. The Q3A Bots.lst file contains all default Quake III Arena Bots.

2.6 - RoQ Compiler Wizard
Since the release of Team Arena (and the 1.27 pointreleases) it is possible to make small videofiles and include them in a map, or use them instead of a levelshot in the Team Arena menu. A RoQ video file must be build up from tga files using the RoQ compiler (which is an external executable which can be downloaded from ftp.idsoftware.com). The instructions that the compiler needs are sent to it through a param file. The Quake ToolKit RoQ Compiler will create this param file for you. It will ask for all information needed to build the param file, and it will start the compile process by itself. The easy to use wizard-like setup makes it easy for even the newest newbies. Note that you MUST download and install the actual RoQ Compiler itself (roq.exe). You can setup the Quake ToolKit to work with this compiler from withing the configuration screen. The ToolKit RoQ Compiler is nothing more than a shell that builds the param file for you.

2.7 - Server Configuration
The Server Configuration tool is a tool with which you can set up your own LAN or Internet server and launch it from the ToolKit with one single click on a button. Your server can be set up as FFA, TeamDM, 1vs1, CTF and any of the team arena gametypes server, and even with a completely differend Mod. You have full control over the server's settings. Unlike most server config utilities, the ToolKit can configure each map independently. You can set
gametype, minimum number of players, the frag-, time- and capturelimits and message of the day for each map in your map rotation. Tired of playing CTF on and on for hours on the same server? With the Server Configuration utility in the Quake ToolKit you can create a server that cycles through the gametypes, so that each match is a new experience. This way you can even run through the same map rotation four times, each with differend gametypes! You can also set global server options, like a hostname, bot skill, remote control password and some additional options.

3 - Extra Features

3.1 - Small QuickButton window and Tray Icon
Don't want the Quake ToolKit to fill up your screen, but you want quick access to the tools (and even to Q3Radiant)? Right click in the main window and you can choose to open up the QuickButton Window or to Minimize the Main Window to a TrayIcon in the Windows TaskBar. The first option closes the Main Window and opens up a very small window with small buttons each linking to a tool.
When you minimize the Main Window to a Tray Icon a red Quake logo appears in the right bottom of your screen, next to the clock. You can right-click on the icon to open up the menu with links to each of the tools. As you can see, you can make the ToolKit as small as you want.

3.2 - Support for custom skins
The way the Quake ToolKit now handles skins has significantly improved since the very first version of the ToolKit. Every piece of the ToolKit's main window is now skinnable. Refer to the file skins.html for more information on how to create new skins for the Quake ToolKit.

3.3 - Startup parameters
If you want a tool to automatically start whenever you start the Quake Toolkit, you can use the startup parameters. These parameters have to be put behind the startup command to start the Quake Toolkit. Here's a list of available startup parameters with their functions:

So for instance, if you wanted to run the Map Compiler GUI at startup, you could start the ToolKit with
C:\Program Files\QToolkit\Toolkit.exe -compiler

Different startup parameters can be combined to perform more actions on startup.

4.3 - Check for Updates
If at any time you would like to see if there is a new version of the Quake ToolKit available, right click in the main window and select "Check for Updates". Your default webbrowser will be opened and the Quake ToolKit update page will be displayed, telling you if you should update or not.

4 - FAQ

4.1 - How can I configure the Quake ToolKit?
Before doing anything with the ToolKit you must first configure it. The configuration window will pop up automatically the first time you start the application. If you missed this, or accidently clicked Ok, you can always open this window again. Right click on the background of the main window and click on 'Configure'. I think the configuration is easy enough to use without further explanation. In this screen you can load a skin and set the path to a number of executables.

4.2 - How can I select another skin?
You can select a different skin in the Quake ToolKit configuration window. See the first question in the FAQ for more info.

4.3 - I'm not sure what I'm doing wrong, but there's definately something wrong
See paragraph 4.4

4.4 - Where can I report bugs?
Send me a mail at eraser@planetquake.com. Please include detailed information on the problem, if possible a description on how to recreate the problem. Also please tell me the version of the ToolKit that you are currently using, and the OS that you are running. If you have a problem with the Map Compiler GUI, then send me the q3map.bat file (located in the toolkit installation) as it is right after the problem occured as well. Also let me know if the compiler (q3map, q3map2 or bspc) gave any errors.
For problems with the Server Configuration tool, send me the cfg it has created (it creates serverconfig.cfg in the baseq3 folder by default) and the quake3.bat file the toolkit has created when you chose to run Quake 3 with your server configuration. If there's errors in the Quake 3 console, then those could be important as well for me to know.

4.5 - If I have any kick-ass ideas, where should I be to make my voice heard?
Send me a mail at eraser@planetquake.com. I'm desperately in need of more ideas for these small tools, or additions to existing tools. Your name will ofcourse be included in the list of credits

4.6 - I've got some experience with programming. Can I join the development team?
People with fresh ideas for the Quake Toolkit are always welcome, especially if they can work out those ideas themselves. There are a few requirements though. First of all, it is very important that you have at least some experience working with Borland Delphi. Also, your project must 'fit' in the toolkit. Don't use a completely different interface as the standard interfaces. The Quake ToolKit must look like one cohesive application. And last but not least, you can take a little bit of criticism! If I see the need to change something to your project then I'm authorized to do so. If you don't like changes I've made then you can always withdraw your project from the Quake ToolKit. If you want more info on the basic Toolkit setup (some things you need to know to get started), then mail me at eraser@planetquake.com and I'll send it to you right away.

4.7 - Where can I find an update for the Quake ToolKit?
Our website is located at www.planetquake.com/eoc. You can also download other Quake related material there such as maps, articles and recammed demos.

5 - Version History

1.54:
-Added enw Q3Map2 2.5.3/2.5.4 switches: -custinfoparms and -lightmapsize N for -light
-Fixed Map Compiler GUI becoming a wreck if a wrong Q3/RTCW pathname was given with a custom mod folder name entered as well.

1.53:
-Added new Q3Map2 2.5.2 switches: -subdivisions and -bounceonly
-Added startup parameters (view paragraph 3.3 for more info)
-Added "Check For Updates" item under right-click context menu from main window.
-Fixed Map Compiler GUI using Q3 custom mod folder settings when editing an RTCW map using custom mod folder settings (big doh! here).
-Fixed RTCW doing nothing when starting SP map (intro cinematic is played before the map is loaded though)

1.52:
-Added q3map2 switches: convert, debuginset, mi, mv, nohint, np, debugaxis, debugcluster, debugorigin, faster, bouncescale, bsp2map, snap, samples
-Added bspc -ext switch
-Added lightmap import and export buttons
-Added option to run BSPC twice for RTCW SP aas file compilation (create both aas files in one run)
-Added skin preview to the configuration window's appearance tab
-Added jpg file support to skins
-Fixed "Tournament" gametype in Map Compiler GUI referring to g_gametype 2 instead of 1.
-Fixed starting RTCW SP with devmap instead of spdevmap
-Fixed using -game switch for bspc when using RTCW
-Fixed compiler GUI trying to read map info data from bsp or aas files
-Fixed Run button ignoring selected gametype
-Fixed aasopt and cluster switches unusable due to locked bsp2aas/bsp2map switches
-Fixed problem with starting Radiant from paths containing spaces
-Map Compiler GUI interface panel status saved on close.
-Checks for already running instances of the program on startup

1.51:
-Added new q3map2 switches and removed old non-functional ones
-Added the option to save/load compile setup presets/configs
-Added a file info box to compiler window
-Added the option to add custom bot names to arena files
-Fixed -area and -point entry fields
-All compile switches show a function description at the bottom of the window on mouse-over
-Map Compiler GUI's interface reworked

1.5:
-Added Return to Castle Wolfenstein support to Map Compiler GUI
-Added option to load botfiles in Bot Maker
-Added Punkbuster option to Server Config
-Expanded the Server Configuration tool. Now includes every serverside cvar under advanced settings
-Fixed problem with long pathnames for q3map2
-Fixed bug causing the Bot Maker to forget the walking characteristic value of the bot
-Fixed parameter options in Map Compiler GUI
-Fixed bspc -fs_game flag
-Fixed errors in scale range indications on Bot Maker interface
-Reworked the helpfile

for full version history, read the version history.txt file

6 - Credits, thanks & contact

Jerry 'Eraser' Laman
Programming, Research & Design
eraser@planetquake.com

Rick 'r3tina' Laman
Research, Testing and Suggestions
r3tina@planetquake.com

Remco 'SithLord' Mooijweer
RTG Programming
sithlord@planetquake.com

Thanks go to

• o'dium for pointing out the problem with spaces in filenames with the RoQ compiler.
• Brenda Make for her support and suggestions
• Old_Fellow for pointing out some missing q3map2 switches
• Todtsteltzer for his various tips and suggestions
  
  
• White Ants Systemhouse BV for the Delphi TWinTaskBar component
  Visit theirwebsite at www.whiteants.com
• EC Software for the Delphi helpfile components
  Visit their website at www.ec-software.com
• id software for making such a kick ass game
  Visit their website at www.idsoftware.com
• Ydnar for his excellent q3map2 compiler
  Visit his website at www.shaderlab.com
• Also pay a visit to the amazing Quake3World Forums.
  Visit at www.quake3world.com/forums

VISIT OUR WEBSITE AT: HTTP://WWW.PLANETQUAKE.COM/EOC