diff --git a/NadekoBot/Modules/Administration/AdministrationModule.cs b/NadekoBot/Modules/Administration/AdministrationModule.cs index 670d2513..2ea33354 100644 --- a/NadekoBot/Modules/Administration/AdministrationModule.cs +++ b/NadekoBot/Modules/Administration/AdministrationModule.cs @@ -815,7 +815,7 @@ namespace NadekoBot.Modules.Administration }); cgb.CreateCommand(Prefix + "donators") - .Description("List of lovely people who donated to keep this project alive.") + .Description("List of lovely people who donated to keep this project alive. | `{Prefix}donators`") .Do(async e => { await Task.Run(async () => diff --git a/NadekoBot/Modules/Administration/Commands/SelfAssignedRolesCommand.cs b/NadekoBot/Modules/Administration/Commands/SelfAssignedRolesCommand.cs index b8c27f1a..f88957bd 100644 --- a/NadekoBot/Modules/Administration/Commands/SelfAssignedRolesCommand.cs +++ b/NadekoBot/Modules/Administration/Commands/SelfAssignedRolesCommand.cs @@ -112,7 +112,7 @@ namespace NadekoBot.Modules.Administration.Commands cgb.CreateCommand(Module.Prefix + "iam") .Description("Adds a role to you that you choose. " + "Role must be on a list of self-assignable roles." + - $" | {Prefix}iam Gamer") + $" | `{Prefix}iam Gamer`") .Parameter("role", ParameterType.Unparsed) .Do(async e => { @@ -168,7 +168,7 @@ namespace NadekoBot.Modules.Administration.Commands .Alias(Module.Prefix + "iamn") .Description("Removes a role to you that you choose. " + "Role must be on a list of self-assignable roles." + - $" | {Prefix}iamn Gamer") + $" | `{Prefix}iamn Gamer`") .Parameter("role", ParameterType.Unparsed) .Do(async e => { diff --git a/NadekoBot/Modules/ClashOfClans/ClashOfClansModule.cs b/NadekoBot/Modules/ClashOfClans/ClashOfClansModule.cs index 37443900..449c4da6 100644 --- a/NadekoBot/Modules/ClashOfClans/ClashOfClansModule.cs +++ b/NadekoBot/Modules/ClashOfClans/ClashOfClansModule.cs @@ -148,7 +148,7 @@ namespace NadekoBot.Modules.ClashOfClans cgb.CreateCommand(Prefix + "createwar") .Alias(Prefix + "cw") - .Description($"Creates a new war by specifying a size (>10 and multiple of 5) and enemy clan name. |{Prefix}cw 15 The Enemy Clan") + .Description($"Creates a new war by specifying a size (>10 and multiple of 5) and enemy clan name. | `{Prefix}cw 15 The Enemy Clan`") .Parameter("size") .Parameter("enemy_clan", ParameterType.Unparsed) .Do(async e => @@ -186,7 +186,7 @@ namespace NadekoBot.Modules.ClashOfClans cgb.CreateCommand(Prefix + "startwar") .Alias(Prefix + "sw") - .Description("Starts a war with a given number.") + .Description("Starts a war with a given number. | `{Prefix}sw 15`") .Parameter("number", ParameterType.Required) .Do(async e => { @@ -211,7 +211,7 @@ namespace NadekoBot.Modules.ClashOfClans cgb.CreateCommand(Prefix + "listwar") .Alias(Prefix + "lw") - .Description($"Shows the active war claims by a number. Shows all wars in a short way if no number is specified. | {Prefix}lw [war_number] or {Prefix}lw") + .Description($"Shows the active war claims by a number. Shows all wars in a short way if no number is specified. | `{Prefix}lw [war_number] or {Prefix}lw`") .Parameter("number", ParameterType.Optional) .Do(async e => { @@ -253,7 +253,7 @@ namespace NadekoBot.Modules.ClashOfClans cgb.CreateCommand(Prefix + "claim") .Alias(Prefix + "call") .Alias(Prefix + "c") - .Description($"Claims a certain base from a certain war. You can supply a name in the third optional argument to claim in someone else's place. | {Prefix}call [war_number] [base_number] [optional_other_name]") + .Description($"Claims a certain base from a certain war. You can supply a name in the third optional argument to claim in someone else's place. | `{Prefix}call [war_number] [base_number] [optional_other_name]`") .Parameter("number") .Parameter("baseNumber") .Parameter("other_name", ParameterType.Unparsed) @@ -292,21 +292,21 @@ namespace NadekoBot.Modules.ClashOfClans .Alias(Prefix + "cf") .Alias(Prefix + "cf3") .Alias(Prefix + "claimfinish3") - .Description($"Finish your claim with 3 stars if you destroyed a base. Optional second argument finishes for someone else. | {Prefix}cf [war_number] [optional_other_name]") + .Description($"Finish your claim with 3 stars if you destroyed a base. Optional second argument finishes for someone else. | `{Prefix}cf [war_number] [optional_other_name]`") .Parameter("number", ParameterType.Required) .Parameter("other_name", ParameterType.Unparsed) .Do(e => FinishClaim(e)); cgb.CreateCommand(Prefix + "claimfinish2") .Alias(Prefix + "cf2") - .Description($"Finish your claim with 2 stars if you destroyed a base. Optional second argument finishes for someone else. | {Prefix}cf [war_number] [optional_other_name]") + .Description($"Finish your claim with 2 stars if you destroyed a base. Optional second argument finishes for someone else. | `{Prefix}cf [war_number] [optional_other_name]`") .Parameter("number", ParameterType.Required) .Parameter("other_name", ParameterType.Unparsed) .Do(e => FinishClaim(e, 2)); cgb.CreateCommand(Prefix + "claimfinish1") .Alias(Prefix + "cf1") - .Description($"Finish your claim with 1 stars if you destroyed a base. Optional second argument finishes for someone else. | {Prefix}cf [war_number] [optional_other_name]") + .Description($"Finish your claim with 1 stars if you destroyed a base. Optional second argument finishes for someone else. | `{Prefix}cf [war_number] [optional_other_name]`") .Parameter("number", ParameterType.Required) .Parameter("other_name", ParameterType.Unparsed) .Do(e => FinishClaim(e, 1)); @@ -314,7 +314,7 @@ namespace NadekoBot.Modules.ClashOfClans cgb.CreateCommand(Prefix + "unclaim") .Alias(Prefix + "uncall") .Alias(Prefix + "uc") - .Description($"Removes your claim from a certain war. Optional second argument denotes a person in whose place to unclaim | {Prefix}uc [war_number] [optional_other_name]") + .Description($"Removes your claim from a certain war. Optional second argument denotes a person in whose place to unclaim | `{Prefix}uc [war_number] [optional_other_name]`") .Parameter("number", ParameterType.Required) .Parameter("other_name", ParameterType.Unparsed) .Do(async e => @@ -344,7 +344,7 @@ namespace NadekoBot.Modules.ClashOfClans cgb.CreateCommand(Prefix + "endwar") .Alias(Prefix + "ew") - .Description($"Ends the war with a given index. |{Prefix}ew [war_number]") + .Description($"Ends the war with a given index. | `{Prefix}ew [war_number]`") .Parameter("number") .Do(async e => { diff --git a/NadekoBot/Modules/Conversations/Commands/RipCommand.cs b/NadekoBot/Modules/Conversations/Commands/RipCommand.cs index f6960e5f..9c4842bf 100644 --- a/NadekoBot/Modules/Conversations/Commands/RipCommand.cs +++ b/NadekoBot/Modules/Conversations/Commands/RipCommand.cs @@ -23,7 +23,7 @@ namespace NadekoBot.Modules.Conversations.Commands internal override void Init(CommandGroupBuilder cgb) { cgb.CreateCommand("rip") - .Description("Shows a grave image of someone with a start year | @NadekoBot rip @Someone 2000") + .Description("Shows a grave image of someone with a start year | `@NadekoBot rip @Someone 2000`") .Parameter("user", ParameterType.Required) .Parameter("year", ParameterType.Optional) .Do(async e => diff --git a/NadekoBot/Modules/CustomReactions/CustomReactions.cs b/NadekoBot/Modules/CustomReactions/CustomReactions.cs index a613b6c5..b62b2dd7 100644 --- a/NadekoBot/Modules/CustomReactions/CustomReactions.cs +++ b/NadekoBot/Modules/CustomReactions/CustomReactions.cs @@ -50,7 +50,7 @@ namespace NadekoBot.Modules.CustomReactions var c = cgb.CreateCommand(commandName); if (commandName.Contains(NadekoBot.BotMention)) c.Alias(commandName.Replace("<@", "<@!")); - c.Description($"Custom reaction. |{command.Key}") + c.Description($"Custom reaction. | `{command.Key}`") .Parameter("args", ParameterType.Unparsed) .Do(async e => { @@ -64,4 +64,4 @@ namespace NadekoBot.Modules.CustomReactions }); } } -} \ No newline at end of file +} diff --git a/NadekoBot/Modules/Gambling/GamblingModule.cs b/NadekoBot/Modules/Gambling/GamblingModule.cs index efa3a553..d7ced224 100644 --- a/NadekoBot/Modules/Gambling/GamblingModule.cs +++ b/NadekoBot/Modules/Gambling/GamblingModule.cs @@ -187,7 +187,7 @@ namespace NadekoBot.Modules.Gambling cgb.CreateCommand(Prefix + "leaderboard") .Alias(Prefix + "lb") - .Description($"Displays bot currency leaderboard | {Prefix}lb") + .Description($"Displays bot currency leaderboard | `{Prefix}lb`") .Do(async e => { var richestTemp = DbHandler.Instance.GetTopRichest(); diff --git a/NadekoBot/Modules/Music/MusicModule.cs b/NadekoBot/Modules/Music/MusicModule.cs index eaf290ba..e0045ab9 100644 --- a/NadekoBot/Modules/Music/MusicModule.cs +++ b/NadekoBot/Modules/Music/MusicModule.cs @@ -756,7 +756,7 @@ namespace NadekoBot.Modules.Music cgb.CreateCommand(Prefix + "getlink") .Alias(Prefix + "gl") - .Description("Shows a link to the song in the queue by index, or the currently playing song by default.") + .Description("Shows a link to the song in the queue by index, or the currently playing song by default. | `{Prefix}gl`") .Parameter("index", ParameterType.Optional) .Do(async e => { @@ -791,7 +791,7 @@ namespace NadekoBot.Modules.Music cgb.CreateCommand(Prefix + "autoplay") .Alias(Prefix + "ap") - .Description("Toggles autoplay - When the song is finished, automatically queue a related youtube song. (Works only for youtube songs and when queue is empty)") + .Description("Toggles autoplay - When the song is finished, automatically queue a related youtube song. (Works only for youtube songs and when queue is empty) | `{Prefix}ap`") .Do(async e => { diff --git a/NadekoBot/Modules/Permissions/Commands/FilterInvitesCommand.cs b/NadekoBot/Modules/Permissions/Commands/FilterInvitesCommand.cs index d26a9aca..445558c3 100644 --- a/NadekoBot/Modules/Permissions/Commands/FilterInvitesCommand.cs +++ b/NadekoBot/Modules/Permissions/Commands/FilterInvitesCommand.cs @@ -55,7 +55,7 @@ namespace NadekoBot.Modules.Permissions.Commands .Alias(Module.Prefix + "cfi") .Description("Enables or disables automatic deleting of invites on the channel." + "If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once." + - $" | {Prefix}cfi enable #general-chat") + $" | `{Prefix}cfi enable #general-chat`") .Parameter("bool") .Parameter("channel", ParameterType.Optional) .Do(async e => @@ -95,7 +95,7 @@ namespace NadekoBot.Modules.Permissions.Commands cgb.CreateCommand(Module.Prefix + "srvrfilterinv") .Alias(Module.Prefix + "sfi") - .Description($"Enables or disables automatic deleting of invites on the server. | {Prefix}sfi disable") + .Description($"Enables or disables automatic deleting of invites on the server. | `{Prefix}sfi disable`") .Parameter("bool") .Do(async e => { diff --git a/NadekoBot/Modules/Permissions/Commands/FilterWordsCommand.cs b/NadekoBot/Modules/Permissions/Commands/FilterWordsCommand.cs index 33fd1ac4..b574ef23 100644 --- a/NadekoBot/Modules/Permissions/Commands/FilterWordsCommand.cs +++ b/NadekoBot/Modules/Permissions/Commands/FilterWordsCommand.cs @@ -53,7 +53,7 @@ namespace NadekoBot.Modules.Permissions.Commands .Alias(Module.Prefix + "cfw") .Description("Enables or disables automatic deleting of messages containing banned words on the channel." + "If no channel supplied, it will default to current one. Use ALL to apply to all existing channels at once." + - $" | {Prefix}cfw enable #general-chat") + $" | `{Prefix}cfw enable #general-chat`") .Parameter("bool") .Parameter("channel", ParameterType.Optional) .Do(async e => @@ -89,7 +89,7 @@ namespace NadekoBot.Modules.Permissions.Commands cgb.CreateCommand(Module.Prefix + "addfilterword") .Alias(Module.Prefix + "afw") .Description("Adds a new word to the list of filtered words" + - $" | {Prefix}afw poop") + $" | `{Prefix}afw poop`") .Parameter("word", ParameterType.Unparsed) .Do(async e => { @@ -111,7 +111,7 @@ namespace NadekoBot.Modules.Permissions.Commands cgb.CreateCommand(Module.Prefix + "rmvfilterword") .Alias(Module.Prefix + "rfw") .Description("Removes the word from the list of filtered words" + - $" | {Prefix}rw poop") + $" | `{Prefix}rw poop`") .Parameter("word", ParameterType.Unparsed) .Do(async e => { @@ -133,7 +133,7 @@ namespace NadekoBot.Modules.Permissions.Commands cgb.CreateCommand(Module.Prefix + "lstfilterwords") .Alias(Module.Prefix + "lfw") .Description("Shows a list of filtered words" + - $" | {Prefix}lfw") + $" | `{Prefix}lfw`") .Do(async e => { try @@ -152,7 +152,7 @@ namespace NadekoBot.Modules.Permissions.Commands cgb.CreateCommand(Module.Prefix + "srvrfilterwords") .Alias(Module.Prefix + "sfw") - .Description($"Enables or disables automatic deleting of messages containing forbidden words on the server. | {Prefix}sfw disable") + .Description($"Enables or disables automatic deleting of messages containing forbidden words on the server. | `{Prefix}sfw disable`") .Parameter("bool") .Do(async e => { diff --git a/NadekoBot/Modules/Permissions/PermissionsModule.cs b/NadekoBot/Modules/Permissions/PermissionsModule.cs index a201f848..d2bc1840 100644 --- a/NadekoBot/Modules/Permissions/PermissionsModule.cs +++ b/NadekoBot/Modules/Permissions/PermissionsModule.cs @@ -813,7 +813,7 @@ namespace NadekoBot.Modules.Permissions cgb.CreateCommand(Prefix + "allcmdcooldowns") .Alias(Prefix + "acmdcds") - .Description("Shows a list of all commands and their respective cooldowns.") + .Description("Shows a list of all commands and their respective cooldowns. | `{Prefix}acmdcds`") .Do(async e => { ServerPermissions perms; diff --git a/NadekoBot/Modules/Searches/SearchesModule.cs b/NadekoBot/Modules/Searches/SearchesModule.cs index 84d0c0a1..c484fabf 100644 --- a/NadekoBot/Modules/Searches/SearchesModule.cs +++ b/NadekoBot/Modules/Searches/SearchesModule.cs @@ -149,7 +149,7 @@ $@"🌍 **Weather for** 【{obj["target"]}】 cgb.CreateCommand(Prefix + "randomcat") .Alias(Prefix + "meow") - .Description("Shows a random cat image.") + .Description("Shows a random cat image. | `{Prefix}meow`") .Do(async e => { await e.Channel.SendMessage(JObject.Parse( @@ -159,7 +159,7 @@ $@"🌍 **Weather for** 【{obj["target"]}】 cgb.CreateCommand(Prefix + "randomdog") .Alias(Prefix + "woof") - .Description("Shows a random dog image.") + .Description("Shows a random dog image. | `{Prefix}woof`") .Do(async e => { await e.Channel.SendMessage("http://random.dog/" + await SearchHelper.GetResponseStringAsync("http://random.dog/woof").ConfigureAwait(false)).ConfigureAwait(false); diff --git a/NadekoBot/Modules/Trello/TrelloModule.cs b/NadekoBot/Modules/Trello/TrelloModule.cs index 14938aca..527a2ed5 100644 --- a/NadekoBot/Modules/Trello/TrelloModule.cs +++ b/NadekoBot/Modules/Trello/TrelloModule.cs @@ -106,7 +106,7 @@ namespace NadekoBot.Modules.Trello cgb.CreateCommand(Prefix + "lists") .Alias(Prefix + "list") - .Description($"Lists all lists yo ;) | {Prefix}list") + .Description($"Lists all lists, yo ;) | `{Prefix}list`") .Do(async e => { if (!NadekoBot.IsOwner(e.User.Id)) return; diff --git a/README.md b/README.md index 4992761a..7f57978b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ ![img](https://ci.appveyor.com/api/projects/status/gmu6b3ltc80hr3k9?svg=true) [![Discord](https://discordapp.com/api/servers/117523346618318850/widget.png)](https://discord.gg/0ehQwTK2RBjAxzEY) +[![Documentation Status](https://readthedocs.org/projects/nadekobot/badge/?version=latest)](http://nadekobot.readthedocs.io/en/latest/?badge=latest) # NadekoBot -## [Click here to invite nadeko to your discord server](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303) +## [Click here to invite Nadeko to your Discord server](https://discordapp.com/oauth2/authorize?client_id=170254782546575360&scope=bot&permissions=66186303) ## [Click here for a list of commands](https://github.com/Kwoth/NadekoBot/blob/master/commandlist.md) ## INSTRUCTIONS, FAQ ---> [Wiki](https://github.com/Kwoth/NadekoBot/wiki)