Clank (formerly known as Makibot) is the Discord bot for the makigas Discord server. It is not stable enough and it probably doesn't contain the most useful commands right now, but it works.
- Node.js >= 6.0
- A Discord application that can behave as a bot.
- A Discord server.
Register a Discord bot if you haven't. Create a Discord app, then bundle a bot. Here is a neat guide covering the process. The guide also covers how to make the bot join the server, which is important if the bot is not public because it will need to be manually invited to the server.
Clank won't run unless you do this. Copy config/config.example.json to config/config.json. The configuration file is local because it will contain login keys that you should NOT expose. Fill in the following keys:
-
token: that's the bot token. Log in to Discord via browser, visit the My Apps page, and click on your bot. Under the section App Bot User, your token will be revealed after you press 'Click to reveal'.
-
owner: that's your user ID. Clank will recognize the user having this ID as the administrator, as some commands will only be available to the bot owner. How to get your user ID:
-
If you are using the native Discord client for Windows, Linux or macOS, go to Appearance settings on your Discord client, and turn on Developer Mode.
-
Type
\@[your username]into a Discord chat and press Enter. This will send a message with your user ID, and you will be able to see it on the history. Type your username as you'd type it to mention yourself, so if your username isdanirod#2667, send a message with the contents\@danirod. Even if you changed your alias, type your username.
-
npm installnpm start
Have an idea? Found a bug? This is an open source project, so you are free to contribute or provide knowledge if you want. See CONTRIBUTING.md for details, but here is the excerpt:
- Send as many issues/PRs as you need, but please, only one topic per issue/PR.
- Don't send a non-trivial PR without creating a tracking issue in the issue tracker first.
- Don't work on top of master branch.
By submitting an issue or a PR – I'd dare to say that by pressing the Fork button as well –, you declare that you have read and agree with the contents of this document.