Installation·Unity 2022.3+·5 min read
From empty project to working menu
WagSettings is a UPM package. Import it, open the editor, run setup, press Play. The full walkthrough is in Getting Started; this is the short version.
1 · Install
- From the Asset Store: Window → Package Manager, switch to My Assets, Download, then Import.
- From a tarball: Package Manager → + → Add package from tarball… and choose the
.tgz. - Confirm it: Tools → WaggleBum → WagSettings is in the menu bar, and
WAGGLEBUM_WAGSETTINGSis in your scripting defines.
2 · Run setup
Tools → WaggleBum → WagSettings → Setup. Tick the categories you want, pick UI Toolkit or uGUI, pick a store, watch the preview, press Generate. A profile, its settings and the menu land in Assets/WagSettings. The Summary page then lists the two or three things left to do by hand.
Want rebinding? Install the Input System package first — the Summary page has a button that opens it in the Package Manager. Without it, everything except the Controls category works.
3 · Press Play
The menu is in your scene and already saving. Reading a value from code is one line:
using WaggleBum.WagSettings; float master = WagSettings.Get<float>("audio.master");
Something off?
- The menu shows English. Call
SettingsMenuLocalization.Apply("ja")before it opens; see Localization. - A setting is not in the menu. It has to be in the profile's list — the Settings Profile page shows what is, and flags a bad key.
- Values do not survive a restart. Check the store on the profile, and that
Applyis being called;Setis pending until then. See Persistence. - Something throws. Every error names the fix in its message. The Debugger page shows the live state in Play mode.