chiqors / auricle-music-bot

An open source code music bot created with the sapphirejs framework and discord-player

Auricle

This is a music bot created by using the sapphire framework & discord-player with this project being written in TypeScript.

Prerequisites

Before you get started, you will need the following:

• Node.js (v18 or higher)
• Yarn package manager (or a package manager of your choice)

yarn install
yarn run build

Features

• A music system built with slash commands
• Hot module reloading to never have to restart
• Built-in cooldown system
• Easy to configure and use

Keeping your Forked Repository Up to Date

This is from GitHub Blog and is a straightforward example for updating your forked repository

How can I generate a command?

Before hand you should have the sapphire cli globally or installed in your devDependencies

sapphire generate command <name>

This will automatically generate a slash command in the src/commands folder from the template in the templates folder

Hot Module Reloading

It is advised to firstly build the dist folder using yarn run build and then use yarn run auricle, this will enable @sapphire/plugin-hmr and will actively reload modules when they are updated.

License

This project is under the MIT license

The license can be found in the root named as LICENSE