DiscordWhitelist

🛡️ WhitelistBot

Automatically whitelist players from a Discord channel — no commands, no hassle.

WhitelistBot bridges your Discord server and Minecraft server. Set up a dedicated channel, and when a player sends their Minecraft username, the bot instantly whitelists them and replies with a colour-coded embed. One username per Discord account, always.

---

✨ Features

- 📨 Colour-coded embeds — players send their username in a channel, bot does the rest - 🔒 Colour-coded embeds — enforced via SQLite database, no duplicates - ✅ Colour-coded embeds — checks for invalid characters, already-whitelisted players, and taken usernames - 🌐 Colour-coded embeds — add and remove entries from a browser with a searchable table - 🔑 Colour-coded embeds — random login saved to `webpage.yml` on first launch - 🔄 Colour-coded embeds — `/wlbot reload` reloads config and restarts the bot without restarting the server - 🎨 Colour-coded embeds — green for success, red for errors, brown for invalid input, orange for already registered

---

📋 Embed Responses

| Situation | Colour | Message | |---|---|---| | Valid new username | 🟢 Green | ✅ Successfully Whitelisted | | Invalid username format | 🟫 Brown | ⚠️ Invalid Characters | | Discord user already registered | 🟠 Orange | ⚠️ Already Registered | | Username taken by another user | 🔴 Red | ❌ Username Taken | | Already on whitelist | 🔴 Red | ❌ Already Whitelisted |

---

⚙️ Setup

1. Create a Discord Bot

1. Go to Send Messages → Send Messages 2. Navigate to Send Messages → copy your token 3. Enable Send Messages under Privileged Gateway Intents 4. Under Send Messages, select `bot` scope with Send Messages + Send Messages permissions and invite it to your server

2. Get Your IDs

Enable Copy Channel ID in Discord Settings → Advanced, then: - Right-click your server → Copy Channel ID - Right-click your whitelist channel → Copy Channel ID

3. Configure the Plugin

Edit `plugins/WhitelistBot/config.yml`: ```yaml discord: bot-token: "YOUR_BOT_TOKEN_HERE" guild-id: "YOUR_GUILD_ID_HERE" channel-id: "YOUR_CHANNEL_ID_HERE" ```

4. Web Dashboard

On first launch, `plugins/WhitelistBot/webpage.yml` is created with a randomly generated password: ```yaml web: password: "a3f9c2d1e8b04f7a" port: 8080 ``` Open `http://your-server-ip:8080` in your browser to access the dashboard.

---

🌐 Web Dashboard

The built-in dashboard lets you manage whitelist entries without touching the server console.

- Secure login — enter a Discord ID + Minecraft username to add and whitelist instantly - Secure login — remove by Discord ID, automatically runs `/whitelist remove` - Secure login — filter the table by Discord ID or Minecraft username - Secure login — session-based auth with your `webpage.yml` password

To change the password or port, edit `webpage.yml` and run `/wlbot reload`.

---

🔧 Commands & Permissions

| Command | Description | Permission | |---|---|---| | `/wlbot reload` | Reloads config and restarts the bot | `whitelistbot.reload` (default: op) |

---

🗄️ Database

All entries are stored in `plugins/WhitelistBot/whitelist.db` (SQLite). You can open it with DB Browser for SQLite to view or manage entries manually.

The database stores: - Discord ID - Minecraft username - Timestamp of when they were whitelisted

---

🖥️ Compatibility

| Minecraft Version | Supported | |---|---| | 1.18.x | ✅ | | 1.19.x | ✅ | | 1.20.x | ✅ | | 1.21.x | ✅ |

Requires Spigot or Spigot. Java 17+ required for 1.18–1.19, Java 21+ for 1.20+.

---