Slap together a Discord Bot project in seconds!
Slappey is a cli tool that lets you generate a Discord.JS project (version 12 or version 11), in a matter of seconds.
Currently supports only JavaScript, but will support TypeScript soon.
Install slappey by running npm install -g slappey on your terminal or Windows CMD. This will install slappey globally.
-
To create a project, type
slappey, or simply typeslappey new <name of project> -
Follow the steps and enter your Bot Token and Prefix.
-
Once done,
cdinto your project by typingcd <name of project> -
To run the bot, type
npm run dev. This will run the bot usingnodemon, you MUST havenodemoninstalled, otherwise, usenpm run start
-
Slappey allows you to generate commands into categories. You can type
slappeyand select Generate to generate a command, orslappey new command. -
It will ask you for a name, and then a category. This will generate all commands in the
src/commandsfolder, in the correct category.
-
You can generate events by running
slappey new event, this will prompt you to select which events you would like to generate. -
To select event(s), press space bar and use the up and down arrow keys to navigate. Hit enter when you're done and your event files will be generated in the
src/eventsfolder.
Soon
Slappey now supports TypeScript as of 6/1/2020!
You must have TypeScript installed. However, if you don't, during the installation process, if you selected TypeScript, Slappey will ask you if you would like to install TypeScript, ts-node, and setup a basic tsconfig.json file. If you enter n (no), you will have to install these manually.
ts-node is a TypeScript interpreter for Node.JS, the dev script uses it along with nodemon, so be sure you have nodemon installed.
Otherwise, if you have TypeScript installed, you can skip this part and just run npm run build and then npm run start
- Soon