|
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 /.
Admin commands
command: serveraddr
parameter: valid IRC server address
access level: admin
description: Sets the IRC server address for
future broadcasts. This change will occur on the next
map change or level restart.
example: /msg UTR admin serveraddr b0rk.uk.quakenet.eu.org
command: serverport
parameter: valid IRC server port
access level: admin
description: Sets the IRC server address for
future broadcasts. This change will occur on the next
map change or level restart.
example: /msg UTR admin serverport 6667
command: comchnl
parameter: valid IRC channel
access level: admin
description: Sets the channel for commentary
broadcasts. This change occurs immediately.
example: /msg UTR admin comchnl #ut.reporter.commentary
command: comon
parameter: on/off or 1/0
access level: admin
description: Enables or disables commentary broadcasts.
This change occurs immediately.
example: /msg UTR admin comon on
/msg UTR admin comon 0
command: scorechnl
parameter: on/off or 1/0
access level: admin
description: Set the channel for scoreline broadcasts.
This change occurs immediately.
example: /msg UTR admin scorechnl #ut.reporter.scores
command: scoreon
parameter: on/off or 1/0
access level: admin
description: Enables or disables scoreline broadcasts.
This change occurs immediately.
example: /msg UTR admin scoreon on
/msg UTR admin scoreon 0
command: repname
parameter: valid IRC nickname
access level: admin
description: Sets the reporters IRC nickname.
This change occurs immediately. If the nickname is already
in use a new nickname based on the supplied parameter
will be generated.
example: /msg UTR admin repname UTR][
command: adminpass
parameter: valid single word
access level: admin
description: Sets the admin password. This change
occurs immediately. The password must be a single word
only. Specifying more than one word will result in only
the first supplied word being used for the password.
example: /msg UTR admin adminpass admin2
command: reppas
parameter: valid single word
access level: admin
description: Sets the reporter password. This
change occurs immediately. The password must be a single
word only. Specifying more than one word will result
in only the first supplied word being used for the password.
example: /msg UTR admin reppass reporter2
command: comlvl
parameter: number in range 0 to 5
access level: admin
description: Sets the commentary level. This
affects the messages that are broadcast to IRC and can
be used to filter out specific message types. The parameter
range corresponds to:
0 = Human admin / reporter generated
messages (ie responses to IRC UTR commands)
1 = Score messages
2 = General UT messages (eg player joined)
3 = Player messages (generated by the say UT command)
4 = UT taunts
5 = UT auto taunts
Note that the way in which this works is that if you
specify a param of 3, then all player messages aswell
as general UT messages, score messages and human response
messages are broadcast. If you specify a parameter of
4 then all the previous messages are broadcast along
with UT taunts.
example: /msg UTR admin comlvl 2
command: updperiod
parameter: number 0, or 30+
access level: admin
description: Sets the timed score broadcast period.
The paramter should be entered as the number of seconds
between timed score broadcasts. This does not affect
any other commentary broadcasts. If a valueof 0 is specified
then timed score broadcasts will be disabled. A minimum
of 30 seconds between broadcasts is enforced.
example: /msg UTR admin updperiod 60
command: leaguename
parameter: valid IRC text
access level: admin
description: Sets the league name to be broadcast
as part of score updates and game information. The parameter
can be any text so it does not necessarily have to reflect
the name of the league but could instead reflect a specific
game name (eg Clan X vs Clan Y, Game 1, League Final).
If a blank parameter is passed then the server name
will be used in place of the leaguename.
example: /msg UTR admin leaguename UT World Championship,
Game 1
command: redteamname
parameter: valid IRC text
access level: admin
description: Sets the red team name. If a blank
parameter is passed then the red team name will be set
to "Red".
example: /msg UTR admin redteamname Clan X
command: blueteamname
parameter: valid IRC text
access level: admin
description: Sets the blue team name. If a blank
parameter is passed then the blue team name will be
set to "Blue".
example: /msg UTR admin blueteamname Clan Y
command: greenteamname
parameter: valid IRC text
access level: admin
description: Sets the green team name. If a blank
parameter is passed then the green team name will be
set to "Green".
example: /msg UTR admin greenteamname Clan 1
command: goldteamname
parameter: valid IRC text
access level: admin
description: Sets the gold team name. If a blank
parameter is passed then the gold team name will be
set to "Gold".
example: /msg UTR admin goldteamname Clan 2
command: resetteamnames
parameter: none
access level: admin
description: Resets all team names to the defaults.
example: /msg UTR admin resetteamnames
command: irccommand1
parameter: valid IRC command
access level: admin
description: Sets the first IRC command text
to be sent when UTR connects to IRC. The parameter must
take the format of a valid IRC command, not a mIRC command.
If you do not know the difference then you really shouldn't
be using this facility :) This facility can be used
to autologin to IRC bots etc, thus enabling you UTR
to become auto op'ed, voiced or just generally protected
from IRC dicks...
example: /msg UTR admin irccommand1 PRIVMSG Q
:auth MyQUsername MyQPassword
command: irccommand2
parameter: valid IRC command
access level: admin
description: Sets the second IRC command text
to be sent when UTR connects to IRC.
example: /msg UTR admin irccommand2 PRIVMSG Q
:auth MyQUsername MyQPassword
command: irccommand3
parameter: valid IRC command
access level: admin
description: Sets the third IRC command text
to be sent when UTR connects to IRC.
example: /msg UTR admin irccommand3 PRIVMSG Q
:auth MyQUsername MyQPassword
command: irccom
parameter: valid IRC command
access level: admin
description: Issues an IRC command specified
in the parameter in the context of UTR. Effectively
this sends an IRC command via the UTR. Depending on
the channel priveleges this can be a very power command
so be careful who you give your admin password to.
example: /msg UTR admin irccom mode #ut.clan.channel
+o MyCurrentIRCNick
/msg UTR admin irccom PRIVMSG #ut.clan.channel :My message
to be sent via UTR to IRC
command: showconfig
parameter: none
access level: admin
description: Broadcasts multiple NOTICE messages
to you detailing the current UTR configuration.
example: /msg UTR admin showconfig
command: msg
parameter: valid IRC text
access level: admin
description: Sends a message from IRC into the
current UT game. The message will be displayed using
your IRC nickname: message.
example: /msg UTR admin msg Stop auto taunting.
Auto taunting is for newbie llama's or members of lame
clans.
command: ver
parameter: none
access level: admin
description: Broadcasts to IRC the current version
information for UTR.
example: /msg UTR admin ver
command: mute
parameter: on/off or 0/1
access level: admin
description: Mutes all broadcasts from the reporter
to IRC.
example: /msg UTR admin mute 0
command: startmute
parameter: on/off or 0/1
access level: admin
description: Enables you to mute the reporter
at the start of a level restart or map switch. The most
common time for IRC kicks is during a busy game's map
switch. By muting the reporter the kick does not occur,
though broadcasts will have to be enabled using the
mute command.
example: /msg UTR admin startmute 0
command: gameadvert
parameter: on/off or 0/1
access level: admin
description: Enables or disables an in game advert.
The advert tells the players where the broadcast is
being sent to. This is not useful for anything other
than public servers.
example: /msg UTR admin gameadvert 0
command: gameadvertdur
parameter: number 0, or < 10
access level: admin
description: Sets the duration of advert in seconds.
An advert may be displayed for a maximum of 10 seconds.
example: /msg UTR admin gameadvertdur 5
command: gameadvertfreq
parameter: number 0, or > 30
access level: admin
description: Sets the delay between adverts in
seconds.
example: /msg UTR admin gameadvertfreq 120
Reporter commands
command: showscore
parameter: none
access level: reporter
description: Broadcasts the current game score
to the commentary channel and/or the scoreline channel.
example: /msg UTR admin/reporter showscore
command: showteam
parameter: 0/1/2/3 or real team name
access level: reporter
description: Broadcasts information regardning
the team specified to IRC the commentary channel and/or
the scoreline channel.
example: /msg UTR admin showteam 0
/msg UTR admin/reporter showteam MyClanName
command: showgameinfo
parameter: none
access level: reporter
description: Broadcasts current game information
to the commentary channel and/or the scoreline channel.
example: /msg UTR admin/reporter showgameinfo
command: speclist
parameter: none
access level: reporter
description: Broadcasts a list of spectators
to the commentary channel.
example: /msg UTR admin/reporter speclist
|