Skip to content

Plug-ins

A Hyperion plug-in is a Lua script that runs inside the client and uses the hyperion.* API to draw, read game state, and build UI elements. Plug-ins are sandboxed and loaded by the built-in plugin manager.

Anatomy of a plug-in

Each plug-in is a .lua file with a required metadata table and optional lifecycle callbacks.

plugin = {
    name = "My Plugin",
    version = "1.0.0",
    description = "Short summary"
}

function onLoad() end
function onUnload() end
function onTick() end
function onMenu() end

Lifecycle

  • onLoad(): runs once after the script is loaded.
  • onUnload(): runs before unloading.
  • onTick(): runs every frame while enabled (keep this lightweight).
  • onMenu(): renders your menu UI tab (if provided).

Where plug-ins live

  • Windows: %APPDATA%/.lmts/plugins/
  • Linux/macOS builds: ~/.local/share/.lmts/plugins/

Plug-ins are discovered automatically on startup and appear in the Plug-ins tab in the menu.