MythicHUD

https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis
Admin
MythicHUD is a Minecraft plugin for creating and customizing heads-up displays (HUDs) with layouts,...
Tokens:15,263
Snippets:245
Trust Score:8.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Static Texture Layer Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Example configuration for a static texture layer. Useful for backgrounds or static icons.

```yaml
outline:
  texture:
    path: assetsvanilla/exp_bar_short_outline.png
  align: right
  outlined: false
  color: white
  offset:
    x: 0
    y: 0
```

--------------------------------

### Nameplate Text Layer Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Example configuration for a nameplate text layer with a dynamic background. Uses player name as text content.

```yaml
nameplate:
  text: "%player_name%"
  font: default
  align: center
  background:
    texture: assets/death-message/outline.png
    cap: 5
    padding: 3
  offset:
    x: 0
    y: 0
```

--------------------------------

### Example Layout Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Layouts

Demonstrates a complete layout configuration with multiple elements, including their asset, alignment, position, and offset. This example shows how to position health, food, armor, and air indicators.

```yaml
default-layout:
  elements:
    health:
      asset: 'vanilla-health'
      align: left
      position:
        x: 50.0
        y: 0
      offset:
        x: -10
        y: 55
    food:
      type: 'asset'
      asset: 'vanilla-hunger'
      align: right
      position:
        x: 50.0
        y: 0.0
      offset:
        x: 10
        y: 55
    armor:
      asset: 'vanilla-armor'
      align: left
      position:
        x: 50.0
        y: 0.0
      offset:
        x: -10
        y: 65
    air:
      asset: 'vanilla-air'
      align: right
      position:
        x: 50.0
        y: 0.0
      offset:
        x: 10
        y: 65
```

--------------------------------

### Head Layer Examples

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Demonstrates how to configure layers to display the current player's head or the head of the last attacker using PlaceholderAPI.

```yaml
self-head:
  head:
    size: 4
  align: left
  offset:
    x: 0
    y: 0

killer-head:
  head:
    size: 4
    target: "%last_attacker%"
  align: left
  offset:
    x: 36
    y: 0
```

--------------------------------

### pack.mcmeta Configuration for Overlays

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions

Shows how to configure resource pack overlays in `pack.mcmeta`. This example defines an overlay named `mythichud-example` that is applied to client versions between 1.20.5 and 1.21.1.

```json
{
  "overlays": {
    "entries": [{
      "formats": {
        "min_inclusive": 32,
        "max_inclusive": 34
      },
      "directory": "mythichud-example-overlay"
    }]
  }
}
```

--------------------------------

### Placeholder Condition Examples

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Placeholder

Demonstrates various ways to use the placeholder condition for hiding elements based on player attributes. These examples utilize the Player PAPI expansion.

```yaml
# Hide if player's direction is not south.
- placeholder{ph=%player_direction%;v=S} false hide
```

```yaml
# Hide if player is flying.
- placeholder{ph=%player_is_flying%;v=yes} true hide
```

```yaml
# Hide if player's light level is less than 5.
- placeholder{ph=%player_light_level%;v=5;o=>} true hide
```

--------------------------------

### Conditional HUD Layout Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions

This example shows the 'default-layout' using a condition to hide the oxygen bar until its value is in use, demonstrating practical application of conditions within a HUD configuration.

```yaml
vanilla-air:
  conditions:  #Hide if the fill layer is empty.
    - progress{l=fill;o=<;v=100%} true hide
  layers:
    icon:
      texture:
        path: assets/vanilla/air.png
      offset:
        x: -5
        y: 2
    fill:
      texture:
        path: assets/vanilla/exp_bar_short_fill.png
      color: "#525aff"
      offset:
        x: 0
        y: 0
      function:
        listener: air
        increment: 13
        orientation: horizontal
    outline:
      texture:
        path: assets/vanilla/exp_bar_short_outline.png
```

--------------------------------

### Example Command to Send a Popup

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Pop-Ups

This command sends a pop-up to a specific player. The popup will display for a set duration and can include arguments.

```minecraft-commands
/mythichud popup Notch action-bar 60 Hello There Notch!
```

--------------------------------

### Functional Texture Layer Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Example configuration for a functional texture layer representing a health bar. Links to the 'health' listener and has horizontal depletion.

```yaml
fill:
  texture:
    path: assets/vanilla/exp_bar_short_fill.png
  align: right
  outlined: false
  color: "#f23a3a"
  scale: 0.5
  offset:
    x: 0
    y: 0
  function:
    listener: health
    increment: 13
    orientation: horizontal
    reversed: false
```

--------------------------------

### Resource Pack Inclusion Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Specifies a list of external resource packs to be used for extracting assets. These can be local paths, URLs, or the server's own resource pack.

```yaml
resource-pack:
    resources:
        - server_pack
        - https://example.com/downloads/my_resource_pack.zip
        - ItemsAdder/contents/merged_pack_1
```

--------------------------------

### Mythic Condition Examples - MythicHUD

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/MythicConditions

Use this condition to hide elements, change colors, or modify textures based on MythicMobs conditions. Ensure MythicMobs is installed.

```yaml
conditions:
# Hide if player is not on the ground.
- mythic{onGround} false hide
# Color the hud red if player is in combat.
- mythic{inCombat} true color red
# Change texture at night.
- mythic{night} true texture assets/hud/night_overlay.png
```

--------------------------------

### Resource Pack Support: Minimum Version Range

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the resource pack to support a version range starting from a specified minimum version up to the latest supported by MythicHUD. Useful for supporting newer clients.

```yaml
resource-pack:
    support:
        min: 1.20.1
```

--------------------------------

### Configure HUD Update Events

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

This example shows how to disable HUD updates for most events and enable them only for player respawning. It complements the general update interval configuration.

```yaml
updaters:
    CONSUMING: false
    RESPAWNING: true
    ARMOR: false
    AIR: false
    EXPERIENCE: false
```

--------------------------------

### Resource Pack Merge Strategy Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures how to merge external resource packs into the final pack, specifying a strategy for handling duplicate assets. The 'OVERRIDE' strategy means the last pack in the list takes precedence.

```yaml
resource-pack:
    merge:
        server_pack: OVERRIDE
        "https://example.com/downloads/my_resource_pack.zip": OVERRIDE
        "ItemsAdder/contents/merged_pack_1": KEEP_FIRST
```

--------------------------------

### Check for LUCK Potion Effect

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Effect

This example demonstrates how to color an asset green if the player has the LUCK potion effect. The 'e' alias is used for 'effect'.

```yaml
lucky_charm:
  conditions:
  - effect{e=luck} true color green
  layers:
    icon:
      texture:
        path: assets/luck/clover.png
      offset:
        x: -5
        y: 2
```

--------------------------------

### Multiple Conditions Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions

Shows how to apply multiple conditions to a HUD element. The first condition hides the HUD if the 'fill' layer is empty, and the second colors the HUD green if the user has the 'luck' effect.

```yaml
conditions:  #Hide if the fill layer is empty.
  - progress{l=fill;o=>;v=0} true hide
#Color the hud green if the user has the luck effect.
  - effect{e=luck} true color green
```

--------------------------------

### Custom Font Configuration Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Fonts

Defines a custom font named 'custom-font' using a bitmap provider. It maps specific Unicode characters to icons within a sprite sheet. This is useful for replacing standard characters with custom visuals.

```yaml
custom-font:
  providers:
    # standard space characters unchanged
    spaces:
      type: "space"
      advances:
        " ": 4
        "\u200c": 0
    # remapped unicode characters to icons:
    nonlatin-european:
      type: "bitmap"
      texture: font/custom-font/sprites.png
      height: 8
      chars:
        - "\u00a1\u2030\u00ad\u00b7"
        - "\u20b4\u2260\u00bf\u00d7"
        - "\u00d8\u00de\u04bb\u00f0"
        - "\u00f8\u00fe\u0391\u0392"
```

--------------------------------

### Get Player HudHolder

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/MythicHUD-API

Retrieve the HudHolder for a specific player. This is necessary for managing their HUD layouts.

```java
MythicHUD.getInstance().holders().getPlayer(Player);
HudHolder.get(Player);
```

--------------------------------

### Accessing and Modifying Player HUD Layouts with HudHolder

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/MythicHUD%20API

Demonstrates how to get a player's HudHolder and use it to add, remove, or check for active HUD layouts. Returns early if the HudHolder is not found.

```java
public static void test(Player player) {
  HudHolder holder = MythicHUD.getInstance().holders().getPlayer(player);
  if (holder == null) return;
  
  holder.addLayout(hudLayout);
  holder.removeLayout(hudLayout);
  Optional<ActiveLayout> activeLayout = holder.getActiveLayout("hudlayout");
  if (activeLayout.isPresent()) {
  }
}
```

--------------------------------

### Hide HUD element if air is less than 100%

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Progress

This example demonstrates how to hide an asset in the HUD layout if the 'air' listener in the 'fill' asset layer is less than 100%. It uses the 'progress' condition with a less than operator.

```yaml
vanilla-air:
  conditions:  #Hide if the fill layer is empty.
    - progress{l=fill;o=<;v=100%} true hide
  layers:
    icon:
      texture:
        path: assets/vanilla/air.png
      offset:
        x: -5
        y: 2
    fill:
      texture:
        path: assets/vanilla/exp_bar_short_fill.png
      color: "#525aff"
      offset:
        x: 0
        y: 0
      function:
        listener: air
        increment: 13
        orientation: horizontal
```

--------------------------------

### Resource Pack Structure with Overlay

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions

Illustrates a typical resource pack structure when using MythicHUD overlays. The `built-pack` directory contains the main assets and the version-specific overlay folder.

```text
MythicHUD
    └── built-pack
        ├── assets
        ├── mythichud-example-overlay
        │   └── assets
        ├── pack.mcmeta
        └── pack.png
```

--------------------------------

### Resource Pack Support: All Versions

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the resource pack to support all client versions compatible with MythicHUD. This is a simple way to ensure broad compatibility.

```yaml
resource-pack:
    support: all
```

--------------------------------

### Basic Condition Syntax

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions

Illustrates the general structure for defining conditions, including type, arguments, outcome, and action.

```yaml
conditions:
- <condition type>{<condition arguments>} <outcome> <action> <action variable>
```

--------------------------------

### Custom Mana Listener Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Listeners

Configure a custom listener for mana using PlaceholderAPI placeholders. This YAML file defines the current mana value and the maximum mana, which are used for display and bar fill calculations.

```yaml
mana:
  value: '%mmocore_mana%'
  max: '%mmocore_stat_max_mana%'
```

--------------------------------

### Hide Asset Based on Gamemode

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Gamemode

Use this condition to hide a HUD asset if the player is in a specified gamemode. This example hides the `lucky_charm` asset when the player is in Creative or Spectator mode.

```yaml
lucky_charm:
  conditions:
  - gamemode{gm=creative,spectator} false hide
  layers:
    icon:
      texture:
        path: assets/luck/clover.png
      offset:
        x: -5
        y: 2
```

--------------------------------

### Configure MythicHUD Resource Pack Copying

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Compatibility

Enable and configure MythicHUD to copy its resource pack assets to a specified directory. This is useful for integrating with other plugins that manage resource packs.

```yaml
copy-resource-pack:
  enabled: false
  namespaces:
    minecraft: "myPack/assets"
    mythichud: "myPack/assets"
```

--------------------------------

### Configure MythicHUD Asset Path for ItemsAdder

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Compatibility

Set the destination path for MythicHUD's resource pack assets when integrating with ItemsAdder. This ensures ItemsAdder can correctly locate and use the HUD assets.

```yaml
copy-pack:
  enabled: true
  path: ItemsAdder/contents/mythichud/resourcepack
```

--------------------------------

### GradleKts Dependency for MythicHUD API

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/MythicHUD%20API

Add this to your build.gradle.kts file to include the MythicHUD API. Ensure you replace $VERSION with the correct API version.

```gradle
repositories {
  maven("https://mvn.lumine.io/repository/maven-releases/")
  # For Snapshots
  #maven("https://mvn.lumine.io/repository/maven-snapshots/")
}

dependencies {
  compileOnly("io.limine.mythichud:api:$VERSION")
}
```

--------------------------------

### Resource Pack Support: Maximum Version Range

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the resource pack to support a version range from the oldest supported by MythicHUD up to and including a specified maximum version. Useful for supporting older clients.

```yaml
resource-pack:
    support:
        max: 1.21.3
```

--------------------------------

### Vanilla Air Asset Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Assets

This YAML configuration defines the 'vanilla-air' asset. It includes conditions for visibility based on oxygen levels and specifies multiple layers (icon, fill, outline) with their respective textures, offsets, and functions.

```yaml
vanilla-air:
  conditions: # Only visible when below 100% oxygen
    - progress{l=fill;o=<;v=100%} true hide
  layers:
    icon:
      texture:
        path: assets/vanilla/air.png
      offset:
        x: -5
        y: 2
    fill:
      texture:
        path: assets/vanilla/exp_bar_short_fill.png
      color: "#525aff"
      offset:
        x: 0
        y: 0
      function:
        listener: air
        increment: 13
        orientation: horizontal
    outline:
      texture:
        path: assets/vanilla/exp_bar_short_outline.png
```

--------------------------------

### Configure Overlays for Modern Versions

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Advanced-Version-Support

This JSON configuration snippet is used in pack.mcmeta to define overlays for modern Minecraft versions. Ensure the 'mythichud-modern' directory is placed at the root of your resource pack.

```json
"overlays": {
    "entries": [
      {
        "formats": {
          "min_inclusive": 32,
          "max_inclusive": 34
        },
        "directory": "mythichud-modern"
      }
    ]
  }
```

--------------------------------

### Text Layer Background Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configure a dynamic background for text layers. The texture is sliced into caps and a tileable center. Set 'background.texture' to enable.

```yaml
background:
  texture: ui/text_bg
  cap: 4
  padding: 2
  offset:
    y: 0
```

--------------------------------

### Functional Texture Layer Listener Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configure the listener for a functional texture layer to determine the percentage fill of a bar.

```yaml
function:
    listener: health
```

--------------------------------

### Pop-Up Asset and Asset Layers Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Pop-Ups

Configures the visual components of the 'death-message' pop-up, including an icon, killer name, victim name, and an outline texture.

```yaml
death-message:
  layers:
    icon:
      texture:
        scale: 0.5
        path: assets/death-message/icon.png
      offset:
        x: 86
        y: -2
    killer:
      text: "%arg-1%"
      font: "default"
      outlined: true
      align: left
      offset:
        x: 80
        y: -2
    victim:
      text: "%arg-2%"
      font: "default"
      outlined: true
      align: right
      offset:
        x: 100
        y: -2
    outline:
      texture:
        path: assets/death-message/outline.png
```

--------------------------------

### Maven Dependency for MythicHUD API

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/MythicHUD%20API

Add this to your pom.xml file to include the MythicHUD API. Ensure you replace $VERSION with the correct API version.

```xml
<dependency>
  <groupId>io.lumine.mythichud</groupId>
  <artifactId>api</artifactId>
  <version>$VERSION</version>
  <scope>provided</scope>
</dependency>
```

--------------------------------

### Resource Pack Support: Single Version

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the resource pack to support only a specific client version. Use this when targeting a precise Minecraft version.

```yaml
resource-pack:
    support: 1.20.6
```

--------------------------------

### Enable Crucible Resource Pack Merging

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Compatibility

Configure Crucible to automatically merge MythicHUD's assets into its resource pack. Ensure to reload MythicHUD before generating the Crucible pack for asset updates.

```yaml
Generation:
  MergeMythicHUD: true
```

--------------------------------

### Pop-Up Layout Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Pop-Ups

Defines the arrangement and positioning of multiple 'death-message' assets on the screen, suitable for a PvP-focused death notification.

```yaml
death-message:
  elements:
    kill-1:
      asset: death-message
      align: left
      position:
        x: 100.0
        y: 100.0
      offset:
        x: -20
        y: -20
    kill-2:
      asset: death-message
      align: left
      position:
        x: 100.0
        y: 100.0
      offset:
        x: -20
        y: -40
    kill-3:
      asset: death-message
      align: left
      position:
        x: 100.0
        y: 100.0
      offset:
        x: -20
        y: -60
    kill-4:
      asset: death-message
      align: left
      position:
        x: 100.0
        y: 100.0
      offset:
        x: -20
        y: -80
    kill-5:
      asset: death-message
      align: left
      position:
        x: 100.0
        y: 100.0
      offset:
        x: -20
        y: -100
```

--------------------------------

### Configure ItemsAdder HUD Settings

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Compatibility

Adjust ItemsAdder's HUD settings, specifically disabling 'enabled' and 'force_color' for 'huds', to ensure compatibility with MythicHUD's 'hide exp level' feature.

```yaml
huds:
  enabled: false
  force_color:
    enabled: false
    color: '#FFFFFF'
```

--------------------------------

### Head Layer Target Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Specifies which player's head to display. Supports player names, UUIDs, and PlaceholderAPI placeholders. Defaults to the HudHolder's head if not specified.

```yaml
head:
  target: boy0000
  #target: 9cc444cd-47cf-4660-96b7-17a7bfef302c
  #target: "%some_placeholder%"
```

--------------------------------

### Resource Pack Support: Closed Version Range

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the resource pack to support a specific closed version range, including both the minimum and maximum specified versions. Ideal for targeting a precise set of client versions.

```yaml
resource-pack:
    support:
        min: 1.20.1
        max: 1.21.3
```

--------------------------------

### Reposition Experience Level

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Vanilla-HUD-Repositioning

Configure the layer and X/Y coordinates to reposition the experience level number. Positive X moves right, negative Y moves up.

```yaml
elements:
    EXPERIENCE_LEVEL:
        layer: front
        x: 50
        y: -25
```

--------------------------------

### Asset Layer Shadow Outline

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configures a shadow-backdrop outline for an asset layer. Supports HEX color codes with alpha.

```yaml
  shadow: "#ff0000ff"
```

--------------------------------

### Single Inline Condition

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions

Demonstrates the shorthand for applying a single condition directly as a string, rather than a list.

```yaml
conditions: progress{l=fill;o=>;v=0} true hide
```

--------------------------------

### Animated HUD Asset Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Fonts

Configures an animated HUD element named 'anim' that displays text from a PlaceholderAPI placeholder. It specifies the font to use for rendering the placeholder's output.

```yaml
anim:
  layers:
    display:
      text: "%icon_sparkle%"
      font: "sparkle"
      outlined: false
      align: center
      offset:
        x: 0
        y: 0
```

--------------------------------

### Asset Layer Offset Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Sets the core positioning of an asset layer relative to the asset's origin. Can be configured as a map or a comma-separated string.

```yaml
  offset:
    x: -5  # pixels left/right
    y: 2   # pixels up/down
    z: 0   # render layer (depth), optional
```

```yaml
  offset: "-5, 2"      # x: -5, y: 2
```

```yaml
  offset: "-5, 2, 1"   # x: -5, y: 2, z: 1
```

--------------------------------

### Head Layer Size Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Sets the pixel size for each individual pixel of the player's skin displayed in the HUD. The default size is 4, resulting in a 32x32 pixel display.

```yaml
head:
  size: 4  # default, renders as a 32px square
```

--------------------------------

### Asymmetric Text Layer Background

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configure asymmetric background caps and padding for text layers. Allows different stretching behavior for left and right sides.

```yaml
background:
  texture: ui/text_bg
  cap:
    left: 6
    right: 2
  padding:
    left: 4
    right: 4
```

--------------------------------

### Static Repeated Texture Layer

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configures a static texture layer to repeat an icon a fixed number of times with specified spacing. Useful for background elements like empty hearts.

```yaml
empty-hearts:
  texture:
    path: assets/vanilla/heart_empty.png
    type: repeated
    increment: 10   # always draw 10 empty hearts
    spacing: 1      # 1px between each heart
  align: left
  offset:
    x: 0
    y: 0
```

--------------------------------

### Asset Layer Color Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Applies color to an asset layer, such as tinting a texture or setting font color. Supports named colors and HEX codes.

```yaml
  color: white
```

```yaml
  color: "#ffbb00"
```

--------------------------------

### Asset Layer Scale Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Scales the asset layer, adjusting the pixel resolution of the input texture by a multiplier.

```yaml
  scale: 0.5
```

--------------------------------

### Set EXPERIENCE_LEVEL element to front

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the EXPERIENCE_LEVEL element to always be shown in front of the player's custom HUD. This setting is only applicable to elements that can be moved.

```yaml
elements:
    EXPERIENCE_LEVEL: front
```

--------------------------------

### Functional Texture Layer Orientation Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configure the orientation for a functional texture layer's depletion. Can be 'horizontal' or 'vertical'.

```yaml
function:
    orientation: horizontal
```

--------------------------------

### Set EXPERIENCE_LEVEL element to front with Y offset

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the EXPERIENCE_LEVEL element to be shown in front of the HUD with a vertical offset downwards. This setting is only applicable to elements that can be moved.

```yaml
elements:
    EXPERIENCE_LEVEL: front
        x: 0.0
        y: 20.0
```

--------------------------------

### Display HUD Element in Front with Offset

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin-Configuration

Positions a HUD element in front of the custom HUD and applies a vertical and horizontal offset. This is applicable to elements that can be moved.

```yaml
elements:
    EXPERIENCE_LEVEL: front
    x: 0.0
    y: 20.0
```

--------------------------------

### Define Element Position

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Layouts

Specifies the position of an element relative to the player's screen size using percentage values. This can be written as a nested structure or an inline string.

```yaml
position:
  x: 50
  y: 50
```

```yaml
position: "50, 50"
```

--------------------------------

### Functional Texture Layer Reversed Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configure whether a functional texture layer should deplete in reverse. Defaults to false.

```yaml
function:
    reversed: true
```

--------------------------------

### Define Element Offset

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Layouts

Specifies pixel-based adjustments to an element's position for fine-tuning placement. This can be written as a nested structure or an inline string.

```yaml
offset:
  x: -5  # pixels left/right
  y: 2   # pixels up/down
```

```yaml
offset: "-5, 2"
```

--------------------------------

### Configure ItemsAdder Text Effects and Shaders

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Compatibility

Disable specific text effect and scoreboard number hiding features in ItemsAdder to prevent conflicts with MythicHUD displays. This configuration is necessary for proper HUD rendering.

```yaml
text_effects:
  enabled: false
  hide_scoreboard_numbers: false
  hide_scoreboard_numbers_old_clients: false
```

--------------------------------

### Set EXPERIENCE_LEVEL element to behind

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the EXPERIENCE_LEVEL element to always be shown behind the player's custom HUD. This setting is only applicable to elements that can be moved.

```yaml
elements:
    EXPERIENCE_LEVEL: behind
```

--------------------------------

### Functional Repeated Texture Layer

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configures a functional texture layer to repeat an icon based on a listener's value, scaling the number of copies drawn. Ideal for dynamic icon bars like health indicators.

```yaml
hearts:
  texture:
    path: assets/vanilla/heart.png
    type: repeated
  align: left
  offset:
    x: 0
    y: 0
  function:
    listener: health
    increment: 10   # full health shows 10 hearts
    spacing: 1      # 1px between each heart
```

--------------------------------

### Functional Texture Layer Increment Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers

Configure the increment for a functional texture layer, determining how many sections the bar texture should split into.

```yaml
function:
    increment: 13
```

--------------------------------

### Hide HEALTH and HUNGER elements

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the HEALTH and HUNGER elements to be invisible to the player. Only elements that can be hidden can use this setting.

```yaml
elements:
    HEALTH: hidden
    HUNGER: hidden
```

--------------------------------

### Set EXPERIENCE_LEVEL element to behind with Y offset

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin%20Configuration

Configures the EXPERIENCE_LEVEL element to be shown behind the HUD with a vertical offset downwards. This setting is only applicable to elements that can be moved.

```yaml
elements:
    EXPERIENCE_LEVEL: behind
        x: 0.0
        y: 20.0
```

--------------------------------

### Hide Experience Level

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Vanilla-HUD-Repositioning

Set the layer to 'hidden' to completely conceal the experience level number from the HUD.

```yaml
elements:
    EXPERIENCE_LEVEL: hidden
```

--------------------------------

### Display HUD Element Behind with Offset

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin-Configuration

Positions a HUD element behind the custom HUD and applies a vertical and horizontal offset. This is applicable to elements that can be moved.

```yaml
elements:
    EXPERIENCE_LEVEL: behind
    x: 0.0
    y: 20.0
```

--------------------------------

### Custom Font for Animation Frames

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Fonts

Defines a custom font named 'sparkle' for use in animations. It maps a range of Unicode characters to individual sprites within a texture file. This font is intended to be used with a PlaceholderAPI placeholder delivering sequential Unicode characters.

```yaml
sparkle:
  providers:
    spaces:
      type: "space"
      advances:
        " ": 4
        "\u200c": 0
    ascii:
      type: "bitmap"
      texture: font/sparkles.png
      height: 12
      chars:
        - "\u8080\u8081\u8082\u8083\u8084"
        - "\u8085\u8086\u8087\u8088\u8089"
```
Tokens:
Raw