Installation

Installation

Requirements

• Java 21 or newer.
• A Minecraft 1.21.x compatible server.
• Paper, Folia, Spigot, or Purpur.
• Optional: Vault for economy shop features.
• Optional: PlaceholderAPI for placeholders.
• Optional: ProtocolLib for compatibility with packet-based ecosystems.

Install Steps

1. Stop the server.
2. Place the VortexEnchantments jar in the plugins/ folder.
3. Start the server once.
4. Confirm the plugin creates its configuration files.
5. Stop the server again before large configuration changes.
6. Edit the generated YAML files.
7. Start the server and run /ve to confirm command registration.

Generated Files

VortexEnchantments generates or uses these files:

File	Purpose
config.yml	Main plugin settings and system toggles.
messages.yml	Player-facing language and messages.
mob_drops.yml	Mob drop chances and rarity weights.
custom_items.yml	Custom item definitions and recipes.
enchants/**/*.yml	Individual enchantment definitions.
playerdata/	Flat-file player data when flat-file storage is selected.

Recommended First Setup

1. Review config.yml.
2. Set the enchantment limit for your server style.
3. Tune success and destroy rates.
4. Set shop prices for your economy.
5. Configure Souls rewards if PvP is enabled.
6. Disable VortexEnchantments in lobby or minigame worlds if needed.
7. Edit messages.yml to match your server branding.
8. Give staff the correct admin permissions.

Updating

1. Back up the plugin folder.
2. Replace the old jar.
3. Start the server.
4. Check console for config migration or validation messages.
5. Run /ve reload after small message/config edits.
6. Restart after major feature or jar updates.

Do not edit YAML while the server is saving player data unless you have a backup.