https://github.com/zptxdev/quaver
Simple-to-use music bot with features such as bass boost, nightcore, seek, search, and more.
https://github.com/zptxdev/quaver
discord discord-bot discord-js localization music music-bot typescript
Last synced: 6 months ago
JSON representation
Simple-to-use music bot with features such as bass boost, nightcore, seek, search, and more.
- Host: GitHub
- URL: https://github.com/zptxdev/quaver
- Owner: ZPTXDev
- License: gpl-3.0
- Created: 2021-05-17T00:37:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T21:19:23.000Z (7 months ago)
- Last Synced: 2024-10-22T16:38:49.720Z (6 months ago)
- Topics: discord, discord-bot, discord-js, localization, music, music-bot, typescript
- Language: TypeScript
- Homepage: https://go.zptx.dev/InviteQuaver
- Size: 3.85 MB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Quaver
Simple-to-use music bot with features such as bass boost, nightcore, seek, search, and more.
# 🎵 Public Instance
Quaver is available for public use [here](https://go.zptx.dev/InviteQuaver), and its dashboard is available [here](https://quaver.zptx.dev). 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](https://github.com/lavalink-devs/Lavalink) v4 (or higher)
- [youtube-source plugin](https://github.com/lavalink-devs/youtube-source#plugin) installed
- [LavaSrc plugin](https://github.com/topi314/LavaSrc#lavalink-usage) installed
- [java-timed-lyrics plugin](https://github.com/DuncteBot/java-timed-lyrics#using-with-lavalink) installed
> Please note the connection details of your Lavalink instance. You will need to specify them in `settings.json` later.
- Bot token from [Discord](https://discord.com/developers/applications)
## 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](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](https://github.com/ZPTXDev/Quaver/issues) 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](https://github.com/ZPTXDev/Quaver-Web). 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](https://github.com/topi314/LavaSrc) 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](https://translate.zptx.dev).
# 📝 Contributing
Refer to [CONTRIBUTING.md](CONTRIBUTING.md).