Add logotype

Bot/Handler/MusicPlayer/PlayCommand/readme.md

@@ -8,6 +8,29 @@ flowchart TD
     PlayTrack --> NowPlayingEmbed
 ```
 
+```mermaid
+sequenceDiagram
+    participant User
+    participant Bot
+    participant DiscordSocketClient
+    participant IAudioService
+    participant SocketSlashCommand
+    participant LavalinkPlayer
+
+    User->>Bot: /play [song]
+    Bot->>DiscordSocketClient: Get user voice channel
+    DiscordSocketClient-->>Bot: Voice channel info
+    Bot->>IAudioService: Get or create player
+    IAudioService-->>Bot: Player instance
+    Bot->>SocketSlashCommand: Get search query
+    SocketSlashCommand-->>Bot: Search query
+    Bot->>IAudioService: Load tracks
+    IAudioService-->>Bot: Track collection
+    Bot->>LavalinkPlayer: Play track
+    LavalinkPlayer-->>Bot: Track started
+    Bot->>User: Now playing embed
+```
+
 ## Steps in the code
 
 | Name | Description |
@@ -32,4 +55,4 @@ There is also OnTrackEnd, when it get called an attempt is made to play the next
 | `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. |
+| `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. |

Bot/Handler/MusicPlayer/README.md

@@ -67,73 +67,23 @@ public class MessageReceivedHandler : INotificationHandler<MessageReceivedNotifi
 ### Class Diagram
 
 ```mermaid
-classDiagram
-    class ClearQueueHandler {
-        +Task Handle(ClearQueueCommand command, CancellationToken cancellationToken)
-    }
-    class DisconnectHandler {
-        +Task Handle(DisconnectCommand command, CancellationToken cancellationToken)
-    }
-    class PauseHandler {
-        +Task Handle(PauseCommand command, CancellationToken cancellationToken)
-    }
-    class PlayHandler {
-        +Task Handle(PlayCommand command, CancellationToken cancellationToken)
-    }
-    class ResumeHandler {
-        +Task Handle(ResumeCommand command, CancellationToken cancellationToken)
-    }
-    class SkipHandler {
-        +Task Handle(SkipCommand command, CancellationToken cancellationToken)
-    }
-    class MessageReceivedHandler {
-        +Task Handle(MessageReceivedNotification notification, CancellationToken cancellationToken)
-    }
-    class IAudioService
-    class DiscordSocketClient
-    class SocketSlashCommand
-    class CancellationToken
-    class Task
-    class IRequestHandler
-    class INotificationHandler
+sequenceDiagram
+    participant User as User
+    participant DiscordSocketClient as DiscordSocketClient
+    participant MessageReceivedHandler as MessageReceivedHandler
+    participant MessageReceivedNotification as MessageReceivedNotification
+    participant EmbedBuilder as EmbedBuilder
+    participant Channel as Channel
 
-    ClearQueueHandler ..|> IRequestHandler
-    DisconnectHandler ..|> IRequestHandler
-    PauseHandler ..|> IRequestHandler
-    PlayHandler ..|> IRequestHandler
-    ResumeHandler ..|> IRequestHandler
-    SkipHandler ..|> IRequestHandler
-    MessageReceivedHandler ..|> INotificationHandler
-    ClearQueueHandler --> IAudioService
-    DisconnectHandler --> IAudioService
-    PauseHandler --> IAudioService
-    PlayHandler --> IAudioService
-    ResumeHandler --> IAudioService
-    SkipHandler --> IAudioService
-    ClearQueueHandler --> DiscordSocketClient
-    DisconnectHandler --> DiscordSocketClient
-    PauseHandler --> DiscordSocketClient
-    PlayHandler --> DiscordSocketClient
-    ResumeHandler --> DiscordSocketClient
-    SkipHandler --> DiscordSocketClient
-    ClearQueueHandler --> SocketSlashCommand
-    DisconnectHandler --> SocketSlashCommand
-    PauseHandler --> SocketSlashCommand
-    PlayHandler --> SocketSlashCommand
-    ResumeHandler --> SocketSlashCommand
-    SkipHandler --> SocketSlashCommand
-    ClearQueueHandler --> CancellationToken
-    DisconnectHandler --> CancellationToken
-    PauseHandler --> CancellationToken
-    PlayHandler --> CancellationToken
-    ResumeHandler --> CancellationToken
-    SkipHandler --> CancellationToken
-    ClearQueueHandler --> Task
-    DisconnectHandler --> Task
-    PauseHandler --> Task
-    PlayHandler --> Task
-    ResumeHandler --> Task
-    SkipHandler --> Task
+    User->>DiscordSocketClient: Send message "!LunarisStats"
+    DiscordSocketClient->>MessageReceivedHandler: MessageReceivedNotification
+    MessageReceivedHandler->>MessageReceivedNotification: Handle(notification, cancellationToken)
+    MessageReceivedNotification->>MessageReceivedHandler: BotMentioned(notification, cancellationToken)
+    MessageReceivedHandler->>DiscordSocketClient: Get guilds and voice channels
+    DiscordSocketClient-->>MessageReceivedHandler: List of guilds and voice channels
+    MessageReceivedHandler->>EmbedBuilder: Create embed with statistics
+    EmbedBuilder-->>MessageReceivedHandler: Embed
+    MessageReceivedHandler->>Channel: Send embed message
 ```
 
 ### Sequence Diagram for PlayHandler
@@ -186,4 +136,104 @@ sequenceDiagram
     end
 ```
 
-This README provides an overview of the handlers and their responsibilities, along with class and sequence diagrams to illustrate the interactions and relationships between the components.
+## Extensions.cs
+
+#### Namespaces
+- **Discord**: Provides classes for interacting with Discord.
+- **Discord.WebSocket**: Provides WebSocket-specific classes for Discord.
+- **Lavalink4NET**: Provides classes for interacting with Lavalink.
+- **Lavalink4NET.Players**: Provides player-related classes for Lavalink.
+- **Lavalink4NET.Players.Queued**: Provides queued player-related classes for Lavalink.
+- **Microsoft.Extensions.Options**: Provides classes for handling options and configurations.
+
+#### Class: `Extensions`
+This static class contains extension methods for various Discord and Lavalink operations.
+
+##### Method: `GetPlayerAsync`
+- **Parameters**:
+  - `IAudioService audioService`: The audio service to retrieve the player from.
+  - `DiscordSocketClient client`: The Discord client.
+  - `SocketSlashCommand context`: The context of the slash command.
+  - `bool connectToVoiceChannel`: Whether to connect to the voice channel (default is true).
+- **Returns**: `ValueTask<QueuedLavalinkPlayer?>`
+- **Description**: Retrieves a `QueuedLavalinkPlayer` for the given context. If the retrieval fails, it returns null and sends an appropriate error message.
+
+##### Method: `GetGuild`
+- **Parameters**:
+  - `SocketSlashCommand message`: The slash command message.
+  - `DiscordSocketClient client`: The Discord client.
+- **Returns**: `SocketGuild`
+- **Description**: Retrieves the guild associated with the given slash command message. Throws an exception if the guild ID is null.
+
+##### Method: `GetVoiceState`
+- **Parameters**:
+  - `SocketSlashCommand message`: The slash command message.
+- **Returns**: `IVoiceState`
+- **Description**: Retrieves the voice state of the user who issued the slash command. Throws an exception if the user is not connected to a voice channel.
+
+##### Method: `RespondAsync`
+- **Parameters**:
+  - `SocketSlashCommand message`: The slash command message.
+  - `string content`: The content of the response.
+- **Returns**: `Task`
+- **Description**: Sends an ephemeral response to the slash command.
+
+##### Method: `GetOptionValueByName`
+- **Parameters**:
+  - `SocketSlashCommand command`: The slash command.
+  - `string optionName`: The name of the option to retrieve the value for.
+- **Returns**: `string`
+- **Description**: Retrieves the value of the specified option from the slash command. Returns an empty string if the option is not found.
+
+# MessageModule
+
+The `MessageModule` class provides utility methods for sending and removing messages in a Discord guild using the Discord.Net library. It maintains a dictionary to keep track of message IDs for each guild, allowing for easy removal of messages when needed.
+
+## Methods
+
+### `SendMessageAsync(SocketSlashCommand context, string message, DiscordSocketClient client)`
+
+Sends a follow-up message with the specified text content in response to a slash command.
+
+- **Parameters:**
+  - `context`: The `SocketSlashCommand` context in which the command was executed.
+  - `message`: The text content of the message to be sent.
+  - `client`: The `DiscordSocketClient` instance.
+
+### `SendMessageAsync(SocketSlashCommand context, Embed message, DiscordSocketClient client)`
+
+Sends a follow-up message with the specified embed content in response to a slash command.
+
+- **Parameters:**
+  - `context`: The `SocketSlashCommand` context in which the command was executed.
+  - `message`: The `Embed` content of the message to be sent.
+  - `client`: The `DiscordSocketClient` instance.
+
+### `RemoveMessages(SocketSlashCommand context, DiscordSocketClient client)`
+
+Removes all tracked messages for the guild in which the command was executed.
+
+- **Parameters:**
+  - `context`: The `SocketSlashCommand` context in which the command was executed.
+  - `client`: The `DiscordSocketClient` instance.
+
+### `StoreForRemoval(SocketSlashCommand context, DiscordSocketClient client)`
+
+Stores the message ID for removal and deletes any previously tracked messages for the guild.
+
+- **Parameters:**
+  - `context`: The `SocketSlashCommand` context in which the command was executed.
+  - `client`: The `DiscordSocketClient` instance.
+
+- **Returns:**
+  - The guild ID as a `ulong`.
+
+## Usage
+
+To use the `MessageModule` class, simply call the appropriate method from your command handling logic. For example:
+
+```csharp
+await context.SendMessageAsync("Hello, world!", client);
+```
+
+This will send a follow-up message with the text "Hello, world!" in response to the slash command.