mirror of
https://github.com/Myxelium/Lunaris2.0.git
synced 2026-04-13 16:10:36 +00:00
Compare commits
1 Commits
0.1.18
...
Fix-bug-wi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cbef37c575 |
@@ -1,189 +0,0 @@
|
|||||||
### README.md
|
|
||||||
|
|
||||||
# Handlers
|
|
||||||
|
|
||||||
Handlers for the Lunaris2 bot, which is built using C#, Discord.Net, and Lavalink4NET. Below is a detailed description of each handler and their responsibilities.
|
|
||||||
|
|
||||||
## Handlers
|
|
||||||
|
|
||||||
### ClearQueueHandler
|
|
||||||
|
|
||||||
Handles the command to clear the music queue.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class ClearQueueHandler : IRequestHandler<ClearQueueCommand>
|
|
||||||
```
|
|
||||||
|
|
||||||
### DisconnectHandler
|
|
||||||
|
|
||||||
Handles the command to disconnect the bot from the voice channel.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class DisconnectHandler : IRequestHandler<DisconnectCommand>
|
|
||||||
```
|
|
||||||
|
|
||||||
### PauseHandler
|
|
||||||
|
|
||||||
Handles the command to pause the currently playing track.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class PauseHandler : IRequestHandler<PauseCommand>
|
|
||||||
```
|
|
||||||
|
|
||||||
### PlayHandler
|
|
||||||
|
|
||||||
Handles the command to play a track or playlist.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class PlayHandler : IRequestHandler<PlayCommand>
|
|
||||||
```
|
|
||||||
|
|
||||||
### ResumeHandler
|
|
||||||
|
|
||||||
Handles the command to resume the currently paused track.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class ResumeHandler : IRequestHandler<ResumeCommand>
|
|
||||||
```
|
|
||||||
|
|
||||||
### SkipHandler
|
|
||||||
|
|
||||||
Handles the command to skip the currently playing track.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class SkipHandler : IRequestHandler<SkipCommand>
|
|
||||||
```
|
|
||||||
|
|
||||||
### MessageReceivedHandler
|
|
||||||
|
|
||||||
Handles incoming messages and processes commands or statistics requests.
|
|
||||||
|
|
||||||
```csharp
|
|
||||||
public class MessageReceivedHandler : INotificationHandler<MessageReceivedNotification>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Mermaid Diagrams
|
|
||||||
|
|
||||||
### 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
|
|
||||||
|
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sequence Diagram for PlayHandler
|
|
||||||
|
|
||||||
```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
|
|
||||||
```
|
|
||||||
|
|
||||||
### Sequence Diagram for MessageReceivedHandler
|
|
||||||
|
|
||||||
```mermaid
|
|
||||||
sequenceDiagram
|
|
||||||
participant User
|
|
||||||
participant Bot
|
|
||||||
participant DiscordSocketClient
|
|
||||||
participant ISender
|
|
||||||
participant MessageReceivedNotification
|
|
||||||
|
|
||||||
User->>Bot: Send message
|
|
||||||
Bot->>MessageReceivedNotification: Create notification
|
|
||||||
Bot->>DiscordSocketClient: Check if bot is mentioned
|
|
||||||
DiscordSocketClient-->>Bot: Mention info
|
|
||||||
alt Bot is mentioned
|
|
||||||
Bot->>ISender: Send ChatCommand
|
|
||||||
end
|
|
||||||
Bot->>DiscordSocketClient: Check for statistics command
|
|
||||||
alt Statistics command found
|
|
||||||
Bot->>DiscordSocketClient: Get server and channel info
|
|
||||||
DiscordSocketClient-->>Bot: Server and channel info
|
|
||||||
Bot->>User: Send statistics embed
|
|
||||||
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.
|
|
||||||
@@ -2,15 +2,11 @@
|
|||||||
```mermaid
|
```mermaid
|
||||||
flowchart TD
|
flowchart TD
|
||||||
Program[Program] -->|Register| EventListener
|
Program[Program] -->|Register| EventListener
|
||||||
Program --> Intervals[VoiceChannelMonitorService]
|
|
||||||
Intervals --> SetStatus[SetStatus, Updates status with amount of playing bots]
|
|
||||||
Intervals --> LeaveChannel[LeaveOnAlone, Leaves channel when alone for a time]
|
|
||||||
EventListener[DiscordEventListener] --> A[MessageReceivedHandler]
|
EventListener[DiscordEventListener] --> A[MessageReceivedHandler]
|
||||||
|
|
||||||
EventListener[DiscordEventListener] --> A2[SlashCommandReceivedHandler]
|
EventListener[DiscordEventListener] --> A2[SlashCommandReceivedHandler]
|
||||||
|
|
||||||
A --> |Message| f{If bot is mentioned}
|
A --> |Message| f{If bot is mentioned}
|
||||||
A --> |Message '!LunarisStats'| p[Responds with Server and Channel Statistics.]
|
|
||||||
f --> |ChatCommand| v[ChatHandler]
|
f --> |ChatCommand| v[ChatHandler]
|
||||||
|
|
||||||
A2[SlashCommandReceivedHandler] -->|Message| C{Send to correct command by
|
A2[SlashCommandReceivedHandler] -->|Message| C{Send to correct command by
|
||||||
@@ -18,11 +14,8 @@ flowchart TD
|
|||||||
|
|
||||||
C -->|JoinCommand| D[JoinHandler]
|
C -->|JoinCommand| D[JoinHandler]
|
||||||
C -->|PlayCommand| E[PlayHandler]
|
C -->|PlayCommand| E[PlayHandler]
|
||||||
C -->|PauseCommand| F[PauseHandler]
|
C -->|HelloCommand| F[HelloHandler]
|
||||||
C -->|DisconnectCommand| H[DisconnectHandler]
|
C -->|GoodbyeCommand| G[GoodbyeHandler]
|
||||||
C -->|ResumeCommand| J[ResumeHandler]
|
|
||||||
C -->|SkipCommand| K[SkipHandler]
|
|
||||||
C -->|ClearQueueCommand| L[ClearQueueHandler]
|
|
||||||
```
|
```
|
||||||
Program registers an event listener ```DiscordEventListener``` which publish a message :
|
Program registers an event listener ```DiscordEventListener``` which publish a message :
|
||||||
|
|
||||||
@@ -37,33 +30,20 @@ await Mediator.Publish(new MessageReceivedNotification(arg), _cancellationToken)
|
|||||||
|
|
||||||
## Handler integrations
|
## Handler integrations
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart LR
|
flowchart TD
|
||||||
D[JoinHandler] --> Disc[Discord Api]
|
D[JoinHandler] --> Disc[Discord Api]
|
||||||
E[PlayHandler] --> Disc[Discord Api]
|
E[PlayHandler] --> Disc[Discord Api]
|
||||||
F[SkipHandler] --> Disc[Discord Api]
|
F[HelloHandler] --> Disc[Discord Api]
|
||||||
G[PauseHandler] --> Disc[Discord Api]
|
G[GoodbyeHandler] --> Disc[Discord Api]
|
||||||
v[ChatHandler] --> Disc[Discord Api]
|
v[ChatHandler] --> Disc[Discord Api]
|
||||||
ClearQueueHandler --> Disc
|
|
||||||
ClearQueuehandler --> Lava
|
|
||||||
DisconnectHandler --> Disc
|
|
||||||
Resumehandler --> Disc
|
|
||||||
v --> o[Ollama Server]
|
v --> o[Ollama Server]
|
||||||
o --> v
|
o --> v
|
||||||
E --> Lava[Lavalink]
|
E --> Lava[Lavalink]
|
||||||
F --> Lava
|
|
||||||
G --> Lava
|
|
||||||
```
|
```
|
||||||
|Name| Description |
|
|Name| Description |
|
||||||
|--|--|
|
|--|--|
|
||||||
| JoinHandler| Handles the logic for **just** joining a voice channel. |
|
| JoinHandler| Handles the logic for **just** joining a voice channel. |
|
||||||
| PlayHandler| Handles the logic for joining and playing music in a voice channel. |
|
| PlayHandler| Handles the logic for joining and playing music in a voice channel. |
|
||||||
| PauseHandler | Handles the logic for pausing currently playing track. |
|
| HelloHandler| Responds with Hello. (Dummy handler, will be removed)|
|
||||||
| DisconnectHandler | Handles the logic for disconnecting from voicechannels. |
|
| GoodbyeHandler| Responds with Goodbye. (Dummy handler, will be removed)|
|
||||||
| ClearQueueHandler | Handles the logic for clearing the queued songs, except the currently playing one. |
|
|
||||||
| SkipHandler | Handles the logic for skipping tracks that are queued. If 0 trackS is in queue, it stops the current one.|
|
|
||||||
| Resumehandler | Resumes paused tracks. |
|
|
||||||
| ChatHandler| Handles the logic for LLM chat with user. |
|
| ChatHandler| Handles the logic for LLM chat with user. |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user