Documentation
1. Installation
- Download the `UltraFairLootPlus.jar` file.
- Place the JAR in your server's `/plugins` folder.
- If you want economy features, also install Vault and an economy plugin (like EssentialsX).
- Start or restart your server. The default configuration files will be generated.
2. Configuration Files
The plugin is controlled by three simple files located in `/plugins/UltraFairLootPlus/`.
config.yml
This is your main control panel. Here you can set the loot system, delivery mode, and configure the appearance of GUIs, chests, and visual effects.
Code (YAML):
# Example: Choosing your loot system
settings:
loot-system
:
"INDIVIDUAL_ROLLS"
# Example: Choosing your delivery mode
delivery:
default-mode
:
"CHEST"
effects.yml
This is your "Effects Library." Create and design all your sounds and particles here with a unique ID.
Code (YAML):
# Example: A custom effect for a rare drop
rare-reward:
sound:
sound
:
"UI_TOAST_CHALLENGE_COMPLETE"
volume
: 1.0
pitch
: 1.5
particle:
particle
:
"ENCHANT"
count
: 100
speed
: 0.8
loottables.yml
This is where you define the actual loot for each mob. It's designed to be simple and readable.
Code (YAML):
ZOMBIE:
mode
:
"OVERRIDE"
# Can be OVERRIDE or ADDITIVE
effect-id
:
"zombie-groan"
# ID from effects.yml
sound-enabled
: true
particle-enabled
: false
rewards:
- type
:
"XP"
chance
: 100.0
amount
:
"5-15"
- type
:
"ITEM"
chance
: 2.5
item:
material
:
"DIAMOND_SWORD"
name
:
"&bZombie Slayer's Blade"
3. Commands & Permissions
The plugin uses a hierarchical permission structure. `ultrafairloot.admin` grants all permissions.
Commands:
- /ufl reload - Reloads all configuration files.
- /ufl test <LootTableID> - Simulates a loot drop for the specified loot table.
Permissions:
- ultrafairloot.admin - Grants access to all admin commands. (default: op)
- ultrafairloot.command.reload - Allows use of the reload command. (default: op)
- ultrafairloot.command.test - Allows use of the test command. (default: op)
- ultrafairloot.bypass.damage - Bypasses the minimum damage requirement for loot. (default: false)