Diskord 🤖
JavaScript/Node.js library to create simple answer bots for Discord messaging app
This library is not production bullet-proof ready, use at your own risk
$ npm install -S diskord
OR$ yarn add diskord
Requirements
- Nodejs v6
- A discord bot token (guide how to get one)
Usage
Create your bot instance
First, you will need to create your bot instance aka login to the bot.
const Diskord = ;const bot = token: 'XXXX' ;
Register a simple answer
Then you can create actions, theses actions will react to a message sent by a user. You can filter actions to trigger them only on a specified channel or a server.
Let's create a simple action, the ping request:
bot;
Writing
ping
or!ping
in the channel where the bot is present will trigger the action.
Register an action with a function
For more complex operations you can register a function to your action:
bot;
Register an action accepting arguments
Most of the time you want user to interact with the bot by providing options, it's easy to do it:
bot;
API
new Diskord(SimpleBotOptions)
SimpleBotOptions = token: 'XXXX' // Secret bot token
registerAction(Action)
Action = trigger: string // Message (with or without prefix '!') to match action: string | ActionFunction // Action to start on when trigger match { // params = { // author: { username: string }, // args: string[], // reply: Function // }}
TODO
- Spam protection
- Documentation on how to make great messages
- Support of attachment in answers
- Ideas? Create an issue!