/CTF-Bot

An IRC bot for announcing upcoming CTF events based on the CTFtime.org API

Primary LanguageRubyMIT LicenseMIT

CTF-Bot

An IRC bot that announces upcoming on-line CTF events built with the Cinch framework.

It also stores credentials to events' accounts.

Setup

Make sure that you have both Ruby and Bundler installed. Then follow these steps:

# Download the code
git clone https://github.com/LiquidLemon/CTF-Bot.git
cd CTF-Bot
# Install the dependencies
bundle
# Clone the example config
cp example-config.rb config.rb
# Now make changes to the config with your text editor of choice (e.g. Vim)
vim config.rb

Configuration

Example configuration is present in example-config.rb along with explanation of all the options.

Running

Run ruby bot.rb in the project's root directory.

Usage

!ctfs - display info about all events
!current - display info about current events
!upcoming - display info about upcoming events
!next - display info about the next event
!update - update the database (this happens automatically every hour)
!creds - modify the credentials database
!load - load the credentials database (if modified manually)
!quit - leave the server (you have to be set as an admin in the config)
!help - display this message