TWeeNot - Twitter Weewar Notifier

DESCRIPTION

TWeeNot is a Twitter Automated Robot developed by Scott Chrestman (http://twitter.com/centronix). TWeeNot will keep track of your active Weewar games, and notify you via Twitter when it's your turn to play at any one of your games! While game notification was the projects original goal, TWeeNot is quickly gaining more functionallity, with new ideas being implemented every day. If you are a die-hard Weewar and Twitter user, this is for you!

USAGE

In order to use TWeeNot, you'll first need to 'follow' TWeeNot on Twitter. You can accomplish this by sending a Twitter update with the message 'follow TWeeNot'. TWeeNot looks for new followers every fifteen (15) minutes, and once it see's you are a new follower, TWeeNot will automatically start following you as well. By both you and TWeeNot following each other, the both of you will be able to pass direct messages to and from each other, which is TWeeNot's primary way of communicating with you. Once TWeeNot is following you, it will send you a direct message letting you know that it is ready to accept your direct commands.

Once TWeeNot is following you, you'll need to setup your Weewar ID with TWeeNot. To do this, send the following command: 'd TWeeNot add <-Weewar-ID-> <-Weewar-API-Token->'. The key here is the API Token, which is located at the bottom of your Settings page on Weewar.com. This only allows TWeeNot to access your HQ information and other information available via the Weewar API. It does NOT allow TWeeNot, or it's author, any way to access your games or other account settings. Once you have successfully sent the add command, you will receive a message back from TWeeNot, letting you know that your account has been added and that you are now being tracked! By default, your account is set to active, with a notify time interval of 60 minutes (more on this below).

EXTENDED USAGE

There are several commands you can use with TWeeNot. These commands will allow you to control different aspects of TWeeNot, and how it interacts with you.

help - Help is available any time by sending 'd TWeeNot help'. Help will give you the current list of available commands. It is a good idea to check here periodically, as new features will always be added to the help command, but may be added before this page is updated. 'Help' is always your first stop for up-to-date information on TWeeNot's commands!
add - Add your Weewar information to TWeeNot. The syntax is 'd TWeeNot add <-weewar-id-> <-weewar-API-token->'. The Weewar API Token is availble on your settings page on weewar.com. Currently, you can add as many Weewar accounts as you like. I currently have mixed feelings about this. Weewar rules state you can only maintain one account at a time. However I would imagine there are several reasons why a user (read: developer, tester, etc) might use more than one account. This functionallity will remain, unless I am asked by Weewar LTD.
del - Delete your Weewar information. The syntax is 'd TWeeNot del <-weewar-id->'. This will remove a specific Twitter/Weewar-ID combination.
notify - Get or set your notification time. The syntax is 'd TWeeNot notify <-hours->'. If you send just 'notify' to TWeeNot by itself, it will return your current notification interval. By default, this interval is set at 24 hours. What this means is, you will be notified once per day for each pending game inwhich it is your turn. If you don't take your turn within 24 hours, you will receive the same notification again. This number is variable, and can be set anywhere between 1 and 72 hours. Eventually you will be able to have greater control over the timespan.
activate - Activate notifications. The syntax is 'd TWeeNot activate <-weewar-id->'. This will activate notifications for the particular Weewar ID. With this option, you will receive all notifications when it's your turn in any game. See deactivate below.
deactivate - Deactivate notifications. The syntax is 'd TWeeNot deactive <-weewar-id->'. This will stop all notifications from being sent to you, but will not remove your actual user account. This is great when you'll be away for the weekend, out of town, etc.
uptime - Return system uptime. This may be removed in the future, but is currently used to monitor the server statistics for the server that TWeeNot runs on.

CONTACT

You can contact the author, Scott Chrestman, via e-mail at schrestman {-at-} gmail {-dot-} com, or via Twitter to user 'CentroniX'. I welcome your comments, suggestions, and criticisms.