An open API service indexing awesome lists of open source software.

https://github.com/qbit/mcchunkie_js

Home for the new mcchunkie - now with 100% moar chunk (NodeJS,JavaScript)
https://github.com/qbit/mcchunkie_js

Last synced: about 1 year ago
JSON representation

Home for the new mcchunkie - now with 100% moar chunk (NodeJS,JavaScript)

Awesome Lists containing this project

README

          

mcchunkie
=========
![mcchunkie](https://raw.github.com/qbit/mcchunkie/master/mcchunkie.png)

an irc bot with dynamically loadable plugins.

Features
========

* **Dynamic plugins**

Plugin Features
===============

* **aprs.js** - query the FCC license database for license info. *requires api key for aprs.fi*
* **basho.js** - print haikus from Basho
* **beer.js** - query brewerydb for delicious delicious beer
* **beeradvocate.js** - query beer advocate for delicious beer
* **botsnack.js** - feed the bot!
* **dayum.js** - Daaayum Daaayyyyuuummm DAAAAAAYYYYUUUUMMMMMMMM
* **free.js** - no one is as free as 'Merika!
* **getoverhere.js** - mortal kombat style ~~~~~~>
* **ham.js** - query the FCC license database for license info.
* **ham_tests.js** - quiz players on Extra, General and Tech exams for Ham Radio.
* **high5.js** - respond to high5's
* **love.js** - respond to people who love us
* **mojo.js** - I got my mojo workin!
* **navi.js** - HEY LOOK!!!!! AHHHHHHHH!
* **openbsd.js** - uses the pubsub
* **oyfb.js** - respond randomly to oyfb
* **pew.js** - get shot with LASERS!
* **pigpen.js** - translate text to pigpen
* **protip.js** - return random protips
* **puny.js** - translate strings to punycode
* **putitback.js** - once a table has been fliped, politely put it back
* **reverse.js** - reverse a string
* **sballs.js** - do you know SpaceBalls?
* **tell.js** - tell $person $msg next time you see them
* **thanks.js** - be polite
* **tmnt.js** - return random TMNT quotes (really hard to find good ones!)
* **twts.js** - watch incoming messages for possible twss jokes. Can be trained.
* **uptime.js** - print bot's uptime
* **version.js** - print version information
* **wb.js** - respond to welcom backs
* **wq.js** - print the tales of Wq
* **xmas.js** - ride the joly train on xmas!
* **yeah.js** - pull a sweet CSI move
* **ykysaw.js** - you know you're South African when

Writing Plugins
===============

Plugins should be javascript functions wrapped in (); and should take
six args: botname, to, from, msg, store and callback.

The callback should be passed null, to, from, and resp.

Example:

````javascript
exports.fn = function( botname, to, from, msg, store, cb, proto ) {
// Plugin to reverse every msg that is passed in.
var resp = msg.split("").reverse().join("")

// do something awesome with storage here..

// do some more manip of the msg here

cb(to, from, resp, proto )
}
````
To disable a plugin, simple add a '''~''' to the name.

Installation
=================
git clone ;
cd ;
npm install;
node bin/mcchunkie -h

Usage
==================
````-n -s -c , -j -p ````

**Example:**
````
nodejs bin/mcchunkie -n 'nameOfBot' -s 'host' -c 'channelName'
````