[UT99] UT Reporter v2.2.2

Description

UT Reporter
V2.2.2 (Oct 24, 2001)

Created by TheFury, hacked by WebSlinger
For further information and updates can be found at http://www.planetunreal.com/ut​reporter. Alternatively come
find me in #theweb on the EnterTheGame IRC Network.
irc://irc.enterthegame.com/the​web

Description
-----------
UT Reporter (UTR) enables IRC based spectators to view a live broadcast of an Unreal
Tournament game. Depending on the configuration of UTR all in game messages (except
team say messages) can be broadcast to a "commentary channel". In addition to the
commentary channel a separate "scoreline channel" can be configured to which only score
information will be broadcast.

Features
--------
-Full message broadcast (except teamsay messages)
-Message filtering, remove certain message types from the broadcast (eg Auto Taunts)
-Send messages from IRC to the running UT game
-Configurable timed updates of score
-Ability to configure team names to reflect clans that are playing
-Configurable league / server name
-Admin mode, stops unwanted changes to UTR settings
-Reporter mode, enables certain IRC spectators the ability to summon game information
-Colour coded broadcasts based on team colours
-Web admin for both administrators and reporters

Installation
------------
UTR is a server side only module. There are no client downloads of any kind. All installation
instructions refer to your UT server.

-UMod distribution, double click Reporter.umod to install automatically with the default settings in your unrealtournament.ini. Note that this will not enable web admin for UTR.

-Zip distribution, extract reporter.zip to your Unreal TournamentSystem and Unreal TournamentWeb directories. Note there are no default settings installed as part of the zip distribution.

Once UTR has been installed you should then configure your servers ini file with the base UTR settings. Most leagues and multi-server sites use multiple ini files for each UT port that is being run. Each ini file will require a modification to enable a UTR broadcast for the UT port.

Standard UnrealTournament.ini (yours may be called something different)

[Engine.GameEngine] ServerActors=Reporter.UTReport​erController

[UWeb.WebServer] Applications[2]=Reporter.UTRWe​bAdmin
ApplicationPaths[2]=/UTR
Applications[3]=Reporter.UTRIm​ageServer
ApplicationPaths[3]=/UTRimages

[Reporter.UTRWebAdmin] AdminRealm=UTReporter admin

[Reporter.UTReporterConfig] ServerAddr=b0rk.uk.quakenet.eu​.org
ServerPort=6667
CommentaryChannel=#ut.reporter​.commentary
CommentaryEnabled=True
ScorelineChannel=#ut.reporter.​scoreline
ScorelineEnabled=True
ReporterNick=UTR
CommentaryLevel=5
AdminPassword=12345
ReporterPassword=54321
ScoreUpdatePeriod=60
LeagueName=
GameName=
RedTeamName=
BlueTeamName=
GreenTeamName=
GoldTeamName=
IRCCommand1=
IRCCommand2=
IRCCommand3=
MuteOnStart=False
ShowCredit=True
EnableIRCCom=True
Enabled=True
InGameAdvert=False
AdvertDuration=10
AdvertFreq=30
AdvertColour=(R=255,G=255,B=25​5,A=0)

Note that to enable web admin of the UTR the [UWeb.WebServer] section of the ini file will require updating with the information outlined above. If you do not wish to use web admin then do not insert the UTR lines into that section. If you do wish to use web admin, then make sure that you replace the [2] and [3] items with the next available slots (this will depend on if you have additional web admin modules installed on your server).

Command Set
-----------

All commands that are sent via IRC take the form:

/msg reportername password command parameter

The reportername refers to the IRC nickname of the reporter that you want the command sending to. The password must always be entered and may differ between commands. There are actually two passwords that provide admin access or reporter access. Certain commands will require admin access whilst others, mainly score and game information, require only reporter access. The command parameter specifies the command you want executing, and the parameter contains any relevant data for the command. All examples use an admin password of admin, a
reporter password of reporter, a reporter nickname of UTR and a IRC client command identifier of /.

Please refer to http://www.planetunreal.com/ut​reporter for a complete IRc command list.

Limitations
-----------

Currently UTR directly supports DM, TDM, CTF, and DOM game types. Other game types may work in part, though the score updates are unlikely to function correctly.

If you are running multiple ports on a host then ensure you choose an IRC server which supports clones from the same IP address.

Since UTR is broadcasting as a standard IRC user it will be subject to any restrictions imposed on the IRC network. If you do not grant UTR channel ops or protect it in another fashion then it is likely to be kicked due to flooding.

Your choice of name for the UTR IRC user may not be available. Again this is a feature of IRC.

The broadcast originates from the UT server. The traffic generated is small, but for some servers which are already struggling for bandwidth, UTR might just push the UT server under an acceptable level of performance. CPU performance will not be affected by more than 1 or 2 %.

Credits
-------

Thanks go out to the following people and groups:

From WebSlinger:
================

The Fury - for letting me hack his mod.

Clan Carpe Imperium [Ci] - for putting up with me, helping test, and giving ideas.

TheDuke and Allison - for helping to test.

Mongo - for showing me where the flag color is!

The +MF+ Most Feared Clan - BETA Testing

From The Fury:
==============

GamesInferno (www.gamesinferno.com) - undoubtably the best UK hosted UT servers there are... A great test bed for UTR. Big time thanks to Streaky for giving me access to the equipment to test on.

ExeCute - Constructive criticism and ideas, plus beta testing UTR in the Gemini league (www.go-gemini.co.uk)

Void - The clan who are unfortunate to have me as a player :) Thanks to these guys, especially Danzanti6, Qui and Nailz for their
comments and feedback.

Poker - The man who produced the inspiration for UTR. If you play Tribes then you should know Poker and his two excellent additions to the game - BWAdmin and TribesRadio. Check out www.pokerspockets.freeserve.co​.uk to see more of Poker's work.

Not to forget the other people who have seen UTR in action and urged me to finish it!

Version History
---------------
Oct 24, 2001 - Release 222

- DOM Support

Sep 5, 2001 - Release 2.2.1
Service Release - fixed bugs

- Reset team names was resetting Gold team to "Green"

- Getting version string was not reflecting new version number

13/08/2001 - Release 2.20
Cosmetic update, first release with WebSlinger's hacked code

- CTF Flag Icon: A little colored exclamation point to the left of a player's name will show that they have the flag. This will make it a bit easier to follow CTF games.

- ON JOIN /Notice: the bot will send a NOTICE to people entering the channel, letting them know what the current teams, score, map, scorelimit, and time remaining are.

- ON JOIN /msg: WHen the BOT enters the server and channel it will send a message to the room stating what the current teams, score, map, scorelimit, and time limit are.

- ShowTeamInfo updated with score: when the score of a game is shown, so is the team info for both teams, no need for a reporter or admin to request it

- ShowTeamInfo improved: Player ping and packet loss are now shown with player scores

- Reports Cleaned up a bit: Information is now pipe | delimited instead of using the brackets ][.

- FIXED: in CTF when a flag cap is made, the timer for timed score updates is reset

- FIXED: in CTF when the caplimit is reached to end a game, the score is only shown once

26/10/2000 - Release 2.00
Major update release. Fixes many bugs aswell as implementing the new features / changes outlined below:

- UTR is now not mutator based. This means it will not interfere with NGStats, and now does not need to be included in the servertravel command.

- administrator web access added.

- reporter web access added.

- UTR now automatically reconnects to IRC if it is kicked for flooding.

- message formats have been generally cleaned up based on user feedback.

- removed the annoying IRc credits broadcast (no one asked me to, but even I was getting fed up of seeing my name plastered all over IRC).

- new speclist IRC command will broadcast the names of the spectators in the UT game (note that there is a bug in this version where there will always appear to be 2 spectators. These are actually UTR spectators, and will be fixed in the next release).

- in game advertisement of if UTR is active, and if so, where it is broadcasting to (useful for public servers, not so useful for league servers).

- UTR can now be enabled or disabled during the game.

- god only knows what else - if you think Ive been keeping a list of the changes Ive been making then you are very much in the wrong :)

07/06/2000 - Release 1.01
Fixed a couple of minor problems with send boolean toggle commands through IRC.

06/06/2000 - Release 1.00
Initial release to public.