> For the complete documentation index, see [llms.txt](https://mode-development.gitbook.io/pulseprison/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mode-development.gitbook.io/pulseprison/readme.md). # Introduction **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](https://3602599042-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNIZLod0DbqxSEIEdppwj%2Fuploads%2Fgit-blob-dcc93d49f9da1cd2cae53b0ef76dc1f317fc0d29%2F01-features.png?alt=media) | | | | --------------------- | ---------------------------------------------------------------------------------------------- | | Version | 2.0.0 | | Server | Paper 1.20.4 to 1.21.11 | | Java | 17 or newer | | Required dependencies | None | | Optional dependencies | PlaceholderAPI, 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](/pulseprison/core-concepts/stats.md) 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](/pulseprison/getting-started/modules.md) 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](/pulseprison/developers/developer_api.md) with services, events and extension points to build addons. *** ## How this documentation is organized | Section | For | | ------------------------ | ------------------------------------------------------------------------------------------ | | **Getting started** | Installing, setting up a server from scratch, choosing modules and storage | | **Core concepts** | What every system shares: currencies, actions, formulas, costs, stats, menus and languages | | **Pickaxe and enchants** | Everything that lives on the pickaxe | | **Mines** | Rank mines, private mines, cells and robots | | **Economy** | Selling, prices, market, backpacks and multipliers | | **Progression** | Ranks, levels and every player upgrade system | | **Mine content** | Placeables, autominers and AFK blocks | | **Social** | Clans, seasons and chat | | **Administration** | Staff commands, reloads and backups | | **Reference** | Full tables of commands, permissions, placeholders and files | | **Developers** | API, events and how to build addons | If this is your first time, start with [Installation](/pulseprison/getting-started/installation.md) and continue with [First server](/pulseprison/getting-started/first-setup.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://mode-development.gitbook.io/pulseprison/readme.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.