*********
*********
Readme file mircbot
 IRCBOT v0.4.1 by nWo|tK
original text:
This is a heavily modifiedversion of the irc bot which was included with the old Aseco/RASP.

What does it do?
- Relay game scores and times and playernames from all gamemodes (team, rounds and time attack)
- Relay chat from IRC to TMN and the other way around ** NEW in v0.4 **

- In Team Mode

Show the top x playernames and their times each lap.
Live Team score update each lap.
Blue colors for blueteam players and Red colors for redteam players.
Give names to the Blue and Red team.
- In Rounds mode
Show the top x playernames and their times each lap.
Live Top player score each lap.
- In Time Attack mode
Show the top x playernames and their times on each map.

- Chat through the BOT using a simple ingame command
- Join or Leave IRC channels
- Specify a IRC channel to broadcast in
- And alot more!


FIXES:

- Changed the setup so that you don't have to replace any existing files
- Fixed the problem that it wouldn't connect to Quakenet
- Changed method to keep connection alive
- Added auto reconnect function when disconnected from IRC


=======================================
IRC BOT INSTALL v0.4.1 FOR Aseco RASP TMF 
=======================================

1. Make sure the ASECO 1.2.4. and RASP 2.2.4 are running (without errors).
Should work on newer versions aswel.

2. Copy the unzipped/unrarred files to the correct folders.
- plugin.irc_bot.php to the /plugins dir

3. Edit plugins.xml and add
<plugin>plugin.irc_bot.php</plugin> 
somewhere at the end

4. Edit plugin.irc_bot.php you have copied to the plugins dir and change the IRC Variables. The following have to be changed:
>> ONLY CHANGE THE TEXT BETWEEN THE SECOND ''

'nick' => 'IRCBOT1', // Change this to whatever botnick you'd like
'nick2' => 'IRCBOT2', // Change this to whatever back-up botnick you'd like (if first one is taken)
'channel' => '#ircchannel', // Change this to the IRC channel you'd like to join on startup. Don't forget the #
'serverlogin' => 'serverloginhere', // Specify the serverlogin here. Use lowercase.
'ircadmin' => array(
0 => '@youradminircip',
1 => '@Anotherircadmin.users.quakenet.org' // when adding more, dont forget to add , at the end of the previous line (not the last one).

>> If you get an error when starting Aseco.bat or Aseco.sh, you prolly forgot a ' or a , !!
>> (I will work on a XML file in the future)

6. Start aseco.bat

=======================================
IRC BOT INSTALL v0.4.1 FOR Aseco 0.95
=======================================

1. Make sure the latest ASECO/RASP v0.95 are running (without errors).
Should work with older versions aswel (v0.93 tested and OK).

2. Copy the unzipped/unrarred files to the correct folders.
- plugin.irc_bot.php to the /plugins dir
- irc.settings.php to the /includes dir

3. Edit plugins.xml and add
<plugin>plugin.irc_bot.php</plugin>
somewhere in the middle

4. Edit irc.settings.php and change the IRC Variables. The following has to be changed:
- $IRC_CONFIG['nick'] = 'theIRCBOTnickhere'
- $IRC_CONFIG['channel'] = '#channeltojoin'
- $IRC_CONFIG['serverlogin'] = 'myserverloginhere' < this is very important, if its incorrect try lowercase.
- $IRC_CONFIG['ircadmin'][x] = '@iphere' < add as many IRC admins you want, but replace x with a unique number (start with 0, then 1 etc). Also do not forget the @.

5. Open and edit Aseco.php in the main folder and add: require_once('includes/irc.settings.php'); // IRC config settings
Below this line: require_once('includes/rasp.settings.php'); // specific to the RASP plugin

6. Start aseco.bat


=======================================
IRCADMIN INGAME COMMANDS
=======================================
Start every command with /irc <command>.
Note: edit irc.settings.php $IRC_CONFIG['allowadmin'] and $IRC_CONFIG['allowoperator'] to adjust the security level of /irc command
Availible commands (NOTE: DO NOT USE CAPITAL LETTERS):

swich on > Turns the IRCBOT on
swich off > Turns the IRCBOT off (does not disconnect from IRC)
------
channel broadcast #channel > Broadcast in a channel, if the BOT is not in this channel yet, it will join it first
channel leave #channel > Leaves a IRC channel, only possible when the channel you want to leave is not the broadcast channel
channel join #channel > Joins a IRC channel, but the broadcast channel will not change
------
say <some text here> > Say something on IRC through the BOT
------
blue <team name> > Change the Blue team name (more than 1 word allowed)
red <team name> > Change the Red team name (more than 1 word allowed)
------
recs round <number> > Number of times shown in IRC for every lap (in TEAM and ROUNDS mode only)
recs track <number> > Top x players shown at the end of each track (in ROUNDS and TIME ATTACK mode only)
------
chatter on > Enables 2-way communication between TMN <-> IRC ** NEW in v0.4 **
chatter off > Disables 2-way communication between TMN <-> IRC ** NEW in v0.4 **
------
reconnect > Reconnects the IRCBOT. Does not ask for confirmation, so make sure it is disconnected.
------
style old > old color style in IRC
style new > default new style


=======================================
PUBLIC INGAME COMMANDS
=======================================

/ircinfo
This will show info about the current IRC BOT status

/pmirc <IRCNICK> <some text here> 
sends a msg to an IRC user


=======================================
IRC COMMANDS ** NEW in v0.4 **
=======================================
These commands can be executed in the IRC channel where the BOT is located, or by PRIVMSG to the IRCBOT.
Note: These commands can only be executed by IRC admins. Add the ip's of them in irc.settings.php ($IRC_CONFIG['ircadmin'][x] = '@iphere')
All commands start with !admin.

restart > restarts current challenge.
------
nextmap > skips current challenge.
------
rounds <alternate rules: yes/no> <pointslimit> > change gamemode to rounds.
------
team <alternate rules: yes/no> <pointslimit> <maxpoints> > change gamemode to team.
------
timeattack <minutes> > change gamemode to timeattack with a <minutes> timelimit.
------
swich on > Turns the IRCBOT on
swich off > Turns the IRCBOT off (does not disconnect from IRC and commands are still executed)
------
serverpass <newpass> > change server password
specpass <newpass> > change server spectator password
servername <newservername> > change servername
------
help > gives a list of available commands
------
kick <login> > kick a login (use players for a list of players)
ban <login> > ban a login (use players for a list of players)
------
players > gives a list of players and spectators currently on the server.
------
pm all <some text here> > send a msg to all players ingame
pm <login> <some text here> > send a private msg to player login
------
chatter on > Enables 2-way communication between TMN <-> IRC
chatter off > Disables 2-way communication between TMN <-> IRC

edited by w1lla v 0.4.2b .
 added on 27.06.2008:
the following things:
!admin specpw: shows specpw
!admin playerpw: shows playerpw
!admin comment: sets and gets servercomment
!info shows where the server is located.
!relay shows the relay server tmtp://
added !admin blacklist to blacklist people.
edited the /ircinfo command
added the following things in irc.settings.php:
$IRC_CONFIG['preset'] = '2'; // set the default style in IRC, use 2 (new). as this is much nicer to read.

$IRC_CONFIG['auth'] = ''; // Enter your quakenet auth here

$IRC_CONFIG['authpass'] = ''; // Enter your quakenet auth password here

$IRC_CONFIG['servername'] = $IRC_CONFIG['colors2']['11'].'Change Name for Server'.$IRC_CONFIG['colors2']['12'].' Server'.$IRC_CONFIG['colors2']['4'];

$IRC_CONFIG['Country/ManiaZone'] = ''; //country/maniazone of where the server is ;)

$IRC_CONFIG['joinserver'] = 'tmtp://#join='; // is for tmtp:// join server

$IRC_CONFIG['relayserver'] = 'tmtp://#spectate='; // set tmtp:// code of the relay server in here and in mirc when someone type !relay it will give the tmtp code. 


everything in irc_settings.php can be edited.




also add this line in aseco at round 43.

require_once('includes/irc.settings.php'); // specific to IRCBOT.
and add this line in plugins.xml

<plugin>plugin.irc_bot.php</plugin>


Some things are edited and tested by Geroke` also known as Geronimo.

*********
*********
