An omnipresent multi-platform bot who's goal in life is become Skynet
Ruby CSS JavaScript HTML CoffeeScript
Clone or download
Pull request Compare This branch is 135 commits ahead, 7 commits behind mutewinter:master.
Fetching latest commit
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
db
docs/dev
images
lib
locales
log
pid
public
sass
test
views
.codeclimate.yml
.csslintrc
.env.example
.eslintignore
.eslintrc
.gitignore
.powrc
.rubocop.yml
.ruby-version
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE.md
Procfile
Procfile.local
README.md
Rakefile
TODO.md
cinchize.yml.example
coffeelint.json
config.ru
environment.rb
showbot_irc.rb
showbot_web.rb

README.md

Stories in Ready Code Climate Issue Count

JBot

A sweet IRC bot with a web interface for Jupiter Broadcasting. Built on cinch and sinatra. It is a fork/evolution of Showbot, built for 5by5.

IRC Commands

To get a list of the available commands on your JBot instance, send it the follwing message once it is connected to an IRC network:

!help

(Make sure your JBot is allowed to send private messages on the IRC network!)

Setup and Customization

Prerequisites

Setup

These commands will get you setup to run the stable version of Showbot.

  • git clone https://github.com/rikai/Showbot.git
  • cd Showbot
  • bundle
  • foreman run rake db:migrate

If you would like to run the development version of Showbot, use the following commands instead:

  • git clone https://github.com/rikai/Showbot.git
  • cd Showbot
  • git checkout devel
  • bundle
  • foreman run rake db:migrate

Configuring JBot

For JBot to work correctly, you need to set up your .env file in the root of the project. Start by copying the .env.example file to .env and edit accordingly.

You also need to set up your cinchize.yml file. Copy cinchize.yml.example to cinchize.yml, and edit accordingly. To deactivate a plugin, comment out all lines related to that plugin in cinchize.yml. Don't forget to also update the connection settings and your bot's name.

NOTE: If you choose to configure a plugin it MUST be disabled, otherwise the bot will fail to start.

Lastly, you will need to create a data.json file. This file can be hosted by JBot's web server by putting it into public/, or can be hosted externally by setting the DATA_JSON_URL variable in .env to the URL. To learn more about data.json, read up on its documentation in docs/dev/DATA.JSON.md.

Launching Showbot

Website and the IRC Bot

$ bundle exec foreman start -f Procfile.local

Just the Website

$ bundle exec foreman start web -f Procfile.local

Just the IRC Bot

$ bundle exec foreman start irc -f Procfile.local

Modifying the CSS

Modifying showbot.scss requires that you start the rake sass:watch command. While this command is running, public/showbot.css will be overwritten with any changes that are made in showbot.scss. This annoying setup is necessary due to Bourbon not working well outside of the Rails asset pipeline.

Want to help out?

Check out our CONTRIBUTING doc to find out how to contribute to JBot.

Special Thanks

  • Special thanks to Rikai for reverse-engineering the setup steps for someone setting up Showbot from scratch.
  • To gouwens for implementing the clustered view.

JBot on the Internets

The Creation of Showbot