QUAKELAUNCH HELPFILE Build 23-12-97 freeware release By Jools Chesters (C) Copyright 1996,1997 Jools Chesters email: quakelaunch@joolsc.net website: www.joolsc.net/~joolsc/ TABLE OF CONTENTS NEW INSTALLATION RUNNING MAIN SCREEN MULTIPLAYER SCREEN CONFIGURATION SCREEN MISCELLANEOUS SCREEN FEEDBACK/LICENCE/THANKS _________________________________________________________________ NEW INSTALLATION First thing is to extract the QL.ZIP file to a temporary directory and run the SETUP.EXE file to install it in the same directory as QUAKE.EXE. You can then delete any files left from the temporary directory. This release also supports Quake 2 as long as it is installed into the same directory as Quake. This should not be a problem as the directories and files that Quake 2 uses will not conflict with Quake. Quakelaunch expects to see an \ID1\MAPS directory under the \QUAKE directory, it will create one if not found. Also a \QUAKEC directory under \QUAKE is needed to store the zipped patches. One will also be created by Quakelaunch if needed. You need to store your maps in the \QUAKE\ID1\MAPS directory but you need to store them as their original ZIP files (which are extracted automatically on launching). If Quakelaunch sees a BSP file that was not left from last time it ran, it will give you the option of zipping it up (with it's text file, if found) this saves the hassle of zipping up hundreds of maps yourself. Also patches such as TC's, Bots and Weapon changes etc. these need to be stored as their original ZIP files in the \QUAKE\QUAKEC directory (again automatically extracted). Make sure the maps ZIP filename is the same as the BSP name and also if there is a TXT file that it is also the same as the filename. This also applies to the patches, make sure the TXT file has the same name as the filename. It is very important that your maps and patches are compressed into ZIP files as Quakelaunch may delete any files it considers to be left from last time it has run, they will also not show in Quakelaunch's menus. On launching Quake/Quake 2 the patch files will be extracted into the \QUAKE\QUAKEC directory and if the ZIP has a path tree it will be extracted relative to the \QUAKE\QUAKEC directory. If you are running QuakeWorld then there is an option above the listbox to 'put in own dir', this will extract the files into a directory with the same name as the ZIP file. The map ZIP files will be extracted into the \QUAKE\ID1\MAPS directory on launching, if you are running QuakeWorld then they will be extracted into the \QUAKE\QW\MAPS directory instead. if you are running Quake 2 then they will be extracted into the \QUAKE\BASEQ2\MAPS directory. If you are also running a patch at the same time and the 'put in own dir' is checked then it will put the maps in a \MAPS directory under the patches one. For example a patch ZIP file stored in \QUAKE\QUAKEC: NEW1.ZIP has PROGS.DAT, PAK0.PAK, NEW1.TXT, \SOUND\PLAYER\DEATH1.WAV and \SOUND\WEAPONS\3.WAV in it. This would then extract out like this: \QUAKE\QUAKEC\PROGS.DAT \QUAKE\QUAKEC\PAK0.PAK \QUAKE\QUAKEC\NEW1.TXT \QUAKE\QUAKEC\SOUND\PLAYER\DEATH1.WAV \QUAKE\QUAKEC\SOUND\WEAPONS\3.WAV (Or for QuakeWorld, if the patch's 'put in own dir' is checked the QUAKEC will be NEW1) For example a map ZIP file stored in \QUAKE\ID1\MAPS: DM7.ZIP has DM7.BSP and DM7.TXT in it. This would then extract out like this: \QUAKE\ID1/MAPS\DM7.BSP \QUAKE\ID1\MAPS\DM7.TXT (Or if running QuakeWorld the ID1 will be QW, if the patch's 'put in own dir' is not checked) (If both 'put in own dir' are checked the ID1 will be NEW1) You can also store a CUSTOM.CFG in the root of the patch ZIP, this will be executed with the patch when it is run. Any files in any directories under \QUAKE\QUAKEC are removed when Quakelaunch is next run. If there are any files which Quakelaunch considers to not belong to a patch or a map then a message shows asking whether you want to delete them or not. The overall directory structure must look something like this: C:\CDGAMES\QUAKE is where QUAKE.EXE/QUAKE2.EXE is. C:\CDGAMES\QUAKE\ID1\MAPS is where all maps as ZIP files are. C:\CDGAMES\QUAKE\QUAKEC is where all patches as ZIP files are. (You don't have to have a TXT file to go with a map or patch, if you try to view it then nothing will display) _________________________________________________________________ RUNNING When you run Quakelaunch for the first time you need to set it up correctly, firstly making sure you have the correct directory structure (see NEW INSTALLATION). If you have either the Hipnotic or Rogue mission packs installed Quakelaunch will tell you that they need to be moved, the PAK files are moved into the \QUAKE\QUAKEC directory and renamed as HIPNOTIC.MP1 or ROGUE.MP2. They can be moved back to their original directories by clicking the appropriate button on the MISCELLANEOUS SCREEN. On the first screen there is a CONFIGURATION SCREEN tab, choose that and setup which version of Quake or Quake 2 you wish to use. When Quakelaunch is first started it may tell you that there are files that need to be deleted, it will give you the option to remove them. This is usually because they need to be zipped up into a map or patch ZIP. You can setup a password on startup by changing the default of no password from the MISCELLANEOUS SCREEN. You will be asked the password every time Quakelaunch is started (if you've set one up that is). Most buttons and options are self explanatory if you know anything about Quake/Quake 2 and its options. Look at the different screen sections just in case you don't. If you wish to look at the text file that is included in a map or a patch ZIP file then double click the file to view it. These are for viewing only and when extracted they are deleted. If you choose the 'Don't use' option on the maps then when Quake/Quake 2 is launched it will allow you to choose a map to start at. If you have either the Hipnotic or Rogue mission packs installed (Quake only) you can choose appropriate maps from either, depending on which has been chosen on the CONFIGURATION SCREEN. If a patch is used then when Quake is running the 'L' key will bring up the console and show you a list of all the IMPULSE commands read from the text file included in the patch. If there are any saved games stored from single player Quake/Quake 2 it will show a screen allowing you to pick one from a list to load in. If you don't want to load a saved game just choose the Cancel button. It will also tell you the name of the map it was saved against and also the details about kills, secrets and skill level (not Quake 2 though). When you have launched Quake/Quake 2, Quakelaunch will exit to free up as much memory as possible for running the game. If you click the status bar at the bottom of the Quakelaunch screen it will allow you to send email directly to me. _________________________________________________________________ MAIN SCREEN NO JOYSTICK, will switch off the annoying joystick calibration on original Quake. [this will disable the joystick under Quake 2] NO CD AUDIO, will not play any music from the CD player. FREELOOK, select if you want to use the mouse to free look around all the time. WINMEM or x1000 Heapsize, depending on which version of Quake you are running (see CONFIGURATION SCREEN) this will add a command line parameter telling Quake about the number of Megabytes of memory you want to allocate when run. It will not let you type less than 8 in, or choose 0 to ignore this parameter. WinQuake, GLQuake and QuakeWorld use a heapsize parameter which is in KB, so Quakelaunch will multiply the amount up. VIDEO MODE, Type in the Video mode number to start Quake with, 0 is the default, it will allow up to 20. This parameter is not used in VQuake or GLQuake. [this parameter is also used in Quake 2, it will work for both software and OpenGL drivers] SKILL LEVEL, Choose from the combobox from Easy to Nightmare. MULTIPLAYER, will start a Multiplayer game and connect to the number in the configuration screen, warns you if one is not set. Also another way to use is by using Gamespy/QSpy to launch QL.EXE instead of Quake/Quake 2 directly. If you make sure Gamespy/QSpy is setup so that 'Only copy IP address to clipboard' is checked and do a CTRL-C before launching then Quakelaunch will use the IP address in the clipboard as the address to connect to. It will clear the clipboard after using the address. SINGLE PLAYER, will start a normal single player game. BOTS/LISTEN SERVER, will start a Multiplayer game but allow connections to come in. Use this for any Bot patches. LAUNCH, launches Quake with the current map/patch and settings. This will also exit Quakelaunch to free up as much memory as possible for the game. I recommend putting a shortcut on the desktop for Quakelaunch as it will be a lot quicker to load back again once you have exited Quake. Q95.BAT, launches the Q95.BAT file for Quake Internet play, this option requires the 'connect to' box to have something in it (or an IP address in the clipboard). This will also exit Quakelaunch when run. This button is not relevant for WinQuake, GLQuake, QuakeWorld or Quake 2 as they use Windows networking for Multiplayer games. DON'T RUN (on maps and patches listboxes), if checked on maps will ask when launched which map you want to start with instead of extracting the currently selected one, and show you the full name of the map at the same time. On patches it will just ignore the patch currently selected. PUT IN OWN DIR (on maps and patches listboxes), to see an explanation of how these work see NEW INSTALLATION. MAPS (listbox), the selected map will be extracted automatically when Quake/Quake 2 is launched and you will start at this map. (Double click map name to see the associated text file in the ZIP.) If you also click in the Scr column of a map it will allow you to enter a score for that map. Also clicking on the column headers will sort the list by that type. It remembers which map you last played and will select it again next time you startup. It will also sort the box by the date last played as a default. By right clicking in the box you can move the maps ZIP to another category (see below) or rename, delete it, or open the ZIP file itself. An added feature with this listbox is that you can drag and drop ZIP files from the Desktop/Explorer and Quakelaunch will move them into its listbox. CATEGORY (maps combobox), allows you to create and select different categories for maps. Choose a different category from the combobox to see the maps stored in that category. By right clicking you have the option to add new categories, delete or rename the currently selected one. PATCHES (listbox), the selected patch will be extracted automatically when Quake/Quake 2 is launched and will allow you to run modifications to the Quake/Quake 2 environment e.g. run Bots. (Double click the patch to see associated text file in the ZIP.) This will also allow you to click the column headers, remember which one you last played, sort the patches and right click the same way as the maps. An added feature with this list box is that you can drag and drop ZIP files from the Desktop/Explorer and Quakelaunch will move them into it's \QUAKE\QUAKEC directory. CATEGORY (patches combobox), allows you to create and select different categories for patches. Choose a different category from the combobox to see the patches stored in that category. By right clicking you have the option to add new categories, delete or rename the currently selected one. QUICK LAUNCH BUTTONS, These allow you to save the current Quakelaunch configuration (including which map/patch is selected and which version of Quake has been chosen) to allow you to quickly start Quake/Quake 2 in a certain configuration. You must right click on the appropriate button to get a menu, either to update the button, change the name or clear it. Just clicking on the button once will launch Quake with the settings you saved just as if you clicked the normal launch button. _________________________________________________________________ MULTIPLAYER SCREEN NONE, if you are making a connection out use this option. (default) LISTEN, if you are waiting for a connection in use this option. DEDICATED, runs a dedicated session allowing connections in. NO. OF PLAYERS, enter here the maximum number of players allowed to connect in, only relevant if you choose LISTEN or DEDICATED from above. (2 to 32) DEATHMATCH, if you are playing a deathmatch game. Enter the deathmatch level you want to play at. (default is 1) COOPERATIVE, if you are playing a cooperative game. Enter the cooperative level you want to play at. (default is none) [not currently supported in Quake 2] TEAMPLAY, if you are playing a team game (all players with same pants colours will be on the same team on normal Quake). Enter the teamplay level you want to play at. (default is none) [for Quake 2 use the right click menu options to set the DMFLAGS on the command line, see CONFIGURATION SCREEN] PLAYER, enter your name used in Quake/Quake 2 messages here. SHIRT (combobox), select the colour for your shirt. [not relevant in Quake 2] PANTS (combobox), select the colour for your pants. [not relevant in Quake 2] QUAKELAUNCH NAME MAKER, Click this button to go to a separate screen where you can create a Quake/Quake 2 name that uses the extended characters. The screen will show a grid of all the available letters with several buttons to choose from. The name that was in the PLAYER box will be shown in the bottom left in the Quake character set. You have the option to Clear name and start afresh or Backspace if you clicked on the wrong letter. OK will accept the name and return you to the previous screen. Cancel will abandon any changes you have made and return you to the previous screen. FRAGLIMIT, set a limit to the number of frags per map, if the maximum is reached the map finishes. Enter 0 for no limit. (0 to 99) (default is none) TIMELIMIT, set a limit on the time for a map, when the time limit is reached the map finishes. Enter 0 for no limit. (0 to 99) (default is none) SAME MAP, will keep playing the same map over and over (only really useful if you are running a Server and you want everyone to play one particular map only.) (default is unchecked) [for Quake 2 use the right click menu options to set the DMFLAGS on the command line, see CONFIGURATION SCREEN] NOEXIT, will not allow any players to exit the map. (default is unchecked) The following options are only relevant to the DOS versions of Quake. PORT, this is the port address of your com port in hexadecimal, see below for examples. IRQ, this is the IRQ for your com port, see below for examples. BAUD, this is the baud rate at which you wish to run your com port at, generally try the fastest first and if this does not work select progressively lower amounts until it does. MODEM?, this is to tell Quake whether the com port settings are for connecting with a modem or if not checked as a direct connect. CLEAR, the modem string to clear the modem. STARTUP, the modem string to startup the modem. SHUTDOWN, the modem string to hang-up the modem. TONE DIAL?, check this box if you use tone dialling, if not checked it will use pulse dialling. For the com port and IRQ settings under a standard PC they are configured as follows: COM1 port 0x3F8 irq 4 COM2 port 0x2F8 irq 3 COM3 port 0x3E8 irq 4 COM4 port 0x2E8 irq 3 If you select any of the PORT, IRQ or BAUD boxes as 0 then when launching it will ignore the com port settings and attempt to connect to whatever you have selected through a network. (Or the Internet if you are connected). If you are connecting to an Internet address, it will automatically decide not to use the modem even if the settings are valid. Do not blame me if the modem routines have problems dialling out and initialising, the original Quake's modem routines still seem to be very buggy even in the later versions. In some cases it may be better to use a comms program or dial-up networking to dial/answer and then keeping the connection open run Quake as direct connect. _________________________________________________________________ CONFIGURATION SCREEN COMMAND LINE TO START QUAKE WITH, This is the actual command used to run Quake or Quake 2, usually QUAKE.EXE. But you can select other names from the radio buttons below if you have any different versions of Quake. Also you can manually add extra options on the end of the command line as well. By right clicking the text box you can also switch on and off parameters relevant to the version of Quake or Quake 2 you are running. The exception to this is QWSV.EXE as the command line parameters for the QuakeWorld Server need to be done manually. QUAKE/WINQUAKE/VQUAKE/GLQUAKE/QUAKE 2 etc., These are used to select the appropriate version of Quake you wish to run, if you have particular command line arguments that are not relevant for a version of Quake you select then you need to unselect/remove them from the command line. NORMAL QUAKE/MISSION PACK 1?/MISSION PACK 2?, These add or remove the command line parameters used for running the extra mission packs. The map selections will also change depending upon which has been chosen here. [not used in Quake 2] NUMBER TO CONNECT TO IN MULTIPLAYER, when playing a Multiplayer game or running Q95.BAT the system requires a number to dial to or an Internet/Network address to connect to. If you choose the option to select a file, the filename will appear in this box instead. This will be overridden if there is an IP address in the clipboard when Quakelaunch starts, this will be used instead. CHOOSE A FILE FOR CONNECTION INFO, this gives you a filename box where you can choose the file to read connection data from. This is really designed to read HTML files (such as the Stomped or Ironman lists or the file that RIFT can create), in fact any table based HTML file should work. But it can be used to select a file you have created yourself. If you wish to do this then the file must be in a standard ASCII format like this: Name of site|Connection number|Other details This must be one line for each site, the | (split bar) is used as a delimiter. You could for example have a list of phone numbers of friends you play with or names and addresses of people on a LAN, or just your favourite Internet Quake servers. A box will come up at launching to allow you to select what to connect to. NAME OF DEMO TO RECORD, this is where you can type in the name of a demo you want to record of your game, this will work in all modes of play. [not used for Quake 2 in this version] CHOOSE FILENAME TO RECORD, this is where you can pick a name from a list of demos already created or type in a new name. (these are all stored in the \QUAKE directory.) [not used for Quake 2 in this version] NAME OF DEMO TO PLAY, this is where you can type in the name of a demo you want to play, remember if it was recorded using a particular map or patch make sure that these are selected on the main screen. [not used for Quake 2 in this version] CHOOSE FILENAME TO PLAY, this is where you can pick a name from a list of demos already created. (these are all stored in the \QUAKE directory.) [not used for Quake 2 in this version] EDIT CONFIG.CFG, allows you to edit the CONFIG.CFG file for Quake settings. [not reccommended for Quake 2 though] EDIT AUTOEXEC.CFG, allows you to edit the AUTOEXEC.CFG file for Quake/Quake 2 settings. EDIT Q95.BAT, allows you to edit the Q95.BAT file for modifying how the Internet play is set. _________________________________________________________________ MISCELLANEOUS SCREEN TEAM, this is for teamplay, allowing you to join a particular team, useful for clan games. A maximum of 4 letters can be used. (QuakeWorld only) RATE, allows you to change the rate at which a server will send data back to you, this also affects the frame rate of your play. The higher the rate the higher the frame rate, although a standard modem will usually not be able to handle a rate higher than 2500. This ranges from 1000-10000. (QuakeWorld only) R_WATERALPHA, the amount of transparency of the water in GLQuake, ranges from 0 to 1, 0 is totally transparent and 1 is totally opaque. 0.4 seems to be a good balance. (GLQuake only) R_MIRRORALPHA, the amount of transparency of the mirror texture (stained glass window on the start level) in GLQuake, ranges from 0 to 1, 0 is totally transparent and 1 is totally opaque. (GLQuake only) SKIN, this allows you to pick a skin for Internet play, you should store all skins (PCX files) in your \QUAKE\QW\SKINS\ directory. If you do not choose a skin the standard base Quake skin will be used. You must select a valid skin from the male/female directories for use in Quake 2. (QuakeWorld/Quake 2 only) CUSTOM CFG, this allows you to pick a CFG file that is to be executed when Quake starts, you may want to put in any console commands that may be specific to your hardware for example. It must be stored in the \QUAKE directory. SERVER PASSWORD, type in the password needed to connect to the server (if one has been specifically set). (QuakeWorld only) SPECTATOR PASSWORD, type in the password to allow you to connect to the server as a spectator, if there is no password then just type 1. (QuakeWorld only) GETTING WEAPON, DON'T SWITCH IF HIGHER THAN (combobox), this allows you to choose the highest weapon to keep active even if you pickup a better weapon. (QuakeWorld only) GETTING BACKPACK, DON'T SWITCH IF HIGHER THAN (combobox), this allows you to choose the highest weapon to keep active even if you pickup a better weapon in a backpack. (QuakeWorld only) MOVE MISSION PACK 1 FILES BACK, you can move the PAK file used for the Rogue Mission Pack 1 back to it's original location, if you do Quakelaunch will have to exit as it requires the file to be in a particular place. MOVE MISSION PACK 2 FILES BACK, you can move the PAK file used for the Hipnotic Mission Pack 2 back to it's original location, if you do Quakelaunch will have to exit as it requires the file to be in a particular place. MOVE ALL MISSION PACK FILES BACK, you can move both the PAK files used for the Rogue and Hipnotic Mission Packs back to their original location, if you do Quakelaunch will have to exit as it requires the files to be in a particular place. CHANGE QUAKELAUNCH PASSWORD, you can setup a password when Quakelaunch starts, to prevent access. Enter the password first to change to a new password, or leave blank if you haven't yet put one in. If you want to remove the password then leave the new password blank, it will then not ask you for a password when it starts. The buttons for various selected websites can be clicked to jump to the particular site, your default web browser will load and attempt to load the particular page in. The Ironman and Stomped server lists are very useful to get a current list of servers running, just save the HTML source to the \QUAKE directory and you can pick the file from the CONFIGURATION SCREEN. _________________________________________________________________ FEEDBACK/LICENCE/THANKS Quakelaunch Build 23-12-97 freeware release Copyright (c) 1996,1997 Jools Chesters. All rights reserved. email: quakelaunch@joolsc.net website: www.joolsc.net/~joolsc/ THE INFORMATION PROVIDED IS PROVIDED 'AS IS' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL JOOLS CHESTERS BE LIABLE FOR ANY DAMAGES WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, EVEN IF JOOLS CHESTERS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. The program executables, help file and related text files are freeware and may be used for any period of time. The program executables, help file and related text files may not be distributed as part of any commercial package without the express permission of Jools Chesters. I am always glad to hear from anyone who is unhappy about the way Quakelaunch works or who has any problems with it, or anyone who has constructive criticism, or enhancements they would like to see, or even just to say you like it! Any comments, queries or bug reports regarding Quakelaunch please email quakelaunch@joolsc.net Anyone who is interested in beta testing new versions I would be glad to hear from, I already have a few people testing it but any new beta testers would be very helpful. This is a big thanks to Qdeath, Link and Bluesky who between them created a great Quake Theme. You can find this theme at www.anet-stl.com/~sword/. Thanks to Qdeath for the permission to use a couple of animated cursors from the Quake Theme as animated buttons in Quakelaunch. Thanks also to Keith Soltys who suggested the password option on starting up. HAPPY QUAKING!