Installation

Installation

This page covers installing VortexRPG on Paper, Folia, and Spigot servers.

Requirements

Requirement	Value
Java	Java 21
Minecraft	1.21+
Platforms	Paper, Folia, Spigot
Required dependencies	None
Optional dependencies	Vault, PlaceholderAPI, WorldGuard, Citizens

Choose the Correct Jar

VortexRPG ships separate release jars for different server targets:

Server Type	Jar
Paper	VortexRPG-1.2.2-alpha-paper-folia.jar
Folia	VortexRPG-1.2.2-alpha-paper-folia.jar
Spigot	VortexRPG-1.2.2-alpha-spigot.jar
Developers	VortexRPG-1.2.2-alpha-sources.jar

Install Steps

1. Stop your Minecraft server.
2. Install Java 21 if your host is not already using it.
3. Download the correct VortexRPG jar for your platform.
4. Place the jar into the server plugins folder.
5. Start the server once so VortexRPG can generate its configuration files.
6. Stop the server again if you want to edit generated YAML files safely.
7. Configure the files in plugins/VortexRPG/.
8. Start the server and use /vrp help in game.

Optional Integrations

Plugin	What VortexRPG Uses It For
Vault	Economy rewards, player balances, dungeon and breach payouts
PlaceholderAPI	External placeholders and display integrations
WorldGuard	Protection-aware world interactions
Citizens	NPC role integration and guide-style behavior

VortexRPG soft-depends on these plugins. The plugin can start without them, but related features will be limited or disabled.

First Boot Checklist

1. Confirm the server console shows VortexRPG enabled.
2. Join the server and run /vrp about.
3. Choose a class with /class or /vrp class.
4. Open skills with /skills or /vrp skills.
5. Check stats with /stats or /vrp stats.
6. Inspect smart progression with /vrp codex, /vrp reputation, and /vrp synergies.
7. For admin setup, run /vortex or /vrp admin.

Updating From an Older Version

1. Stop the server.
2. Back up the plugins/VortexRPG/ folder.
3. Replace the old jar with the new 1.2.2-alpha jar.
4. Start the server once to allow resource migration and config generation.
5. Check the console for migration notes.
6. Review new config sections, especially smart-systems.
7. Run /vortex validate if available to inspect content state.

Support

For support, use the Discord link from the plugin metadata:

https://discord.gg/Tya84XrgSF