Noname CTF v0.2
A CTF Mod for Unreal   
http://www.captured.com/nonamectf

-----------------------------------------------------------
1 - Welcome + Updates
-----------------------------------------------------------

	This is the first public release of NnCTF.  Please note that this is
NOT the 1.0 release.  It is an early release and should be considered as such!
In other words, expect bugs, unimplemented features, etc.

Current release notes:
* The armor items that seem to be all over the place will eventually be runes.
* The grappling hook currently over-rides the Razorjack.  If this bothers you,
  simply turn off the grappling hook in the "Configure Game" menu.
* If you have the grappling hook option turned on and someone picks up the
  grappling hook, they will lose the hook.  For now, NnCTF will remove any
  instances of the Razorjack, *BUT*, only if the grappling hook is enabled.
* The grappling hook has problems with portals.


Version 0.2:
* HUD/console bug fixed.
* New rune code.
* Quad code added.
* Early Grappling Hook (using Jwindy's hook at
  http://gladstone.uoregon.edu/~jwindshe/unreal/ )
* Early Darkmatch code.  This will allow all the lights on a particular level
  to be dimmed by a server-set percentage.  Right now this code has network
  problems.  IE, it only works on the server.  I think I know how to fix this
  though.

Version 0.1:
* Basic CTF structure (flags, ability to steal and capture flags, etc.)
* Custom HUD
* Custom Scoreboard
* Partially-implemented "Configure Game" menu
* All DM maps included with Unreal are CTF-playable (only flags have been
  added, spawn points have not been adjusted for team play.)
* Runes partially implemented, yet they still don't work correctly under 209.




-----------------------------------------------------------
2 - Installation
-----------------------------------------------------------

Run the installer and specify where your Unreal directory is located.

Then open your unreal.ini file in notepad (or some other editor) and find the
part labeled:

[UnrealI.UnrealServerMenu]

In the list of games, add NnCTF.NnCTFGame and then increment MaxGames by 1.

Here's an example of what the end result might look like this:

[UnrealI.UnrealServerMenu]
Map=DmExcavation.unr
GameType=UnrealI.DeathMatchGame
Games[0]=UnrealI.DeathMatchGame
Games[1]=UnrealI.TeamGame
Games[2]=UnrealI.KingOfTheHill
Games[3]=UnrealI.DarkMatch
Games[4]=UnrealI.CoopGame
Games[5]=NnCTF.NnCTFGame
Games[6]=
Games[7]=
Games[8]=
Games[9]=
Games[10]=
Games[11]=
Games[12]=
Games[13]=
Games[14]=
Games[15]=
MaxGames=5

-----------------------------------------------------------
3 - Credits/Contacts
-----------------------------------------------------------
NOTE TO TEAM: Contact me if I have not included you in the credits.

(In alphabetical order by first name)

Coders
----------------------------------------------------------------------------
David "VicViper" Ludwig				- davidl@captured.com
James "StarDrifer" Abbatiello		- abbeyj@wpi.edu
Andreas Jobs						- Andreas.Jobs@ruhr-uni-bochum.de
Ryan "Garrland" Stolle				- garrland@thepoint.net
Jered "Jwindy" Windsheimer			- jwindshe@gladstone.uoregon.edu
Wesley "Wezo" Lao					- weslao@home.net

Design/Gameplay
----------------------------------------------------------------------------
(to be completed)

Leadership (Da Big Cheeses)
----------------------------------------------------------------------------
Coding - David Ludwig
Design/Gameplay - Luke "weasl" Whiteside


-----------------------------------------------------------
4 - Class Info
-----------------------------------------------------------

The important variables you should know all reside in the NnCTFGame class.
This is where all the options, etc. reside.  Basically, anything a server
admin would want.  It is also important to know that NnCTFGame, for the time
being, is a subclass of TeamGame.  So therefore it should support most of the
options offered in TeamGame and DeathMatchGame.

bool	bAutoFlagReturn;		// should the flag be returned automatically?
bool	bCaptureWithFlag;		// does one's own flag need to be in base in order
								// for the flag to be captured?

bool	bHook;					// should a grappling hook be given to everyone automatically?

float	teamCaptureBonus;		// how many points should a team get for a capture
float	playerCaptureBonus;		// how many points should the capturing player get

bool	bDarkmatch;				// should the lights be dimmed (or increased)
float	lightChangePct;			// by what margin should the light be dimmed (1.0 is 100%)


Changing these variables is documented in Tim Sweeney's console command doc,
which is available on http://unreal.epicgames.com

Anyway, here is the basic syntax for changing them:

get NnCTFGame <variable>			- Gets a value
set NnCTFGame <variable> <value>	- Sets a value


-----------------------------------------------------------
5 - Known Bugs
-----------------------------------------------------------
* When a flag is being carried, it's following movement will occassionally get
  choppy, particularly after going through a teleporter.  Originally, the
  player would simply lose the flag (without having been killed or having
  captured the flag.)  As noone on the team can figure this out yet, a hackish
  fix has been added which checks the flag's location using the Timer()
  function and then updates it if it is off.
  
* The Advanced CTF Options menu shows a bot config menu.  In the code, it
  spawns the advanced menu identically to how the bot config menu is spawned.
  However, it shows the bot config menu for whatever reason.  In the future, I
  plan not to extend the UnrealDMGameOptionsMenu but rather UnrealGameOptions
  or something higher up the tree.

* Runes appear (as armor), but they do nothing.  The rune code works fine in
  version 200, but not 209.  Mr. Sweeney?
  
* The grappling hook cannot correctly travel through portals.

Please read the notes in Section 1 for more information about bugs/etc.

This is all I can think of now.  Please send mail to davidl@captured.com with
any new bugs.


-----------------------------------------------------------
6 - Code Sharing Policy
-----------------------------------------------------------

The code is and always will be available for users to look at, learn from, and
extend.  We simply ask that you not distribute your modified mod as an official
NnCTF release.  We also ask that you contact us before hand.

If you're interested in putting together a CTF mod based off the NnCTF code, or
you'd like to make a contribution to the official codebase, contact David at
davidl@captured.com

If you're interested in helping out on the design side of things (maps, sounds,
textures, etc.), contact Luke at weasl@cnw.com


