/=----------------=[ R e a d M e   F i l e   f o r   W F   R a d i o   S c r i p t   v 1 . 1 0 ]
| by =QoA= Roger aka Roger Hutchings (roger.hutchings@altavista.net)
| Date: 22 July 1999
| (C) Roger Hutchings 1999
|=--------------------------------------------------------------------=( I n f o r m a t i o n )
| This pak file is basically a large script, which sets up keypad usage for Weapons Factory 
| (www.captured.com/WeaponsFactory) - it handles the whole class-specific radio system, class 
| changes, and spy disguises. It's quite complex, but once you get the hang of it, it's pretty 
| convenient for use in play. It utilises the WF AutoConfig feature, which MUST be used for 
| this script to work.
|=--------------------------------------------------------------------------=( F e a t u r e s )
- Full radio system for team messages, sorted by use (offence/defence)
- Automatic class-specific sound set-up
- Easy class change and spy disguise select
|=----------------------------------------------------------------=( F i l e   C o n t e n t s )
| ReadMe.txt     - The file you're reading now... =)
| RadioPak.pak   - The actual pak file needed for play
|=------------------------------------------------------------------=( I n s t a l l a t i o n )
1 - First, extract the pak file to your wf directory, and rename it to the next available 
|   number (ie in the format pakX.pak). We recommend pak6.pak or pak7.pak.
2 - Add this line to your AutoExec.cfg:
|		exec Radio.cfg
|   This line executes the main Radio code, and MUST be run to use the script.
3 - Then, you need to add a line to each of your class configs (boring, I know, but there's no 
|   way round it yet...), in the format:
|		exec Radio/[Class Name].cfg
|   where [Class Name] is the name of each class (ie Recon, Nurse, Engineer, Marine, Cyborg,
|   Arsonist, Gunner, Sniper, Spy and Merc: note spelling!) 
| 
| Once this is done, the alias executes itself automatically when "AutoConfig On" is typed at 
| the Quake II console.
| 
| If, for some bizarre reason, you DON'T use the separate class config files, then you have 
| two options:
|	a) Type the line:
| 		exec Radio/[Class Name].cfg 
| 	   in the console during play.
|	b) Bind a key for each class you want to use the script with to the appropriate class
| 	   radio config file, in the format:
| 		bind [key] "exec Radio/[Class Name].cfg"
| 	   pressing this once in the game will execute the radio script for the class you
| 	   chose. This line can be placed in your autoexec.cfg file.
|
|=--------------------------------------------------------------------------------=( U s a g e )
| OK, this is fairly straightforward.... all keys are on the keypad.
|
| To begin with, the / and * keys are bound to the radio messages "Affirmative" and "Negative"
| respectively; when either key is pressed, it plays the class-specific sound and says the 
| message to the rest of your team. These stay the same whether the radio is on or off, or 
| whether it's set to bank A or B.
|
| The Insert key turns the radio on and off. When the radio is on, pressing any of the 
| keypad numerical keys plays the message assigned to it, depending on the bank. When it's off,
| it prints the message it WOULD play to the screen, so you can find the message you're looking 
| for without flooding the server. When the radio is on, the message sound, along with a text 
| message, is played to your team.
| 
| The Enter key toggles the radio between bank A and bank B. The bank system is a way of 
| getting twice the number of keys out of the keypad. In general, bank A is for defence 
| messages and bank B for offence (except bank B message 6 - Spy in base), but if you open up 
| the pak and edit the messages.cfg file, you can change them to whatever you want - however, 
| unless you've got a bit of experience in doing this, you should leave them...
| 
| This is a list of messages by bank:
| 
| Key        | Bank A                           | Bank B                            
| =-=-=-=-=-=|=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-|-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
| Keypad 1   | Enemy at ramp                    | Enemy flag open
| Keypad 2   | Enemy at courtyard               | Enemy defence net destroyed
| Keypad 3   | Enemy at water entrance          | Flag captured, escort needed
| Keypad 4   | Enemy at balcony                 | Kill enemy snipers
| Keypad 5   | Enemy at main entrance           | Launching strike
| Keypad 6   | Enemy at elevator                | Spy in base
| Keypad 7   | Need defence                     | [Class] reporting
| Keypad 8   | Flag in danger                   | Attack now
| Keypad 9   | Flag room secured                | On patrol
| Keypad Del | On defence                       | On offence
| 
| By holding down the plus key, pressing the numerical keys (where Delete is used to select the 
| tenth class (Mercenary)), you can change the class you will respawn as. As soon as you let go
| of the plus key, the keypad will change back to its previous usage.
| 
| The spy can also use the same method to select his disguises, but this time by holding the 
| minus key, and pressing a numerical key. Once the minus key is released, the keypad will 
| again return to its previous setting, and at the same time it will send a message to your 
| team telling them what class you are disguised as.
|
| Here's how the class-change/disguise select is set up... remember, this set-up is only as
| long as either the plus or minus key is held down....
|
| Key        | Class
| =-=-=-=-=-=|=-=-=-=-=-=-=
| Keypad 1   | Recon
| Keypad 2   | Nurse
| Keypad 3   | Engineer
| Keypad 4   | Marine
| Keypad 5   | Cyborg
| Keypad 6   | Arsonist
| Keypad 7   | Gunner
| Keypad 8   | Sniper
| Keypad 9   | Spy
| Keypad Del | Mercenary
|  
| Finally, each class also broadcasts an initial report on changing class or spawning for the
| first time - this is the same as bank B message 7, ie:
| 	"[Class] reporting at [position]!"
|=------------------------------------------------------------=( V e r s i o n   H i s t o r y ) 
| v1.15 - Revised docs for release, and made a little bank switch sound =) Also did a bit of
|         streamlining in the radio.cfg file, fixed a problem with the modifier aliases not
|	  returning to the same state, and added developers notes.
|
| v1.10 - Added CTF %Command support, changed KP Del to play "On offence/defence" message, 
|         and added an initial status report for each class. Fixed problem where bank changed
|         when turning radio on/off. Had to split radio.cfg into radio.cfg and messages.cfg cos 
|         it got too big =)
| 
| v1.01 - Fixed pak issue reported by Angel06
| 
| v1.00 - Original version
|=----------------------------------------------------------------------------=( C r e d i t s )
| Props to everyone on "The Bind" message board at Captured.com, especially Angel06, Otser, and 
| Tron; to [KWA]-Insanity (or :GA: Slayer =)and [SDW]Iksree; to Jan Goyvaerts for writing 
| EditPad (which I used to write the whole bloody thing =D; to Astral Projection, for soothing
| my frustration with their unique doped-out noddy trancehead style music - which kicks =); to
| ReconN and x20R00x at the WF Langley site (http://www.captured.com/wflangley); to the whole 
| WF team (especially Martin Doudoroff for all the support) and finally, to the rest of my 
| noble clan members, =QoA= - heya to Daf, Drak, Porn*, JJ, Fugee-La and Blane.. Plz visit the 
| clan page at http://qoa.netgames.net, there might even be a few more of my scripts kicking 
| around =) 
| Anyone else who wants a greet get in touch before the next release (if there is one... 
| annoy me enough and I will =) Massive apologies to anyone I forgot...
| 
|                                 ________            _____
|                           ______\_____  \   ____   /  _  \  ______
|                          /_____/ /  / \  \ / __ \ /  ___  \/_____/
|                          /_____//   \_/   |  __  |    _   |/_____/
|                            _____\_____\ \_/\____/\___| |_ | 
|                            \______   \ \__|   ____   ____\/_____
|                             |     / _// __ \ / ___\_/ __ \_  __ \
|                             |    |   (  __  ) /_/  |  ___/|  | \/
|                             |____|_  /\____/\___  / \___  \__|
|                                    \/      /_____/      \/(c)rogerhutchings1999uk
|
| 
\=01010001-01101111-01000001------------------------------------------------=[ s i g n   o f f ]