Skip to content

R41z0r/LibSettingsDesigner

Repository files navigation

LibSettingsDesigner

LibSettingsDesigner is a vendored World of Warcraft settings-center library. It turns structured metadata into a rendered settings UI through:

addon.LibSettingsDesigner.Config
addon.LibSettingsDesigner.UI

The library is intentionally not a shared LibStub package. Each host addon owns and ships its own vendored copy.

Documentation

The maintained documentation lives in the project wiki:

The same wiki source is kept in docs/ for repository review and syncing.

Runtime

The files to vendor into an addon are in:

runtime/LibSettingsDesigner/

Recommended host addon layout:

MyAddon/
  MyAddon.toc
  libs/
    LibSettingsDesigner/
      LibSettingsDesigner.xml
      LibSettingsDesignerConfig.lua
      LibSettingsDesignerUI.lua
      Assets/

TOC include:

libs\LibSettingsDesigner\LibSettingsDesigner.xml

BigWigsPackager

For host addon release packaging, consume the stable main branch as an external:

externals:
  MyAddon/libs/LibSettingsDesigner:
    url: https://github.com/R41z0r/LibSettingsDesigner.git
    branch: main
    path: runtime/LibSettingsDesigner

Use a version tag instead of branch: main when a host addon needs a fully reproducible dependency snapshot.

The standalone sample addon includes its own .pkgmeta. The GitHub Actions release workflow prepares that sample directory as the package root before running BigWigsPackager. Uploads run only after changes land on main or master, or when the workflow is started manually.

Sample Addon

A standalone sample addon is available in:

Samples/LibSettingsDesignerSample/

Open it in game with:

/lsdsample

It demonstrates dashboard cards, status tiles, info pages, controls, search, new-feature badges, slash commands, and a vendored runtime copy.

Contributor Notes

  • AGENTS.md defines the repository and AI-agent operating rules.
  • SKILL.md is the Codex skill for working with this library.
  • Runtime Lua/XML files contain embedded license notices; do not remove them.
  • Runtime or sample Lua/XML/assets changes require in-game validation before merging to main.

License

LibSettingsDesigner is available under the LibSettingsDesigner Vendoring License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors