> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/codexmomentum/introduction.md).

# Introduction

<mark style="color:red;">**WARNING: CodexMomentum ONLY WORKS ON PAPER 1.20.4 OR NEWER AND REQUIRES AT LEAST ONE SUPPORTED HOST PLUGIN**</mark>

Welcome to the official documentation for **CodexMomentum** — an activity momentum add-on for **PinnaPrison**, **EdPrison 2.0**, **EdTools** and **EdDungeons**. Keep playing (mining blocks, breaking gens, landing sword hits) to climb momentum levels; stop, die, teleport out or log off and your momentum drains back down **progressively, level by level**, until it hits zero.

On PinnaPrison every momentum level grants **live boosters** — extra currency income, a boosted enchant, or all enchants at once — that apply instantly while the level is held and vanish when momentum drops. On the other platforms levels still track and display, and you reward them through per-level console commands.

## ✨ Highlights

* **Momentum ladder** — a fully configurable ladder of levels (10 by default), each with its own block requirement, boosters, boss bar style, title, sound, particles, commands and aura.
* **Live boosters (PinnaPrison)** — currency income %, a specific enchant's proc chance, or every enchant at once; applied the moment a level is reached, removed the moment it is lost.
* **Progressive decay** — after a configurable grace period, momentum drains at a configurable blocks-per-second rate instead of resetting instantly. Death, teleport and logout each have their own loss mode.
* **Boss bar** — a per-level styled boss bar (packet-based where available) with its own draining style, toggleable per player with `/momentum toggle`.
* **Lifetime records** — best level, longest streak and most blocks are saved per player in an embedded H2 database.
* **Async-first** — gain is counted on the host plugins' event threads, decay and the boss bar run on async tickers, saves run on a dedicated I/O thread. Zero main-thread cost.

## 🚀 Installation

1. Download the latest version of the CodexMomentum plugin (`.jar` file).
2. Place the `CodexMomentum.jar` into your server's `plugins/` folder.
3. Make sure at least one supported host plugin is installed: PinnaPrison, EdPrison 2.0, EdTools or EdDungeons. [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) is recommended for placeholders.
4. Restart your server. CodexMomentum generates its configuration files inside `plugins/CodexMomentum/`.

See the [Installation](/p/codexmomentum/getting-started/installation.md) page for full setup details.

## 🧭 Where to start

* New to the plugin? Read [Installation](/p/codexmomentum/getting-started/installation.md) → [How Momentum Works](/p/codexmomentum/momentum/how-momentum-works.md) → [Levels](/p/codexmomentum/momentum/levels.md).
* Setting up rewards? See [Boosters](/p/codexmomentum/momentum/boosters.md) (PinnaPrison) or the per-level `commands` in [Levels](/p/codexmomentum/momentum/levels.md) (all other platforms).
* Styling the display? See [Boss Bar](/p/codexmomentum/momentum/bossbar.md) and [Visual Effects](/p/codexmomentum/momentum/visuals.md).
* Looking for a command or placeholder? Jump to the [Reference](/p/codexmomentum/reference/commands.md) section.

## 💬 Support

Need help? Join the Discord: <https://discord.gg/7RapfdQ7VH>