Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fabichan99/lavasharp

A Selfhostable Music Bot for Discord using DisCatSharp and Lavalink
https://github.com/fabichan99/lavasharp

bot discord discord-bot discordbot lavalink

Last synced: about 20 hours ago
JSON representation

A Selfhostable Music Bot for Discord using DisCatSharp and Lavalink

Awesome Lists containing this project

README

        

# LavaSharp Documentation

![logo](https://github.com/FabiChan99/LavaSharp/assets/73954978/56bb0841-f573-497f-93a3-bb51608a800e)

LavaSharp is a self-hostable music bot for Discord, built using [DisCatSharp](https://github.com/Aiko-IT-Systems/DisCatSharp) and [Lavalink](https://github.com/lavalink-devs/Lavalink).

## Installation and Usage
> [!Note]
> This is a single server bot. Each discord server needs its own instance!

### Installation:
1. Download the latest release from the [releases page](https://github.com/FabiChan99/LavaSharp/releases).
2. Extract the zip file for your operating system.
3. Setup Lavalink (see [Lavalink Releases](https://github.com/lavalink-devs/Lavalink/releases) and [Lavalink](https://github.com/lavalink-devs/Lavalink) for more information).
> [!IMPORTANT]
> LavaSharp is only compatible with Lavalink 4.0.0 and above! Also use the [application.yml](https://raw.githubusercontent.com/FabiChan99/LavaSharp/master/application.yml).
4. Rename the `config.example.json` to `config.json` and fill in the required information.

### Features:
- Compatible with YouTube, Spotify, SoundCloud, Vimeo, Twitch and HTTP URLs.
- Supports playlists.
- Supports searching on YouTube, Spotify* and SoundCloud.
- Support autoleave when the bot is alone in a voice channel.
- seeking, pausing, resuming, skipping, repeating, shuffling, volume control and more.

> Spotify support is only available if you have entered a valid Spotify client ID and client secret in the config.json.

## Screenshots:

![Auto Detection and Search forcing](https://i.imgur.com/kxCCF75.png)
![Screenshot](https://i.imgur.com/casjdF4.png)
![Screenshot](https://i.imgur.com/cSunISg.png)
![Screenshot](https://i.imgur.com/ozsKAEN.png)

## Contribution

If you want to contribute to LavaSharp, you can create a fork of the project and submit your changes. Please note that
all contributions must adhere to the rules and standards of this project.

## Contact

For more information or support, you can contact me on GitHub or at Discord -> [@fabichan](https://discord.com/users/591226486657253377).

Please note that this documentation is based on the current state of the project and may change over time as LavaSharp
is still in development.