- Updated Changelog.md

- Fixed intent error message condition

CHANGELOG.md

@@ -5,6 +5,15 @@ Experimental changelog. Mostly based on [keepachangelog](https://keepachangelog.
 
 ## Unreleased
 
+- More cool stuff coming soon
+
+## [4.0.1] - 03.03.2022
+
+- Added `usePrivilegedIntents` to creds.yml if you don't have or don't want (?) to use them
+- Added a human-readable, detailed error message if logging in fails due to missing privileged intents
+
+## [4.0.0] - 02.03.2022
+
 ### Added
 - Added `.deleteemptyservers` command
 - Added `.curtr <id>` which lets you see full information about one of your own transactions with the specified id

src/NadekoBot/Bot.cs

@@ -52,6 +52,9 @@ public sealed class Bot
 #else
             50;
 #endif
+
+        if(!_creds.UsePrivilegedIntents)
+            Log.Warning("You are not using privileged intents. Some features will not work properly");
         
         Client = new(new()
         {
@@ -63,8 +66,10 @@ public sealed class Bot
             AlwaysDownloadUsers = false,
             AlwaysResolveStickers = false,
             AlwaysDownloadDefaultStickers = false,
-            GatewayIntents = GatewayIntents.All,
-            LogGatewayIntentWarnings = false
+            GatewayIntents = _creds.UsePrivilegedIntents
+                ? GatewayIntents.All
+                : GatewayIntents.AllUnprivileged,
+            LogGatewayIntentWarnings = false,
         });
 
         _commandService = new(new()
@@ -75,9 +80,7 @@ public sealed class Bot
 
         // _interactionService = new(Client.Rest);
 
-#if GLOBAL_NADEKO || DEBUG
         Client.Log += Client_Log;
-#endif
     }
 
 
@@ -216,30 +219,28 @@ public sealed class Bot
 
     private async Task LoginAsync(string token)
     {
-        var clientReady = new TaskCompletionSource<bool>();
+        var clientReady = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
 
-        Task SetClientReady()
+        async Task SetClientReady()
         {
-            _ = Task.Run(async () =>
+            clientReady.TrySetResult(true);
+            try
             {
-                clientReady.TrySetResult(true);
-                try
-                {
-                    foreach (var chan in await Client.GetDMChannelsAsync())
-                        await chan.CloseAsync();
-                }
-                catch
-                {
-                    // ignored
-                }
-            });
-            return Task.CompletedTask;
+                foreach (var chan in await Client.GetDMChannelsAsync())
+                    await chan.CloseAsync();
+            }
+            catch
+            {
+                // ignored
+            }
         }
 
         //connect
         Log.Information("Shard {ShardId} logging in ...", Client.ShardId);
         try
         {
+            Client.Ready += SetClientReady;
+
             await Client.LoginAsync(TokenType.Bot, token);
             await Client.StartAsync();
         }
@@ -253,11 +254,10 @@ public sealed class Bot
             LoginErrorHandler.Handle(ex);
             Helpers.ReadErrorAndExit(4);
         }
-
-        Client.Ready += SetClientReady;
-        await clientReady.Task;
+        
+        await clientReady.Task.ConfigureAwait(false);
         Client.Ready -= SetClientReady;
-
+        
         Client.JoinedGuild += Client_JoinedGuild;
         Client.LeftGuild += Client_LeftGuild;
 
@@ -341,7 +341,33 @@ public sealed class Bot
 
     private Task Client_Log(LogMessage arg)
     {
-        if (arg.Exception is not null)
+        if (arg.Message?.Contains("unknown dispatch", StringComparison.InvariantCultureIgnoreCase) ?? false)
+            return Task.CompletedTask;
+
+        if (arg.Exception is { InnerException: WebSocketClosedException { CloseCode: 4014 } })
+        {
+            Log.Error(@"
+Login failed.
+
+*** Please enable privileged intents ***
+
+Certain Nadeko features require Discord's privileged gateway intents.
+These include greeting and goodbye messages, as well as creating the Owner message channels for DM forwarding.
+
+How to enable privileged intents:
+1. Head over to the Discord Developer Portal https://discord.com/developers/applications/
+2. Select your Application.
+3. Click on `Bot` in the left side navigation panel, and scroll down to the intents section.
+4. Enable both intents.
+5. Restart your bot.
+
+Read this only if your bot is in 100 or more servers:
+
+You'll need to apply to use the intents with Discord, but for small selfhosts, all that is required is enabling the intents in the developer portal.
+Yes, this is a new thing from Discord, as of October 2020. No, there's nothing we can do about it. Yes, we're aware it worked before.
+While waiting for your bot to be accepted, you can change the 'usePrivilegedIntents' inside your creds.yml to 'false', although this will break many of the nadeko's features");
+        }
+        else if (arg.Exception is not null)
             Log.Warning(arg.Exception, "{ErrorSource} | {ErrorMessage}", arg.Source, arg.Message);
         else
             Log.Warning("{ErrorSource} | {ErrorMessage}", arg.Source, arg.Message);

src/NadekoBot/Common/Creds.cs

@@ -14,12 +14,15 @@ public sealed class Creds : IBotCredentials
     [Comment(@"List of Ids of the users who have bot owner permissions
 **DO NOT ADD PEOPLE YOU DON'T TRUST**")]
     public ICollection<ulong> OwnerIds { get; set; }
+    
+    [Comment("Keep this on 'true' unless you're sure your bot shouldn't use privileged intents or you're waiting to be accepted")]
+    public bool UsePrivilegedIntents { get; set; }
 
     [Comment(@"The number of shards that the bot will running on.
 Leave at 1 if you don't know what you're doing.")]
     public int TotalShards { get; set; }
 
-    [Comment(
+    [Comment(   
         @"Login to https://console.cloud.google.com, create a new project, go to APIs & Services -> Library -> YouTube Data API and enable it.
 Then, go to APIs and Services -> Credentials and click Create credentials -> API key.
 Used only for Youtube Data Api (at the moment).")]
@@ -96,8 +99,9 @@ Windows default
 
     public Creds()
     {
-        Version = 3;
+        Version = 4;
         Token = string.Empty;
+        UsePrivilegedIntents = true;
         OwnerIds = new List<ulong>();
         TotalShards = 1;
         GoogleApiKey = string.Empty;

src/NadekoBot/Common/IBotCredentials.cs

@@ -6,6 +6,7 @@ public interface IBotCredentials
     string Token { get; }
     string GoogleApiKey { get; }
     ICollection<ulong> OwnerIds { get; }
+    bool UsePrivilegedIntents { get; }
     string RapidApiKey { get; }
 
     Creds.DbOptions Db { get; }

src/NadekoBot/Services/Impl/BotCredsProvider.cs

@@ -165,9 +165,9 @@ public sealed class BotCredsProvider : IBotCredsProvider
         if (File.Exists(CREDS_FILE_NAME))
         {
             var creds = Yaml.Deserializer.Deserialize<Creds>(File.ReadAllText(CREDS_FILE_NAME));
-            if (creds.Version <= 2)
+            if (creds.Version <= 3)
             {
-                creds.Version = 3;
+                creds.Version = 4;
                 File.WriteAllText(CREDS_FILE_NAME, Yaml.Serializer.Serialize(creds));
             }
         }

src/NadekoBot/Services/Impl/StatsService.cs

@@ -7,7 +7,7 @@ namespace NadekoBot.Services;
 
 public class StatsService : IStatsService, IReadyExecutor, INService, IDisposable
 {
-    public const string BOT_VERSION = "4.0.0";
+    public const string BOT_VERSION = "4.0.1";
 
     public string Author
         => "Kwoth#2452";

src/NadekoBot/creds_example.yml

@@ -1,10 +1,12 @@
 # DO NOT CHANGE
-version: 3
+version: 4
 # Bot token. Do not share with anyone ever -> https://discordapp.com/developers/applications/
 token: ''
 # List of Ids of the users who have bot owner permissions
 # **DO NOT ADD PEOPLE YOU DON'T TRUST**
 ownerIds: []
+# Keep this on 'true' unless you're sure your bot shouldn't use privileged intents or you're waiting to be accepted
+usePrivilegedIntents: true
 # The number of shards that the bot will running on.
 # Leave at 1 if you don't know what you're doing.
 totalShards: 1