From a93de6368b6da3b5d226a2f594b520fc98f08cbe Mon Sep 17 00:00:00 2001 From: vacer25 Date: Fri, 24 Apr 2020 18:35:59 -0400 Subject: [PATCH] Updated readme with whitelist role instrucions Incremented version to 1.3.0 --- README.md | 30 ++++++++++++++++++++---------- plugin.yml | 2 +- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index aaa6ed3..4815a3d 100755 --- a/README.md +++ b/README.md @@ -17,19 +17,29 @@ If you upgrade without knowing what you are doing. Registration will not work co - **limited-add group**: allows the user to whitelist a limited amount of times (recommended for users, default amount is 3) - limited-add group can be disabled in the config (enabled by default) -- removed list: - - this list removes the ability for limited-add users to add back users that have been removed by the add-remove group - - can be disabled in the config (enabled by default) +- Removed list: + - This list removes the ability for limited-add users to add back users that have been removed by the add-remove group + - Can be disabled in the config (enabled by default) -- use '!whitelist add "minecraftUsername"' in a valid channel to whitelist people on your minecraft server -- use '!whitelist remove "minecraftUsername"' in a valid channel to remove people from the whitelist on your minecraft server -- use '!whitelist' in a valid channel to get info about the bot and how to use it +- Discord commands: + - Use `!whitelist add "minecraftUsername"` in a valid channel to whitelist people on your minecraft server + - Use `!whitelist remove "minecraftUsername"` in a valid channel to remove people from the whitelist on your minecraft server + - Use `!whitelist` in a valid channel to get info about the bot and how to use it -- only select Discord roles can whitelist through the bot -- bot only listens for messages in select text channels -- logs whitelist attempts from valid roles in the console +- Automatically add/remove a role when adding/removing to/from the whitelist + - This feature is meant to be used when users can add themselves to the whitelist. + - If `whitelisted-role-auto-add` is set to true (false by default), the Discord role with the name defined by `whitelisted-role` ("Whitelisted" by default) will be added to that user when they successfully add (themselves) to the whitelist. + - If `whitelisted-role-auto-remove` is set to true (false by default), that role will be removed from that user when they successfully remove (themselves) from the whitelist. + - This requires: + - The bot to have the `Manage Roles` permission in Discord + - Setting up a Discord role with the same name (case sensitive) as the config + - The bot's role must be higher than the whitelist role + +- Only select Discord roles can whitelist through the bot +- Bot only listens for messages in select text channels +- Logs whitelist attempts from valid roles in the console ### Set Up: -Config file is located at: (server-root)/plugins/DiscordWhitelister - this needs a valid bot token and valid channel ids to work. +Config file is located at: (server-root)/plugins/DiscordWhitelister - this needs a valid bot token and valid channel id(s) to work. To create a Discord application and/or find your discord bot token, follow this link: https://discordapp.com/developers/applications/ diff --git a/plugin.yml b/plugin.yml index 13a10b7..7ac02b1 100755 --- a/plugin.yml +++ b/plugin.yml @@ -1,5 +1,5 @@ name: DiscordWhitelister -version: 1.2.0 +version: 1.3.0 author: Joe Shimell main: uk.co.angrybee.joe.DiscordWhitelister description: Discord whitelister bot.