https://github.com/jedahan/sfpcbot

a bot for #sfpc on freenode, http://sfpc.io
https://github.com/jedahan/sfpcbot

Last synced: about 2 months ago
JSON representation

a bot for #sfpc on freenode, http://sfpc.io

• Host: GitHub
• URL: https://github.com/jedahan/sfpcbot
• Owner: jedahan
• Created: 2013-10-15T20:08:59.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-18T17:23:17.000Z (about 11 years ago)
• Last Synced: 2024-10-13T01:03:31.496Z (3 months ago)
• Language: CoffeeScript
• Size: 570 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
This is an irc robot for irc://irc.freenode.net/sfpc and http://sfpc.io

Install dependencies with `npm install`

Then you can mess with bot.coffee (make sure to change the nickname!)

To test your bot out, change the nickname and do `npm start`

The bot has three main functions, `on`, `onMessage`, and `onPrivateMessage`. Each take a [regular expression][1] to filter on specific messages, and a callback that should return a message to send back. The simplest bot may look like this:

```coffee

sfpcbot = require './lib/sfpcbot'

shibu = new sfpcbot.bot 'simplebot'

shibu.on /.*/, (from, to, message) ->

    "wow so message so wow"

```

That shibu bot will send a message, every time it hears any chatter. While it's enthusiasm is admirable, lets make something that understands basic American conversational greetings:

```coffee

sfpcbot = require './lib/sfpcbot'

nicebot = new sfpcbot.bot 'nicebot'

nicebot.on /hello/i, (from, to, message) ->

    "Hello #{from}"

```

 If you are new to [regular expressions][1], the `i` after the `/hello/` is not a typo - it says **i**gnore the case of the message. So now our bot only says hello when someone else says "hello" or "Hello" or "HeLlO", and even says your name back!

Other things to note about the bot, is that everything it hears will be logged to a file `sfpc.log`. If you want to see/edit the magic, check out `lib/sfpcbot.coffee`.

Feel free to make your own bots, add [issues][2] or submit pull requests to the main sfpcbot!

[1]: http://codular.com/regex

[2]: http://github.com/jedahan/sfpcbot