readme.md

# KF2AutoAnnouncer
Adds very basic announcement and autoresponder functionality to webinterface. The Webinterface might have a good API but I don't know how to access it, therefore I made a quick and dirty attempt at JavaScript. Since the KF2 Webadmin is based on the UT3 one I guess it can be adapted without much effort. Though there are mutators out there that do a better job, those mutators derank the server. This script works from within the browser and therefore does not derank. The browser can be minimized.

I am using this plugin with Tampermonkey 3.11 (http://tampermonkey.net) on Google Chrome 45 but with minor adjustments it should run on Greasemonkey (http://www.greasespot.net) + Firefox too. With some more adjustments it could as well be uploaded on the webserver and embedded in the pages.

# What does it do? (right now)
The plugin adds a textarea and some control elements to the maximized chat tab area "/ServerAdmin/current/chat". It moves some items out of the way, increases the available space for messages and leave some for the control elements. The Script helps you with automatically announcing a predefined text and autoresponding to certain chat commands like !help. Each of those two functionalities can be activated and deactivated by using the checkboxes. The checkbox status is shown overhead at the KF2 logo.

You can add multiple announcements, by separating the messages with '; ' (semicolon + space). The space is important, because otherwise wink emotes could not be posted and that would be tragic. Autorespond conditions and messages have to be entered inside of the code. The browser window must remain open and Tampermonkey plugin activated for this plugin to work. You can set a timer (post message every x seconds) and a message text. Those can be edited and the changes will effect the messages posted and intervall in between postings, but the settings will reset when closing or reloading the browser window. At the moment you have to edit the script file to save changes.

# What could it do? (in the future)
If someone good at tinkering gets to update the script it could be turned into a lower latency auto response and chat command bot. Also mapvote could be implemented so that commands like !mapvote KF-BurningParis, !listmaps, !changemap and many more could work (some like mapchange by sending POST requests to the website). It might be a good alternative until mutators don't derank servers anymore.

# How to install?

##Browser:
Get Tampermonkey for Chrome: https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo
Or Greasemonkey for Firefox: http://www.greasespot.net/
Install and activate the monkey
Open the raw .js here on GitHub, that should show a message, asking to install the script.
If this doesn't work either create a new script from Monkey menu and copy paste it or download and pull it onto the browser window.

Once it is installed you should go into script settings and edit the variables for server_ip, server_port, server_name and. It could look like this:

var server_name = 'KarateKid KF2 Server';
var server_ip = 'ijustcant.tekkit.de';
var server_port = 7777;

Also if you have a custom webinterface path, you will have to change the Tempermonkey directory filters. Either in the script settings or in the script code, by changing these entries:

// @include     \*/ServerAdmin/current/chat\*

// @match       \*/ServerAdmin/current/chat\*

##KF2 Webinterface
I recommend creating a seperate administrator account for the chat bot so you can use your normal admin account while the script is doing its thing and you can give the bot its own name, so it is discernable from your admin account in chat.

See screenshots for recommended setup:
http://imgur.com/a/MgXnP

Have fun and happy cleaning my messed up code.