... | @@ -20,7 +20,7 @@ This documents fields under the `resource-pack` configuration node. |
... | @@ -20,7 +20,7 @@ This documents fields under the `resource-pack` configuration node. |
|
| `support` | [(more)](#support) | Configures the _client_ versions supported by the generated resource pack. [More](#support). |
|
|
| `support` | [(more)](#support) | Configures the _client_ versions supported by the generated resource pack. [More](#support). |
|
|
| `description` | (version info.) | The description of the resource pack displayed to clients. |
|
|
| `description` | (version info.) | The description of the resource pack displayed to clients. |
|
|
| `resources` | `[]` | A list of resource packs used to pull assets. [More](#resources). |
|
|
| `resources` | `[]` | A list of resource packs used to pull assets. [More](#resources). |
|
|
| `merge` | `{}` | A mapping of pack locations to merge strategy for inclusion in the final resource pack. [More](#merge) |
|
|
| `merge` | `{}` | A mapping of pack locations to merge strategy for inclusion in the final resource pack. [More](#merge). |
|
|
| `destination` | `MythicHUD/built-pack` | The folder (or .zip file) relative to the `plugins/` folder where the generated resource pack should be placed. |
|
|
| `destination` | `MythicHUD/built-pack` | The folder (or .zip file) relative to the `plugins/` folder where the generated resource pack should be placed. |
|
|
|
|
|
|
## Support
|
|
## Support
|
... | @@ -145,7 +145,85 @@ This documents fields under the `boss-bar` configuration node. |
... | @@ -145,7 +145,85 @@ This documents fields under the `boss-bar` configuration node. |
|
| `color` | `YELLOW` | Which color is used for passthrough boss bars. |
|
|
| `color` | `YELLOW` | Which color is used for passthrough boss bars. |
|
|
|
|
|
|
# Vanilla HUD Elements
|
|
# Vanilla HUD Elements
|
|
This documents fields under the `elements` configuration node.
|
|
`elements` allows users to configure the appearance and location of vanilla HUD elements. Here is a table describing how each element can be controlled:
|
|
|
|
|
|
|
|
| Element | Description | Can Move? | Can Hide? |
|
|
|
|
| ------- | ----------- | --------- | --------- |
|
|
|
|
| `EXPERIENCE_LEVEL` | The number indicating the player's experience level | :white_check_mark: | :white_check_mark: |
|
|
|
|
| `HEALTH` | Hearts indicating the player's health | :x: | :white_check_mark: |
|
|
|
|
| `ARMOR` | Armor plates indicating the player's equipped armor | :x: | :white_check_mark: |
|
|
|
|
| `HUNGER` | Porkchops indicating the player's hunger | :x: | :white_check_mark: |
|
|
|
|
| `AIR` | Bubbles indicating the player's remaining air | :x: | :white_check_mark: |
|
|
|
|
| `EXPERIENCE` | Bar indicating the player's progress towards the next experience level | :x: | :white_check_mark: |
|
|
|
|
| `VEHICLE_HEALTH` | Hearts indicating the player's vehicle's health | :x: | :white_check_mark: |
|
|
|
|
| `JUMP` | Bar indicating the player's vehicle's jump | :x: | :white_check_mark: |
|
|
|
|
|
|
|
|
## Positions
|
|
|
|
<details>
|
|
|
|
<summary><b>Default</b></summary>
|
|
|
|
Does nothing to the position of the element. This is the default.
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
elements:
|
|
|
|
VEHICLE_HEALTH: default
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>Hidden</b></summary>
|
|
|
|
To configure an element to be invisible to the player, use `hidden`:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
elements:
|
|
|
|
HEALTH: hidden
|
|
|
|
HUNGER: hidden
|
|
|
|
```
|
|
|
|
|
|
|
|
With the generated resource pack, the player's health and hunger bars will now be invisible.
|
|
|
|
</details>
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>In Front</b></summary>
|
|
|
|
To configure an element to be in front of the customized HUD, use `front`:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
elements:
|
|
|
|
EXPERIENCE_LEVEL: front
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures the experience level to always be shown in front of the player's custom HUD. Additionally, you can offset it:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
elements:
|
|
|
|
EXPERIENCE_LEVEL: front
|
|
|
|
x: 0.0
|
|
|
|
y: 20.0
|
|
|
|
```
|
|
|
|
|
|
|
|
This results in an experience number always in front of the HUD but vertically offset downward.
|
|
|
|
</details>
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary><b>Behind</b></summary>
|
|
|
|
To configure an element to be behind the customized HUD, use `behind`:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
elements:
|
|
|
|
EXPERIENCE_LEVEL: behind
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures the experience level to always be shown behind the player's custom HUD.
|
|
|
|
As with `front`, you can choose to offset it:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
elements:
|
|
|
|
EXPERIENCE_LEVEL: behind
|
|
|
|
x: 0.0
|
|
|
|
y: 20.0
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
# HUD Updating
|
|
# HUD Updating
|
|
This documents fields under the `updaters` configuration node. |
|
This documents fields under the `updaters` configuration node. |
|
|
|
\ No newline at end of file |