Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The MythicHud Extension bridges TypeWriter’s dialogue system with the MythicHUD plugin. It enables spoken dialogue with typing effects, option-based choice dialogues, cinematic segments, and look-at-audience popups — all powered by MythicHUD’s command-based popup system.

​
Key Features

Spoken Dialogue

Typing animation with per-character sound support.

Option Dialogue

Interactive choice menus with grid navigation and scrollable option window.

Cinematic Dialogue

Multi-segment cinematic sequences with typing effects.

Look Audience

Contextual popups when a player looks at a position.

​
Installation

  1. Place TypeWriter-MythicHudExtension.jar in plugins/TypeWriter/extensions/
  2. Copy the YAML templates from the JAR to plugins/MythicHUD/:
    • assets/typewriter_spoken_asset.yml
    • assets/typewriter_option_asset.yml
    • assets/typewriter_look_asset.yml
    • popups/typewriter_spoken_dialogue.yml
    • popups/typewriter_option_dialogue.yml
    • popups/typewriter_look_popup.yml
  3. Run /hud reload to register the new assets and popups
  4. Run /typewriter reload to load the extension

​
Commands

MythicHUD popups are triggered by commands dispatched automatically by the extension: 
/happyhud popup <player> <popup_id> <ticks> <arg1|arg2|...>
Arguments are pipe-separated (|) and become %arg-1%, %arg-2%, etc. in the popup YAML text layers.

​
Comparison with BetterHUD Extension

FeatureBetterHUDMythicHUD
Popup APIProgrammatic (Java events)Command-based (/happyhud popup)
Update frequencyEvery tick (~50ms)Every ~250ms (throttled)
Variable injectionUnlimited (Map)Up to 28 arguments
YAML customizationNoYes (editable assets/popups)
Typing soundYesYes
Scroll windowYesYes

​
Interface Variables

​
Spoken Dialogue

ArgumentVariableDescription
%arg-1%speakerDisplay name of the speaking character
%arg-2%textCurrent text being typed out
%arg-3%progressInteger percentage (0-100)
%arg-4%percentageFloat percentage (0.00-1.00)
%arg-5%instruction"finish" or "continue"
%arg-6%is_complete"true" or "false"
%arg-7%pressbutton”Press X to continue” text

​
Option Dialogue

ArgumentDescription
%arg-1%Speaker name
%arg-2%Dialogue text
%arg-3%Progress 0-100
%arg-4%Animation complete (true/false)
%arg-5%Instruction text
%arg-6%Total option count
%arg-7%Selected index (absolute)
%arg-8%Selected option text
%arg-9%Timer remaining (seconds)
%arg-10%–%arg-19%Option texts (visible window)
%arg-20%–%arg-28%Scroll window metadata