
              tH3.b34Stv3.0f
              - -=- -=+*=-* *-* *-**-**** * -*********-**-***=*--*-=
              - -=--=-+*_***_***_***-=***_ -**_____*___ *_____*_**--
              --= - -+*| |*| |*| |*=-=*| |***|  ___|/ _ \ /  ___| |*--=
              - = --=+*| |_| |_| |*___-*| |__*| |__*/ /_\ \\ `--.| |_*-
              -- - -+*| __|  _  |/ _ \*| '_ \|  __||  _  | `--. \ __|=
              -- --=-+*| |_| |*| |  __/*| |_) | |___| || |/\__/ / |_*-
              = =-=- +*\__\_|*|_/\___|*|_.__/\____/\_|*|_/\____/ \__|=
              -=- -=--=-+****  **-***-=-***-*** **-*********-***-*
              =  - =- -=+=*-***-* *-*** *-**- **-*-**AjK, 1997-=
              tH3.b34Stv3.0f


                   =--------------------------------------------------=                  
                   | Extended help file for tH3.b34St v3.0f by snOwDawG |
                   =--------------------------------------------------=


                  =-[CONTENTS]-----------------------------------------=                                              
                  | Section (1): About this script                       |                                      
                  | Section (2): Issues of 2\3 button meese              |
                  | Section (3): Editing tipz                            |
                  | Section (4): Master list of controls - bindz         |
                  | Section (5): Closing tipz\comments\etc.              |
                  =----------------------------------------------------=   


   * Section (1): About this script
  -==========================================================================================- 
  |                                                                                            |
  |    This script really started out as nothing more than a .cfg file to bind some KQP shit   |
  | (mainly impulses) to some handy keys. Then at some point, someone pointed me to the kewlio |
  | Quake archives at ftp.cdrom.com. I downloaded a couple of the scripts there, so as to see  |
  | what has\could be done with Quake. w0w to say the least! How much more customizable could  |
  | you want a game?!? Needless to say, after seeing such inspirations as NecroBoi'z shit, I   |
  | knew I had to do my own. What you have now is the latest incarnation of my efforts...      |
  |    tH3.b34St is really a multi-purpose script; It is extremely functional in both single   |
  | player and deathmatch Quake... And has a host of options that are available to you... Most |
  | only a single keypress away. There are 3 total "online" menus that can be called up at any |
  | time. These list most all available commands in a "easy to read" format.                   |
  |    New to the most rescent releases (late v2.02 and up), QuakeWorld\iNET server support    |
  | have been added, as well as some game specific bindz... These include bindz for several    |
  | TeamFortress specific aliases (dropammo, inventory, det20, detpipe, reload), as well as    |
  | data recieve rate (CPS) toggle and Pushlatency toggle for QuakeWorld. Dangerous indeed..   |
  |                                                                                            |
  -==========================================================================================- 


   * Section (2): Issues of two and three button meese...
  -==========================================================================================- 
  |                                                                                            |
  |    tH3.b34St is *very very* three buttoned mouse oriented... My personal preference being  |
  | Logitech'z absolutely kick ass Trackman Marble. All is not lost tho if you're a two button |
  | MS mouse slave =]  tH3.b34St, by default, assigns Mouse3 (mouse button 3) the job of using |
  | the Quickshot rocket\grenade system. Once the secondary aliases (bst-sec.rc) are loaded,   |
  | Mouse3'z use can be switched to a couple other things (using F10 key). These are:          |
  |                                                                                            |
  | * Use the Grapple aliases, instead of the CTRL key.                                        |
  | * z[00]m in and out fairly smoothly... Crosshair enabled + some screen centering.          |
  | * Use the default QuickShot weapon aliases.                                                |
  |                                                                                            |
  |    So as you can see, if your only using a two button mouse, you loose that instant access |
  | to the above aliases... Don't ya? Well, if there is a will, there is a way =)  All you     |
  | would need to do is slightly modify a alias group located in the file "bst-sec.rc"... I    |
  | know I know... "I dun know how!" After seeing the below, you will :)                       |
  |                                                                                            |
  -==========================================================================================- 


   * Section (3): Editing tipz
  -==========================================================================================- 
  |                                                                                            |
  |    So as to keep the above ball rolling, we will use this three buttoned mouse issue as a  |
  | example way to edit this script to your liking. The first set of aliases is how they would |
  | normally appear in version 3.0f. The second set of aliases is a edited *example* of how    |
  | you could utilize Mouse3'z functions using another key. This example uses SPACE...         |
  |                                                                                            |
  -==========================================================================================- 


// This is the alias set that toggles Mouse3'z mode. This is *exactly* how it appears in the script.  
alias m3_toggle m3_qs
alias m3_qs "unbind MOUSE3; bind MOUSE3 +engage; alias m3_toggle m3_gr; echo b> MOUSE3 using = [QuickShot Mode] "
alias m3_gr "unbind MOUSE3; bind MOUSE3 +grapple; alias m3_toggle m3_zo; echo b> MOUSE3 using = [Grappling hOOk] "
alias m3_zo "unbind MOUSE3; bind MOUSE3 +zoom; alias m3_toggle m3_qs; echo b> MOUSE3 using = z[00]m Lense "

// This is the modified script, with SPACE now "emulating" Mouse3.
alias m3_toggle m3_qs
alias m3_qs "unbind SPACE; bind SPACE +engage; alias m3_toggle m3_gr; echo b> Spacebar using = [QuickShot Mode] "
alias m3_gr "unbind SPACE; bind SPACE +grapple; alias m3_toggle m3_zo; echo b> Spacebar using = [Grappling hOOk] "
alias m3_zo "unbind SPACE; bind SPACE +zoom; alias m3_toggle m3_qs; echo b> Spacebar using = z[00]m Lense "


   * Section (3) cont.
  -==========================================================================================- 
  |                                                                                            |
  |    So as you can see from the above, it would be quite easy for ya to customize the script |
  | to your liking. The above code is bug free and quite compatible with the existing script.  |
  | as a rule of thumb, try to keep the two main rc files (bst-pri.rc & bst-sec.rc) under      |
  | 7.6KB.. Going to much higher usually results in stack_overflow, malloc, etc. errors on the |
  | loading of the scripts. Other than that, feel free to rip it apart and do what ya' will    |
  | it. But if ya' break it, don't email me! Simply make backups before u fux anything up =)   |
  |                                                                                            |
  -==========================================================================================-


   * Section (4): Master list of controls - bindz
  -==========================================================================================- 
  |                                                                                            |
  |    Below is the *master list* with all of the known tH3.b34St key bindz. This list is just |
  | about the same as the one included in the file "beasthlp.txt", with the exception that all |
  | addon key bindz are also listed. As in the above mentioned file, a (1) means the entry can |
  | be used straight away in the script. A (2) means the secondary aliases must be loaded for  |
  | the entry to function. Finally, a (A) means a addon file must be loaded first.             |                                                                                
  |                                                                                            |
  -(MOUSE BUTTONS)-=-=-=-=-=-=-=-=-=-========================================================-
  |                                                                                            |
  |  (1) MOUSE1 (left button)   = Attack with current weapon.                                  |
  |  (1) MOUSE2 (right button)  = Forward.                                                     |
  |  (1) MOUSE3 (middle button) = QuickShot Weapon,Grapple OR z[00]m lense.                    |
  |                                                                                            |
  -(DIRECTIONALS)-=-=-=-=-=-=-=-=-=-=========================================================-
  |                                                                                            |
  |  (1) UP ARROW    = Jump.                                                                   |
  |  (1) DOWN ARROW  = Reverse\Retreat.                                                        |
  |  (1) LEFT ARROW  = Normal\attack\jump-attack STRAFE LEFT.                                  |
  |  (1) RIGHT ARROW = Normal\attack\jump-attack STRAFE RIGHT.                                 |
  |                                                                                            |
  -(MISC. KEYS OF INTEREST)-=-=-=-=-=-=-=-=-=-===============================================-
  |                                                                                            |
  |  (1) CTRL   = Initiatez a "Quick Grapple".                                                 |
  |  (1) R      = Resets the weapons memory..                                                  |
  |  (A) G      = Cycles thru a couple gravity settings..                                      |
  |  (A) Z & X  = Cyclez up\down thru CD Audio tracks..                                        |
  |  (1) 1 to 8 = *MAIN* weapons selector keys. Includes current weapon memory, etc.           |
  |  (A)  -     = CPS rate toggle for QuakeWorld.                                              |
  |  (A)  +     = Pushlatency toggle for QuakeWorld.                                           |
  |  (2) ]      = Key for choosing QuickShot weapon. Hold down then press 1-8 to select weapon |   
  |  (1) [      = Key for choosing Strafe weapon. Hold down then press 1-8 to select weapon    |
  |  (A) C      = ReaperBot specific bind, Add one ReaperBot to DeathMatch play.               |
  |  (A) V      = ReaperBot specific bind, Add four ReaperBots to DeathMatch play.             |
  |  (A) B      = ReaperBot specific bind, Updates active bots team info.                      |
  |  (A) M      = ReaperBot specific bind, Adds progrssivly harder bots, one at a time.        |
  |  (A) N      = ReaperBot specific bind, Displays available ReaperBot commands.              |
  |  (A) ENTER  = TeamFortress specific bind, forces a reload of armed weapon.                 |
  |  (A) INSERT = TeamFortress specific bind, lobz one type 1 grenade.                         |
  |  (A) DELETE = TeamFortress specific bind, lobz one type 2 grenade.                         |
  |  (A) END    = TeamFortress specific bind, drops some ammo.                                 |
  |  (A) HOME   = TeamFortress specific bind, checks your inventory.                           |
  |  (A) PAGEUP = TeamFortress specific bind, drops a 20 second detpack.                       |
  |  (A) PAGEDN = TeamFortress specific bind, detonates a dropped pipebomb.                    |
  |  (A) .      = TeamFortress specific bind, demo man pipebomb toss and detonate key          |
  |  (A) ,      = TeamFortress specific bind, demo man pipebomb\mirv toss and detonate key     |
  |  (A) O      = TeamFortress specific bind, tells your team your going offensive.            |
  |  (A) D      = TeamFortress specific bind, tells your team your staying defensive.          |
  |  (A) F      = TeamFortress specific bind, tells your team you *have* the flag...           |
  |                                                                                            | 
  -(SUPPORTED FUNCTION KEYZ)-=-=-=-=-=-=-=-=-=-==============================================-
  |                                                                                            |
  |  (1) F1  = Loads secondary alias file (bst-sec.rc).                                        |
  |  (2) F2  = Selects a external file to load from 8 available addons.                        |
  |  (2) F3  = Loads the selected addon file.                                                  |
  |  (2) F4  = Cyclez grapple impulse between impulses 22\32\97-98\9\1.                        |
  |  (1) F5  = Toggles Mouse Looking (mLOOK) ON\OFF.                                           |
  |  (2) F6  = Displays the controls menu, mildly abbreviated no less hehehe =]                |
  |  (2) F7  = Toggles the crosshair ON\OFF OR ReaperBot multi-skin UP                         |
  |  (A) F8  = Cycles available ShortCut servers OR ReaperBot multi-skin DOWN                  |
  |  (A) F9  = Connects to selected ShortCut server OR ReaperBot multi-skin mode               |
  |  (2) F10 = Cyclez QuickShot mode\Grappling hOOk\z00m lense for MOUSE3.                     |
  |  (1) F11 = Cyclez between attack\normal\jump-attack strafe modez.                          |
  |  (2) F12 = Displays "hotkey" menu, aimed at these keys (F1 to F12).                        |
  |                                                                                            |
  -==========================================================================================-
                                                                                           

   * Closing tipz\commentz\rantz\etc.
  -==========================================================================================- 
  |                                                                                            |
  |    I have been playing Quake with tH3.b34St aliases now for a couple of months... And it   |
  | really starts to grow on you after a while. For the most part it is bug free, crash free,  |
  | and just kick ass all around. There are a couple of thingz that I wish I could do with the |
  | existing script language that just aren't possible... But overall I am pleased with the    |
  | current version (v3.0f) of this script. ANYWAYZ (above was a rant obviously), below are a  |
  | couple of notez about how this script behaves, and how you can tame it =]                  |
  |                                                                                            |
  |  (1): If you acquire a weapon during gameplay and plan on using it as your active weapon,  |
  |      hit the button that corresponds with the weapon once so as to set tH3.b34St's weapon  |
  |      memory to your current configuration. For instance, if you had the double barrel      |
  |      shotgun armed, and picked up the rocket launcher, hit the "7" key once to keep the    |
  |      rocket launcher as your active weapon, even tho it appears already armed...           |
  |                                                                                            |
  |  (2): Always try to stay on top of your weapons selections. Having both QuickShot mode and |
  |      the ability to strafe with a dif weapon can be taxing if you don't keep yourself      |
  |      "current". Make sure you have the weapon that you have selected as your Strafe gun.   |
  |      Make sure that you have your selected QuickShot weapon (if your using it). Doing      |
  |      these things become second nature after a while, and take little or no time to do..   |
  |                                                                                            |
  |  (3): Make sure you have the correct Grappling hOOk impulse selected (w\F4 key). Obviously |
  |      the server\game your in must support the grappling hook as well (dOh!)                |
  |                                                                                            |
  |  (4): When in doubt about a specific tH3.b34St command during gameplay, just hit F6 or F12 |
  |      depending on which key bindz menu you need. F6 displays the basic controls menu, and  |
  |      F12 displays the function keys menu (F1 to F12). Very helpful indeed.                 |
  |                                                                                            |
  |  (5): The example of how to modify this script given above (MOUSE3 toggle aliases) is what |
  |      I call a multi-level toggle. IE: It has more "positions" than a typcial two position  |
  |      toggle. In this case, it has a total of 3 possible settings. I have found that when   |
  |      doing things such as these, its best to do them as "one way" toggles. IE: No backward |
  |      and forward toggling. They wind up taking way to much .rc file size for the convience |
  |      they offer... Just something for ya' to ponder =]                                     |
  |                                                                                            | 
  |  (6): Both the Strafe weapon selector (used to be [ & ] ) and the QuickShot toggle (INS..) |
  |      have been changed since the last release. Now to change Strafe weapons, press\hold in |
  |      the "[" key. With it held in, hit 1-8 for which Strafe weapon u want to use. Same for |
  |      the QuickShot selector except it uses the "]" key now, and needs the secondary file   |
  |      of aliases (bst-sec.rc, hit F1 to load). Using this method made it *quicker* to do,   |
  |      and shaved several KB off of each of the two main .rc files. One of my testers tells  |
  |      me that NecroBoi did this same alias setup "long ago...", so greetz to ya for beating |
  |      me to it heheheh! Note that my aliases are 500% original... And along with that about |
  |      450% untested in the field (just kidding, more like 375% =] )                         |
  |                                                                                            | 
  |  (7): There was a time not long ago that this script just plain did not like being used    |
  |      on heavily modded servers. By heavily modded I mean the likes of FvF or TF. Many of   |
  |      aliases would fail to work properly, and sometimez the whole thing would crash! Well, |
  |      these are all things of the past now... With little or no sacrifice on .rc file size  |
  |      or anything else... What I'm trying to say is have no fear using this script on any   |
  |      of your fave iNET servers. I play TeamFortress daily with tH3.b34St, and FvF as well. |
  |      both work fine without any hitches. On the "dark side" of it all is the kinda popular |
  |      "Quake SuperHeroes" patch. tH3.b34St does *NOT* like servers running this mod at all! |
  |      Mind you most everything still works correctly after a quick R (weapons reset)... But |
  |      still...SHEEESH! To many damn server aliases\bindz I guess...                         |
  |                                                                                            | 
  |  (8): Most importantly, ENJOY THE SCRIPT! I honestly hope that you like using\learning     |
  |      from it as much as I do! Feel free to use whatever you want (aliases wise, etc.) from |
  |      this script. I am very aware that 9\10ths of everyone who downloads it will probably  |
  |      never even use it per say... And this is quite alright! Most all of the code is all   |
  |      original (maybe not the idea..), so if u want to thank\make mention of someone...     |
  |      well... Do whatever u think is right =)                                               |
  |                                                                                            |
  |                                  A. Kincaid  aka  snOwDawG                                 |   
  |                                                                                            |
  -==========================================================================================- 


