New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add DiscordShardedClient sample project & Client FAQ entry. #1177
Changes from 1 commit
a53dd4b
c848667
51b0914
fc7ac80
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -63,4 +63,23 @@ use the cached message entity. Read more about it [here](xref:Guides.Concepts.Ev | |||||
|
||||||
[MessageCacheSize]: xref:Discord.WebSocket.DiscordSocketConfig.MessageCacheSize | ||||||
[DiscordSocketConfig]: xref:Discord.WebSocket.DiscordSocketConfig | ||||||
[MessageUpdated]: xref:Discord.WebSocket.BaseSocketClient.MessageUpdated | ||||||
[MessageUpdated]: xref:Discord.WebSocket.BaseSocketClient.MessageUpdated | ||||||
|
||||||
## What is a shard/sharded client, and how is it different from the `DiscordSocketClient`? | ||||||
As your bot grows in popularity, it is recommended that you should section your bot off into separate processes. | ||||||
The [DiscordShardedClient] is essentially a class that allows you to easily create and manage multiple [DiscordSocketClient] | ||||||
instances, with each one serving a different amount of guilds. | ||||||
|
||||||
Aside from a few noteworthy differences in some event names, and specifying the amount of shards to connect with | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
in a [DiscordSocketConfig], there are very few differences from the [DiscordSocketClient] class, and it is very straightforward | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
to modify your existing code to use a [DiscordShardedClient] when necessary. | ||||||
|
||||||
The main differences are: | ||||||
1. You need to specify the total amount of shards, or shard ids, via [DiscordShardedClient]'s constructors. | ||||||
2. The [Connected], [Disconnected], [Ready], and [LatencyUpdated] events | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||
are replaced with [ShardConnected], [ShardDisconnected], [ShardReady], and [ShardLatencyUpdated]. | ||||||
3. Every event handler you apply/remove to the [DiscordShardedClient] is applied/removed to each shard. | ||||||
If you wish to control a specific shard's events, you can access an individual shard through the `Shards` property. | ||||||
|
||||||
If you do not wish to use the [DiscordShardedClient] and instead reuse the same [DiscordSocketClient] code and manually shard them, | ||||||
you can do so by specifiying the [ShardId] for the [DiscordSocketConfig] and pass that to the [DiscordSocketClient]'s constructor. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<Project Sdk="Microsoft.NET.Sdk"> | ||
|
||
<PropertyGroup> | ||
<OutputType>Exe</OutputType> | ||
<TargetFramework>netcoreapp2.1</TargetFramework> | ||
<RootNamespace>_03_sharded_client</RootNamespace> | ||
</PropertyGroup> | ||
|
||
<ItemGroup> | ||
<ProjectReference Include="..\..\src\Discord.Net.Commands\Discord.Net.Commands.csproj" /> | ||
<ProjectReference Include="..\..\src\Discord.Net.WebSocket\Discord.Net.WebSocket.csproj" /> | ||
</ItemGroup> | ||
|
||
</Project> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
using System.Threading.Tasks; | ||
using Discord.Commands; | ||
|
||
namespace _03_sharded_client.Modules | ||
{ | ||
// Remember to make your module reference the ShardedCommandContext | ||
public class PublicModule : ModuleBase<ShardedCommandContext> | ||
{ | ||
[Command("info")] | ||
public async Task InfoAsync() | ||
{ | ||
var msg = $@"Hi {Context.User}! There are currently {Context.Client.Shards} shards! | ||
This guild is being served by shard number {Context.Client.GetShardFor(Context.Guild).ShardId}"; | ||
await ReplyAsync(msg); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
using System; | ||
using System.Threading.Tasks; | ||
using _03_sharded_client.Services; | ||
using Discord; | ||
using Discord.Commands; | ||
using Discord.WebSocket; | ||
using Microsoft.Extensions.DependencyInjection; | ||
|
||
namespace _03_sharded_client | ||
{ | ||
// This is a minimal example of using Discord.Net's Sharded Client | ||
// The provided DiscordShardedClient class simplifies having multiple | ||
// DiscordSocketClient instances (or shards) to serve a large number of guilds. | ||
class Program | ||
{ | ||
private DiscordShardedClient _client; | ||
|
||
static void Main(string[] args) | ||
=> new Program().MainAsync().GetAwaiter().GetResult(); | ||
public async Task MainAsync() | ||
{ | ||
// You specify the amount of shards you'd like to have with the | ||
// DiscordSocketConfig. Generally, it's recommended to | ||
// have 1 shard per 1500-2000 guilds your bot is in. | ||
var config = new DiscordSocketConfig | ||
{ | ||
TotalShards = 2 | ||
}; | ||
|
||
var services = ConfigureServices(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
_client = new DiscordShardedClient(config); | ||
|
||
// The Sharded Client does not have a Ready event. | ||
// The ShardReady event is used instead, allowing for individual | ||
// control per shard. | ||
_client.ShardReady += ReadyAsync; | ||
_client.Log += LogAsync; | ||
|
||
await _client.LoginAsync(TokenType.Bot, Environment.GetEnvironmentVariable("token")); | ||
await _client.StartAsync(); | ||
|
||
await Task.Delay(-1); | ||
} | ||
|
||
private IServiceProvider ConfigureServices() | ||
{ | ||
return new ServiceCollection() | ||
.AddSingleton(_client) | ||
.AddSingleton<CommandService>() | ||
.AddSingleton<CommandHandlingService>() | ||
.BuildServiceProvider(); | ||
} | ||
|
||
|
||
private Task ReadyAsync(DiscordSocketClient shard) | ||
{ | ||
Console.WriteLine($"Shard Number {shard.ShardId} is connected and ready!"); | ||
return Task.CompletedTask; | ||
} | ||
|
||
private Task LogAsync(LogMessage log) | ||
{ | ||
Console.WriteLine(log.ToString()); | ||
return Task.CompletedTask; | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
using System; | ||
using System.Reflection; | ||
using System.Threading.Tasks; | ||
using Microsoft.Extensions.DependencyInjection; | ||
using Discord; | ||
using Discord.Commands; | ||
using Discord.WebSocket; | ||
|
||
namespace _03_sharded_client.Services | ||
{ | ||
public class CommandHandlingService | ||
{ | ||
private readonly CommandService _commands; | ||
private readonly DiscordShardedClient _discord; | ||
private readonly IServiceProvider _services; | ||
|
||
public CommandHandlingService(IServiceProvider services) | ||
{ | ||
_commands = services.GetRequiredService<CommandService>(); | ||
_discord = services.GetRequiredService<DiscordShardedClient>(); | ||
_services = services; | ||
|
||
_discord.MessageReceived += MessageReceivedAsync; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd probably move it under There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes. |
||
} | ||
|
||
public async Task InitializeAsync() | ||
{ | ||
await _commands.AddModulesAsync(Assembly.GetEntryAssembly(), _services); | ||
} | ||
|
||
public async Task MessageReceivedAsync(SocketMessage rawMessage) | ||
{ | ||
// Ignore system messages, or messages from other bots | ||
if (!(rawMessage is SocketUserMessage message)) | ||
return; | ||
if (message.Source != MessageSource.User) | ||
return; | ||
|
||
// This value holds the offset where the prefix ends | ||
var argPos = 0; | ||
if (!message.HasMentionPrefix(_discord.CurrentUser, ref argPos)) | ||
return; | ||
|
||
// A new kind of command context, ShardedCommandContext can be utilized with the commands framework | ||
var context = new ShardedCommandContext(_discord, message); | ||
var result = await _commands.ExecuteAsync(context, argPos, _services); | ||
|
||
if (result.Error.HasValue && | ||
result.Error.Value != CommandError.UnknownCommand) // it's bad practice to send 'unknown command' errors | ||
await context.Channel.SendMessageAsync(result.ToString()); | ||
} | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Run-on sentence; revision is recommended.