Skip to content

Developers

github-actions[bot] edited this page Jul 29, 2026 · 4 revisions

This wiki is for players. Contributor and integrator documentation lives in the repository — do not treat this page as a second Docs tree. When wiki tips and Docs disagree, Docs and code win.

How the suite is shaped

  • OneWoW is always loaded: hub UI, shared OneWoW_GUI toolkit, themes, locales, Manage Features, and shared services (search/predicate engine, collectibles, overlays, and more).
  • Feature modules (OneWoW_Bags, OneWoW_QoL, OneWoW_Mail, …) are separate Load-on-Demand addons. Disabling one in Manage Features unloads it.
  • Data stores (OneWoW_CatalogData_*, OneWoW_AltTracker_*) feed parent features (and some consumers like Shopping List / Mail) without their own player hub.
  • Cross-unit reads go through published _API surfaces and core services — not by reaching into another unit’s SavedVariables.

Clone the repo (or browse on GitHub) and start with CONTRIBUTING + ARCHITECTURE before changing load order, lifecycle hooks, or DB defaults.

Start here

Topic Doc
How to contribute (PRs, locales) CONTRIBUTING.md
Docs index OneWoW/Docs/README.md
Load units, lifecycle, enable model, hub ARCHITECTURE.md
SavedVariables / OneWoW_GUI.DB DATABASE.md
UI toolkit GUI.md
Localization (11 locales) LOCALES.md
Search / # expression engine PREDICATE_ENGINE.md · player syntax: Bags Search Syntax
Named searches / catalog SEARCH_CATALOG.md

Feature integration

Area Doc
Bags third-party API OneWoW_Bags/API/README.md
Bags internals OneWoW_Bags/Docs/README.md
QoL external modules OneWoW_QoL/DEVELOPERS.md · MODULES.md
Mail shipments pipeline OneWoW_Mail/Docs/ARCHITECTURE.md
Trackers OneWoW_Trackers/Docs/ARCHITECTURE.md
Slash command inventory suitecommands.md
In-game inspector (opt-in) OneWoW_Utility_DevTool/README.md

Conventions

Location Audience
GitHub Wiki (this site) Players
Addon README.md Players
ADDON/Docs/ and OneWoW/Docs/ Contributors / integrators
CONTRIBUTING.md Anyone opening a PR

Related

Sources

Clone this wiki locally