Skip to main content

Overlay Engine

The Overlay Engine is GUIFX’s original visual system. It places your artwork over matching Bukkit inventory menus without changing the underlying menu plugin.

What an overlay theme can include​

  • Static full-canvas artwork
  • Ambient looping overlay frames
  • Original-title replacement or title preservation
  • Opening transitions
  • Click feedback, including per-slot full-overlay states
  • Slot widgets with static or animated artwork
  • Open, click, and close sounds
  • Permission-based theme variants

Overlay art is stored under plugins/GUIFX/graphics/. It never shares a folder or registry with native Client UI artwork.

A menu file decides when GUIFX should match an inventory. A theme file decides how that match looks.

# menus/ocean_market.yml
id: ocean_market
enabled: true

match:
  title_contains: "Ocean Market"
  rows: 6
  type: CHEST

theme: ocean_market
# themes/ocean_market.yml
id: ocean_market
display-name: "Ocean Market"

overlay:
  enabled: true
  rows: 6
  mode: static
  image: static/ocean_market.png

  size:
    width: 256
    height: 256

  position:
    offset-x: -8
    offset-y: 0

Studio can generate both files visually, including slot widget placement and animation frame lists.

Animation wording​

An overlay animation is a server-controlled GUIFX effect. A native Client UI animation is a client-side resource-pack loop. They are different systems and should not be described as the same thing.