Skip to main content
Critical Health FX wiki

Wiki

Critical Health FX Wiki

Low-health visuals, heartbeat audio, blackout tuning, frost pulses, tier extras, and the public admin workflow for CriticalHealthFX.

Getting Started

Install the plugin cleanly, validate the startup state, and learn the admin command surface before deeper tuning.

Core Tuning

Set the activation threshold, shape the vignette, and tune the audio and overlay layers that define the low-health loop.

GUI and Editing

Use the in-game editor safely, understand what each page owns, and decide when YAML is still the better tool.

Runtime and Troubleshooting

Use presets deliberately, force test mode safely, and troubleshoot the common reasons the effect feels missing or wrong.

GUI and Editing

GUI Main Pages, Chat Prompts, and Save Flow

Understand the main inventory pages, click editing, chat prompts, and how GUI changes persist back into `config.yml`.

CriticalHealthFX is designed so staff can do most public editing from the GUI and still keep config.yml as the saved source of truth.

Opening the GUI

Use:

TEXT
/chfx gui

Running /chfx with no arguments as a player also opens the GUI in the current build.

The main page layout

The main menu is the dashboard for the whole plugin. It links into:

  • Presets
  • General
  • Border Vignette
  • Heartbeat
  • Blackout
  • Darkness
  • Frost Corners
  • Tiers
  • Debug
  • About

That matches the actual public configuration surface rather than hiding important settings in YAML only.

What each page is for

Presets

Apply the built-in profile sets:

  • MCWAR Default
  • Subtle
  • Hardcore
  • Off

General

Edit:

  • enabled
  • critical_threshold_hp
  • scan_period_ticks
  • allowed gamemodes

Border

Edit:

  • warning_blocks
  • warning_time
  • center_update_period_ticks
  • center_update_min_distance
  • border re-apply behavior

Heartbeat

Edit:

  • global heartbeat enable state
  • global sound key
  • global volume

Blackout and Darkness

Edit the potion-overlay thresholds and visibility flags.

Frost

Edit:

  • frost enable state
  • HP trigger
  • pulse timing
  • pulse chance
  • max intensity
  • biome whitelist

Tiers

Manage:

  • add tier
  • remove last tier
  • reset to MCWAR defaults
  • open a specific tier editor
  • global toggles for tier potions and tier particles

Debug

Toggle:

  • debug actionbar
  • log state changes

About

Quick identity page for:

  • plugin name
  • author duq_
  • example server mcwar.co
  • Paper-first design notes

Click editing behavior

Most numeric fields use click editing:

  • left click and right click change the value
  • shift click uses a larger step
  • the lore on the item tells you the current value and the intended direction

This is the normal editing flow for thresholds, scan cadence, warning values, durations, pitch, chance, offsets, and most counts.

Chat prompt editing

Some values are better typed in chat than cycled in an inventory. The GUI uses prompts for things like:

  • sound keys
  • biome keys
  • token-style effect names
  • particle type names
  • dust colors

When the GUI closes for a prompt:

  1. type the new value in chat
  2. or type cancel
  3. the plugin reopens the previous page after the input is handled

What gets saved

The GUI writes back into config.yml, then reloads the plugin's local runtime settings. That means the GUI is not some separate hidden state layer. It is editing the same config you would edit by hand.

When YAML is still the better tool

Use config.yml directly when:

  • you want to rename several tiers cleanly
  • you want to paste a long particle list
  • you want to edit many biome keys at once
  • you want version-controlled diff history on every change

Use the GUI when:

  • you are tuning numbers live
  • you want to compare the feel of changes immediately
  • a staff member needs safe access to the public editing surface

Good editing habits

Save your mental model first

Do not start by changing everything. Decide whether you are tuning:

  • activation threshold
  • border intensity
  • audio pacing
  • overlay thresholds
  • tier extras

Then stay in that lane until the feel is right.

Use test mode while editing

Run:

TEXT
/chfx test on

before deep live tuning. That makes it much easier to feel each change without setting up repeated damage.

Keep one YAML check pass before release

Even if you did most edits in the GUI, open config.yml once before release and confirm the file still reads the way you intend.

Next pages