Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/groovygab/lavalink-music-bot
https://github.com/groovygab/lavalink-music-bot
discord discord-bot discord-js discord-js-bot discord-js-v13 discord-music-bot discordjs discordjs-bot discordjs-v13 erelajs erelajs-spotify lavalink lavalink-discord lavalink-music lavalink-musicbot sapphire-framework slash-commands spotify typescript
Last synced: about 9 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/groovygab/lavalink-music-bot
- Owner: GroovyGab
- License: wtfpl
- Created: 2021-09-29T22:41:43.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T05:04:18.000Z (over 1 year ago)
- Last Synced: 2024-09-23T16:02:43.585Z (1 day ago)
- Topics: discord, discord-bot, discord-js, discord-js-bot, discord-js-v13, discord-music-bot, discordjs, discordjs-bot, discordjs-v13, erelajs, erelajs-spotify, lavalink, lavalink-discord, lavalink-music, lavalink-musicbot, sapphire-framework, slash-commands, spotify, typescript
- Language: TypeScript
- Homepage:
- Size: 947 KB
- Stars: 24
- Watchers: 1
- Forks: 3
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lavalink Music Bot
# Slash Commands Live now!!
I made this bot because, well, groovy was taken down, so I made my own clone.
It's written in TypeScript and [Discord.js V13](https://github.com/discordjs/discord.js/), uses [Lavalink](https://github.com/freyacodes/Lavalink) for stable audio playback and [erela.js](https://github.com/MenuDocs/erela.js) as It's wrapper, it also uses the [Sapphire Framework for Discord bots](https://github.com/sapphiredev/framework/). (Note that this is a personal project, don't expect this code to be perfect and maybe it isn't a good idea to run it in a production environment)
## Requirements
1. Node.js 16.6.x
2. Java version 13 or higher (For Lavalink).
3. Lavalink (Get it from [here](https://github.com/freyacodes/Lavalink/releases))
4. Spotify API Client ID, and Client Secret. (Get them from [here](https://developer.spotify.com/dashboard/applications))
5. A Discord bot token
## Self-hosting guide
This bot is pretty easy to set up, here's the guide:
1. Clone this repo:
```
git clone https://github.com/iliveinsideyourwalls/lavalink-music-bot.git
```
2. cd into de directory.
3. Install dependencies:
```
npm install
```
4. Change the name of the `src/.env.example` file to `.env`.
5. Populate your .env file:
```
# Bot essentials
DISCORD_TOKEN=
OWNERS=
PREFIX=
# Default lavalink cradentials
LAVALINK_HOST=localhost
LAVALINK_PORT=2333
LAVALINK_PASSWD=youshallnotpass
# For spotify support
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
# You can put whatever in these
CLIENT_NAME=
CLIENT_VERSION=
# The default player's volume
DEFAULT_VOLUME=
```
6. Now you have to set-up a Lavalink node, Get lavalink from [here](https://github.com/freyacodes/Lavalink/releases).
7. Make a folder called `lavalink_server` wherever you want (I recommend that you put it in the same folder as where you cloned the repo)
8. Put the Lavalink executable in the folder you just made along with a [application.yml](https://github.com/freyacodes/Lavalink/blob/master/LavalinkServer/application.yml.example) file.
9. Run lavalink (Note that you **must** run the command in the same folder as the application.yml file):
```
java -jar /Lavalink.jar
```
10. Now build the bot:
```
npm run build
```
11. Run the bot:
```
node dist/index.js
```
If you see something like [this](https://i.imgur.com/1ewTEM5.png) then the bot is ready to go, now all there's left is inviting your bot to your server.