Update README.md

This commit is contained in:
JoeShimo 2019-08-01 15:31:04 +01:00 committed by GitHub
parent d16122cdce
commit 9a7db26b5b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1 +1,12 @@
# DiscordWhitelisterBot-Spigot
A simple spigot plugin which allows whitelisting through a discord text channel.
Features:
- use '!whitelist MinecraftUsername' in a valid channel to whitelist people on your minecraft server
- 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
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/