🍊OrangeWhitelist

Welcome to the official documentation for OrangeWhitelist! Here you'll find everything you need to know to configure and use the plugin effectively.

About OrangeWhitelist

OrangeWhitelist is a highly secure, sophisticated, and fully customizable whitelist plugin designed to protect your server. Whether your server is under maintenance or private, this plugin ensures only authorized players can join. It supports bans and kicks for non-whitelisted players and integrates with LiteBans for enhanced moderation.

---

How to Configure OrangeWhitelist

The plugin features a straightforward configuration system, allowing server administrators to customize whitelist behavior, punishment methods, and messages.

Settings.yml File

Below is a breakdown of the configuration file and how to modify it according to your needs:

# Version of the configuration file, do not modify these settings.
Config-Version: 3.0
Plugin-Version: 3.1

###############################
##      Plugin Config        ##
###############################
Plugin-Config:
  Enabled-Whitelist: true  # Enable or disable the whitelist feature.
  Mode: KICK  # Options: KICK or BAN

• Enabled-Whitelist: Enables or disables the whitelist system.

• Mode: Determines how non-whitelisted players are handled (KICK or BAN).

---

Enforcement Methods

OrangeWhitelist provides multiple enforcement mechanisms:

Kick & Ban Hooks:

Kick-Ban-Hooks:
  Hook: PLUGIN  # Options: PLUGIN, LiteBans
  Kick-Message: 'You are not in the Whitelist of this server'
  Ban-Message: 'You are not in the Whitelist of this server!!!'

• PLUGIN: Uses the internal ban/kick system.

• LiteBans: Integrates with LiteBans for banning via console command.

• Messages: Customizable kick/ban messages.

---

Permissions System

Plugin Permissions:

• dragonwhitelist.set – Allows enabling or disabling the whitelist.

• dragonwhitelist.manage – Grants permission to add or remove players.

• dragonwhitelist.reload – Allows reloading the plugin.

• dragonwhitelist.admin – Grants access to all plugin commands.

---

Commands and Usage

General Commands:

• /orangewhl enable – Enables the Whitelist.

• /orangewhl disable – Disables the Whitelist.

• /orangewhl add <PLAYER> – Adds a player to the Whitelist.

• /orangewhl remove <PLAYER> – Removes a player from the Whitelist.

• /orangewhl reload – Reloads the plugin configuration.

Example Usage:

/orangewhl enable
/orangewhl add Notch
/orangewhl remove Steve

---

Customizing Messages

OrangeWhitelist allows complete message customization using MiniMessage format.

Messages:
  Prefix: '<aqua>Fruit<white>Forge <dark_gray><bold>» <reset>'
  No-Perms: '<red>You dont have permission to do that'
  No-Args: '<red>Command is missing arguments'
  Reload: '<green>Plugin ready!'
  W-ON: '<green>The whitelist has been activated'
  W-OFF: '<red>The whitelist has been deactivated'
  Added: '<green>The user %player% was added to the whitelist'
  Removed: '<red>The user %player% was removed from the whitelist'
  No-Whitelisted-Player: '<red>This player does not exist or was no longer on the Whitelist'
  Kick-Message: |
    <dark_gray>|-------------------------------------|
    <aqua>Fruit<white>Forge <yellow>Studios
    <red>You are not on the server Whitelist!</red>
    <dark_purple>Discord: https://fruitforge.com/discord</dark_purple>
    <dark_gray>|-------------------------------------|

---

Whitelist Management

The plugin allows defining a pre-configured whitelist in the configuration file:

Whitelist:
  - Notch
  - TeoremalDev

• Manually pre-add players in the Whitelist section.

• Use commands to dynamically add/remove players.

---

Features

✅ Robust Whitelist System – Ensures only whitelisted players can join. ✅ Case-Insensitive Names – Prevents name spoofing. ✅ Supports Bedrock Players – Compatible with GeyserMC. ✅ Fully Customizable – Modify messages and behaviors. ✅ LiteBans Integration – Use external banning systems. ✅ Future Updates – Planned support for Bungee, Velocity, and more!

---

Future Implementations

🔹 BungeeCord & Velocity Support – Cross-server whitelist enforcement. 🔹 Essentials & AdvancedBans Hook – Additional banning/kicking integration. 🔹 LibertyBans Support – Compatibility with alternative ban plugins.

---

Why Choose OrangeWhitelist?

OrangeWhitelist is designed for security, flexibility, and ease of use. Whether you run a private server or need temporary access control, this plugin provides powerful and reliable whitelist enforcement.

For additional support, visit our FruitForge Studios Discord. Thank you for choosing OrangeWhitelist!