> 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/getting-started/installation.md).

# Installation

## Requirements

| Requirement        | Notes                                                                                                                                          |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| **Server**         | Paper (or a Paper fork). Spigot/Bukkit are **not** supported.                                                                                  |
| **Versions**       | 1.20.4 or newer                                                                                                                                |
| **Java**           | Java 21 or newer                                                                                                                               |
| **Host plugin**    | **Required.** At least one of: PinnaPrison (1.1.5+), EdPrison 2.0, EdTools, EdDungeons. Without one, CodexMomentum disables itself on startup. |
| **PlaceholderAPI** | **Recommended.** Enables the `%codexmomentum_...%` placeholders and lets you use PAPI placeholders inside the boss bar.                        |

## Steps

1. Stop your server.
2. Place `CodexMomentum.jar` into `plugins/`.
3. Make sure at least one host plugin (PinnaPrison, EdPrison, EdTools, EdDungeons) is in `plugins/` too.
4. Start the server once so all files generate.
5. Edit `config.yml` to taste — the [level ladder](/p/codexmomentum/momentum/levels.md) is where most of the tuning happens — then `/momentum reload`.

{% hint style="info" %}
Every supported host plugin found at startup is hooked automatically — nothing to configure. To ignore one on purpose, set it to `false` under `platforms:` in `config.yml`.
{% endhint %}

## File structure

After the first launch you will find these inside `plugins/CodexMomentum/`:

```
config.yml       # platforms, grace period, decay, gain, boss bar, visuals, levels
messages.yml     # all plugin messages (help, stats, chat lines, loss reasons)
data/            # embedded H2 database (records, toggle preference, saved momentum)
```

## Reloading

Use `/momentum reload` (permission `codexmomentum.admin`) to reload `config.yml` and `messages.yml` at runtime — no restart required. Players keep their live momentum through the reload.

{% hint style="warning" %}
If you shrink the level ladder while players are on a higher level, their level is clamped to the new maximum.
{% endhint %}