---

Janus is a Discord bot template written in Typescript, supporting most of Discord.js' features alongside tools useful for bot development.
🇪🇸 README en Español

📚 Introduction

This is a template for giving developers (and myself) an easy but robust start to develop a bot.

The template as it is is not completely meant to be used for big public bots since it doesn't support crucial stuff for it like Sharding, or, ironically, it supports stuff that they don't need like message commands, though you can always adapt this to your liking.

The bot is 100% working just by cloning the repo, installing dependencies and setting up your config.json, and, as a matter of fact, it includes some example commands to see the possibilities of the bot.

This template is greatly inspired by Modbot.

✨ Features

All of these features are included on the template. You can modify each of them to your liking or add more of them.

Events

• Register many actions per event, or listen to your own.

Schedules

• Schedule actions to happen only at a certain time or every once on a while.
• Stop and resume Schedules to your liking.
• Using Cron to power the schedules.

Commands

• Both message and slash command support with only one declaration.
• Subcommand support, registered on Discord as well.
• Automatic argument parsing on message commands to a CommandInteractionResolver.
• Command aliases (only message commands), command description and command syntax support.
• Multiple prefixes support.
• Command categories support based on folder names.
• Permission checking (Members can only execute commands if they have certain permissions) support.
• Autocompletions support: answer to autocompletes as you'd like.
• Discord's context menus (User Commands and Message Commands) support.
• Default support for DM commands, can be turned off per command.
• Colorize your commands by adding a defaultColor to their data.

Other

• Built-in Prisma support for easier and faster database managing.
• Built-in Tracer support for powerful logging.
• (Theorically but not really practical?) Support for multiple bots running at once.

📖 Usage

Refer to the Wiki for steps to use the template.

🌐 License

LICENSE

Janus is licensed under the MIT License, linked above.

If you don't want to bother reading it all, here's what you need to know:

• ✅ You can: Modify the software for your personal or public usage, distribute it freely and/or commercially.

• ❌ You can't: Change the license, though you can include it inside a proyect with a more restrictive license, but the original code stays licensed under MIT.

• 📝 You need: To include the copyright (LICENSE file) inside the modified code.

You don't need to explicitly give credit to this repository (all the credit is inside LICENSE already), but I'll be grateful if you do so 💙.

🚧 Disclaimers

• To avoid meaningless commands, only the first name is used to register slash commands. The rest only work for message commands.
• There are some parts (like static overriding on Commands data) that aren't exactly pretty. The template is always open to suggestions and/or PRs.