Compare commits

...

1 Commits

Author SHA1 Message Date
f292124228 Update documentation 2024-10-25 21:38:47 +02:00

View File

@@ -2,11 +2,15 @@
```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
@@ -14,8 +18,11 @@ flowchart TD
C -->|JoinCommand| D[JoinHandler] C -->|JoinCommand| D[JoinHandler]
C -->|PlayCommand| E[PlayHandler] C -->|PlayCommand| E[PlayHandler]
C -->|HelloCommand| F[HelloHandler] C -->|PauseCommand| F[PauseHandler]
C -->|GoodbyeCommand| G[GoodbyeHandler] C -->|DisconnectCommand| H[DisconnectHandler]
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 :
@@ -30,20 +37,33 @@ await Mediator.Publish(new MessageReceivedNotification(arg), _cancellationToken)
## Handler integrations ## Handler integrations
```mermaid ```mermaid
flowchart TD flowchart LR
D[JoinHandler] --> Disc[Discord Api] D[JoinHandler] --> Disc[Discord Api]
E[PlayHandler] --> Disc[Discord Api] E[PlayHandler] --> Disc[Discord Api]
F[HelloHandler] --> Disc[Discord Api] F[SkipHandler] --> Disc[Discord Api]
G[GoodbyeHandler] --> Disc[Discord Api] G[PauseHandler] --> 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. |
| HelloHandler| Responds with Hello. (Dummy handler, will be removed)| | PauseHandler | Handles the logic for pausing currently playing track. |
| GoodbyeHandler| Responds with Goodbye. (Dummy handler, will be removed)| | DisconnectHandler | Handles the logic for disconnecting from voicechannels. |
| 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. |