[----------------------------------------------]
| XConsole Enhanced System Console V2.81       |
|                                              |
| w/site: www.unrealize.co.uk                  |
| email: xconsole@unrealize.co.uk              |
| Release date: 17/08/2004                     |
[----------------------------------------------]

Updates:

        + Added fast spectate/play switch
	+ Fixed UTPure ShowIDs

What it does:

	Change colours of your teammates messages displayed in HUD.
	Easy change teams
	Logging in text or HTML with CSS support (works with CSHP but see notes below)
	Quickly dump console text to a log file
	Turns on/off various types of messages in console (not the HUD) for logging
	Can now use the console in Command, Say, Teamsay or Admin mode (must be logged in for that)
        Load/Save custom key configs (macros)
	Front-end for server Admin, UTPure, ASH and LeagueAS CSHP commands


=========================================================================================================

INSTALLATION

	*Warning* I've been informed that some CSHP setups might see XConsole as a cheat
	and may cause you to be kicked or even banned from a server, depending on the
	setup. But I have personally yet to experience anything like this. If you have
	any problems at all please email me.

    *First, if you have any macros saved, backup your XMacros.ini (in UTs sytem folder)
     and then copy it back there after installing, otherwise your macros will be lost!*
    
    1.	Run XConsole.umod installer
    2.	Start UT and go to advanced options (type 'preferences' in console)
    3.  Go to Drivers section, click on 'Console' and choose XConsole
    4.  Close the window and restart UT for changes to take effect

TO UNINSTALL

    1.  Go to advanced options and set console back to UT Console
    2.  Either use Setup to uninstall or delete the files manually from system folder

=========================================================================================================

Admin

	After logging in, level can be changed by selecting game type, map and any combination of five
	mutators. The map vote checkbox will select either BDBMapVote304 (and *only* this version) or
	League Assault map voting if League Assault is the game type. Note these mutators must be setup
	on the server to work.

=========================================================================================================

UTPure

	Pure commands can be issued via the various buttons
	To login type your pass into the text box and press enter or click the login button.
	Use up/down arrows to scroll back/forward through password history.
	Pure ON/OFF = enable/disable cheat protection (needs map restart)
	Show IPs = Lists player IPs in console.
	Netspeeds = Show player netspeeds.
	Tickrate = Show server Tickrate.
	Info = Show CSHP settings and info.
	Fix Teams = If enabled, balances the teams.
	Next Teams = Quickly changes your team.
	1st Person = Goes to 1st person view - ie behindview 0 - useful for speccing cheaters.
	3rd Person = Resorts to normal view.
	Show IDs = Lists unique player IDs - needed to kick cheaters.
	To kick/ban a player click 'Show IDs' button to find a players ID number, use one of the
	drop-down boxes to select his ID and press Kick ID or Ban ID button.

=========================================================================================================

ASH

	ASH commands can be issued via the buttons/drop-down boxes, with the exception of changing 
	replacement aimbot keybinds (MUTATE ASH ReplacementABKeybinds <? | Keybind>) due to
	lack of space and being a command that probably isnt used often in-game.
	To add/remove an admin type 'name | IP' in the text box and click Add or Del button.
	Use up/down arrows to scroll back/forward through admin history.
	
	"?" - Displays the current value of a command
	ON - Turns the command ON
	OFF - Turns the command OFF

=========================================================================================================

League Assault

	LeagueAS and CSHP commands issued via buttons (note: List Maps requires the MapVote mutator to be
	running (LeagueAS-SP.MapVote))
	CSHP Info = Display settings and info about CSHP
	Show Cheats = List cheaters currently playing
	Kick Cheats = Kick cheaters (with security level 0)
	Cheat Test = Stops CSHP reporting for your IP only
	X HUD = ToggleExtendedHUD (shows more detailed objective info)
	Mute = ToggleMute (cycles through mute enemies, mute all, mute off)
	List Maps = Prints current map list in the console
	Vote button and dropdown box = Map Vote controls
	
	THX DaTel and '//3iRd(o) for the  info.

=========================================================================================================

CONSOLE COMMANDS
 
 	Trans                  Toggles console transparency on/off
 	Beep                   Toggles console message beeps on/off (only script messages)
 	Help or ?              Shows help
	Log                    Logging on/off - does not save state when you shut down UT
	Lock                   Log Lock on/off - on will auto start logging every time UT boots up
	TimeLog		       Log Timestamp on/off (not in safe mode)
	Rounds		       Assault logging in rounds on/off
	SafeMode	       Safe mode on/off 
	/C /S /T /A	       Change console mode between 'command','say', 'teamsay', 'Admin' modes
 	/		       Use slash as an escape character to type console commands while in speech modes
	/Me		       Displays your name mIRC style(ish) if used at the start of a line
	Info		       Some info about server, map, date, time etc.

CONSOLE/BIND/EXEC COMMANDS

        Echo                   Echoes text to console
        Exo                    Echoes test to console + HUD
	Dump		       Instantly dumps console text to a [Dump] log file

EXTRA COMMANDS (meant for debugging but left in for now):
 
        Load 		       Manually load settings from XConsole.ini (normally automatic)
        Save 		       Manually save settings (normally automatic)
        LoadTimer	       Loads the log timer (rogue actor) and also leaves safe mode logging
        KillTimer	       Dumps the log timer actor and goes to safe mode logging

*notes: None of these are case sensitive
        In say or teamsay modes, you must use '/' to make any console commands
        To swap back to command mode from say or teamsay use '/c'
        Bind/Exec commands work from keybinds and in an execed file but usually only offline so eg use 
        'Disconnect | Dump'


=========================================================================================================

LOGGING ISSUES

There are problems with Enhanced CSHP which might mean having to log in 'Safe Mode' and there may also
be conflicts with ngStats local logging because Ive overridden the existing UT functions to open/close/write
to ngStat files since I know 0 about C++ and making DLLs like other chat loggers use.

CSHP: 

        CHSP scans for 'rogue actors' that are running in your client when you join a server, to check for
        aimbots and other cheats. Unfortunately client-side chat loggers and irc reporters also need a sort
        of 'rogue actor' to update the game events in realtime. Logging in normal mode seems to work pretty
        well with most CSHP, although it does get reported as using a 'rogue actor' in the server log
        (XConsole_LogActor) But, with 'Enhanced' types of CSHP the normal logger wont work at all (although
        all the other console features/commands seem ok). You must use 'safe mode' logging for these servers
        or use the 'Dump' button/command.

League Assault and 'Enhanced' CSHP

       So far the only way Ive found to log these games is in safe mode - this protection seems to stop
       anything that isnt a legit original UT actor or server-side mod from running at all.


Turning safe mode on/off:

        Use the 'Safe Mode' checkbox/command to do this. Its probably best to do this between games, 
        not while on a server. You can also use 'LoadTimer' and 'KillTimer' to do this.
        
        *note: when you first install XConsole it will be in safe mode by default

Pros of safe mode:

        Should work with *any* type CSHP protection
        Does not use any 'rogue actor' so you shouldn't ever get kicked or reported
        There shouldn't be any alerts in the server log so it will keep the admins happy :p
	
Cons of safe mode:
		
	You cant have any timestamps in the log because its not 'real-time' logging
	500 line limit per game excluding the server info and other bumf  (down to UTs text area size limit)
        Actually does the logging between map changes (ie offline) so quiting UT too fast (or if it crashes)
        might lose the info and the log.
        Maybe a slight delay between map changes, as its writing the file

        
        *I've experimentally set it for 1000 lines, but don't know at this stage whether some CSHP resets it
        back to the default 500 or not

=========================================================================================================

BUGS

For any problems, bugs, crashes etc please mail me at xconsole@unrealize.co.uk including:
 
	Your UnrealTournament.log in the UnrealTournament\System folder (make a copy before restarting UT)
	Your XConsole.ini file
	Which server you were playing on
	Which map you were playing
	What commands, buttons etc you were using if it made UT crash
	What type CSHP (especially if you have problems with logging)


Assault Messages:

Assault messages eg like 'The tank was destroyed' in Guardia, are built into the map (in the FortStandard)
and I havent yet found a way to turn these off.

CSS support:

For some reason CSS seems to only work with IE, so Mozilla, Firebird, Netscape etc may have problems

=========================================================================================================

FILE LIST

 	UnrealTournament\System\:

 		XConsole.u = the main package
 		XConsole.ini = saved settings
 		XConsole.int = info for UT about the package
                XMacros.ini = saved key macros settings

 	UnrealTournament\Help\XConsole\:

 		ReadMe.txt

	UnrealTournament\XLogs:

		A folder for log files which also contains style.css and favicon.ico
	

=========================================================================================================

Thanks goes out to all the beta testers in <[NBS]> and UTAssault for help and encouragement, to 
<[NBS]>Matanza for getting me started on this, and to -)BiB(- Desdecado and -)BiB(- Joko for help with
ideas and format.


Dave

AKA <[NBS]>~V~, and HeadCase in the UTAssault forum

=========================================================================================================


