Skip to content

Latest commit

 

History

History
248 lines (185 loc) · 12.3 KB

README.md

File metadata and controls

248 lines (185 loc) · 12.3 KB
Raw

Version Contributors Forks Stargazers Issues Support Server MIT License Run on Repl.it Remix on Glitch


lavamusic

Lavamusic

Lavamusic is a Discord music bot that uses Discord.js, lavalink-client, and TypeScript.

Invite Lavamusic · Report Bug & Request Feature

🔥 Unique Features

  • User-friendly and Easy to Use
  • Highly Configurable
  • Customizable Prefix
  • Multilingual support Here
  • 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

  • SoundCloud
  • Twitch
  • Bandcamp
  • Vimeo
  • Nico
  • Mixer
  • http

🔌 Plugin Sources

Note: You need to install the plugins to use these sources

To Setup a Lavalink server on Windows, Linux, or Replit, Click Here!

Need help with plugins?

Join our Discord Server and ask for help in the #support channel!

🔧 Requirements

Before starting with the installation, you need to have the following:

Optional

🚀 Installation from source

  1. Clone the Lavamusic repository:
git clone https://github.com/appujet/lavamusic.git
  1. Change to the Lavamusic directory:
cd lavamusic
  1. Install the required packages:
npm i

  1. Copy the .env.example file to .env and fill in all required values

  2. Copy the example.<The data source you want to use>.schema.prisma file to schema.prisma in prisma folder Note: If you want to use sqlite, skip this step. If you are using a different data source, don't forget to fill in the DATABASE_URL value in .env.

  3. Generate the Prisma client:

npm run db:push
  1. Run the migrations (Only if you want to migrate your database):
npm run db:migrate
  1. Run the bot:

Note: You can also run run.bat to easily run the bot on Windows.

npm start
  1. Invite the bot to your server:

Generate an invite link for your bot and invite it to your server using the Discord Developer Portal or Permissions Calculator.

🚀 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.

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:

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:

docker-compose up --force-recreate --build -d
image prune -f

You can automate this by using Watchtower. The following should be sufficient:

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

📝 Tutorial

A tutorial has been uploaded on YouTube. Watch it by clicking here.

📜 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 LICENSE for more information.

☕ Donate

Do you like this project? Support it by donating! ko-fi

👥 Contributors

Thanks go to these wonderful people: