Upstream/DiscordWhitelisterSpigot
1
0
Fork 0
mirror of https://github.com/Shimeo98/DiscordWhitelisterSpigot.git synced 2024-12-01 07:03:36 +01:00
Code Issues Projects Releases Wiki Activity
Spigot plugin that allows whitelisting users through a discord text channel.
35 Commits 1 Branch 30 Tags 397 KiB
Java 100%
847273bf48
Go to file
vacer25 847273bf48 Added option to add/remove a role to users after whitelisting. 
This feature is meant to be used when users have the ability to whitelist themselves (limited-add-roles).
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 when the user successfully adds to the whitelist.
If whitelisted-role-auto-remove is set to true (false by default), that role will be removed when the user successfully removes from the whitelist.
2020-04-24 17:40:36 -04:00
src/main/java/uk/co/angrybee/joe Added option to add/remove a role to users after whitelisting. 2020-04-24 17:40:36 -04:00
.gitignore Split allowed to use role into 2 roles 2019-10-29 15:19:43 +00:00
plugin.yml added info/version command, unlist users on guild leave. version bump to 1.2 not compatible with lower versions! 2020-04-14 17:45:34 +02:00
pom.xml Removed JDA warning messages, Actually error out when bot fails to initialize, Update / Add entries to config without user input 2019-11-04 13:45:53 +00:00
README.md added info/version command, unlist users on guild leave. version bump to 1.2 not compatible with lower versions! 2020-04-14 17:45:34 +02:00

README.md

Discord Whitelister Bot for Spigot

A simple spigot plugin which allows whitelisting through a discord text channel. This provides an easy way for users to whitelist without needing to be on the minecraft server.

Backwards compatibility

Version 1.2.0 and greater are not compatible with version 1.1.x and lower. The layout of the internal user-list.yml got updated. You need to remove it manually and let the plugin on v1.2.x create a new one. If you upgrade without knowing what you are doing. Registration will not work correctly.

Features:

  • 3 separate role groups:

    • add-remove group: allows the user to add and remove users from the whitelist an unlimited amount of times (recommended for owners and admins)
    • add group: allows the user to add to the whitelist an unlimited amount of times (recommended for moderators)
    • 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)

  • 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

Set Up:

Config file is located at: (server-root)/plugins/DiscordWhitelister - this needs a valid bot token and valid channel ids to work. To create a Discord application and/or find your discord bot token, follow this link: https://discordapp.com/developers/applications/