generator-discordbot

generator-discordbot

creates a base template to start a new Discord bot using discord.js

generator-discordbot is an easy way to get started creating a Discord bot.

generator-discordbot will include:

• discord.js, a library that allows you to interact with the Discord API.
• clapp, a module that makes your bot behave like in a command line interface.

generator-discordbot is based on generator-node, so your project will also include:

• A filled package.json file
• ESLint linting and code style checking
• nsp known vulnerability check
• Travis CI continuous integration (optional)
• A license

Installation

First, install Yeoman and generator-discordbot using npm (we assume you have pre-installed node.js).

$ npm install -g yo
$ npm install -g generator-discordbot

Then generate your new project:

$ yo discordbot

Getting started

After the generation is done, first make sure that your config.js looks ok. Then you may start working in your bot. Your bot's files are located in the /lib folder. index.js is your entry point. You may add your bot's commands to the /commands folder, and they will be automatically bound to your app. To learn how to create a command, please refer to the clapp documentation. To learn how to interact with the Discord API, refer to the discord.js documentation.

Once you are done working, you can run your bot from your root folder with:

$ npm run bot

License

Apache-2.0 © Pablo Rodríguez