Skip to content

GitLab

Last edited by wordandahalf
Page history
This is an old version of this page. You can view the most recent version or browse the history.

Plugin Configuration

This page serves as a general reference for all fields in MythicHUD's main configuration.

General

Field Default Description
locale en_US Configures the language of messages. Currently, only American English is supported.
generate-default-files true Indicates whether the plugin should attempt to generate the default HUD files on startup.
layout.default [] A list of layout names that are given to players by default.
check-update 5 The number of ticks between HUD placeholder updates.
decimal-format #.## The format which decimal-valued placeholders are presented in the HUD.
disable-geyser-players true Indicates whether HUDs should be sent to Bedrock players connected via Geyser.
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.

Resource Pack

This documents fields under the resource-pack configuration node.

Field Default Description
support (more) Configures the client versions supported by the generated resource pack. More.
description (version info.) The description of the resource pack displayed to clients.
resources [] A list of resource packs used to pull assets. More.
merge {} A mapping of pack locations to merge strategy for inclusion in the final resource pack. More.
destination MythicHUD/built-pack The folder (or .zip file) relative to the plugins/ folder where the generated resource pack should be placed.

Support

The support field configures the client versions supported by the generated resource pack. It has flexibility to allow for many configurations:

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.

Types

All Versions You can configure the plugin to generate a resource pack supporting all versions supported by the plugin: 
resource-pack:
    support: all
Single Version You can configure the plugin to generate a resource pack supporting a single version by directly specifying the version in the field: 
resource-pack:
    support: 1.20.6

This configures MythicHUD to generate a resource pack only supporting 1.20.6.

Half-Open Version Range You can configure the plugin to generate a resource pack supporting a half-open version range starting or ending at a particular version. 
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.

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.

Closed Version Range You can configure the plugin to generate a resource pack supporting a closed version range starting _and_ ending at a particular version. 
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.

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.

Example 
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 on how to configure pack merging.

Merge

The merge field is a map which pairs a resource pack (specified in the format described in 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.
Example

Following from the previous section,

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.

Boss Bars

This documents fields under the boss-bar configuration node.

Field Default Description
max 7 The maximum number of boss bars that can be passed through to the player.
hud-position 4 Which boss bar is used to display the HUD to players. Cannot exceed max.
color YELLOW Which color is used for passthrough boss bars.

Vanilla HUD Elements

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 ✅ ✅
HEALTH Hearts indicating the player's health ❌ ✅
ARMOR Armor plates indicating the player's equipped armor ❌ ✅
HUNGER Porkchops indicating the player's hunger ❌ ✅
AIR Bubbles indicating the player's remaining air ❌ ✅
EXPERIENCE Bar indicating the player's progress towards the next experience level ❌ ✅
VEHICLE_HEALTH Hearts indicating the player's vehicle's health ❌ ✅
JUMP Bar indicating the player's vehicle's jump ❌ ✅

Positions

Default Does nothing to the position of the element. This is the default. 
elements:
    VEHICLE_HEALTH: default
Hidden To configure an element to be invisible to the player, use `hidden`: 
elements:
    HEALTH: hidden
    HUNGER: hidden

With the generated resource pack, the player's health and hunger bars will now be invisible.

In Front To configure an element to be in front of the customized HUD, use `front`: 
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:

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.

Behind To configure an element to be behind the customized HUD, use `behind`: 
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:

elements:
    EXPERIENCE_LEVEL: behind
        x: 0.0
        y: 20.0

HUD Updating

This documents fields under the updaters configuration node.