For preview videos please visit our Wiki and select the feature you would like to preview!

VortexPrisonCore

VortexPrisonCore is a server-side, all-in-one Prison core plugin designed for Spigot/Paper Minecraft servers (1.21.3+). It replaces separate plugins for prison mines, custom enchants, rankups, custom currencies, backpacks, auto-sell, mining bombs, boosters, and vouchers, unifying them into a single optimized engine with zero NMS dependeny.

---

Why Choose VortexPrisonCore?

Setting up a traditional Prison server requires configuring and linking separate plugins for backpacks, mine resets, custom pickaxe enchantments, rankup and prestige progression, sell multipliers, token economies, mining explosives, and reward vouchers. This often leads to performance lag, configuration conflicts, and update headaches. VortexPrisonCore replaces all of these separate systems and resolves these issues by providing:

• Unified Performance: All core systems are written to work together under a single, cohesive framework, reducing server overhead and keeping MSPT (Millis per Tick) low.
• Zero NMS Dependency: Built using the standard Paper API without relying on internal Net Minecraft Server (NMS) code, ensuring high stability across minor server updates.
• Single Configuration Point: Manage your ranks, enchants, backpack capacities, mine resets, and boosters from a single plugin directory.

---

Key Modules & Features

Progressive Pickaxes & Custom Enchants

• Pickaxe Leveling: Players gain pickaxe experience by mining, upgrading their pickaxes over time.
• Requirement-Based Upgrades: Custom enchants require players to complete block-mining collections (e.g., mine 100 Coal and 50 Iron) before they can unlock or level up specific enchants.
• Built-in Enchants: Includes vanilla enchants (Efficiency, Fortune, Unbreaking) and custom Prison enchants:
  • Smelt: Automatically smelts mined ores.
  • Double Drop: Chance to duplicate drops.
  • Experience: Multiplies pickaxe EXP gain.
  • Explode: Explodes sections of the mine, instantly harvesting blocks.

Optimized Mine Management

• Flexible Refill Rules: Mines can be configured to reset automatically at set time intervals or when a specific percentage of blocks in the mine has been broken.
• MSPT-Optimized Resets: Features block placement limits per tick during mine resets to prevent server lag spikes during refills.

Integrated Backpacks & Inventory Helpers

• Backpack System: Provides players with upgradable backpacks to store large amounts of mined resources.
• AutoSell: Passively sells mined items or backpack contents with configurable multipliers.
• AutoBlock: Automatically compresses raw mined items (like Coal or Iron) into block form to optimize player inventory space.

Ranks, Prestiges, and Economy

• A-Z Progression: Fully configurable rank progression path (pre-configured from A to Z).
• Dual-Currency Ranks: Upgrading ranks can require both Vault money and custom tokens.
• Custom Tokens: Features a built-in token economy designed for Prison gameplay (used for purchasing pickaxe upgrades and enchantments).

Boosters, Bombs, and Vouchers

• Multi-Tier Mining Bombs: Throwable explosives that players can use to clear large mine areas instantly.
• Global & Personal Boosters: Multipliers for money, tokens, and experience that can be activated server-wide or individually.
• Redeemable Vouchers: Voucher items that players can redeem for money, tokens, gems, keys, or ranks.

Relational Database Support

• File-Based Storage: Local H2 database works out of the box for smaller servers.
• Network Databases: MySQL and MariaDB support for large servers or multi-lobby networks to sync player data, gems, and statistics.

---

Quick Start Guide

Installation

1. Download the VortexPrisonCore.jar file.
2. Place it into your server's plugins folder.
3. Ensure Vault and a compatible economy plugin are installed for money transactions.
4. Restart your server.

Default Setup

• On first join, players are automatically given a starting pickaxe and introductory mining bombs (customizable in config.yml).
• Configure custom enchants in plugins/VortexPrisonCore/Enchants/config.yml.
• Set up ranks and progression costs in plugins/VortexPrisonCore/Rank/config.yml.
• Define mine areas and block percentages in plugins/VortexPrisonCore/Mines/config.yml.

---

System Requirements

• Platform: Paper, Purpur, or compatible forks.
• Minecraft Version: 1.21.3 and above.
• Required Dependencies:
• Vault & a compatible economy plugin.