{"id":19324651,"url":"https://github.com/soarez/rulio","last_synced_at":"2026-06-17T19:31:23.575Z","repository":{"id":4271644,"uuid":"5399539","full_name":"soarez/rulio","owner":"soarez","description":"Barebones module based irc bot","archived":false,"fork":false,"pushed_at":"2012-10-06T22:44:45.000Z","size":218,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-05-02T10:36:58.465Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soarez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-08-13T13:53:03.000Z","updated_at":"2015-02-24T23:28:03.000Z","dependencies_parsed_at":"2022-08-29T14:21:10.312Z","dependency_job_id":null,"html_url":"https://github.com/soarez/rulio","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/soarez/rulio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soarez%2Frulio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soarez%2Frulio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soarez%2Frulio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soarez%2Frulio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soarez","download_url":"https://codeload.github.com/soarez/rulio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soarez%2Frulio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34463551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-17T02:00:05.408Z","response_time":127,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T02:06:10.756Z","updated_at":"2026-06-17T19:31:23.557Z","avatar_url":"https://github.com/soarez.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rulio\n#### *A Barebones module based irc bot.*\n\n====\n## Install\n\n    git clone git://github.com/Soarez/rulio.git\n    cd rulio\n    npm install\n    cp config.json.example config.json\n\nEdit `config.json` to your needs.\n\n## Run\n\n    node server\n\n## Modules\n\nRulio works with modules. Modules should export a function with two arguments, an instace of [node-irc](https://github.com/martynsmith/node-irc/) (you should check the [API](http://node-irc.readthedocs.org/en/latest/API.html)) and an object with Rulio's configuration. Client.\n\n**Rulio modules should be [npm modules](http://howtonode.org/how-to-module).**\n\n###### Example\n\nHere is a module that echos private messages. \n\nOn dedicated folder, create a file named `echo.js` with this:\n\n    module.exports = function(client) {\n      client.addListener('pm', function (nick, text) {\n         client.say(nick, text);\n      });\n    };\n    \nUse [`npm init`](https://npmjs.org/doc/init.html) to have npm create a `package.json`, and when set `name` to `rulio-echo` and `main` to `echo.js`.\n\nNow the module can be published with `npm publish` and other rulio users could start using it by using `npm install rulio-echo`. But before publishing we want to test it, and make changes to it. So we use use [`npm link`](https://npmjs.org/doc/link.html) to debug:\n\nOn the module folder:\n\n    npm link\n    \nOn rulio's folder:\n\n    npm link rulio-echo\n\nThis way, npm will symlink the modules folder to a folder named rulio-echo inside node_modules. This way, the module can be `require()`d like any installed npm module.\n\n**Don't forget to publish your rulio module** so we can use it too :) You should [add it to our list of rulio modules in the wiki](https://github.com/Soarez/rulio/wiki/modules).\n\n#### Loading modules\n\nLoad it in rulio's `config.json`, by adding it to `modules`.\n\n    ...\n    \"modules\": [\n      \"rulio-echo\"\n     ]\n    ... \n    \n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoarez%2Frulio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoarez%2Frulio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoarez%2Frulio/lists"}