Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appujet/lavamusic
lavalink music bot base in shoukaku and discord.js v14
https://github.com/appujet/lavamusic
bot discord discord-bot discord-js discord-js-v14 discord-music-bot lavalink lavalink-music lavalink-music-bot lavalink-musicbot lavamusic- lavaplayer music music-bot music-bot-discord nodejs shoukaku soundcloud- spotify youtube
Last synced: about 11 hours ago
JSON representation
lavalink music bot base in shoukaku and discord.js v14
- Host: GitHub
- URL: https://github.com/appujet/lavamusic
- Owner: appujet
- License: gpl-3.0
- Created: 2021-08-16T06:53:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T08:06:45.000Z (about 18 hours ago)
- Last Synced: 2024-09-24T11:03:34.805Z (about 16 hours ago)
- Topics: bot, discord, discord-bot, discord-js, discord-js-v14, discord-music-bot, lavalink, lavalink-music, lavalink-music-bot, lavalink-musicbot, lavamusic-, lavaplayer, music, music-bot, music-bot-discord, nodejs, shoukaku, soundcloud-, spotify, youtube
- Language: TypeScript
- Homepage: https://appujet.github.io/lavamusic/
- Size: 10.1 MB
- Stars: 567
- Watchers: 9
- Forks: 492
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[![Version][version-shield]](version-url)
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Support Server][support-shield]][support-server]
[![MIT License][license-shield]][license-url]
[](https://repl.it/github/appujet/lavamusic)
[](https://glitch.com/edit/#!/import/github/appujet/lavamusic)
Lavamusic
Lavamusic is a Discord music bot that uses Discord.js, Shoukaku, and TypeScript.
Invite Lavamusic
·
Report Bug & Request Feature
## 🔥 Unique Features
- User-friendly and Easy to Use
- Highly Configurable
- Customizable Prefix
- Multilingual support
- Hybrid Command Handling (Slash and Normal Commands)
- Developed using TypeScript and Discord.js v14
- Advanced Music System
- Powerful Search Engine
- 12 + Music Filters
- 24/7 Music Playback
- Playlist commands
- Music channel system
## 🎶 Support Sources
### 🔍 Default Sources
- 
- 
- 
- 
- 
- 
- 
### 🔌 Plugin Sources
**Note: You need to install the plugins to use these sources**
-  ([Required Plugin][youtube-source])
-  ([Required Plugin][LavaSrc])
-  ([Required Plugin][LavaSrc])
-  ([Required Plugin][LavaSrc])
-  ([Required Plugin][LavaSrc])
-  ([Required Plugin][Jiosaavn])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
-  ([Required Plugin][skybot-lavalink-plugin])
[LavaSrc]: https://github.com/topi314/LavaSrc
[skybot-lavalink-plugin]: https://github.com/DuncteBot/skybot-lavalink-plugin
[youtube-source]: https://github.com/lavalink-devs/youtube-source
[jiosaavn]: https://github.com/appujet/jiosaavn-plugin
To Setup a Lavalink server on Windows, Linux, or Replit, [Click Here!](https://github.com/LucasB25/lavalink-server)
### **Need help with plugins?**
Join our [Discord Server](https://discord.gg/YsJCtDuTXp) and ask for help in the `#support` channel!
## 🔧 Requirements
Before starting with the installation, you need to have the following:
-  [Recommend LTS or higher](https://nodejs.org/)
-  [v4 or higher](https://github.com/lavalink-devs/lavalink)
### Optional
-  [Optional](https://www.mongodb.com/try/download/community) (For MongoDB database)
-  [Optional](https://www.postgresql.org/download/) (For PostgreSQL database)
-  [Optional](https://www.docker.com/) (For Docker Installation)
-  [Optional](https://docs.docker.com/compose/) (For Docker Installation)
## 🚀 Installation from source
1. Clone the Lavamusic repository:
```bash
git clone https://github.com/appujet/lavamusic.git
```
2. Change to the Lavamusic directory:
```bash
cd lavamusic
```
3. Install the required packages:
```bash
npm i
```
4. Copy the .env.example file to .env and fill in all required values.
Note: Optional values are noted as comments in the settings.
5. Generate the Prisma client:
```bash
npm run db:push
```
6. Run the migrations (Only if you want to migrate your database):
```bash
npm run db:migrate
```
7. Run the bot:
If you are using Windows, click run.bat on Windows explorer.
```bash
npm start
```
8. Invite the bot to your server:
Generate an invite link for your bot and invite it to your server using the [Discord Developer Portal](https://discord.com/developers/applications) or [Permissions Calculator](https://discordapi.com/permissions.html).
## 🚀 Installation using Docker Compose
This section assumes you have Docker and Docker Compose installed and running correctly.
Edit docker-compose.yml and make sure to set the following variables:
Your .env file should look like this or you can use the .env.example file.
```yaml
TOKEN="." # Your bot token and remember, don't show everyone your bot token
DEFAULT_LANGUAGE= "EnglishUS" # Default language for bot
PREFIX="!" # Your prefix
OWNER_IDS=["859640640640640640","859640640640640640"] # Your discord id, you can add multiple ids
GUILD_ID="859640640640640640" # Your server ID (if you want to use it for a single server)
```
For more information how to fill all the variables go to this page.
You do not need to edit anything like the LAVALINK_SERVERS, DATABASE_URL and the ports unless you know what you're doing.
After saving your changes you can open a terminal and go to the same location as the docker-compose.yml file. Then run the following:
```bash
docker-compose up -d
```
The above command will start all your services and your bot should be up and running!
If you want to run it from the console, remove the -d argument.
To update, you only have to type the following:
```bash
docker-compose up --force-recreate --build -d
image prune -f
```
You can automate this by using [Watchtower](https://github.com/containrrr/watchtower). The following should be sufficient:
```bash
docker run --detach \
--name watchtower \
--volume /var/run/docker.sock:/var/run/docker.sock \
--restart on-failure \
containrrr/watchtower --cleanup
```
Do note that the bot will restart itself to update to the latest!
## 🔗 Useful Links
-  [Node.js](https://nodejs.org/en/download/)
-  [Discord.js](https://discord.js.org/#/)
-  [Lavalink](https://github.com/lavalink-devs/Lavalink)
-  [MongoDB](https://www.mongodb.com/try/download/community)
-  [PostgreSQL](https://www.postgresql.org/download/)
-  [Docker](https://www.docker.com/)
-  [Docker-Compose](https://docs.docker.com/compose/)
## 📝 Tutorial
A tutorial has been uploaded on YouTube. Watch it by [clicking here](https://youtu.be/x5lQD2rguz0).
## 📜 Contributing
Thank you for your interest in contributing to Lavamusic! Here are some guidelines to follow when contributing:
1. Fork the repository and create a new branch for your feature or bug fix.
2. Write clean and concise code that follows the established coding style.
3. Create detailed and thorough documentation for any new features or changes.
4. Write and run tests for your code.
5. Submit a pull request with your changes.
Your contribution will be reviewed by the project maintainers, and any necessary feedback or changes will be discussed with you. We appreciate your help in making Lavamusic better!
## 🔐 License
Distributed under the GPL-3.0 license. See  for more information.
## ☕ Donate
Do you like this project? Support it by donating!
[](https://ko-fi.com/H2H7LKT9L)
## 👥 Contributors
Thanks go to these wonderful people:
[version-shield]: https://img.shields.io/github/package-json/v/appujet/lavamusic?style=for-the-badge
[contributors-shield]: https://img.shields.io/github/contributors/appujet/lavamusic.svg?style=for-the-badge
[contributors-url]: https://github.com/appujet/lavamusic/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/appujet/lavamusic.svg?style=for-the-badge
[forks-url]: https://github.com/appujet/lavamusic/network/members
[stars-shield]: https://img.shields.io/github/stars/appujet/lavamusic.svg?style=for-the-badge
[stars-url]: https://github.com/appujet/lavamusic/stargazers
[issues-shield]: https://img.shields.io/github/issues/appujet/lavamusic.svg?style=for-the-badge
[issues-url]: https://github.com/appujet/lavamusic/issues
[license-shield]: https://img.shields.io/github/license/appujet/lavamusic.svg?style=for-the-badge
[license-url]: https://github.com/appujet/lavamusic/blob/master/LICENSE
[support-server]: https://discord.gg/PMpJnJaHmy
[support-shield]: https://img.shields.io/discord/942117923001098260.svg?style=for-the-badge&logo=discord&colorB=7289DA