mikerogne / somereason

Just another IRC bot and learning experiment -- powered by Node.js.

somereason irc bot

Just another IRC bot. All the cool kids are doing it! 👈👈😎

Getting Started

Prerequisites

• Node.js (I like using nvm personally. See more: Node Version Manager)
• Common sense

Plugins Requiring API Key

• GIPHY: Register for API key
• TENOR: Register for API key
• YOUTUBE: Register for API key
• DOCS: App ID & API key required -- but you have to find this on your own :).

Getting Up & Running

• git clone [e-mail]:mikerogne/somereason.git
• npm ci
• cp config/example-client.json config/client.json (this is where you set the config options)
• cp config/example-env.json config/env.json (this is where you set the env options)
• cp config/example-ignored_users.json config/ignored_users.json (this is where you set the ignored users - but use .ignore/.unignore for that)
• npm start (Make sure to set the appropriate values in config/env.json - depending on which plugins you want to use!)

Running the tests

• npm run test or npm run watch

JetBrains users might want to check out: Get rid of "Unresolved function/method/variable" warning in Jest test files

Contributing

License

This project is licensed under the ISC License

Acknowledgments

• https://github.com/Throne3d/node-irc/
• Shoutout to asteele for the TypeScript help!