                             Inner Circle Trinket


Author       : Gary Griggs (ggriggs@gis.net)
Version      : 1.01
Release Date : 8/29/96
Description  : The Inner Circle Trinket is a QuakeC addon that provides a
               new powerup that has random effects. Some of these effects are
               good and some are downright evil. The Inner Circle Trinket is
               designed to be added to new maps; The first such map, 
               giggler.bsp is being released simultaneously with this patch. 
               This quake map is excellent for deathmatches of 4-6 players 
               and was designed by giggler, author of many excellent Doom
               wads. 
 
Details:

   * Installing the patch

     To install the code create a directory named ictrink under the main
     quake directory and copy the progs.dat from the ICTRINK archive there.
     The patch only needs to be installed on the server side, however the
     provided sounds do add to the enjoyment of the game and it is
     recommended that clients install these. 

     The .wav files need to reside in a directory quake\id1\sound\items

   * Example for starting a map with Inner Circle Trinkets

          quake -game ictrink +deathmatch 2 +map giggler

   * Game Play

     The Effects:

     Just in case you can't figure out whether an effect is good or
     bad from the detailed description provided, I've labelled each 
     effect with a (Good), (Bad), and in one case (Ugly).

     * Max Axe (Good)

       The Max Axe supercharges your axe so that one hit on an opponent will
       gib them. If the quarter damage is active the max ax overrides it. 
       The Max Axe lasts 60 seconds or until death. A dropped backpack 
       will not contain a Max Axe. 

     * All Weapons & Maximum Ammo (Good)

       Just like the name implies this gives you all the Quake weapons and
       maximum ammunition for each. This is not a timed effect.

     * Quad Damage (Good)

       The Quad Damage works the same as the normal Quad Damage powerup. It 
       amplifies the damage of all your weapons by a factor of 4. This is a 
       timed effect that lasts 60 seconds or until death. The Quad Power 
       cancels any Quarter damage effect.

     * Plant Bomb (Good)

       When you plant a bomb the next person who picks it up is gibbed and
       you get the credit for it. Beware though - if you pick up your own
       bomb, you lose two frags and potentially four if you own Two for One
       Fragging! This is not a timed effect.

     * Two for One Fragging (Good)

       Every frag gained or lost is multiplied by two! This is a timed effect 
       that lasts 60 seconds or until death.

     * Super Health and Armor (Good)

       This gives you maximum health (250) and the Red Armor (200) regardless
       of current health and armor. However, Inner Circle slime do not get
       any armor and health credits. This effect is not timed and lasts until
       death.

     * Quarter Damage (Bad)

       The Quarter Damage behavior is similar to the Quad Damage only you
       don't want to be stuck with this one. Instead of doing 4x damage with
       any weapon, you do 1/4 the damage. Even rockets aren't so hot now!
       Of course there's always suicide. This is a timed effect that lasts 60
       seconds or until death. The Quarter Damage effect cancels any Quad
       Power effect. If the Max Axe is owned it does not lose any
       effectiveness.

     * Bomb Detonation (Bad)

       If you've never been killed before you will be now. Picking up a
       planted bomb will gib you instantly. The player who planted the
       bomb is credited with a frag. If you pick up your own bomb you lose
       frags - see the details under Plant Bomb. 

     * Honorary Inner Circle Member (Ugly)

       What's worse than picking up a planted bomb or running around doing
       1/4 the normal damage with your weapons? How about becoming an
       honorary Inner Circle Member where you cannot go above 25 health and
       have no armor for a period of 60 seconds? Bad? Well, that's only part
       of it. Even death is not a valid excuse for leaving the Inner Circle!
       But wait, there's more... Heck, as if being an easy target wasn't
       enough, you get a pitiful Inner Circle name chosen for you during your
       stay; it's sure to make you the talk of the town. 


     Randomness of effects :

     The effects of the Inner Circle Trinket are random with the exception of
     bomb detonation which is always the next effect after dropping a bomb. 
     The Good effect to Bad effects ratio is set at 6:4. 

     Extension of effects :

     All timed effects will be extended if the same effect is encountered 
     again. Any remaining time is discarded and the countdown begins anew.

     Cumulative effects :

     Some effects are cumulative, including some of the timed effects. As an
     example, it's feasible depending on the number of Inner Circle Trinkets,
     and the respawn times on each, to have Super Health and Armor, All
     Weapons and Maximum Ammo, Quad Power, Two For One Fragging, and Plant
     a Bomb - all at the same time.

History of the Inner Circle :

Intelligence data gathered on the Inner Circle tells us they are a group
of youngsters between the ages of 14 and 17 who frequently band together
for the purposes of intentionally causing mischief. The author of this 
patch has encountered them on DWANGO where they frequently get slimed, 
kicked, and banned from the system. The prowess of the Inner Circle is
truly seen when they attempt in vain at hacking the DWANGO system using 
such innovative aliases such as hacka, tracka, laqueefa, and tacopaco to 
name a few.

Coding for the Inner Circle Trinket :

The Inner Circle Trinket is a new powerup that can be added to new maps at
the map author's discretion. Map authors can do this by adding an entity
and assigning it an origin, classnaname ic_trinket, and optionally
spawnflags. Bits 0-5 of spawnflags are used to describe the respawn
times of each Inner Circle Trinket entity. 0 = Default respawn time, 
1-62 = 5 second increments (ie. 5 seconds to 310 seconds in 5 second
increments), 63 = random respawn times (5 seconds to 310 seconds).


Bugs/Problems :

   If the sounds are not present on the client machine, an error message
   is displayed every time a IC Trinket sound tries to play. This does not
   prohibit game play. The option to turn off sounds thus preventing these
   messages will be available in the next release.

   Max Axe does not have any visual indication while active. It does give a
   message at pickup and when about to expire.

   Stuttering on Access Denied if player is an honorary Inner Circle member
   and tries to pick up health or armor. 

   Users do not get renamed if they exit the game as an Inner Circle member.

   Name changes are not recognized which affects renaming players after 
   gettting their reprieve from a stay with the Inner Circle. 

Credits :
	QA    - A special thanks to duke, metal, giggler who participated in
            early alpha testing. Also thanks to crom7, and blackjak.
	Bugs  - Mine, all mine!

Reporting problems or requesting enhancements :

	Please contact me via email at ggriggs@gis.net 




 
