> For the complete documentation index, see [llms.txt](https://wiki.innouniq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.innouniq.com/plugins/parkour-dimension/configuration/options.md).

# Options

## Modules

Parkour offers a wide range of modules that can be used to enhance the gameplay. It's up to the administrator to decide which modules should be enabled.

#### BASIC

* Common mode of the Parkour.
* Pass the map in the shortest time.
* During the journey, various obstacles are waiting for adventurers.

```yaml
Options:
  Module:
    BASIC:
      Active: true
```

## BungeeCord

This mode is primarily determined for bigger server network, while Parkour is a separated server. In this section, you can specify the channel how to communicate with BungeeCord. Also, the name of lobbies, where the player is moved at leaving the server, is listed here.

```yaml
Options:
  BungeeCord:
    Active: false
    Channel: "BungeeCord" #Name of the channel BungeeCord communicates.
    LobbyList: #Name of lobbies where can be player moved at leaving a parkour lobby.
      - "Hub01"
      - "Hub02"
```

## Command

All about in-game commands that players can use.

```yaml
Options:
  Command:
    WhiteList: #Commands allowed to be executed while racing the map. Other commands are blocked.
      - "parkour"
      - "pa"
```

## Economy

Management of Economies used in Parkour.

Support of multiple currencies.

```yaml
Options:
  Economy:
    List:
      Vault:
        Currency:
          Type: "VAULT_WRAPPER"
          Sign: "$"
        Format:
          Decimal: true #Display decimal numbers
          PriceLabel: "{currency_sign}{product_price}" #Final formatting of the price used in the store.
```

#### Available currency types

* `VAULT_WRAPPER` - Use Vault API to get currency information.
* `PLAYER_POINTS`
* `EXPERIENCE`
* `TOKEN_MANAGER`
* `REV_ENCHANTS_C1`
* `REV_ENCHANTS_C2`

#### How to add a new currency type

```yaml
Options:
  Economy:
    List:
      Vault:
        Currency:
          Type: "VAULT_WRAPPER"
          Sign: "$"
        Format:
          Decimal: true #Display decimal numbers
          PriceLabel: "{currency_sign}{product_price}" #Final formatting of the price used in the store.
      Experience:
        Currency:
          Type: "EXPERIENCE"
          Sign: "XP"
        Format:
          Decimal: false #Display decimal numbers
          PriceLabel: "{product_price}{currency_sign}" #Final formatting of the price used in the store.
```

## Store

Through the store, players can unlock maps and other stuff from Parkour Dimension.

{% hint style="warning" %}
Only currencies supported from [the Economy](https://github.com/INNOUNIQ-Plugin-Development/WIKI/blob/main/plugins/parkour-dimension/configuration/economy.md) section are allowed to be used in the store.
{% endhint %}

```yaml
Options:
  Store:
    SupportedCurrencyList: #Currencies allowed to be used in the store.
      - "VAULT_WRAPPER"
    Confirmation: #Requirement of extra confirmation of the purchase.
      Active: true
```

## Duel

To enhance the experience, players can compete against other players. Challenger and challenging player has to bet some amount of currency. Winner takes the whole bet.

```yaml
Options:
  Duel:
    Active: true #Flag if duels are allowed on the server.
    PendingDuration: 30 #Duration remaining the player to make a decision about joining the duel.
    Bet: #Currencies and their amounts supported by the duel system.
      DefaultCurrency: "VAULT_WRAPPER" #Currency used by default if no one is specified while creating a duel.
      CurrencyList: #Currencies supported by the duel system.
        VAULT_WRAPPER:
          Default: 10 #Amount of currency used by default.
          Minimum: 5 #Minimal amount of currency allowed to bet.
```

## Rating

To get feedback from players, Parkour offers a rating system that can help other players decide whether to join the race or not.

When a player completes the map, he is asked for a rating of it.

```yaml
Options:
  Rating:
    Active: true
    Range: 5 #Maximal rating value.
    CooldownDuration: 5 #How long(minutes) after completing the race is able to rate the map.
    Sign: #Symbols representing rating value.
      EMPTY: "\u25CB"
      HALF: "\u25D0"
      FULL: "\u25CF"
```

## Perks

Useful addons are making the player's experience even more enjoyable during the race.

```yaml
Options:
  Perk:
    CompassNavigation: #Perk shows the direction to the finish.
      Active: true
    FakeContactDamage: #This perk allows a player to receive damage without taking his health.
      Active: false
    InteractiveItemList: [ ] #While racing the map, players can interact with selected items.
```

## Replay

Replays of the leaders are available for watching. Also, the personal best race is watchable.

If enabled, each race is recorded.

{% hint style="warning" %}
There is required to have [AdvancedReplays](https://www.spigotmc.org/resources/advancedreplay-1-8-1-21.52849/) and [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) plugins installed.
{% endhint %}

```yaml
Options:
  Replay:
    Active: false
    NamePattern: "M_{map}-P_{player}-ID_{id}" #File Name Pattern
```

## Board

Personal and leading statistics are displayed on the leaderboards. Various modes of the leaderboard are available.

{% hint style="info" %}
Colors are in RGB format, separated by colon(`:`).
{% endhint %}

```yaml
Options:
  Board:
    Personal:
      Type: "NONE"
      Dress:
        Color: "127:255:212"
    Leader:
      Type: "NONE"
      Dress:
        FIRST:
          Color: "255:215:0"
        SECOND:
          Color: "211:211:211"
        THIRD:
          Color: "177:86:15"
        OTHER:
          Color: "183:146:104"
    Section:
      DefaultSwitchTime: 10
    DefaultData:
      Texture: "ewogICJ0aW1lc3RhbXAiIDogMTYwMjUzMzgzNjA0NywKICAicHJvZmlsZUlkIiA6ICI4NjY3YmE3MWI4NWE0MDA0YWY1NDQ1N2E5NzM0ZWVkNyIsCiAgInByb2ZpbGVOYW1lIiA6ICJTdGV2ZSIsCiAgInNpZ25hdHVyZVJlcXVpcmVkIiA6IHRydWUsCiAgInRleHR1cmVzIiA6IHsKICAgICJTS0lOIiA6IHsKICAgICAgInVybCIgOiAiaHR0cDovL25vdmFzay5pbi80Njc1MDk3LnBuZyIKICAgIH0sCiAgICAiQ0FQRSIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOTUzY2FjOGI3NzlmZTQxMzgzZTY3NWVlMmI4NjA3MWE3MTY1OGYyMTgwZjU2ZmJjZThhYTMxNWVhNzBlMmVkNiIKICAgIH0KICB9Cn0="
      TextureSignature: "Ri+gD6opLkTsZQuGpSzm3mT8K7s7n1fylC+3Opt/4CW+VTaBhRV8swJVVkqzvAW5N+FxRVLqjM2LYyKNoNfOHTg5UOTmO+Iel5B6mEZWTxRedUETj/M399GPwlv/Kn75KzN/SAMIQJ/2JLUF9Rr4iwQUaFkeT2aCK+4GHGsTKwQhE0GNRCZeKbiQQDBHg94CM+yFpG30IRcgZipBIYiYsLlFyDJXOU28tb+v99Io51QKPKa4uaSTx/M5FeVEBBBAFOG5VPnSy6Y7PLZRPUk7FkXFKsBjrrZnWTLNzevPjwvTT0W7BEdglXaNAYqx9EH1PpnEbu/HI4wz71V7BDwMKs6RAOAfCJm57gAz31yobCr6MhAcdrIvKqC7GQ9vL6qZms1+cZtLvSBtmXtKt69zSeC4lT2FyTiPFN1o69cWNa0atOz1QDRtU+MsOx9sQevtdJM9344+AcKPoxKZC0tXTJ4exP+Hud+eml7PyNPh5hQJ1KeKlALY9hTeeqHLlPlaUOtOOVOV7d54i4rVgAlOj7wloZ2Gt7k5WvPSExzFPN5P7P0lmTjhrwJvhBfV54w4jKe+l24GlsJrDYwqA2JooYGr+NA8D9UsCWk+LFWJ0lGKcYqdF1nBMqfnvwXE9wOqn0udJN3U7tcgrEE1/KM4fFByqIBas9778TzgiIyTgOU="
```

#### Supported Board Types

* `BANNER` - Hologram as a leaderboard.
* `PODIUM_ARMOR_STAND` - ArmorStand Figures are placed on the podium.
* `PODIUM_PLAYER` - NPC Figures are placed on the podium.
* `SIGN` - Signs used as a leaderboard.

#### Creating Boards

**Personal Board**

1. Find suitable place for the board and execute command `/Parkour Board Personal Place`
2. (Optional) To change a type of the board, execute command `/Parkour Board Personal Type <Type>`

**Map Board**

As default top 3 players of each map can be displayed at LeaderBoards.

(Optional) To change a type of the board, execute command `/Parkour Board Leader Type <Type>`

**Banner**

1. Find suitable place for the board and execute command `/Parkour Board Map <MapName> Place Banner`

**Podium**

1. Find suitable place for the best(first) player, fix your position and execute command `/Parkour Board Map <MapName> Place Podium 1`
2. Repeat for the next two podiums, just find new place and change the last argumennt from `1` to `2` and `3`.

**Sign**

1. Find a suitable place for the best(first) player, place sign and type
   * \*\*Parkour\*\*
   * MapName
   * Order(Position)
2. Repeat for the next two signs, just find new place and change the position from `1` to `2` and `3`.
3. (Optional) Place the head (skull item) above the sign to see textures of the player.

**Summary Board**

There are collected more types of statistics. To display them at podiums/banner can take too much place at the server. Instead of that, you can create just one place and let a system change boards with statistics in defined intervals.

(Optional) To change a type of the board, execute command `/Parkour Board Leader Type <Type>`

**Board Sections**

At first, we need to create a section, which ensures changing stat components in defined intervals.

1. Create a section by executing command `/Parkour Section Create <CustomName>`
2. Add a stat component to the section using command `/Parkour Section Component Add <CustomName> <Type>`
3. (Optional) Change default switch time by executing command `/Parkour Section UpdateSwitchTime <CustomName> <Time>`

**Available Component types:**

* `THE_HIGHEST_RANK`

**Banner**

1. Find suitable place for the board and execute command `/Parkour Board Leader Place Banner <ComponentType>`

**Podium**

1. Find suitable place for the best(first) player, fix your position and execute command `/Parkour Board Leader Place Podium <ComponentType> 1`
2. Repeat for the next two podiums, just find new place and change the last argumennt from `1` to `2` and `3`.

**Sign**

1. Find a suitable place for the best(first) player, place sign and type
   * \*\*Parkour\*\*
   * ComponentType
   * Order(Position)
2. Repeat for the next two signs, just find new place and change the position from `1` to `2` and `3`.
3. (Optional) Place the head (skull item) above the sign to see textures of the player.

## Statistics

Properties about statistics.

```yaml
Options:
  Statistic:
    LeaderCount: 3 #How many top players are shown in the leaderboard.
    PreferredModule: "BASIC" #At some places, only statistics from preferred modules are shown.
```

## Visual

All about the visual part of Parkour system.

#### BroadCast Messages

Messages sent to all players can be disabled or restricted in specific worlds.

```yaml
Options:
  Visual:
    BroadCastMessage:
      RACE__COMPLETION:
        Active: true
        WorldRestriction: [ ] #List of world names, where the message will NOT be sent.
```

#### Map Timer

Timer is displayed at the action bar while racing the map or at leaderboard.

{% hint style="info" %}
To display hours, change FormatPattern to: `HH:mm:ss.SSS`.
{% endhint %}

```yaml
Options:
  Visual:
    Map:
      Timer:
        Active: true
        FormatPattern: "mm:ss.SSS"
```

## HotBar

Management of HotBars used in Parkour.

**Exploring HotBar** used when the player is exploring. By exploring, it's meant that the player is in a Parkour lobby.

```yaml
Options:
  HotBar:
    EXPLORING:
      Active: false
```

## Split

While the player is racing the map, we collect his current time. When he reaches CheckPoint, we show him the current situation compared to the best time of the map using BossBar.

```yaml
Options:
  Split:
    Active: true
    LeaderThreshold: 2 #How many seconds can be player slower than the map best time to show a still reachable state.
    BossBar: #Visual indicator of the current split status.
      RACE_LEADER:
        Color: "GREEN"
        Style: "SOLID"
      BEHIND_RACE_LEADER:
        Color: "YELLOW"
        Style: "SOLID"
      PERSONAL_BEST:
        Color: "BLUE"
        Style: "SOLID"
      OUT_OF_CONTENTION:
        Color: "RED"
        Style: "SOLID"
```

#### Available BossBar colors

`PINK`, `BLUE`, `RED`, `GREEN`, `YELLOW`, `PURPLE`, `WHITE`

#### Available BossBar styles

`SOLID`, `SEGMENTED_6`, `SEGMENTED_10`, `SEGMENTED_12`, `SEGMENTED_20`

## PredefinedMapData

Base map data used at initialization of the new map. These predefined data are copied into the new map's configuration.

More about Map properties at [Map Configuration](/plugins/parkour-dimension/configuration/map/map.md).

```yaml
Options:
  PredefinedMapData:
    Management:
      AuthorLimit: 1 #Count of maps that can be created by the one player.
```


---

# 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.innouniq.com/plugins/parkour-dimension/configuration/options.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.