> For the complete documentation index, see [llms.txt](https://docs.arnixstudio.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.arnixstudio.fr/documentation/en-official-wiki-hytjump.md).

# 📑 EN / Official Wiki: HytJump 🏃‍♂️💨

### 🌟 Introduction

HytJump is designed to provide a unique Parkour experience. Instead of jumping on static blocks, the path generates in real-time in front of you. Every attempt is a new challenge!

### 🛠️ Quick Installation

1. 📥 Download the `HytJump.jar` file.
2. 📂 Place it in your `/plugins/` folder.
3. 🔄 Restart your server.
4. 🌍 The `languages/` folders and configuration files will be created automatically.

### 📍 Course Setup (Admin)

To make the plugin functional, you must define two essential points:

1. The Finish (End): Go to where the parkour should end and type:

   👉 `/hytjump end` *(This is the mandatory first step).*
2. The Start (Start): Go to your starting point and type:

   👉 `/hytjump start`

   *Note: The plugin will automatically calculate the direction towards the finish line.*
3. The Chest (Rewards): Look at a chest or a barrel and type:

   👉 `/hytjump reward set`

   *To remove it: `/hytjump reward unset`.*

***

#### 🎮 How to Play? <a href="#how-to-play" id="how-to-play"></a>

* Starting: Step on the start weighted pressure plate.
* The Jump: A block appears. Jump on it to make the next one appear. The previous block disappears behind you.
* The Fall: If you fall, you are teleported behind the start plate to try again.
* Victory: Reach the finish plate to record your time!

***

#### 🏆 Ranking System (Leaderboard) <a href="#ranking-system-leaderboard" id="ranking-system-leaderboard"></a>

The plugin tracks the Top 15 best times on the server. You can display this ranking via holograms using PlaceholderAPI.

* Available Variables:
  * `%hytjump_top_1_name%`: Name of the champion.
  * `%hytjump_top_1_time%`: Their record.
  * *(Works from 1 to 15).*

***

#### 🎁 Rewards & Cooldown <a href="#rewards-and-cooldown" id="rewards-and-cooldown"></a>

After a victory, the player unlocks access to the reward chest.

* ⏳ Cooldown: By default, a player can claim a reward every 24h.
* ⏱️ Tracking: Use the placeholder `%hytjump_reward_cooldown%` to show the player exactly how much time is left before their next claim.

***

#### 💻 Admin Commands <a href="#admin-commands" id="admin-commands"></a>

| Command                            | Description                                         |
| ---------------------------------- | --------------------------------------------------- |
| `/hytjump start/end`               | Configures the game plates.                         |
| `/hytjump reward set/unset`        | Configures the reward chest.                        |
| `/hytjump cooldown reset <player>` | Makes the chest available immediately for a player. |
| `/hytjump cooldown set <player>`   | Blocks a player's chest access for 24h.             |
| `/hytjump reload`                  | Reloads config and language files.                  |

Exporter vers Sheets

***

#### 🌍 Customization (Config & Languages) <a href="#customization-config-and-languages" id="customization-config-and-languages"></a>

* Languages: Change `language: fr` or `en` in the `config.yml`. All messages are fully editable in the `/languages/` folder.
* Blocks: You can choose which blocks appear during the jump in the `jump-blocks` list in the config.
* Rewards: Add as many commands as you want with a percentage-based chance system.

***

#### 🖼️ Placeholders Table (PlaceholderAPI) <a href="#placeholders-table-placeholderapi" id="placeholders-table-placeholderapi"></a>

| Placeholder                 | 📝 Short Description                                   | 💡 Example Render |
| --------------------------- | ------------------------------------------------------ | ----------------- |
| `%hytjump_best_time%`       | Displays the player's personal best (record).          | `00:45:120`       |
| `%hytjump_last_time%`       | Displays the time of the very last successful run.     | `00:52:800`       |
| `%hytjump_reward_cooldown%` | Remaining wait time before opening the chest.          | `18h 05m 30s`     |
| `%hytjump_top_{1-15}_name%` | Displays the player's name at the specified rank.      | `Papa_Arnix`      |
| `%hytjump_top_{1-15}_time%` | Displays the time of the player at the specified rank. | `00:38:005`       |


---

# 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://docs.arnixstudio.fr/documentation/en-official-wiki-hytjump.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.