Update readme.md

Bot/Handler/MusicPlayer/PlayCommand/readme.md

@@ -0,0 +1,33 @@
+```mermaid
+flowchart TD
+    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.
+
+Short explaination for some of the variables used:
+
+| Variable | Type | Description |
+| --- | --- | --- |
+| `_lavaNode` | `LavaNode` | An instance of the `LavaNode` class, used to interact with the LavaLink server for playing music in Discord voice channels. |
+| `_client` | `DiscordSocketClient` | An instance of the `DiscordSocketClient` class, used to interact with the Discord API for sending messages, joining voice channels, etc. |
+| `_musicEmbed` | `MusicEmbed` | An instance of a custom `MusicEmbed` class, likely used to create and send rich embed messages related to the music player's current status. |
+| `context` | `SocketSlashCommand` | An instance of the `SocketSlashCommand` class, representing a slash command received from Discord. Used to get information about the command and to respond to it. |
+| `player` | `LavaPlayer` | An instance of the `LavaPlayer` class, representing a music player connected to a specific voice channel. Used to play, pause, skip, and queue tracks. |
+| `guildMessageIds` | `Dictionary<ulong, List<ulong>>` | A dictionary that maps guild IDs to lists of message IDs. Used to keep track of messages sent by the bot in each guild, allowing the bot to delete its old messages when it sends new ones. |
+| `songName` | `string` | A string that represents the name or URL of a song to play. Used to search for and queue tracks. |
+| `searchResponse` | `SearchResponse` | An instance of the `SearchResponse` class, representing the result of a search for tracks. Used to get the tracks that were found and queue them in the player. |

README.md

@@ -10,10 +10,12 @@ Lunaris2 is a Discord bot designed to play music in your server's voice channels
 
 ## Setup
 
-1. Clone the repository.
-2. Install the required packages by running `dotnet restore`.
-3. Build the project using `dotnet build`.
-4. Run the bot using `dotnet run`.
+1. Clone the repo.
+2. Extract.
+3. If there isn't already a appsettings.json file in there, create one.
+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