UI Mods

Discovers Vue mod components and notifies UI when mod files change.

Overview

ui_uiMods scans /ui/ui-vue/mods/ for Vue mod directories and monitors file changes to trigger UI hot-reloads. It also watches /ui/modModules/ and calls sendUIModules() when those change.

Extension path: lua/ge/extensions/ui/uiMods.lua

Exports (M)

Internals

getVueMods

Scans /ui/ui-vue/mods/ recursively for all files. Groups them by the first directory segment after mods/:

{
  ["myUiMod"] = {
    path = "/ui/ui-vue/mods/myUiMod",
    files = { "/component.vue", "/style.css", ... }
  }
}

onFilesChanged

Checks each changed file path:

• If it starts with /ui/modModules/ → calls sendUIModules() (global).
• If it starts with /ui/ui-vue/mods/ → triggers UiModsChanged guihook.

Both checks are performed at most once per call.

How It Works

1. The UI calls getVueMods() to discover available Vue mod overlays.
2. When the VFS reports file changes, onFilesChanged fires.
3. If Vue mod files changed, UiModsChanged tells the UI to re-scan/reload.
4. If module files changed, sendUIModules() pushes updated module data.

Lua Examples

-- List available Vue UI mods
local mods = extensions.ui_uiMods.getVueMods()
for name, info in pairs(mods) do
  print(name, info.path, #info.files .. " files")
end

Hooks Triggered

Additional Exports

The following exports are available but not yet documented in detail:

• M.getVueMods
• M.onFilesChanged

See Also

• ui/ambientSound - Ambient Sound Stream Player - Related reference
• UI Apps Manager - Related reference
• UI Audio - Related reference
• UI System Guide - Guide