[Cunin]

This is the official support thread for ACIRCBot.
It's a tool that would be useful for server owners only, so don't bother to download it if you're only a player.

Also, this is only for Windows 32/64 bit at the moment.



INTRODUCTION

This is an IRC relay bot made for AssaultCube. Its scope is to relay events happening in-game to an IRC channel. This allows server administrators to watch what's happening in-game without the need of being in-game. Players can also see if it's the right moment for them to join your server



PRE-REQUISITES

The bot reads gamelogs produced by the AssaultCube server, parses them and then sends them in a humanly-readable form on IRC. To make things easier (for me), I modified the sourcecode of the server to produce easily parsable logs.
In this archive you should have found the modified 1.0.4 sources (I only included the ones that I actually modified) and a Win32 executable of the server (ac_server.exe). You need to replace your server's executable with the one supplied to let the bot work.
The only modifications I've done are a simple change to output logs, and the inclusion of the code that can be found here:
http://woop.us/2075
for the map blacklisting.
You also need to have access to your server (preferably via RDP), to let you put the bot's executable and configure it via its GUI (Graphical User Interface).



FEATURES

- Fast and low resource usage. It should never use even 1% of your CPU power, and only a few Mb of RAM.

- Full IRC support. You can set server, port, nickname, identify password, channel, channel key, IRCOP password. It also will auto-reconnect on connection loss (even though it fails sometimes )

- Fully configurable through its GUI -or- from IRC with an extensive set of commands, no complicate command-line configuration.

- Fully customizable output format, and the possibility of selectively enable/disable each event's log output, through IRC or via its GUI.

- Total control over EVERY IRC command. You can easily set what IRC mode an user needs to use any command.

- Easy update. You just need to type '!update NOW' from IRC to let it check for an update. If one it's found, it'll automatically download and apply it.

- You can see the following event from IRC: kills, teamkills, votes, joins, quits, all chat, team chat, disconnects, match starts.

- Additionally, you can use 2 commands to see how many players are in-game, the game mode and the map played in that moment.

(the events support and the informations displayed will be expanded in the next releases)


Example of output:
 ACIRCBot_output.png (29.11K)
Number of downloads: 64


Use this thread for bug reports ONLY please. There's so much that can be added to the bot still, but it's a work-in-progress so I already planned to add lots of features in the future releases.
Also, read the included ReadMe file before asking any questions.

Enjoy

EDIT: I noticed that the uploaded version had our old IRC server by default, I've updated it to our current one (irc.exoduscommunity.com) and updated the archive. Should still work, but this is the right one. Sorry.

Attached File(s)

•  ACIRCBot.zip (302.67K)
  Number of downloads: 69

[3663Nixon]

Cunin you are a genius! Good job <3

[Cunin]

DarKnoT, on 10 August 2009 - 08:26 PM, said:

Sorry but the bot don't work at all to me, He can connects to the irc but he can't say how many players are on my servers when it's full, !gameinfo doesn't work too ...

I hope you've read the included readme file. It needs the supplied ac_server.exe to be used in place of your own ac_server.exe, and you need to select the right logfile AFTER running the server. If you can explain me better the steps you made to make it work, I can probably help more.

[Cunin]

ok I don't know what problem you got there, I just run the server with the following options:

-c[numberofplayers] -f[port] -n[serverdescription] -o[serverMOTD] -r[maprotation.cfg] -x[pass]

(replace [whatever] with the relative data, without the brackets)
and the server outputs without problems in a file named like: serverlog_20090728_22.59.56_local#24558.txt

the server executable is in the \bin_win32 directory on your server directory, and you can place the bot in the previous directory (the main server directory) because the logs are stored there if you run the server with a .bat script.

So the directory structure is:

AssaultCube\ACIRCBot.exe
AssaultCube\server.bat
AssaultCube\serverlog_DATE_local#PORT.txt
AssaultCube\bin_win32\ac_server.exe

[NSL:undecided]

This is very nice indeed! Just a shame it can't be used on Linux.

Would it be possible to release the source for this bot?

It would be nice to mod it so it can parse standard AC logs, so that the logs will also be compatible with the statistics system aswell (parses standard logs)

Edit: i have found this info on makeing an IRC bot in perl, which would mean it is cross-platform, and could parse standard logs if combined with the Games::AssaultCube module. I'll be looking into this

[Cunin]

I will not use Perl for my bot because it doesn't fit my needs, I also haven't used standard logs because they can't be parsed correctly and not that easily anyway, because a developer said, in AC forums, that nicknames will be able to contain spaces in them and so you can't use that as a separator anymore.
I'd like to have a switch in the server to select which kind of logs to choose from, and anyway the format I made is much easier to parse so probably that statistics system (I haven't seen it so I'm just guessing) could be easily modified to support this log format.
Anyway, I'll surely find another way to parse logs if the way I implemented wouldn't work, for any reason, in the future.

I'm sorry but as long as I'll be able to work on it, I'll not release its sources, but I'll surely consider porting it to Linux as you're the 3rd person asking for it already.
If that will ever happen, I'll make sure to report here and in AC forums.

Thanks for posting

[TriGgaS]

ggood job cunin, you da fuckin best


I r not authorized (cries cuz he cant update NOW)

(as opposed to later =D )

[Cunin]

DarKnoT, on 14 August 2009 - 05:39 PM, said:

I can't open the logfile again.

Is it supposed to have colors on the server.bat logs?

i don't know what you mean, the server isn't outputting any logs?
why can't you open logs? they aren't there?

[Ethenal]

DarKnoT, on 16 August 2009 - 04:40 PM, said:

Cunin, on 14 August 2009 - 03:46 PM, said:

DarKnoT, on 14 August 2009 - 05:39 PM, said:

I can't open the logfile again.

Is it supposed to have colors on the server.bat logs?

i don't know what you mean, the server isn't outputting any logs?
why can't you open logs? they aren't there?

No they aren't there, in the server logs it write: failed to open the logfile.

Sounds like the server doesn't have write permission in said folder. Check that? I would say how, but it depends on the OS obviously.

[Cunin]

yeah sounds like that really, the server administrator/owner must set the ac_server.exe's permissions to let it write logs

[Prulez]

DarKnoT, on 17 August 2009 - 02:20 PM, said:

Cunin, on 16 August 2009 - 10:44 PM, said:

yeah sounds like that really, the server administrator/owner must set the ac_server.exe's permissions to let it write logs

Ii open the logfile only when I've a default ac_server
I'm running on vista "

Tried running it as an administrator?

[Ethenal]

Prulez, on 17 August 2009 - 09:26 AM, said:

DarKnoT, on 17 August 2009 - 02:20 PM, said:

Cunin, on 16 August 2009 - 10:44 PM, said:

yeah sounds like that really, the server administrator/owner must set the ac_server.exe's permissions to let it write logs

Ii open the logfile only when I've a default ac_server
I'm running on vista "

Tried running it as an administrator?

Yeah, if you're running it on Vista then chances are pretty high it'll need to be run as an administrator.

[tundra]

oh ok yay mac! =p