Create readme.md

Bot/Handler/MusicPlayer/PlayCommand/readme.md

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

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
 

application.yml

@@ -1,21 +1,16 @@
 server: # REST and WS server
   port: 2333
   address: 0.0.0.0
-  http2:
-    enabled: false # Whether to enable HTTP/2 support
 plugins:
 #  name: # Name of the plugin
 #    some_key: some_value # Some key-value pair for the plugin
 #    another_key: another_value
 lavalink:
   plugins:
-#    - dependency: "com.github.example:example-plugin:1.0.0" # required, the coordinates of your plugin
-#      repository: "https://maven.example.com/releases" # optional, defaults to the Lavalink releases repository by default
-#      snapshot: false # optional, defaults to false, used to tell Lavalink to use the snapshot repository instead of the release repository
-#  pluginsDir: "./plugins" # optional, defaults to "./plugins"
-#  defaultPluginRepository: "https://maven.lavalink.dev/releases" # optional, defaults to the Lavalink release repository
-#  defaultPluginSnapshotRepository: "https://maven.lavalink.dev/snapshots" # optional, defaults to the Lavalink snapshot repository
+#    - dependency: "group:artifact:version"
+#      repository: "repository"
   server:
+    password: "youshallnotpass"
     sources:
       youtube: true
       bandcamp: true
@@ -93,4 +88,4 @@ logging:
   logback:
     rollingpolicy:
       max-file-size: 1GB
-      max-history: 30
+      max-history: 30

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   lavalink:
     # pin the image version to Lavalink v4
-    image: ghcr.io/lavalink-devs/lavalink:3.7.10
+    image: ghcr.io/lavalink-devs/lavalink:3.7.11
     container_name: lavalink
     restart: unless-stopped
     environment: