README.md

Heroes of the Storm IRC bot

Code status

Run

• Get sources
• Copy config.yml.dist to config.yml and edit it with your configuration
• Install dependencies with bundler (bundle install)
• Run the bot: bundle exec rake run

Available bot commands

• getbt USERNAME - Print the BattleTag for the entered name
• addbt BATTLETAG REGION - Saves your BattleTag
• removebt - Remove your BattleTag from the database
• rating USERNAME - Replies with a list of players with the given BattleTag from HotsLogs
• rotation - Prints the current free hero rotation
• tierlist - Replies with the url for the Zuna tierlist
• streams - List live featured streams
• tips - Links the tips section
• tips USERNAME - Links the tips section and highlights user
• mumble - Prints server info of the Reddit Mumble
• ts - Prints server info of the Reddit Teamspeak
• bug - Submit an issue the bot's bug tracker
• help COMMAND - Displays help information for the COMMAND
• help - Lists available commands

Streams module

!streams displays a list of twitch.tv streams that are currently live.

To be able to add or remove streams from the streams list, you need to be a stream admin. Stream admins are managed via the config.yml file.

Stream admins have the following additional commands:

• addstream STREAM — Stream can be a channel name (khaldor) or a twitch URL (http://www.twitch.tv/khaldor)
• removestream STREAM — Stream can be a channel name (khaldor) or a twitch URL (http://www.twitch.tv/khaldor)
• liststreams — List all streams currently in the database
• refreshstreams — Refresh stream cache in database (see bellow)

Caching

As Twitch API can be a bit long to respond, stream data are cached in database on addition and a task is ran every 10 minutes to refresh the cache. The !refreshstreams command can be used to manually refresh the cache.

Contributing

See CONTRIBUTING.md