<h1 align="center" style="border-bottom: none;">Quaver</h1> <h3 align="center">Simple-to-use music bot with features such as bass boost, nightcore, seek, search, and more.</h3> <p align="center"> <img alt="GitHub package.json version (branch)" src="https://img.shields.io/github/package-json/v/zptxdev/quaver/master?color=2a005b&label=stable&style=flat-square"> <img alt="GitHub package.json version (branch)" src="https://img.shields.io/github/package-json/v/zptxdev/quaver/staging?color=356051&label=staging&style=flat-square"> <img alt="GitHub package.json version (branch)" src="https://img.shields.io/github/package-json/v/zptxdev/quaver/next?color=46041f&label=next&style=flat-square"> </p> <p align="center"> <a href="https://www.codefactor.io/repository/github/zptxdev/quaver/overview/next"> <img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/zptxdev/quaver/next?style=flat-square"> </a> <a href="https://go.zptx.dev/discord"> <img alt="Discord" src="https://img.shields.io/discord/334654301651730432?label=chat%20with%20us&style=flat-square"> </a> </p>

🎵 Public Instance

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.

🚀 Getting Started

Using Quaver

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.

Prerequisites

• 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

Setup

1. Clone the repository
2. Make a copy of settings.example.json and rename it to settings.json
3. Edit the fields in settings.json as necessary

Refer to CONFIGURATION.md for a detailed explanation on configuration.

4. Run pnpm i to install packages required to run Quaver
5. Run pnpm build to compile the source code
6. Run pnpm run slash:deploy to deploy slash commands
7. Run pnpm start to start Quaver

❔ FAQ

Can I get in trouble with Google/YouTube for using this?

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.

Can you add x feature to Quaver?

I'll consider it! Submit an issue here and I'll be happy to take a look.

I changed the language through the /settings command. Why isn't it updating in slash commands?

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.

I changed defaultLocaleCode, but it isn't updating in slash command descriptions. Why?

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.

Can I control Quaver from some kind of website/dashboard?

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.

What happened to Spotify support?

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.

💬 Translating

Take a look at our Crowdin project.

📝 Contributing

Refer to CONTRIBUTING.md.