Shrubmod 3 1 1b

README

================================================================================
shrubmod for Return to Castle Wolfenstein 1.4/1.41
--------------------------------------------------------------------------------
Version 3.1.1b, Released 5/10/03
by Ryan Mannion - "shrub" - shrub@planetwolfenstein.com

http://www.planetwolfenstein.com/shrub
================================================================================
NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE

This version's documentation was rushed together in the early morning and I
probably left some features undocumented.  Check the web site for any updates to
this file.

Also, I did not include the sound pack in this release.  If you do not have it,
you will want to download it from my site.
================================================================================

YOU MUST READ AND AGREE TO THE TERMS OF THE LICENSE IN SECTION 7 BEFORE USING
THE INCLUDED .DLL OR .SO FILE.  IT'S VERY REASONABLE, AND I THINK YOU'LL AGREE.

Note that this *is* a beta release, and I would appreciate any and all bug
reports you have.

This mod has been renamed to simply "shrubmod", as it is clear that its
usefulness has expanded well beyond OLTL servers.

What does this mod do?  To put it simply, I designed it primarily to give admins
increased control over every aspect of gameplay so that they may craft a unique
form of playing.  These controls include how points are assigned, what weapons
are allowed, what kind of actions are permissible, and how various in-game
objects are handled.  Second are conveniences for the player, including such
functions as shoving other players out of the way, comprehensive statistics,
automated reminders based on team composition, automated recommendations of
who should revive (which medic is closest) and who to give ammo to (who has the
greatest need, while factoring in distance from the LT), and more!

This mod is completely server-side.  The beauty of it is that it requires no
client downloads whatsoever.

Since there are so many customizable features in this mod, I have set the
variables to a default setting that I think would be a great foundation to start
from.

As always, I'm open to suggestions!  I can be reached at the email address above.

Contents of this Document:
  1. Revision History
  2. Installation
  3. Acknowledgements
  4. Command Summary
  5. What's New/Modified in 3.1b
  6. What's New/Modified in 3.0b
  7. Features Unchanged Prior to 3.0b
  8. Known Bugs
  9. License

================================================================================
1. REVISION HISTORY
================================================================================
Beta 3.1.1 - released 5/10/03
  - fixed problem with disguises and class times
  - removed debug output

Beta 3.1 - released 5/10/03
  - added accurate/overheating MG42s
  - added text shortcuts
  - added g_highachieversmin
  - added panzerfaust arc
  - added party panzer
  - added trip mines
  - added additional sound pack commands
  - added unrestricted sound support
  - added "poll" vote
  - added "putspecs" vote
  - added disguises
  - added logfile trimming
  - added MP40/Thompson rate of fire control
  - added kickable airstrikes
  - added hitsounds
  - added relaxed air strike blocking
  - added ability to zero LT charge on round start
  - added ability to adjust ammo/grenade pack throw rate
  - added customizable objective spawning
  - added cpclient
  - changed warmup damage to allow instant respawn and no damage taken for
    idlers
  - changed logfile output
  - added detailed end of round stats table
  - reinstated unlag code
  - added ability to walk or crouch throw proximity mines
  - added ability to show votes
  - vote successes/failures are logged
  - importance levels are now flagged
  - dropped objs no longer give extra points
  - fixed maxlives/overtime bug
  - fixed ammo bug
  - fixed late join/limited life bug with g_allowLateJoins
  - fixed shove kills logging
  - fixed crash exploit

Beta 3.0.1 - released 1/2/03
  - fixed exploit

Beta 3.0 - released 1/1/03
  - added ready-up system
  - added anti-shove code to prevent shoving teammates to their death
  - added smoke grenades
  - added grenade packs
  - added poison needles
  - added mine hints
  - added weapon unlocking
  - added goomba killing
  - added throwable knives
  - added LT binocular drop on limbo
  - added medic health pack(s) drop on limbo
  - added engineer grenade(s) drop on limbo
  - added chat anti-repeat-spamming protection
  - added rcon lite
  - added high achievers announcements
  - added important flag
  - added poisoning/shoving/goomba deaths logging
  - added objective dropping
  - added sound pack support
  - added death/flamethrower sounds
  - added spectator clicking
  - added g_corpsewar
  - added multiclass
  - added variable maxlives through g_allowLateJoins
  - team counts now displayed in /classes
  - start of round/warmup is now logged
  - added console command "chatclient"
  - added client command "me"
  - chat/chatclient/cp/print are now logged
  - disabled giving ammo from pistols for g_giveammo 2
  - added "On my way" voice chat
  - headshot mode icons now face the shooter
  - modified display of round stats (condensed)
  - fixed bug involving playing dead and mg42s/shoving
  - fixed bug involving putteam and limited-life play
  - locked teams are now persistant across swap_team calls
  - added spec-locking functionality to command "lock"
  - added "lock all" and "unlock all"
  - greatly improved spec-locking
  - added pistol only and needle only modes
  - ammo capping changed significantly
  - modified display of life stats (newlines fixed)
  - medic hints can now be toggled
  - added ability to destroy own objectives
  - added ability to disable objectives/objective spawning
  - added cvars for med/engr grenades and clips
  - added cvar for fatigue recharge rate
  - added warmup announcement
  - fixed gib logging reversal
  - fixed bug involving giveammo
  - added launcha/throwa/flinga/slapa
  - removed unlag
  - removed private messaging (replaced w/name-matching PMing)
  - removed g_allow* cvars (replaced with g_max* cvars)
  - fixed various wolf exploits

Beta 2.07-1.4 - released 11/17/02
  - removed g_ammoGivesPistol

Beta 2.07 - released 8/26/02
  - added corpse dragging
  - added proximity mines
  - added unlag code
  - added ammo giving/donating
  - added warmup damage
  - added group/name-matching private messaging
  - added uncap ammo option
  - added ignore feature (console and vote)
  - added warmup freeze
  - added complaint form ignoring
  - added playing dead
  - added ammo hints (display how much ammo teammates have)
  - added client num finding feature
  - added console slap player
  - added console kill player
  - added console force team
  - added console lock/unlock teams
  - added console force respawn
  - added console print commands
  - added console orient/disorient/shake player
  - vote strings are displayed in console
  - shuffle now keeps previous round and timeleft values for stopwatch mode
  - team gib messages are now yellow

Beta 2.06.1 - released 8/14/02
  - fixed bug involving scoring simultaneous self and other player gibs
  - fixed bug involving scripted map explosions and property damage
  - fixed bug involving fast-loading clients being allowed to late join when
    g_allowLateJoin was off
  - gib messages in client-side log now end names with ^7

Beta 2.06 - released 8/6/02
  - g_allowPF now defaults to 1
  - added chat filter/censor feature
  - manual spectator voice chats are disabled unless g_allowSpecChat is on
  - added special soldier weapons limiting feature
  - added private messaging feature
  - added team shuffling feature
  - added auto team shuffler (shuffle after team has x more wins than the other)
  - auto shuffler now takes into account stopwatch mode
  - added clan alignment feature
  - added headshot mode
  - disallowed dropping weapons while frozen
  - added "unstick" fix to freeze tag
  - fixed bug involving "most kills/revives" stat display
  - added disallowed votes feature
  - added votes for freezetag and headshot modes
  - fixed bug involving g_allowStartVotes
  - medics can revive underwater through g_waterRevive
  - flamers can damage themselves in ff-off mode through g_flameDamage
  - added censored word penalty (gibs players who say a censored word)
  - freeze tag unfreeze timeouts now respawn players at spawn points
  - added more help messages to freeze tag mode

Beta 2.05 - released 7/23/02
  - g_allowLateJoins now defaults to 1
  - g_flagPoints now defaults to 1
  - fixed "getting stuck in something after being revived" bug
  - added freeze tag gametype
  - added property damage feature
  - shortened length of /classes printout
  - spectator stats no longer logged
  - fixed minor bug involving axis/allies left being printed during intermission
  - added rotating server messages/MOTDs
  - added "FF off" mode to touch gibbing
  - added most kills/revives to end of round stats
  - dynamite warnings are now adjustable
  - start round ammo penalties now adjustable
  - added recognition for blocking an air strike
  - ammo packs can give helmets back
  - launch/throw/fling no longer have 3-space limitation
  - allow binoculars for non-LTs
  - added spawnhats to fun mode
  - MG42 repairs and blowing objectives is now logged

  - changes made to freeze tag since its initial beta:
    - changed from fire to green icon over head when frozen
    - added console messages with method of death
    - added logging of freezes and unfreezes
    - added freeze tag stats and most freezes/unfreezes
    - added needle proximity unfreezing