discord-tidal v1.0.0

Tidal

A swift generator for scaffolding Discord.js bots.

Tidal is a simple node.js cli to generate Discord.js Bot projects. Have you ever felt intimidated by starting a new project, from scratch? 😱 Yes, I know the feeling. You don't know what to do, where to begin. So, to help you, Tidal generates pre-written boilerplate code for you.

Available Templates

It currently has these boilerplates, in alphabetical order:

Akairo

This uses the Discord-Akairo Framework, a Command Framework built by 1Computer1, with Discord.js (master). It has:

• Environment Variables for ONWER_ID, PREFIX, and TOKEN.
• Yarn Support: It has a yarn.lock file, so yarn install should work just fine.
• Ping Command.

Discord.js Commando

This uses Discord.js Commando (master), a Command Framework built by the Discord.js Team, with Discord.js (master). It has:

• Environment Variables for ONWER_ID, PREFIX, and TOKEN.
• Yarn Support: It has a yarn.lock file, so yarn install should work just fine.

Discord.js Vanilla

This is pretty much as simple as you're gonna get. It's good ol' basic Discord.js (master), with not much added to it. It has:

• Environment Variables for PREFIX and TOKEN.
• Simplistic Command Handler with out-of-the-box support for command descriptions and usage strings.
• Yarn Support: It has a yarn.lock file, so yarn install should work just fine.
• Ping and Help Command.

Klasa Vanilla

This uses the Klasa Framework (master), a Command Framework built by the Dirigeants Team, with Discord.js (master). It has:

• Environment Variables for PREFIX and TOKEN.
• Yarn Support: It has a yarn.lock file, so yarn install should work just fine.
• All the luxuries of using Klasa.

Klasa with Disabled Commands

This uses the Klasa Framework (master), a Command Framework built by the Dirigeants Team, with Discord.js (master), while disabling some of the default commands. When you go in the commands/ folder, just delete a command's file to enable it again. It has:

• Environment Variables for PREFIX and TOKEN.
• Yarn Support: It has a yarn.lock file, so yarn install should work just fine.
• All the luxuries of using Klasa.

Klasa with klasa-pieces

This uses the Klasa Framework (master), a Command Framework built by the Dirigeants Team, with Discord.js (master), adding on all the pieces from klasa-pieces, which are custom pieces developed by the Klasa community. It has:

• Environment Variables for PREFIX and TOKEN.
• Yarn Support: It has a yarn.lock file, so yarn install should work just fine.
• All the luxuries of using Klasa.
• Other dependencies needed for those pieces to function are listed as optional dependencies, so you can install them on an as-needed basis.

I do plan on adding more templates in the future (working on some for yamdbf right now) as time permits. If you'd like to see something added, please don't hesitate to contact me at SinisterCyborg#8523 on Discord.

How to Use

How to use Tidal? Well it's as easy as 1, 2, 3!

Install Tidal

You can install Tidal using npm or yarn.

npm i -g tidal yarn global add tidal

Navigate to Projects Folder

Navigate to the folder where you store all your projects. Note, Tidal automatically creates the project's folder for you.

Run the Command

Nothing fancy, just run the command. What's the command?

tidal

That's it? No flags or arguments? Nope, nothing. It's as easy as that.