mirror of
https://github.com/Myxelium/Lunaris2.0.git
synced 2026-04-13 16:10:36 +00:00
Compare commits
12 Commits
Fix-bug-wi
...
3362c6bf8c
| Author | SHA1 | Date | |
|---|---|---|---|
| 3362c6bf8c | |||
| a864944318 | |||
| 146455c1bd | |||
| 56eee11fc9 | |||
| e01746a343 | |||
| e847c1579a | |||
| 1ccc31d3d2 | |||
| 7c4d8c246d | |||
| 43f0191752 | |||
| 872b6d3138 | |||
| f292124228 | |||
| 4cbee9a625 |
@@ -31,21 +31,23 @@ public class MessageReceivedHandler : INotificationHandler<MessageReceivedNotifi
|
||||
var servers = _client.Guilds.Select(guild => guild.Name);
|
||||
var channels = _client.Guilds
|
||||
.SelectMany(guild => guild.VoiceChannels)
|
||||
.Where(channel => channel.Users.Any(user => user.IsBot));
|
||||
.Where(channel => channel.ConnectedUsers.Any(guildUser => guildUser.Id == _client.CurrentUser.Id) &&
|
||||
channel.Users.Count != 1);
|
||||
|
||||
var table = new StringBuilder();
|
||||
var serverColumnWidth = 25; // Width for server column
|
||||
var channelColumnWidth = 25; // Width for channel column
|
||||
table.AppendLine($"{"Servers".PadRight(serverColumnWidth - 1)}|{"Channels".PadRight(channelColumnWidth - 1)}");
|
||||
table.AppendLine($"{new string('-', serverColumnWidth - 1)}|{new string('-', channelColumnWidth - 1)}");
|
||||
foreach (var (server, channel) in servers.Zip(channels))
|
||||
{
|
||||
table.AppendLine($"{server.PadRight(serverColumnWidth - 1)}|{channel.Name.PadRight(channelColumnWidth - 1)}");
|
||||
}
|
||||
var statsList = new StringBuilder();
|
||||
statsList.AppendLine("➡️ Servers");
|
||||
|
||||
foreach (var server in servers)
|
||||
statsList.AppendLine($"* {server}");
|
||||
|
||||
statsList.AppendLine("➡️ Now playing channels: ");
|
||||
|
||||
foreach (var channel in channels)
|
||||
statsList.AppendLine($"* {channel.Name} in {channel.Guild.Name}");
|
||||
|
||||
var embed = new EmbedBuilder()
|
||||
.WithTitle("Lunaris Statistics")
|
||||
.WithDescription(table.ToString())
|
||||
.WithDescription(statsList.ToString())
|
||||
.Build();
|
||||
|
||||
await notification.Message.Channel.SendMessageAsync(embed: embed);
|
||||
|
||||
@@ -105,7 +105,7 @@ public class PlayHandler : IRequestHandler<PlayCommand>
|
||||
|
||||
var trackLoadOptions = new TrackLoadOptions
|
||||
{
|
||||
SearchMode = TrackSearchMode.YouTube,
|
||||
SearchMode = TrackSearchMode.YouTubeMusic,
|
||||
};
|
||||
|
||||
var trackCollection = await _audioService.Tracks.LoadTracksAsync(searchQuery, trackLoadOptions, cancellationToken: cancellationToken);
|
||||
@@ -145,7 +145,7 @@ public class PlayHandler : IRequestHandler<PlayCommand>
|
||||
else
|
||||
{
|
||||
// It's just a single track or a search result.
|
||||
var track = trackCollection.Tracks.FirstOrDefault();
|
||||
var track = trackCollection.Track;
|
||||
|
||||
if (track != null)
|
||||
{
|
||||
|
||||
@@ -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 |
|
||||
|
||||
239
Bot/Handler/MusicPlayer/README.md
Normal file
239
Bot/Handler/MusicPlayer/README.md
Normal file
@@ -0,0 +1,239 @@
|
||||
### 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
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
## 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.
|
||||
@@ -6,6 +6,7 @@
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<Nullable>enable</Nullable>
|
||||
<UserSecretsId>ec2f340f-a44c-4869-ab79-a12ba9459d80</UserSecretsId>
|
||||
<AssemblyVersion>0.0.1337</AssemblyVersion>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- Lavalink4net 4.0.25 seems to break the Message Module-->
|
||||
|
||||
@@ -2,11 +2,15 @@
|
||||
```mermaid
|
||||
flowchart TD
|
||||
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] --> A2[SlashCommandReceivedHandler]
|
||||
|
||||
A --> |Message| f{If bot is mentioned}
|
||||
A --> |Message '!LunarisStats'| p[Responds with Server and Channel Statistics.]
|
||||
f --> |ChatCommand| v[ChatHandler]
|
||||
|
||||
A2[SlashCommandReceivedHandler] -->|Message| C{Send to correct command by
|
||||
@@ -14,8 +18,11 @@ flowchart TD
|
||||
|
||||
C -->|JoinCommand| D[JoinHandler]
|
||||
C -->|PlayCommand| E[PlayHandler]
|
||||
C -->|HelloCommand| F[HelloHandler]
|
||||
C -->|GoodbyeCommand| G[GoodbyeHandler]
|
||||
C -->|PauseCommand| F[PauseHandler]
|
||||
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 :
|
||||
|
||||
@@ -30,20 +37,33 @@ await Mediator.Publish(new MessageReceivedNotification(arg), _cancellationToken)
|
||||
|
||||
## Handler integrations
|
||||
```mermaid
|
||||
flowchart TD
|
||||
flowchart LR
|
||||
D[JoinHandler] --> Disc[Discord Api]
|
||||
E[PlayHandler] --> Disc[Discord Api]
|
||||
F[HelloHandler] --> Disc[Discord Api]
|
||||
G[GoodbyeHandler] --> Disc[Discord Api]
|
||||
F[SkipHandler] --> Disc[Discord Api]
|
||||
G[PauseHandler] --> Disc[Discord Api]
|
||||
v[ChatHandler] --> Disc[Discord Api]
|
||||
ClearQueueHandler --> Disc
|
||||
ClearQueuehandler --> Lava
|
||||
DisconnectHandler --> Disc
|
||||
Resumehandler --> Disc
|
||||
v --> o[Ollama Server]
|
||||
o --> v
|
||||
E --> Lava[Lavalink]
|
||||
F --> Lava
|
||||
G --> Lava
|
||||
```
|
||||
|Name| Description |
|
||||
|--|--|
|
||||
| JoinHandler| Handles the logic for **just** joining 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)|
|
||||
| GoodbyeHandler| Responds with Goodbye. (Dummy handler, will be removed)|
|
||||
| PauseHandler | Handles the logic for pausing currently playing track. |
|
||||
| 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. |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
using Discord;
|
||||
using Discord.WebSocket;
|
||||
|
||||
namespace Lunaris2.Service
|
||||
@@ -25,6 +26,30 @@ namespace Lunaris2.Service
|
||||
}
|
||||
|
||||
private async Task CheckVoiceChannels()
|
||||
{
|
||||
SetStatus();
|
||||
await LeaveOnAlone();
|
||||
}
|
||||
|
||||
private void SetStatus()
|
||||
{
|
||||
var channels = _client.Guilds
|
||||
.SelectMany(guild => guild.VoiceChannels)
|
||||
.Count(channel =>
|
||||
channel.ConnectedUsers
|
||||
.Any(guildUser => guildUser.Id == _client.CurrentUser.Id) &&
|
||||
channel.Users.Count > 1
|
||||
);
|
||||
|
||||
if (channels == 0)
|
||||
_client.SetGameAsync(System.Reflection.Assembly.GetEntryAssembly()?.GetName().Version?.ToString(), type: ActivityType.CustomStatus);
|
||||
else if(channels == 1)
|
||||
_client.SetGameAsync("in 1 server", type: ActivityType.Playing);
|
||||
else if(channels > 1)
|
||||
_client.SetGameAsync($" in {channels} servers", type: ActivityType.Playing);
|
||||
}
|
||||
|
||||
private async Task LeaveOnAlone()
|
||||
{
|
||||
foreach (var guild in _client.Guilds)
|
||||
{
|
||||
|
||||
BIN
LOGOTYPE.png
Normal file
BIN
LOGOTYPE.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 230 KiB |
18
README.md
18
README.md
@@ -1,15 +1,17 @@
|
||||
# Lunaris2 - Discord Music Bot
|
||||

|
||||
|
||||
# Lunaris - Discord BOT
|
||||
|
||||
Lunaris2 is a Discord bot designed to play music in your server's voice channels. It's built using C# and the Discord.Net library, and it uses the LavaLink music client for audio streaming.
|
||||
|
||||
## Features
|
||||
## 🎮Features
|
||||
|
||||
- Play music from YouTube directly in your Discord server.
|
||||
- Skip tracks, pause, and resume playback.
|
||||
- Skip tracks, pause, resume playback and more music related commands.
|
||||
- Queue system to line up your favorite tracks.
|
||||
- Local LLM (AI chatbot) that answers on @mentions in Discord chat. See more about it below.
|
||||
|
||||
## Setup
|
||||
## 🤖 Setup
|
||||
|
||||
1. Clone the repo.
|
||||
2. Extract.
|
||||
@@ -27,7 +29,8 @@ The LLM is run using Ollama see more about Ollama [here](https://ollama.com/). R
|
||||
|
||||
## PM2 Setup
|
||||
- Install PM2 and configure it following their setup guide
|
||||
#### Lavalink
|
||||
|
||||
#### 🐦🔥 Lavalink
|
||||
* Download Lavalink 4.X.X (.jar)
|
||||
* Install Java 17
|
||||
|
||||
@@ -46,6 +49,11 @@ Register the Lunaris bot with PM2:
|
||||
- `/play <song>`: Plays the specified song in the voice channel you're currently in.
|
||||
- `/skip`: Skips the currently playing song.
|
||||
|
||||
## Technical Documentations
|
||||
- [Application Layout](https://github.com/Myxelium/Lunaris2.0/blob/master/Bot/README.md)
|
||||
* 🤖 [AI CHAT](https://github.com/Myxelium/Lunaris2.0/blob/master/Bot/Handler/ChatCommand/readme.md)
|
||||
* 🎵 [Music Player](https://github.com/Myxelium/Lunaris2.0/tree/master/Bot/Handler/MusicPlayer)
|
||||
|
||||
## Contributing
|
||||
|
||||
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||
|
||||
@@ -49,12 +49,9 @@ plugins:
|
||||
# Clients are queried in the order they are given (so the first client is queried first and so on...)
|
||||
clients:
|
||||
- MUSIC
|
||||
- ANDROID_TESTSUITE
|
||||
- WEB
|
||||
- TVHTML5EMBEDDED
|
||||
# name: # Name of the plugin
|
||||
# some_key: some_value # Some key-value pair for the plugin
|
||||
# another_key: another_value
|
||||
- ANDROID_TESTSUITE
|
||||
lavalink:
|
||||
plugins:
|
||||
- dependency: com.github.devoxin:lavadspx-plugin:0.0.5 # replace {VERSION} with the latest version from the "Releases" tab.
|
||||
|
||||
Reference in New Issue
Block a user