https://github.com/davidcelis/snap

A bootstrapped IRC bot using Cinch. I write plugins so you don't have to.
https://github.com/davidcelis/snap

Last synced: about 1 month ago
JSON representation

A bootstrapped IRC bot using Cinch. I write plugins so you don't have to.

• Host: GitHub
• URL: https://github.com/davidcelis/snap
• Owner: davidcelis
• Created: 2012-08-12T06:00:38.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-09-14T17:56:16.000Z (over 11 years ago)
• Last Synced: 2024-10-12T08:35:16.813Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 316 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# snap

Snap is an IRC bot written using [cinchrb/cinch](https://github.com/cinchrb/cinch). This code powers a bot currently running in the #reddit-portland channel on `irc.freenode.net`. However, this repository is clonable and runnable using your own configuration options.

## Requirements

* Ruby

* bundler

* Redis

## Usage

To run the bot:

```bash

Usage:

  bot start -n, --nick=NICK

Options:

  -n, --nick=NICK                 

  -s, [--server=SERVER]           

                                  # Default: irc.freenode.net

  -c, [--channels=\#freenode \#cinch-bots]  

  -u, [--username=USERNAME]       

  -p, [--password=PASSWORD]       

      [--redis-host=REDIS_HOST]   

                                  # Default: localhost

      [--redis-port=N]            

                                  # Default: 6379

  -d, [--daemonize]               

```

To stop a daemonized bot:

```bash

Usage:

  bot stop

```

Certain commands respond only to admins (such as `!join`, `!part`, and `!say`). To define your list of admins, create a file `config/auth.yml`:

```yaml

admins: ['davidcelis', 'fredjones']

```