Adding Entity guides, flowcharts, better sample system. (#2054)

* initial * Interaction glossary entry * Sharded Interaction sample * Renames into solution * Debugging samples * Modify target location for webhookclient * Finalizing docs work, resolving docfx errors. * Adding threaduser to user chart * Add branch info to readme. * Edits to user chart * Resolve format for glossary entries * Patch sln target * Issue with file naming fixed * Patch 1/x for builds * Appending suggestions
2022-01-27 14:50:49 +01:00
parent b0f59e3eb9
commit b14af1c008
57 changed files with 1059 additions and 344 deletions
--- a/samples/ShardedClient/Program.cs
+++ b/samples/ShardedClient/Program.cs
@@ -0,0 +1,81 @@
+using Discord;
+using Discord.Commands;
+using Discord.Interactions;
+using Discord.WebSocket;
+using Microsoft.Extensions.DependencyInjection;
+using ShardedClient.Services;
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace ShardedClient
+{
+    // 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
+    {
+        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
+            };
+
+            // You should dispose a service provider created using ASP.NET
+            // when you are finished using it, at the end of your app's lifetime.
+            // If you use another dependency injection framework, you should inspect
+            // its documentation for the best way to do this.
+            using (var services = ConfigureServices(config))
+            {
+                var client = services.GetRequiredService<DiscordShardedClient>();
+
+                // 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 services.GetRequiredService<InteractionHandlingService>().InitializeAsync();
+                await services.GetRequiredService<CommandHandlingService>().InitializeAsync();
+
+                // Tokens should be considered secret data, and never hard-coded.
+                await client.LoginAsync(TokenType.Bot, Environment.GetEnvironmentVariable("token"));
+                await client.StartAsync();
+
+                await Task.Delay(Timeout.Infinite);
+            }
+        }
+
+        private ServiceProvider ConfigureServices(DiscordSocketConfig config)
+            => new ServiceCollection()
+                .AddSingleton(new DiscordShardedClient(config))
+                .AddSingleton<CommandService>()
+                .AddSingleton(x => new InteractionService(x.GetRequiredService<DiscordShardedClient>()))
+                .AddSingleton<CommandHandlingService>()
+                .AddSingleton<InteractionHandlingService>()
+                .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;
+        }
+    }
+}