Compare commits

..

2 Commits

Author SHA1 Message Date
713715901b Create readme.md 2024-04-14 23:54:26 +02:00
1a3a00f4ed Update README.md 2024-04-14 23:33:44 +02:00
2 changed files with 26 additions and 4 deletions

View File

@@ -0,0 +1,20 @@
```mermaid
flowchart LR
PlayHandler --> EnsureConnected
EnsureConnected --> GetPlayer
GetPlayer --> SearchAsync
SearchAsync --> SearchResponse
SearchResponse --> PlayTrack
PlayTrack --> NowPlayingEmbed
```
| Name | Description |
|--|--|
| PlayHandler | Holds the logic for playing songs |
| GetPlayer | Joins voice channel, produces chat resposne |
| EnsureConnected | Makes sure the client is connected |
| SearchAsync | Searches for songs information |
| SearchResponse | Handling possible errors from the response of SearchAsync |
| PlayTrack | Plays the song |
There is also OnTrackEnd, when it get called an attempt is made to play the next song in queue.

View File

@@ -10,10 +10,12 @@ Lunaris2 is a Discord bot designed to play music in your server's voice channels
## Setup ## Setup
1. Clone the repository. 1. Clone the repo.
2. Install the required packages by running `dotnet restore`. 2. Extract.
3. Build the project using `dotnet build`. 3. If there isn't already a appsettings.json file in there, create one.
4. Run the bot using `dotnet run`. 4. Set the discord bot token. How the file should look (without token): [appsettings.json](https://github.com/Myxelium/Lunaris2.0/blob/master/Bot/appsettings.json)]
5. Make sure you got docker installed. And run the file ``start-services.sh``, make sure you got git-bash installed.
6. Now you can start the project and run the application.
## Usage ## Usage