🍊OrangeWhitelist

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

Plugin Name: OrangeWhitelist Current Version: 3.3 Originally Developed By: DragonStudio Maintained By: FruitForge Last Updated: March 31, 2025

Welcome to the official documentation for OrangeWhitelist, a simple yet powerful Minecraft whitelist plugin with optional Discord integration. Whether you're securing your server with a whitelist or managing access via Discord, this plugin has you covered with flexible configuration and straightforward commands.

---

Table of Contents

1. Overview

2. Features

3. Installation

4. Configuration

   • Plugin Config

   • Kick-Ban Hooks

   • Messages

   • Permissions

   • Whitelist

   • Discord Bot Config

5. Commands

6. Permissions

7. Discord Integration

8. Support

---

Overview

OrangeWhitelist is a lightweight plugin designed to manage server access through a whitelist system. It supports two modes for handling non-whitelisted players (kick or ban) and integrates with Discord for enhanced management. Originally crafted by DragonStudio, it’s now proudly maintained by FruitForge.

---

Features

• Flexible Whitelist: Enable or disable the whitelist with ease.

• Kick or Ban Modes: Choose how to handle non-whitelisted players.

• Customizable Messages: Tailor all player-facing messages.

• Hook Support: Works with internal hooks or LiteBans for bans.

• Discord Integration: Manage your whitelist via a Discord bot (optional).

• Simple Commands: Easy-to-use commands for admins.

• Permission System: Fine-tuned control over who can manage the plugin.

---

Installation

1. Download the latest version of OrangeWhitelist from SpigotMC or your preferred plugin source.
2. Place the .jar file in your server’s plugins folder.

3. Restart your server to generate the default Settings.yml.

4. Configure the plugin as needed (see Configuration).

5. Reload the plugin with /orangewl reload or restart the server.

---

Configuration

The configuration file (Settings.yml) is the heart of OrangeWhitelist. Below is a breakdown of each section with examples based on the default settings.

Config Header

# Version of the configuration file / plugin, do not
# modify this file or you will disrupt the
# version and a new file will be created.
Config-Version: 3.0
Plugin-Version: 3.3

Note: Do not manually edit Config-Version or Plugin-Version. Changing these may cause the plugin to reset the file.

---

Plugin Config

Plugin-Config:
  Enabled-Whitelist: true
  Mode: KICK # Options: KICK - BAN

• Enabled-Whitelist: Toggle the whitelist on (true) or off (false).

• Mode: Action for non-whitelisted players:

  • KICK: Kicks the player with a custom message.

  • BAN: Bans the player (requires a compatible hook).

---

Kick-Ban Hooks

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

• Hook: Method to enforce kicks or bans:

  • PLUGIN: Uses the plugin’s internal system.

  • LiteBans: Integrates with LiteBans (falls back to PLUGIN if LiteBans isn’t installed).

• Kick-Message: Shown to kicked players.

• Ban-Message: Shown to banned players.

---

Messages

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 to the whitelist'
  No-Whitelisted-Player: '<red>This player does not exist or was no longer on the Whitelist'
  Already-Whitelisted: '<green>The player is already 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>|-------------------------------------|

• Prefix: Prepends all plugin messages.

• Kick-Message: Multi-line message shown to kicked players (overrides the one in Kick-Ban-Hooks if set).

• Placeholders: %player% is replaced with the target player’s name.

Tip: Use Minecraft color codes (e.g., <red>, <green>) for formatting.

---

Permissions

Permissions:
  Enable-Disable: orangewhitelist.set
  Add-Remove: orangewhitelist.manage
  Reload: orangewhitelist.reload
  ALL: dragonwhitelist.admin

• Define permissions for each action (see Permissions for details).

---

Whitelist

Whitelist:
  - Notch
  - TeoremalDev

• List of players allowed to join when Enabled-Whitelist is true.

• Add or remove players via commands or manually here.

---

Discord Bot Config

Discord-Bot:
  Enabled: false
  Token: "YOUR_DISCORD_BOT_TOKEN_HERE"
  Application-ID: "YOUR_APPLICATION_ID_HERE"
  Language: English  # Options: English, Español, Français, 中文

• Enabled: Toggle Discord bot integration.

• Token: Your Discord bot token (keep this secret!).

• Application-ID: Your bot’s application ID.

• Language: Bot response language.

Note: Discord integration requires additional setup (see Discord Integration).

---

Commands

Command	Description	Permission
/orangewl on	Enables the whitelist	orangewhitelist.set
/orangewl off	Disables the whitelist	orangewhitelist.set
/orangewl add <player>	Adds a player to the whitelist	orangewhitelist.manage
/orangewl remove <player>	Removes a player from the whitelist	orangewhitelist.manage
/orangewl reload	Reloads the plugin configuration	orangewhitelist.reload

Alias: /orangewl can be shortened to /owl.

---

Permissions

Permission	Description
orangewhitelist.set	Enable or disable the whitelist
orangewhitelist.manage	Add or remove players from the whitelist
orangewhitelist.reload	Reload the plugin configuration
orangewhitelist.admin	Grants all permissions (legacy)

---

Discord Integration

OrangeWhitelist supports a Discord bot for managing the whitelist remotely. To set it up:

1. Create a Discord bot via the Discord Developer Portal.
2. Invite the bot to your server with appropriate permissions.

3. Update Discord-Bot in Settings.yml with your Token and Application-ID.

4. Set Enabled to true and reload the plugin.

Bot Commands

• TBD: Specific Discord commands depend on implementation (e.g., /whitelist add <player>). Check FruitForge’s website for updates.

---

Support

Need help? Join our community:

• Discord: fruitforge.com/discord

Report bugs or suggest features via Discord or our issue tracker.

---