# Configuration

## Default config:

```yaml
# plugin developed by Gasper Lukman
# https://github.com/NeutralPlasma/HoloExtension
# All rights reserved to Gasper Lukman
# Support discord server: https://discord.gg/Zpks2WK
#
# for each placeholder replace # with position for example
# {he-baltop-1-user} {he-baltop-2-user} {he-baltop-3-user}

version: "0.0.1 Alpha"

modules:
  # baltop module
  # placeholders:
  # {he-baltop-#-user}
  # {he-baltop-#-value}
  baltop:
    interval: 200L
    noplayer: "unknown"
    updateOffline: true
    size: 10
    enabled: true

  # protocollib module:
  # placeholders:
  # {slow} - 10 seconds
  # {medium} - 1 second
  # {fast} - 0.1 second
  ProtocolLib:
    enabled: true
    updateOffline: true
    type: NUMBER
    interval: 200
    size: 10
    noplayer: 'NULL'


papi:
  # Example papi module
  # placeholders
  # {he-%statistic_seconds_played%-#-user}
  # {he-%statistic_seconds_played%-#-value}
  "%statistic_seconds_played%":  # Change this crap
    interval: 200L
    noplayer: "unknown"
    updateOffline: true
    size: 10
    type: "time"
    enabled: true

```

### Configuring balance top

| Name          | Value     | Explanation                                                           |
| ------------- | --------- | --------------------------------------------------------------------- |
| interval      | 200L      | How often is the balance top refreshed (in ticks 20 ticks = 1 second) |
| noplayer      | "unknown" | Replacement for missing players.                                      |
| updateOffline | true      | Should it update values for players that aren't active on server?     |
| size          | 10        | How big should the leaderboard be (the # in placeholder)              |
| enabled       | true      | Is this module enabled?                                               |

#### Placeholders

| Placeholder         | Information                                                                                                       |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| {he-baltop-#-user}  | Replace # with position (1,2,3,4...), Returns the username of the user on a specific position on the leaderboard. |
| {he-baltop-#-value} | Replace # with position (1,2,3,4...), Returns the balance of user on a specific position on the leaderboard.      |

### Configuring placeholder API extensions

Those are custom leaderboards made from placeholders from PlaceholderAPI plugin. Extension name itself in config should be the placeholder itself.

{% hint style="danger" %}
Make sure placeholder returns the raw value that isn't parsed examples:

* raw: 1512.0
* parsed: 1.5k
  {% endhint %}

| Name          | Value     | Explanation                                                                                                                                                                                                                 |
| ------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| interval      | 200L      | How often is the leaderboard updated?                                                                                                                                                                                       |
| noplayer      | "unknown" | Replacement if the player isn't found.                                                                                                                                                                                      |
| updateOffline | true      | Should the leaderboard update offline players, recommended to be turned off since most of the placeholders don't support parsing data from Offline players and it just gonna use resources for no reason.                   |
| size          | 10        | How big should the leaderboard be (the # in placeholder)                                                                                                                                                                    |
| type          | "time"    | <p>Either TIME or NUMBER, if you set it to time plugin will parse returned value to time format example: 1d 21m 10s</p><p>If you set it to NUMBER its gonna format it as number examples:</p><p>0.0,</p><p>0,</p><p>10k</p> |
| enabled       | true      | Is the module itself enabled or no?                                                                                                                                                                                         |


---

# Agent Instructions: 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:

```
GET https://wiki.virtusdevelops.eu/holoextension/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.