Docs

PulsePrison

PulsePrison is a modular prison core for Paper: a pickaxe with levels and enchants, public and private mines, an economy with unlimited currencies and more than twenty progression systems, all configured in YAML and translated per player.

Features

Version2.0.0
ServerPaper 1.20.4 to 1.21.11
Java17 or newer
Required dependenciesNone
Optional dependenciesPlaceholderAPI, Vault, PlayerPoints, WorldEdit or FastAsyncWorldEdit, WorldGuard, HeadDatabase

What's included

Mining

  • A persistent pickaxe with level, experience, skins, crystals and 25 enchants of up to 100 levels.
  • A YAML enchant creator with formulas, effects and actions.
  • Rank mines with time or percentage resets and an engine that never freezes the server.
  • Packet private mines: thousands of blocks per second without writing the world, with members, visitors, taxes, expansions and stages.
  • Bombs, drills, lucky blocks, autominers, robots and AFK blocks.

Economy

  • Unlimited currencies: internal, stored in the player profile, from Vault, from PlayerPoints or from any plugin through commands.
  • Auto-sell, virtual backpacks, a supply driven market and multipliers.

Progression

  • Ranks, prestige, rebirth and unlimited leveling tracks with rewards.
  • Skill tree, pets, attributes, boosters, milestones, masteries, armor sets and active abilities.
  • One shared list of stats that adds up every bonus, shown with /stats.

Social

  • Clans with a bank and leaderboard, competitive seasons, cells and chat formatting.

For server owners

  • Every system is a module that turns off without leaving anything behind.
  • Every menu is YAML with conditions, pages and actions.
  • Every text is a key in messages.yml, and each player picks their language.
  • Storage in JSON, SQLite or MySQL.
  • A developer API with services, events and extension points to build addons.

How this documentation is organized

SectionFor
Getting startedInstalling, setting up a server from scratch, choosing modules and storage
Core conceptsWhat every system shares: currencies, actions, formulas, costs, stats, menus and languages
Pickaxe and enchantsEverything that lives on the pickaxe
MinesRank mines, private mines, cells and robots
EconomySelling, prices, market, backpacks and multipliers
ProgressionRanks, levels and every player upgrade system
Mine contentPlaceables, autominers and AFK blocks
SocialClans, seasons and chat
AdministrationStaff commands, reloads and backups
ReferenceFull tables of commands, permissions, placeholders and files
DevelopersAPI, events and how to build addons

If this is your first time, start with Installation and continue with First server.

PulsePrison | PulsePrison Core Docs