
  Admin Toolkit - Admin fun for UT3
  Copyright (c) 2005-2007 Rodney Powers
  December 29, 2007
	
-------------------------------------------------------------------------------

	1. Description
	2. Installation
	3. Overview
		3.1. Commands
			3.1.1. Help
			3.1.2. Commands
			3.1.3. Register
			3.1.4. Access
			3.1.5. Grant
			3.1.6. Macro
		3.2 Player Selection
		3.3 Lookup Tables
			3.3.1 Hud Table
			3.3.2 Weapon Table
			3.3.3 Vehicle Table
	4. Credits
	5. Change Log

-------------------------------------------------------------------------------

1. Description:

	Admin Toolkit is a mutator for UT3 that gives admin more control over there
	games. It is a collection of many of the common admin commands plus
	additional ones combined with greater control over who the commands affect
	and what they can do.

	Additionally, it provides a framework for adding new commands and then
	inserting them onto a server on the fly without restarting the server or
	changing maps.

-------------------------------------------------------------------------------

2. Installation:

	* To insall, copy the enclosed UTGame folder into the following location:
	
	Vista:
	
	C:\Users\<Your username>\Documents\My Games\Unreal Tournament 3\

	XP:
	
	C:\Documents and Settings\<Your username>\ My Documents\My Games\Unreal Tournament 3\

	After that, add this as a mutator to your game or server.

	Server can append ?mutator=AdminToolkit.AdminToolkit to their launch
	string to aumatically include the mutator.

-------------------------------------------------------------------------------

3. Installation:

	I'm not going to go over every command here. Every command already comes
	with its own help. I'll list some of the administration commands that will
	be useful however.

3.1 Commands

	All commands are accessed by using a mutate string. In single player mode
	all the commands are available. In only mode admins can use all commands,
	(think of them as super users), and other users can only use commands
	that admins have given them access to. See the Grant and Access commands
	for information about permissions.

3.1.1 Help

	This is the most basic command which will provide you with help about
	any command in the system. Just use the format:
	
	mutate help <command>

3.1.2 Commands

	This command will list all the available commands to you given your
	access level. You can optionally supply a match string to limit down
	the search.

	Example:
	
		mutate commands
		mutate commands Set*

3.1.3 Register

	When you want to add commands to or remove commands  from the toolkit,
	you can use the	register commands. This command has multiple formats
	that will let you specify a single commands from a package or an
	entire collection of commands in a package. The formats are:
	
	mutate register -p AdminStockToolkit
		This will find the package AdminStockToolkit and run register
		on it.

	mutate register -u -p AdminStockToolkit
		This variant unregisters the toolkit, removing all the commands.

	mutate register AdminStockToolkit.SetLivesCommand 0
		Registers the SetLives command only with access level 0.

	mutate register -u AdminStockToolkit.SetLivesCommand
		Unregisters the SetLives command only.

3.1.4 Access

	Access allows you to change the access level of a command. Access
	levels are simply numbers with 0 being the highest level access
	and positive values defining lower sets of access. 100 is the default
	level for all users on the server and all the commands are set to
	0 by default. Access can be used as follows:

	mutate access list
		List all the commands and their access levels.

	mutate access list Set*
		List all the set commands and their access levels.

	mutate access set SetSize 0
		Sets SetSize to access level 0.

	mutate access set SetSize 100
		Sets the access level of SetSize to 100. This value will allow
		any player on the server to use the command.
	
3.1.5 Grant

	Allows you to grant a higher level of access to a user. This lets your
	set up groups of people who can use certain commands.

	mutate grant Player 50
		Sets Player to level 50. This means they can use all commands that
		have an access level of 50 or higher.

	mutate grant -r Player
		Removes the access granted to player, returning them to a 100
		level.

3.1.6 Macro

	The macro command will let you set up a list of commands to run using only
	a single command. It supports paramter substitution using %0 to %9. An
	example usage would be:

	mutate macro add ArmorAndHealth sethealth %0 max; setarmor %0 max max max max

	This adds an ArmorAndHealth command that takes one argument. It can be used
	like this:
	
	mutate ArmorAndHealth All
	
	And now everyone would be maxed out on health and armor.

3.2 Player Selection

		Most commands have a player parameter. This parameter can be one of
		various things to affect one or more players.

		.           : Affects you.
		All         : Affects all players.
		Red         : Affects the red team.
		Blue        : Affects the blue team.
		Player Name : Affects only that player.
		Monsters    : Affects all monsters.
		$rand(x)    : Affects a random X% of the players.
		$mrand(x)   : Affects a random X% of the monsters.

		For a list of players just a comma seperated list with NO spaces.

		Using ! before any of these means to remove those players.

		You can use wild card * (match none or more) and ? (match single char) in player
		names.

		Examples:
			Red,Admin1
				Affects the red team and Admin1.

			Admin1,Player1,Player2
				Affects Admin1, Player1, and Player2.

			All
				Affects everyone.

			Red,Blue
				Pretty much affects everyone.

			All,!Player
				Everyone but player.

3.3 Lookup Tables

	Many of the commands require class names which can be tedious to remember.
	Instead you can use the lookup tables to edit the list of Weapons, Vehicles,
	Items, Hud screens, and so on. Use the mapedit command to edit these list.
	You can even add your own later if you add new packages to your server.

	These tables are used by various commands like Summon to translate short
	names into the class names.

	Following is the default setup of the built in lookup tables.

3.3.1 Hud Table

	Abbreviation					Class
	------------------------------- -------------------------------------------
	DeathMatch						UTGame.UTHUD
	DM								UTGame.UTHUD
	DuelGame						UTGame.UTDuelHUD
	Duel							UTGame.UTDuelHUD
	DG								UTGame.UTDuelHUD
	CaptureTheFlag					UTGame.UTCTFHUD
	CTF								UTGame.UTCTFHUD
	VehicleCaptureTheFlag			UTGame.UTVehicleCTFHUD
	VCTF							UTGame.UTVehicleCTFHUD
	Onslaught						UTGame.UTOnslaughtHUD
	ONS								UTGame.UTOnslaughtHUD
	Warfare							UTGame.UTOnslaughtHUD
	WAR								UTGame.UTOnslaughtHUD

3.3.2 Vehicle Table

	Abbreviation					Class
	------------------------------- -------------------------------------------
	Cicada							UTGameContent.UTVehicle_Cicada_Content
	DarkWalker						UTGameContent.UTVehicle_DarkWalker_Content
	Fury							UTGameContent.UTVehicle_Fury_Content
	Goliath							UTGameContent.UTVehicle_Goliath_Content
	HellBender						UTGameContent.UTVehicle_HellBender_Content
	Leviathan						UTGameContent.UTVehicle_Leviathan_Content
	Manta							UTGameContent.UTVehicle_Manta_Content
	Nemesis							UTGameContent.UTVehicle_Nemesis
	NightShade						UTGameContent.UTVehicle_NightShade_Content
	Paladin							UTGameContent.UTVehicle_Paladin
	Raptor							UTGameContent.UTVehicle_Raptor_Content
	Scavenger						UTGameContent.UTVehicle_Scavenger_Content
	Scorpion						UTGameContent.UTVehicle_Scorpion_Content

3.3.3 Weapon Table

	Abbreviation					Class
	------------------------------- -------------------------------------------
	Avril							UTGameContent.UTWeap_Avril_Content
	AV								UTGameContent.UTWeap_Avril_Content
	BioRifle						UTGameContent.UTWeap_BioRifle_Content
	BR								UTGameContent.UTWeap_BioRifle_Content
	Enforcer						UTGame.UTWeap_Enforcer
	EN								UTGame.UTWeap_Enforcer
	FlakCannon						UTGame.UTWeap_FlakCannon
	Flak							UTGame.UTWeap_FlakCannon
	FC								UTGame.UTWeap_FlakCannon
	ImpactHammer					UTGame.UTWeap_ImpactHammer
	IH								UTGame.UTWeap_ImpactHammer
	LinkGun							UTGame.UTWeap_Linkgun
	Link							UTGame.UTWeap_Linkgun
	LG								UTGame.UTWeap_Linkgun
	RocketLauncher					UTGame.UTWeap_RocketLauncher
	RL								UTGame.UTWeap_RocketLauncher
	ShockRifle						UTGame.UTWeap_ShockRifle
	Shock							UTGame.UTWeap_ShockRifle
	SR								UTGame.UTWeap_ShockRifle
	SniperRifle						UTGame.UTWeap_SniperRifle
	SNR								UTGame.UTWeap_SniperRifle
	Stinger							UTGame.UTWeap_Stinger
	Mini							UTGame.UTWeap_Stinger
	MG								UTGame.UTWeap_Stinger
	Translocator					UTGameContent.UTWeap_Translocator_Content
	Trans							UTGameContent.UTWeap_Translocator_Content
	Redeemer						UTGameContent.UTWeapon_Redeemer_Content
	RD								UTGameContent.UTWeap_Redeemer_Content
	SSR								UTGame.UTWeap_InstagibRifle
	IGR								UTGame.UTWeap_InstagibRifle
	InstagibRifle					UTGame.UTWeap_InstagibRifle

-------------------------------------------------------------------------------

5. Credits:

	This was a solo project that relied heavily on the works of AdminPlus and
	Summoner. Many ideas were used from these packages. All the code contained
	in the packages however is my own, rewritten from scratch in this new
	framework original for 2004 and now UT3.
	
	* Epic Games: For making the Unreal Tournament series of games and
	  releasing the tools necessary for modding them.

	* Unrealwiki: Invaluable resource for figuring out why things don't work
	  the way you'd expected them too. Big thanks to all of the contributors
	  who keep that updated. Especially to all those who contributed to
	  wString.

	* Antonio Cordero Balczar: For creating WOTgreal which has made writing
	  mods so much easier.

	* All the other modders: Because the best way to learn how to do something
	  is reading how someone else did it.

-------------------------------------------------------------------------------

6. Change Log:

0.9 
	Beta release of AdminToolkit for UT 3.