==============================================================================
Classic CTF Final Beta
Version 0.99c
Coordinators: Ark, DD, Hb0mb, Thumper, and Whiplash
==============================================================================

This is the final beta release.
No more drastic changes will take place before the final v1.0 release.



==============================================================================
Features
==============================================================================
- Grappling hook (with Q1 style damage)
- Threewave CTF style Runes(Techs)
- Q1 style Super Nailgun
- Q1 style Lightning discharge
- Q2 style Weaponstay
- Q2 style armor classes
- Q2 style ladders and aditional mapping features
- Q2 style flag trails
- Q3 default physics
- Power screen (not shield like Q2)
- Limited Invulnerability spawnning
- Improved side-by-side scoreboard and smaller HUD
- Weapon/Ammo/Rune/Armor/Flag dropping
- Chat parsing variables for improved teamplay
- Customizable +/- console commands
- Radio sounds (can disable)
- Match commands and tons of Admin features with easy to use menus
- Sudden Death overtime ability
- Hi-Vis team skins
- Per-level configuration ability
- Top-ten scores saving
- Great assortment of CTF maps including remakes
- Easy to find servers using CCTF's own built-in master server
- Online real-time server listings at http://cctf.dhs.org:27950/
- Connect to CCTF servers from the web with included Q3Connect utility



==============================================================================
How to Install it
==============================================================================

1.) First of all, make sure your Quake3 is updated with the latest patches,
    available from: www.3dfiles.com, www.bluesnews.com or www.quake3arena.com
    As of this release, the latest version of Quake3 is v1.17

2.) Clean out your cctf directory if it exist.
    Make sure to save your config files.
    *** The self-installing windows version will
        remove ALL PK3s from your cctf dir.

3a) Windows (EXE file)
    Just run the self-installing .EXE and follow the instructions.

3b) Linux/Mac (ZIP file)
    Unzip the cctf zip into your Quake 3 dir. Not into your baseq3 dir. 
    It will create every file in a cctf dir which should be located as
    quake3/cctf not quake3/baseq3/cctf.

4.) Launch Quake3 and select Classic CTF from the MODs menu, or
    using command-line parameters such as "Quake3.exe +set fs_game cctf"



==============================================================================
Important Notes
==============================================================================

Running Servers	- Server Admins should use the server.bat file included.
Maps            - 10 maps are in this version. cctf1-cctf10.
Bot Support     - Bots are not supported by CCTF.
Arena Files     - In order for maps show up in the cctf map selection menu,
                  the arena file for the map must have type "cctf" set.
Overtime        - There are two different methods of deciding game incase of a
                  tie: Sudden death overtime where the next team to score a
                  capture wins the game or the q2 style where the winner is
                  determined by total team frags. The g_suddendeath cvar is
                  used to enable sudden death.
Weaponstay      - Set g_weaponrespawn to 0 to enable Q2 style weaponstay.
Player Spawing  - By default Q3 only allows you to respawn inside your own
                  base or in the middle ground, set g_spawnIgnoreTeam to 1 to
                  allow players to randomly spawn in either base.
Rune Spawning   - At the start of each level, 2 runes will spawn in each base,
                  in any combination other then strength+regeneration in one
                  and the resistance+haste in the other.
                  After that, runes can respawn at any player spawn point.
Grapple         - Grapple impact damage is 10 points and continuously drains
                  health while connected to an enemy.  Not very effective
                  unless used in conjunction with a stronger weapon.
                  Use: bind x weapon 10
Super Nailgun   - The Super Nail Gun damage is 18.  You get 50 nails from
                  both the nailgun and nail boxes.
                  Use: bind x weapon 11
Lightning Gun   - Discharging in water will always gib yourself, and will
                  produce a radius with damage and size dependant on the
                  amount of ammo you have.  It is also possible to hurt
                  enemies in water while standing out of the water and firing
                  into it, althought this is not extremely powerful.
Railgun         - A new cvar "disc" has been added to cctf that enables you to
                  change the color of the disc of your railgun shot.
                  Set it to 0 to match the core color (set by "color" cvar).
Bfg Lamer Mode  - A server side option to cause the bfg to suicide has been
                  added. It is the first bit of the weaponflags cvar.
Last weapon     - CCTF adds the ability to bind a key to "weaplast"
Scoreboard      - The Scoreboard now shows score and kills. Kills is total
                  frags without bonus points, suicides, or any other way of
                  scoring points.  The scoreboard is laid out side-by-side
                  for easier comparison of teams.  A flag carrier will be
                  hilighted in the color of the flag he is carrying, and
                  yourself will be hilighted yellow.
HUD             - Shrank the display by half for less annoying look.
                  Added name of both flag carriers above flag status hud.
Item Respawning - Lowered powerup respawn to 60 seconds, and ammo to 30.
                  Megahealth will actually spawn every 120 seconds.
                  g_quadRespawn is to set quad/invis respawn times.
                  Invis always spawns 10% more time after the quad.
Health          - Megahealths will allow up to 250 (if you get 2 of them or
                  have regeneration) Only megahealths will make health count
                  down and regeneration will stop this. You now start with
                  only 100 health.  Shards wont tick down.
Armor           - Armor is now setup with classes like Q2:
                  Green=30% protection, 50 max
                  Yellow=60% protection, 100 max
                  Red=80% protection, 200 max.
                  Getting armor from other classes gives you the ratio of
                  their protection values like Q2 (If you have 100red and get
                  50yellow, you will have 137red) Armor shards will allow you
                  to go above the max limit without ticking back down to 100.
Drop Armor      - You must have at least the amount of armor that you get for
                  picking it up, all armor is removed when you drop it, but
                  the armor on the ground will be only worth the normal pickup
                  value. This is the only way to prevent an regeneration armor
                  generator.
Drop PS         - Use the "drop holdable" command to drop medkit/teleporter/ps
Hit Sounds      - There are 5 different levels of hitdamage, so 5 different
                  wavs will play depending on how much damage you do to the
                  enemy:  [1-9] [10-29] [30-49] [50-99] [100+]
Radio Sounds    - Added radio sounds that can be used instead of team_say
                  messages.  Ability to mute local radio sounds with
                  cg_muteRadio and cg_drawRadioHead
Spawning        - Now when you get killed and respawn you have a protective
                  field around you making you invincible for 2-3 seconds.
                  You will automatically lose this protection if you fire a
                  weapon.
Gamespy Support - We now included a cctf gamespy tab
Pingtool        - There is also an included cctf pingtool tab
Crosshairs      - You now can use up to 26 different crosshairs we included
                  with the mod. Type the cmd cg_drawcrosshair # in console
                  to switch to the different crosshairs. You can also use the
                  crosshair selection menu option.



==============================================================================
Dropping Items
==============================================================================

CCTF supports dropping almost anything you can pick up, to share it with your
teammates and promote better teamplay. Use the drop command as follows:

drop rune OR drop tech - drops your current rune
drop weapon - drops your current weapon	
drop flag - drops the flag
drop armor - drops your armor
drop ammo - drops a box of your current ammo
drop holdable - drops your holdable item (medkit/teleporter/powerscreen)

Or specify what type of ammo to drop with the following commands:
drop bullets
drop shells
drop grenades
drop rockets
drop lightning
drop slugs
drop cells
drop bfgammo
drop nails

==============================================================================
Server Admin Commands
==============================================================================

Regular users will get a list of all connected players, a button to elect or
unelect the selected player as an admin, a button to vote to kick the player
and buttons to vote yes or no.
Once elected admin, a player will get a large list of commands to help
moderate the server. Each command may be accessed on the menu, or typed into
the console as follows:

changemap <mapname>
forcetoteam <red|blue|spec> <playername>
kickplayer <playername>
lockchat
lockteams
matchsetup
matchstart <#>
matchend
setcaplimit <#>
setfraglimit <#>
settimelimit <#>
unlockchat
unlockteams
setstartflags <#>
setweaponflags <#>
setitemflags <#>
setdropflags <#>
setweaponrespawn <#>
setwarmuptime <#>
setfriendlyfire <#>
setsuddendeath <#>
setspawnignoreteam <#>
setquadrespawn <#>
setinstakill <#>

Admins may be elected with the following aditional callvote commands:
callvote elect <player> - sets up a vote to give admin privs to a player
callvote unelect <player> - sets up a vote to remove admin privs from a player
Note that there must be at least 3 players connected in order to call votes.


startflags, weaponflags, itemflags, and dropflags are set by bit values
got from adding any of the flags you want to set together.
Admins have submenus to toggle each flag enabled or disabled, but actual
server owners must set these variables in the server.cfg file with numbers.

cvar: startflags - enables infinite ammo, instagib, and sets starting weapon.
Add any of the following values together:
     1 - enable infinite ammo
     2 - start with machinegun
     4 - start with shotgun
     8 - start with grenade launcher
    16 - start with rocket launcher
    32 - start with lightning gun
    64 - start with railgun
   128 - start with plasmagun
   256 - start with bfg
   512 - start with grapple
  1024 - start with nailgun
  2048 - enable instagib
(default is 514, machinegun and grapple)

cvar: weaponflags - enables bfg lamer switch and disables any weapon.
Add any of the following values together:
     1 - enable bfg lamer switch
     2 - disable machinegun
     4 - disable shotgun
     8 - disable grenade launcher
    16 - disable rocket launcher
    32 - disable lightning gun
    64 - disable railgun
   128 - disable plasmagun
   256 - disable bfg
   512 - disable grapple
  1024 - disable nailgun

cvar: itemflags - disables certain items.
Add any of the following values together:
   1 - Disable Quad Damage
   2 - Disable Invisibility
   4 - Disable Flight
   8 - Disable Rebreather
  16 - Disable Personal Teleporter
  32 - Disable Medkit
  64 - Disable Powerscreen
 128 - Disable all Health
 256 - Disable all Armor
 512 - Disable Strength Rune
1024 - Disable Resistance Rune
2048 - Disable Regeneration Rune
4096 - Disable Haste Rune

cvar: dropflags - disables dropping of certain items.
Add any of the following values together:
   1 - Disable Flag dropping
   2 - Disable Weapon dropping
   4 - Disable Ammo dropping
   8 - Disable Armor dropping
  16 - Disable Rune dropping
  32 - Disable Holdable droppping



==============================================================================
Radio Sounds
==============================================================================

CCTF now supports radio sounds. There are both server cmds and client commands
used to disable or use radio commands.

Servers commands:

g_allowRadio (default 1) - set to 0 to disable all radio commands.
g_radioFlood (default 1000) - miliseconds between radio commands.
g_radioDead (default 1) - allow radio msgs when dead.

Client commands:

radio - send a radio message, like "radio damn"
radio_team - send a radio message to your team.
radio_tell - send a radio message to player under crosshair.
radioMenu - use "radioMenu all", "radioMenu team", or "radioMenu tell" to
            bring up a menu list of radio commands.
reloadRadioCfg - use to reload wavs after changing cg_radioCfg
cg_radioCfg (default radio_male.cfg) - set to radio_female.cfg or
            radio_neutral.cfg to hear different radio sounds.
cg_drawRadioHead (default 1) - set to 0 to disable drawing the players head in
                             upper right corner when people play radio sounds.
cg_muteRadio - set to 1 to disable radio wavs.
Both cg_drawRadioHead and cg_muteRadio can be toggled in the menus at
Setup/Game Options.



==============================================================================
Misc Commands
==============================================================================

New customizable +/- commands:
bind any key to +pm0 thru +pm9.
Set the down/up action strings in pm0d / pm0u thru pm9d / pm9u

Example: /set pm4d "weapon 10;wait;wait;+attack"
         /set pm4u "-attack;wait;weaplast"
         /bind g +pm4

This will make it so when you press 'G', you switch to the grapple and fire.
When you let go of 'G', you will disconnect the grapple and automatically
switch back to the last weapon you were using.


New color codes for player names: ^_ - Changes to extended font set.
                                  ^/ - Changes back to normal font set.
                                       Both also reset the color to white.


New chat parsing variables: (like %variables from Q2)
Use in binds like '/bind x say_team Spotted $e near $o'

$h - current Health
$a - current Armor and armor class
$w - current Weapon
$n - list of all weapoNs you have
$m - ammount of aMmo for current weapon
$u - list of amoUnts of all ammo you have
$t - current Tech (same as rune)
$r - current Rune (same as tech)
$l - current Location as per q3's target_location used on the team overlay
$o - current lOcation as figured the Old way from q2 (nearest weapon/powerup)
$e - closest tEch/runE on the ground that you can see
$p - closest Player you can see
$f - closest Friendly teammate you can see
$y - closest enemY you can see
$c - last player to attaCk you
$k - last player to Kill you
$$ - print a single $ sign 
$d - last location you Died at
$i - last location you dIed at figured the old q2 way       
$s - color of people on the Same team as you
$q - color of other team



==============================================================================
Server Side Console Commands
==============================================================================

g_suddendeath     (default 0)    - Set to 1 to enable sudden death overtime.
g_weaponrespawn   (default 20)   - Controls respawn times and weaponstay.
                                   Set to 0 for weaponstay rules.
g_spawnIgnoreTeam (default 1)    - Allows players to spawn in either team's
                                   base, instead of just their own.
g_timecaps        (default 0)    - Set to 1 and a message will appear to all
                                   players stating the time from the first
                                   flag stolen to flag capture.
g_topten          (default 0)    - Set to 1 to make the server keep track of
                                   the players with the all-time highest score
                                   for each map. Scores are saved in the
                                   cctf/topten directory.
g_instakill       (default 0)    - Set to 1 to enable instant death at the
                                   bottom of the pits on maps, otherwise maps
                                   will be restricted to medium pased health
                                   draining.
g_spawnInvuln     (default 1)    - Enables 2 seconds of invulnerability with
                                   every respawn.
g_quadRespawn     (default 90)   - to set quad/invis respawn times.
                                   Invis always spawns 10% slower then quad.
g_allowRadio      (default 1)    - Set to 0 to disable all radio commands.
g_radioFlood      (default 1000) - Miliseconds between radio commands.
g_radioDead       (default 1)    - Allow radio msgs when dead.



==============================================================================
Client Side Console Commands
==============================================================================

cg_drawTeamHealth      (default 0) - Set to 1 and enable team overlay and
                                     teammates health/armor will be displayed
                                     between your crosshair and their name
                                     when you are looking at them.
cg_drawPing            (default 0) - Shows your current ping in the upper
                                     right corner.
cg_selectEmpty         (default 1) - Works in Q2 fashion: set it to 0 and you
                                     can bind best-weapon selection buttons by
                                     not allowing yourself to select weapons
                                     that are out of ammo.
cg_drawTopTen          (default 1) - If a player sets this to 0, then the top 
                                     ten list wont be automatically shown at
                                     the start of each level. Bind a key to
                                     +topten to show the top ten list instead.
cg_drawFriendTriangles (default 1) - Set to 0 to prevent triangle sprites from
                                     appearing over your teammates' heads.
cg_fraggedMsgSize      (default 2) - Set to 0 to disable drawing the
                                     "You fragged xxx" message all together.
                                     Set to 1 to draw the messages half size.
disc                   (default 0) - Sets rail disc color just like color sets
                                     the rail core color. Set to 0 and it will
                                     always match the rail core.
cg_radioCfg (default radio_male.cfg) Set to radio_female.cfg or
                                     radio_neutral.cfg and issue a
                                     reloadRadioCfg to hear different radio
                                     sounds.
cg_drawRadioHead       (default 1) - Set to 0 to disable drawing head in upper
                                     right corner when radio sounds play.
cg_muteRadio           (default 0) - Set to 1 to mute all radio wavs.



==============================================================================
Credits
==============================================================================

Coordinators
- Ark
- DD
- Hb0mb
- Whiplash
- Thumper

Lead Programmer
- Ark

Original Programmer of first public beta
- Grey Machine (retired)

Match Commands
- Morph

Lead Level Designer
- DD

Level Designers
- Hype
- Thumper
- Invictus
- Nuke
- Yuri Davidoff (http://www.ldc.net/~dyv)

Original Mod Founder
- Nuke (MIA)

Webpage
- Slayer
- Thumper

Flash Programming
- Whiplash

IRC Operator
- Kismet

Graphics/Skinning
- Whiplash
- Turbanator
- Jinx

Modeling
- Hb0mb
- Xpress

Shader Programming
- Ark
- Turbanator

Documentation
- Ark

Radio Sounds
- Satanz Judge

Crosshairs
- Rjdriver

Audio Engineers
- Felix D. Hergenhahn (www.werbesprecher.de)
- Daniel Boist (www.db-sonic.de)

Plus a bunch of other people including the guys who made a lot of the free
textures we used in our maps.



==============================================================================
Map Credits
==============================================================================

cctf1   Bletey's Return           Thumper / DD
cctf2   Twice as Hard             DD
cctf3   Dead Zone                 DD
cctf4   Desert Cemetary           Hype
cctf5   Classic Capture Showdown  DD
cctf6   Twisted Base              Hype
cctf7   Heart of Dungeon          Yuri Davidoff
cctf8   Canyon of Lost Souls      Nuke
cctf9   Dragle's Castles          Hype
cctf10  Valley of Fallen Kings    Invictus
