/TwitchWhitelist

Whitelist Player on Minecraft Server via Twitch Channel Points ✅

Primary LanguageKotlinApache License 2.0Apache-2.0

CodeFactor

TwitchWhitelist

This is a customisable 1.8-1.19 Spigot Plugin to Whitelist Players via Twitch Channel Points Rewards.

Setup

  1. Setup a PaperMC (recommended) or SpigotMC Minecraft Server like here
  2. Download the latest Release File
  3. Put the downloaded TwitchWhitelist.jar into the /plugins/ folder of the created PaperMC Server
  4. Start the Server via your Start Script (start.bat or start.sh)
  5. After the Server finished starting, stop it (Type stop in Console)
  6. Navigate in your /plugin/ folder and then in the /TwitchWhitelist/ folder
  7. Open the config.yml File set it up for your needs (You must set the token and channelID => See Further Information)
  8. Start the Server again and everything should work, have fun :)

Channel Reward Setup

In Order the Bot listens to the right Channel Points Reward, be sure to setup a Channel Points Reward and put the Name of the Reward in the config.yml under chanelRewardName.

Be sure to enable the Option Require Viewer to Enter Text in the Channel Points Reward Edit Menu.

One Example: Name of the Channel Points Reward would be Minecraft Whitelist Ticket.

Whitelist Command

Permission: whitelist.cmd

Commands

whitelist on — Enable the Whitelist on your Server
whitelist off — Disable the Whitelist on your Server
whitelist list — Get an overview over all Whitelisted Players
whitelist add playerName — Add a Player to the Whitelist manually by the Minecraft Player Name
whitelist remove playerName — Remove a Player from the Whitelist by the Minecraft Player Name

Further Information

You can use either a second Twitch Account or your own Twitch Account for the token. You can get your Bot Chat Token => Access Token here.

The channelID is the ID of your Twitch Account, get it here.

This Plugin works with a Custom Whitelist, so Vanila Whitelist must be turned off with whitelist off in Console.

If you need further help, feel free to open a new Issue. In case you like my project, please give this Repository a ⭐.