hubot-mubot
Version:
Mubot, A Marking U Bot.
42 lines (41 loc) • 4.17 kB
JSON
{
"name": "hubot-mubot",
"description": "Mubot, A Marking U Bot.",
"version": "0.0.12",
"author": {
"name": "Project bitmark",
"email": "1@bitmark.mx"
},
"license": "??",
"keywords": [
"mubot",
"marking",
"bot",
"hubot",
"hubot-scripts",
"bitmark"
],
"repository": {
"type": "git",
"url": "git://github.com/ileathan/hubot-mubot.git"
},
"bugs": {
"url": "https://github.com/ileathan/hubot-mubot/issues"
},
"dependencies": {
"coffee-script": "latest"
},
"devDependencies": {
},
"main": "index.coffee",
"scripts": {
"test": "cake test"
},
"readme": "# Mubot, A Marking U Bot.\n\n### Status // Version\n[](https://travis-ci.org/ileathan/hubot-mubot)\n[](http://badge.fury.io/js/hubot-mubot)\n\n### Chat\n[](https://gitter.im/ileathan/hubot-mubot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\nSee [`src/mubot.coffee`](src/mubot.coffee) for full documentation.\n\n## Quick Installation\n\n`npm install hubot-mubot --save`\n\nThis must be executed from within the directory where you installed hubot. Please read the Full instalation since you should probably edit the package.json file which is in that same directory.\n\n## Full Instalation\n\nIf you do not already have nodejs installed do that now like so: (For trouble shooting see: [Installing node.js](https://github.com/joyent/node/wiki/installing-node.js-via-package-manager))\n```bash\nsudo apt-get install curl\ncurl -sL https://deb.nodesource.com/setup | bash -\nsudo apt-get install -y nodejs\n```\n\nIf you do not already have hubot installed do that now like so: (I entered 'irc' as my adapter NOT the default)\n```bash\nnpm install -g hubot coffee-script yo generator-hubot\nmkdir -p /path/to/mubot\ncd /path/to/mubot\nyo hubot\n```\n\n**-THIS STEP IS NEEDED-** From within the directory that you ran `yo hubot` run: (Inside your `/path/to/mubot`)\n```bash\nnpm install hubot-mubot --save\n````\n\nThen edit your `external-scripts.json` file and add **hubot-mubot**. Afterwords my file looks like this.\n\n```json\n[\n \"hubot-mubot\",\n \"hubot-diagnostics\",\n \"hubot-help\",\n \"hubot-heroku-keepalive\",\n \"hubot-google-images\",\n \"hubot-google-translate\",\n \"hubot-pugme\",\n \"hubot-maps\",\n \"hubot-redis-brain\",\n \"hubot-rules\",\n \"hubot-shipit\",\n \"hubot-youtube\"\n]\n\n```\n\nTo set your initial balance see Troubleshooting.\n\n## Starting your mubot\n\nIf during setup of your hubot you selected the irc adapter as i did then this is how you would launch your mubot:\n```\nHUBOT_ADAPTER=irc HUBOT_IRC_SERVER=irc.swiftirc.net HUBOT_IRC_ROOMS=\"#AxE\" HUBOT_IRC_NICK=\"Mubot\" HUBOT_IRC_UNFLOOD=\"true\" bin/hubot -a irc\n```\nAlternatively you can add `export` statements in your `/.bashrc` file.\n\n## Sample Interaction\n\n```\nleathan>> mubot marks\nMubot>> You have <amount> marks!\n```\n\n## Troubleshooting\n\nQ.) I get the following error `ERROR TypeError: Cannot read property '...' of undefined`\n\nA.) You need to set your initial balance, open the file `src/marking.coffee` and find the line:\n\n```\n robot.brain.resetSaveInterval(1) \n```\n\nThen add this line after the above line:\n\n```\n robot.brain.data.credits['...'] ?= <amount>\n```\n\nFor example, for me that part of `src/marking.coffee` looks like:\n```\nmodule.exports = (robot) ->\n robot.brain.on 'loaded', ->\n robot.brain.data.credits ?= {}\n credits = robot.brain.data.credits or {}\n robot.brain.resetSaveInterval(1) \n robot.brain.data.credits['irc://leathan@irc.swiftirc.net/'] ?= 12000\n```\n\nQ.) For further questions.\n\nA.) Visit #AxE @ irc.swiftirc.net\n",
"readmeFilename": "README.md",
"gitHead": "7bcd5cef590f0c70a36ffdb5cfd150153cd0aa71",
"homepage": "https://github.com/ileathan/hubot-mubot",
"_id": "hubot-mubot@0.0.11",
"_shasum": "45436586af36c350d68372210c25d10c9e482659",
"_from": "hubot-mubot"
}