Installation

Requirements

Component	Version	Required	Used for
Paper	1.20.4 to 1.21.11	Yes
Java	17 or newer	Yes
PlaceholderAPI	2.11.5+	No	PulsePrison placeholders in other plugins, and `%placeholders%` in menus and actions
Vault	1.7+	No	PulsePrison registers as the economy, or uses another economy as a currency
WorldEdit or FastAsyncWorldEdit	7.2+	Only for cells	Faster rank mine resets and the cell template
WorldGuard	7.0+	No	The `pulseprison-enchants` flag, cell regions and allowed regions for AFK blocks
HeadDatabase	any	No	Pet heads by id
PlayerPoints	3.0+	No	Using its points as a currency

PacketEvents ships inside the jar for private mines. Paper downloads HikariCP and sqlite-jdbc on startup.

Installing

Copy PulsePrison-2.0.0.jar into plugins/.
Start the server. Every configuration file is generated.
Stop the server and choose the modules and storage in config.yml.
Start again and follow the first server guide.

Every option is explained with comments inside its file. When you update the plugin, new options are added to your files without overwriting what you changed.

Generated files

text

plugins/PulsePrison/
├── config.yml            language, storage, modules, number format, mines, pickaxe, rankup
├── messages.yml          English texts (the base of every language)
├── messages_es.yml       Spanish texts
├── currencies.yml        currencies
├── levels.yml            leveling tracks
├── enchants.yml          enchants, activation messages and destruction guard
├── custom-enchants/      your own enchants, one per file
├── ranks.yml             ranks and prestige
├── rebirths.yml          rebirth
├── prices.yml            base prices and rank and prestige multipliers
├── market.yml            dynamic market
├── autosell.yml          sell summary
├── backpacks.yml         backpacks
├── skilltree.yml         skill tree
├── pets.yml              pets
├── robots.yml            robots
├── cells.yml             cells
├── clans.yml             clans
├── seasons.yml           seasons
├── placeables.yml        bombs, drills and lucky blocks
├── autominers.yml        autominers
├── afk-blocks.yml        AFK blocks
├── attributes.yml        attributes
├── boosters.yml          boosters
├── milestones.yml        milestones
├── masteries.yml         masteries
├── skins.yml             pickaxe skins
├── crystals.yml          crystals
├── armors.yml            armor sets
├── abilities.yml         active abilities
├── menus/                one file per menu
├── pmines/               private mines: config.yml, types/, structures/, menus/
├── mines.yml             rank mines (created by /mine create)
├── templates/            cell template (created by /cell confirm)
└── data/                 player data, see Storage

First startup

Check the console: PulsePrison warnings name the file or system with the problem. Confirm everything loaded with:

text

/prison info
/prison modules