|
This page serves as a general reference for all fields in MythicHUD's main configuration.
|
|
This page serves as a general reference for all fields in MythicHUD's main configuration.
|
|
|
|
|
|
## General
|
|
# General
|
|
| Field | Default | Description |
|
|
| Field | Default | Description |
|
|
| ----- | ------- | ----------- |
|
|
| ----- | ------- | ----------- |
|
|
| `locale` | `en_US` | Configures the language of messages. Currently, only American English is supported. |
|
|
| `locale` | `en_US` | Configures the language of messages. Currently, only American English is supported. |
|
... | @@ -12,7 +12,7 @@ This page serves as a general reference for all fields in MythicHUD's main confi |
... | @@ -12,7 +12,7 @@ This page serves as a general reference for all fields in MythicHUD's main confi |
|
| `disable-netty-injection` | `false` | Indicates whether Netty injection should be disabled. Reduces memory churn for very specific use cases. Do not touch if you don't know what you are doing. |
|
|
| `disable-netty-injection` | `false` | Indicates whether Netty injection should be disabled. Reduces memory churn for very specific use cases. Do not touch if you don't know what you are doing. |
|
|
| `config-version` | `10` | The configuration version, for compatibility purposes. Do not touch if you don't know what you are doing. |
|
|
| `config-version` | `10` | The configuration version, for compatibility purposes. Do not touch if you don't know what you are doing. |
|
|
|
|
|
|
## Resource Pack
|
|
# Resource Pack
|
|
This documents fields under the `resource-pack` configuration node.
|
|
This documents fields under the `resource-pack` configuration node.
|
|
|
|
|
|
| Field | Default | Description |
|
|
| Field | Default | Description |
|
... | @@ -23,17 +23,123 @@ This documents fields under the `resource-pack` configuration node. |
... | @@ -23,17 +23,123 @@ This documents fields under the `resource-pack` configuration node. |
|
| `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
|
|
|
|
The `support` field configures the client versions supported by the generated resource pack. It has flexibility to allow for many configurations:
|
|
|
|
|
|
### Resources
|
|
### Default
|
|
|
|
By default, the resource pack will support the closed interval from the server's version to the latest version supported by MythicHUD. For example, if your server is 1.21.2, then the generated resource pack will support from 1.21.2 to 1.21.4. However, if your server was 1.21.4, then the generated pack will support only 1.21.4.
|
|
|
|
|
|
### Merge
|
|
### Types
|
|
|
|
<details>
|
|
|
|
<summary>All Versions</summary>
|
|
|
|
You can configure the plugin to generate a resource pack supporting all versions supported by the plugin:
|
|
|
|
|
|
## Boss Bars
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
support: all
|
|
|
|
```
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Single Version</summary>
|
|
|
|
You can configure the plugin to generate a resource pack supporting a single version by directly specifying the version in the field:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
support: 1.20.6
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures MythicHUD to generate a resource pack only supporting 1.20.6.
|
|
|
|
</details>
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Half-Open Version Range</summary>
|
|
|
|
You can configure the plugin to generate a resource pack supporting a half-open version range starting or ending at a particular version.
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
support:
|
|
|
|
min: 1.20.1
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures MythicHUD to generate a resource pack supporting 1.20.1 to the latest version supported by the plugin.
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
support:
|
|
|
|
max: 1.21.3
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures MythicHUD to generate a resource pack supporting the oldest version supported by the plugin up until and including 1.21.3.
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Closed Version Range</summary>
|
|
|
|
You can configure the plugin to generate a resource pack supporting a closed version range starting _and_ ending at a particular version.
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
support:
|
|
|
|
min: 1.20.1
|
|
|
|
max: 1.21.3
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures MythicHUD to generate a resource pack supporting 1.20.1 until 1.21.3, including both endpoints.
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
## Resources
|
|
|
|
The `resources` field takes a list of external resource packs used to extract resources. They can be specified as a URL, file (relative to the `plugin/` folder), or `server_pack`, to use the resource pack configured in the server properties.
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Example</summary>
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
resources:
|
|
|
|
- server_pack
|
|
|
|
- https://example.com/downloads/my_resource_pack.zip
|
|
|
|
- ItemsAdder/contents/merged_pack_1
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures MythicHUD to pull from the provided resource packs, allowing you to reference their assets in your HUD configurations. If you want these assets to be provided in the final resource pack, they need to be merged. See [the following section](#merge) on how to configure pack merging.
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
## Merge
|
|
|
|
The `merge` field is a map which pairs a resource pack (specified in the format described in [Resources](#resources) to a merge strategy.
|
|
|
|
|
|
|
|
| Strategy | Description |
|
|
|
|
| -------- | ----------- |
|
|
|
|
| `OVERRIDE` | Duplicated are overriden silently, meaning the last pack has the last say. |
|
|
|
|
| `FAIL` | Duplicates cause the pack building process to fail exceptionally, ensuring nothing is ever overwritten. |
|
|
|
|
| `KEEP_FIRST` | Ensures packs "respect" what others have already provided, meaning the first pack has the last say. |
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>Example</summary>
|
|
|
|
|
|
|
|
Following from the previous section,
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
resource-pack:
|
|
|
|
merge:
|
|
|
|
server_pack: OVERRIDE
|
|
|
|
"https://example.com/downloads/my_resource_pack.zip": OVERRIDE
|
|
|
|
"ItemsAdder/contents/merged_pack_1": KEEP_FIRST
|
|
|
|
```
|
|
|
|
|
|
|
|
This configures MythicHUD to merge the three packs, ensuring that both the server pack and pack specified by the URL override any conflicting resources, but preventing the IA merged pack from overriding existing resources.
|
|
|
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
# Boss Bars
|
|
This documents fields under the `boss-bar` configuration node.
|
|
This documents fields under the `boss-bar` configuration node.
|
|
|
|
|
|
## Vanilla HUD Elements
|
|
# Vanilla HUD Elements
|
|
This documents fields under the `elements` configuration node.
|
|
This documents fields under the `elements` configuration node.
|
|
|
|
|
|
## 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 |