### Start Gollum Wiki Server for Local Editing

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

Starts the Gollum wiki server, which is typically run from within the cloned wiki directory. It indicates the server is running on port 4567, ready for local content edits.

```shell
gollum
== Sinatra/1.3.5 has taken the stage on 4567 for development with backup from Thin
>> Thin web server (v1.5.0 codename Knife)
>> Maximum connections set to 1024
>> Listening on 0.0.0.0:4567, CTRL+C to stop
```

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

### YAML Example Layout Configuration

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

An example demonstrating the structure of a MythicHUD layout, including multiple elements with their asset, alignment, position, and offset properties.

```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
```

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

### YAML Placeholder Conditions Examples

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Placeholder/diff_version_id=223a6d1b026355a4b3551dd8430a243b0e712968&view=inline

Examples demonstrating how to use the placeholder condition in YAML configuration files. These examples cover hiding elements based on player direction, flying status, and light level.

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

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

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

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

### Example Pack Structure and pack.mcmeta for Overlays

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

Illustrates a typical resource pack structure generated by MythicHUD, featuring an example overlay directory. It also shows the pack.mcmeta configuration that defines the version range for this overlay.

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

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

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

### pack.mcmeta Configuration for Overlays

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions_version_id=66ee4aacfd569df75470e54d2c0dc100a8b96ea8

Shows how to configure overlays in the `pack.mcmeta` file. This example specifies that the `mythichud-example-overlay` should be applied to client versions ranging from 1.20.5 to 1.21.1.

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

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

### Install Gollum Wiki Engine

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

Installs the Gollum wiki engine using RubyGems. This is a prerequisite for managing the wiki locally.

```shell
gem install gollum
```

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

### Example Pack Structure with Overlay

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions_version_id=66ee4aacfd569df75470e54d2c0dc100a8b96ea8

Demonstrates the directory structure of a MythicHUD resource pack including an overlay folder. The overlay folder contains version-specific assets.

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

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

### MythicHUD Example with Default Layout

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/diff_version_id=ed24352745030e181742ab97b61b52b0f265e522&w=1

Shows a comprehensive example of how conditions are used within a default layout configuration in MythicHUD. This specific example hides the oxygen bar until it's in use.

```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
```

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

### MythicHUD Default Layout Example (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/diff_version_id=ed24352745030e181742ab97b61b52b0f265e522&view=parallel

Illustrates a real-world application of conditions within the `default-layout` configuration for MythicHUD. This example specifically shows how to hide the oxygen bar until it's in use by applying a 'progress' condition.

```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
```

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

### Placeholder Condition Examples (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Placeholder/diff_version_id=223a6d1b026355a4b3551dd8430a243b0e712968&view=inline&w=1

Demonstrates various ways to use the Placeholder condition with different data types and logical operators. It requires the Player PAPI expansion for player-specific placeholders.

```yaml
- placeholder{ph=%player_direction%;v=S} false hide
- placeholder{ph=%player_is_flying%;v=yes} true hide
- placeholder{ph=%player_light_level%;v=5;o=>} true hide
```

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

### Pop-Up Asset and Layer Configuration Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Pop-Ups/diff_version_id=95f5bb5fc2d33269c6fa6d0c5a66e90d94931741&view=inline&w=1

An example YAML configuration for the 'death-message' asset and its layers. This defines how the icon, killer text, victim text, and outline are displayed. It includes settings for texture paths, scaling, text content using placeholders like '%arg-1%', font, outlining, alignment, and offsets.

```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
```

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

### MythicHUD Example Conditions (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/diff_version_id=ed24352745030e181742ab97b61b52b0f265e522&view=parallel

Provides practical examples of how to implement conditions in MythicHUD using YAML syntax. These examples demonstrate hiding HUD elements when a layer is empty and changing the HUD color based on a player's potion 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
```

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

### Hide UI based on Player Light Level (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Placeholder/diff_version_id=382e9a70f0db690430368a6a3ba2e57e0b084ff7&view=parallel

This example illustrates hiding a UI element if the player's light level is below a specified threshold. It uses the player_light_level placeholder with a 'greater than' operator to check against a value of 5.

```yaml
- placeholder{ph=%player_light_level%;v=5;o=>} true hide
```

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

### Pop-Up Layout Configuration Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Pop-Ups/diff_version_id=95f5bb5fc2d33269c6fa6d0c5a66e90d94931741&view=inline&w=1

An example of a YAML configuration for a PvP-focused 'Death Message' pop-up. This configuration defines multiple elements ('kill-1' through 'kill-5') using the 'death-message' asset, specifying their alignment, position, and offset to stack them in the upper right of the screen.

```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
```

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

### MythicHUD Animated Asset Configuration

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Fonts/diff_version_id=c56cced86fcd3872b7d086dc53696bffd990d279&view=inline&w=1

Configures an animated asset in MythicHUD to display text from a PlaceholderAPI placeholder using a custom font. This setup is key for creating dynamic in-game visuals.

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

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

### MythicHUD Example Conditions

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/diff_version_id=ed24352745030e181742ab97b61b52b0f265e522&w=1

Illustrates practical examples of using conditions in MythicHUD. These examples demonstrate how to hide HUD elements or change their color based on player effects or progress values.

```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
```

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

### Configure Resource Pack Sources (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin-Configuration/diff_version_id=db010c4dff2d76089947cf3f621726c3ccf0474b&w=1

This example shows how to define multiple sources for external resource packs to be merged. Sources can be file paths relative to the plugins folder, URLs, or a special 'server_pack' keyword.

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

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

### Example Pack Structure for MythicHUD Overlays

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions/diff_version_id=66ee4aacfd569df75470e54d2c0dc100a8b96ea8&w=1

Illustrates the directory structure for a MythicHUD resource pack that includes a custom overlay for specific client versions. This structure is key to organizing version-specific assets.

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

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

### Hide UI based on Player Flight Status (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Placeholder/diff_version_id=382e9a70f0db690430368a6a3ba2e57e0b084ff7&view=parallel

This example demonstrates hiding a UI element if the player is currently flying. It uses the player_is_flying placeholder and checks if its value is 'yes'.

```yaml
- placeholder{ph=%player_is_flying%;v=yes} true hide
```

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

### Hide UI based on Player Direction (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/Placeholder/diff_version_id=382e9a70f0db690430368a6a3ba2e57e0b084ff7&view=parallel

This example shows how to hide a UI element if the player's current direction is not south. It utilizes the player_direction placeholder and checks for a specific value 'S'.

```yaml
- placeholder{ph=%player_direction%;v=S} false hide
```

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

### Example of Merging External Resource Packs (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin-Configuration/diff_version_id=04f1a8d9c5bbf12b126e09a5666f6ed6482f8b40&view=inline&w=1

This YAML configuration demonstrates how to include and merge external resource packs into the main pack. It shows specifying resource packs via URL, file path relative to the plugin folder, or using the server's configured resource pack.

```yaml
resource-pack:
  files:
    - "https://example.com/resourcepack.zip"
    - "./plugins/MyResources/"
    - "server_pack"
  merge:
    "./plugins/MyResources/": KEEP_FIRST
```

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

### MythicHUD Condition Formatting and Examples (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/diff_version_id=ed24352745030e181742ab97b61b52b0f265e522&view=inline

Demonstrates the general format for defining conditions in MythicHUD using YAML. It includes examples of hiding HUD elements based on progress and coloring the HUD based on active effects.

```yaml
conditions:
  - progress{l=fill;o=>;v=0} true hide
  - effect{e=luck} true color green
```

```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
```

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

### YAML Example for Asset Positioning

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Layouts/diff_version_id=afb8c71352487f4d3bdc31e299512abdf23c0774&view=inline

Illustrates how to define the position of an asset within a layout using x and y coordinates. These values range from 0 to 100, representing percentages of the player's screen width and height.

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

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

### Merge Resource Packs Example (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin-Configuration/diff_version_id=04f1a8d9c5bbf12b126e09a5666f6ed6482f8b40&view=inline

This YAML snippet demonstrates how to use the `merge` field to combine multiple resource packs. It illustrates the `KEEP_FIRST` strategy, where the first encountered pack takes precedence for overlapping resources.

```yaml
resource-pack:
  - "pack1.zip"
  - "pack2.zip"
merge:
  "pack1.zip": KEEP_FIRST
  "pack2.zip": KEEP_FIRST
```

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

### Send a Popup Command Example

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Pop-Ups/diff_version_id=95f5bb5fc2d33269c6fa6d0c5a66e90d94931741&view=parallel

Demonstrates the command structure for sending a pop-up to a specific player. It includes the pop-up name, duration in ticks, and arguments. This is a direct in-game method for triggering pop-ups.

```minecraft-command
/happyhud popup Notch action-bar 60 Hello There Notch!
```

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

### YAML Example for Asset Offset

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Layouts/diff_version_id=afb8c71352487f4d3bdc31e299512abdf23c0774&view=inline

Demonstrates how to apply pixel-based offsets to an asset's position. Negative values move the asset left or up, while positive values move it right or down, relative to its defined position.

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

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

### Functional Texture Layer Full Example (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Components/Asset-Layers/diff_version_id=886c8f932a7c613d5a5389c978439a2c77f338b6&view=parallel

A comprehensive example of a Functional Texture Layer, demonstrating texture path, alignment, color, offset, and all function-related configurations including listener, increment, orientation, and reversed status.

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

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

### Configure Vanilla HUD Element Positioning (Front)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Plugin-Configuration/diff_version_id=f73e7a97725e11649df1e3cde49ae0708925b330&view=inline&w=1

This example demonstrates how to set a vanilla HUD element to always be displayed in front of the player's custom HUD, ensuring it remains visible regardless of other UI elements.

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

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

### MythicHUD Example Conditions: Hide and Color (YAML)

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Conditions/diff_version_id=ed24352745030e181742ab97b61b52b0f265e522&view=parallel&w=1

Illustrates practical examples of condition usage in MythicHUD. The first condition hides an element if a 'fill' progress is less than 0, and the second colors the HUD green if the player 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
```

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

### MythicHUD Example Conditions: Effect and Progress

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

Demonstrates how to use 'effect' and 'progress' condition types. The first example colors the HUD green if the player has the 'luck' potion effect. The second hides an element if the 'fill' layer's value is less than 100%.

```yaml
#Color the hud green if the user has the luck effect.
- effect{e=luck} true color green

#Hide if the fill layer is empty.
- progress{l=fill;o=>;v=0} true hide
```

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

### pack.mcmeta Configuration for Overlays

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions/diff_version_id=66ee4aacfd569df75470e54d2c0dc100a8b96ea8&view=parallel

Demonstrates the JSON configuration within `pack.mcmeta` to define version overlays. This specifies the range of client versions (min_inclusive and max_inclusive) for which a particular overlay directory should be applied.

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

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

### pack.mcmeta Configuration for Overlays

Source: https://git.mythiccraft.io/mythiccraft/mythichud/-/wikis/Supporting-Multiple-Versions_version_id=843aa00c359871ed0ef050b43e5f0efe51dbfe94

Demonstrates the JSON structure within a `pack.mcmeta` file that defines overlays. This configuration specifies the inclusive minimum and maximum client pack formats for which an overlay is applied, along with the directory containing the overlay's assets.

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