Quaver is available for public use here, and its dashboard is available here. Keep in mind that this instance of Quaver will only run the latest stable version.
Quaver utilizes Discord's built-in slash commands, buttons, select menus, modals, and more. After deploying the commands, type /
into your chat to list Quaver's commands.
As Quaver is designed to be as user-friendly as possible, users should be able to immediately understand how a function works within Quaver without having to read any documentation.
- Node.js v20 (or higher)
- Lavalink v4 (or higher)
- youtube-source plugin installed
- LavaSrc plugin installed
- java-timed-lyrics plugin installed
Please note the connection details of your Lavalink instance. You will need to specify them in
settings.json
later.
- Bot token from Discord
- Clone the repository
- Make a copy of
settings.example.json
and rename it tosettings.json
- Edit the fields in
settings.json
as necessary
Refer to CONFIGURATION.md for a detailed explanation on configuration.
- Run
pnpm i
to install packages required to run Quaver - Run
pnpm build
to compile the source code - Run
pnpm run slash:deploy
to deploy slash commands - Run
pnpm start
to start Quaver
I cannot guarantee anything. However, the chances of getting into legal trouble is slim if your bot is used privately. I would still exercise caution when hosting any music bot.
I'll consider it! Submit an issue here and I'll be happy to take a look.
Slash commands are defined when running npm run slash-deploy
.
This means that slash command descriptions will follow the language set in settings.json
(defaultLocaleCode
key), and not the language set through the /settings
command.
You need to re-deploy the commands using npm run slash-deploy
for the new locale to take effect.
Due to Discord's limitations and the localizations we have, we don't currently use Discord's localized command name & description functionality. This may be worked on in the future.
Yes! As of 5.0.0, Quaver has a web dashboard add-on available here. Please note that this is an optional addon and is not required to run Quaver normally.
As of 7.0.0, Spotify support is provided through Lavalink. Please use the LavaSrc plugin with Lavalink to enable Spotify support.
NOTE: To enable support via Lavalink, version 7.0.2 or higher is required. Older versions may block Spotify queries locally.
Take a look at our Crowdin project.
Refer to CONTRIBUTING.md.