Add-ons/Toolbox/Configuration and backups

Lua add-on documentation: Toolbox overview · Add-on hub · Contribute or update documentation

Toolbox stores settings per character and can export named setups for use by other characters on the same computer. Its settings search, HUD layout page, sound controls, and backup tools provide safer ways to make broad changes than editing saved JSON files by hand.^[1]

Finding settings

Open settings with /toolbox, /tbx, or the configured key binding. The category menu opens on General, followed by Toolbelt, XP & Loot, Crafting, Buffs, Consumables & gear, Health bars, Combat, Skill activity, Map & location, Notifications, Sounds, HUD layout, and Menu, setups, backup & reset. General controls the text size and line spacing used by every Toolbox window and strip. The combat-statistics HUD follows these settings too; its own Size setting is a percentage of the General text size.^[1]

The Search box finds options by terms such as sound, size, or target. Selecting a result opens the appropriate category, places that part at the top, and flashes the matching control. Show the whole page restores the complete category. Controls that cannot affect a disabled feature are grayed out.^[1]

The default shortcut is Ctrl+; when the game has not assigned it elsewhere. Change it under Keys on Toolbox's row in the add-on manager. /toolbox key reports the current binding.

Per-character settings

Options and HUD positions belong to the active character. When changing characters, Toolbox follows the game-reported identity and loads that character's settings. Named setups make intentional sharing possible without permanently tying two characters together.

Exporting a setup

Open Menu, setups, backup & reset.
Configure the current character as desired.
Choose Export, supply a descriptive name such as Raid layout, and confirm.

To make the current character itself appear as an import source, enable List this character's setup. It is off initially.

Importing a setup

Select an exported setup or a listed character.
Choose Import.
Confirm the import a second time.

Importing copies the settings. Later edits remain independent for each character. Chat equivalents include /toolbox settings setups, import <name>, export <name>, delete <name>, and share on|off.^[1]

Backing up files

Toolbox uses the game's Lua/SavedVariables directory:

File	Contents
`toolbox.<character>.character.json`	One character's settings, positions, and applicable saved state
`toolbox.account.json`	Named setups and account-level Toolbox data; on clients before Lua API 39, legacy per-character recovery copies

For a consistent manual backup:

Press Save now in Toolbox settings.
Quit the game so no later in-memory changes can overwrite the copy.
Copy the relevant Toolbox JSON files from Lua/SavedVariables to a safe location.

To restore or move computers, quit the game before copying the files back. Keep the filenames unchanged. Saved variables are separate from the installed Lua/toolbox package, so removing and reinstalling the catalog package ordinarily does not remove the settings.^[2]

Automatic recovery and dated backups

Version 1.7.0 validates values before saving and stores only forms the game is known to read safely. If one value cannot be saved, Toolbox reports it in chat without discarding the other values.^[3]

On clients before Lua API 39, Toolbox also keeps a legacy recovery copy of each character's settings, positions, and farming-run history in toolbox.account.json. If the game later starts Toolbox without readable character data, the add-on restores the available copy and reports that recovery in chat. Today's activity counts and the active XP session are not part of this copy.

On clients with Lua API 39 or later, Toolbox 1.9.0 uses the game's dated saved-file backups instead. It requests a backup before a settings reset, setup import, and the first start of a new Toolbox version. Back up now creates another copy on demand; Restore uses a two-step selection and keeps a copy of the file it replaces. The equivalent commands are /toolbox settings backup, backups, and restore <number>.^[4]

A manual backup of the relevant files remains prudent before moving computers or making major changes.

Saved-file capacity

Introduced in Toolbox 1.8.0. The game limits each saved-variable file to 256 KB. Before writing, Toolbox checks the complete serialized file. If a change would exceed the limit, it refuses that change and identifies it rather than allowing it to prevent unrelated data from being saved.^[5]

Map overlays share the per-character file with other character data. The overlay window shows their storage use and provides controls for removing places, overlays, or stored scene maps. Version 1.8.0 also reduces the maximum saved market-price cache from 2,000 entries to 600 to conserve account-file space.^[5]

Reset behavior

Reset all settings takes effect on the next /lua reload. Toolbox's accumulated statistics are retained. This reset is different from /toolbox reset, which starts a new XP session, and from the Loot Tracker's run reset.

Before a full reset, export a named setup or make a file backup if the current layout may be wanted later.

Sounds

The Sounds page provides one overall alert volume and a separate share for each alert. Setting a single sound to zero silences that sound without muting the others. /toolbox sounds lists the selected files, /toolbox sounds 50 sets the overall level, and /toolbox sounds test plays samples.

Custom sound files may be selected in settings. Clients with Lua API 33 provide a file list instead of requiring a typed path; API 34 distinguishes different files that share a filename. In version 1.9.0, a Set button beside each custom path applies the selection without requiring Enter. Per-effect sounds accept .ogg, .wav, or .mp3. Store them under the Lua folder but outside Lua/toolbox, which package updates replace.^[3]^[4] Recognized general-alert filenames include:

toolbox_buff_expiring
toolbox_debuff_landed
toolbox_notify
toolbox_mail
toolbox_ping
toolbox_tap
toolbox_block, toolbox_parry, and toolbox_dodge

The in-addon guide notes that bundled sounds and user-supplied files may have different apparent loudness at the same setting, so test custom audio at a conservative volume.^[1]

Optional Internet permission

Only estimated Loot Tracker prices require Internet access. Enable both Toolbox's price option and the separate Internet permission in the add-on manager. Disabling either stops lookups without affecting other features. The package declares only shroudoftheavatar.net; changing a packaged host list would require renewed permission under the add-on sandbox rules.^[2]

References

↑ ^1.0 ^1.1 ^1.2 ^1.3 ^1.4 Toolbox 1.10.0 in-addon documentation, approved package reviewed November 1, 2026.
↑ ^2.0 ^2.1 Catnip Games: Lua add-on authoring guide, retrieved October 13, 2026.
↑ ^3.0 ^3.1 Toolbox 1.7.0 release notes, published October 13, 2026.
↑ ^4.0 ^4.1 Community Addons: approved Toolbox 1.10.0 package, reviewed November 1, 2026.
↑ ^5.0 ^5.1 Toolbox 1.8.0 release notes, published October 14, 2026.