> For the complete documentation index, see [llms.txt](https://wiki.vortexdevelopment.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.vortexdevelopment.net/projects/vortexprisoncore/ranks.md).

# 🎖️Ranks

The plugin features a comprehensive rank progression system with 26 ranks (A-Z). Each rank has its own token and money requirements and provides access to new mines.

Rank Configuration

Each rank has:

* `Name`: Rank identifier.
* `Token`: Cost in tokens to rank up.
* `Money`: Cost in money to rank up.
* `Weight`: Determines rank hierarchy.
* `Commands When Unlocked`: Executed upon unlocking the rank.

#### Example

```
Ranks:
  A:
    Name: 'A'
    Token: 1000
    Money: 10000
    Weight: 1
    Commands When Unlocked:
      - 'lp user <player> permission set essentials.warps.a server=prison'
      - '[MESSAGE] &6You have unlocked &eA &6mine!'
  B:
    Name: 'A'
    Token: 2000
    Money: 20000
    Weight: 2
    Commands When Unlocked:
      - 'lp user <player> permission set essentials.warps.b server=prison'
      - '[MESSAGE] &6You have unlocked &eB &6mine!'
```

* Players must have required tokens and money to unlock the rank.
* Commands grant permissions and notify the player upon rank-up.
* Higher ranks have higher costs and weights.

**Rankup Command**

Players can rankup using the `/rankup` command when they have enough tokens and money. When a player ranks up:

1. Their tokens and money are deducted
2. They gain access to the mine associated with their new rank
3. Special commands configured for the rank are executed (like permission grants)
4. A message is displayed to notify them of their new access


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.vortexdevelopment.net/projects/vortexprisoncore/ranks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.