How It Works
If you have not installed Snoot yet, see Installation.
What Snoot scans
Section titled “What Snoot scans”- World settings stored in your world’s database.
- Flags attached to world documents (Actors, Items, Scenes, Journals, and the rest).
- Flags attached to documents inside world compendium packs.
Every entry it finds is grouped by the module ID that owns it. The module ID is the namespace on the setting key or the scope on the flag, so my-module.someSetting and flags["my-module"].someFlag both roll up under my-module.
Module statuses
Section titled “Module statuses”Each module Snoot finds is tagged with one of four statuses based on whether the module is installed and enabled in your world.
| Status | Meaning |
|---|---|
| System | Belongs to Foundry core or your active game system. Hidden by default; enable the relevant scan setting to include them. |
| Active | The owning module is installed and enabled. |
| Inactive | The owning module is installed but disabled. |
| Orphaned | No installed module matches the namespace. The module was uninstalled but its data was left behind. |
Stale is a separate concept that applies to individual settings rather than whole modules. A stale setting is one whose key is no longer declared by its module, usually because the module renamed or removed it in a later version. The setting still sits in your world database doing nothing. A module can be Active and still own stale settings.
The dashboard tabs
Section titled “The dashboard tabs”The window has five tabs. How to Use opens first and holds an in-app help and disclaimer panel. The other four are documented below.
How to Use
Section titled “How to Use”A reference panel with the status glossary, a tab guide, and a deletion disclaimer.
Overview
Section titled “Overview”A per-module summary with a status badge and entry counts. Each module row carries a trash button that cleans that one module. Above the module list, four read-only cards show totals across your whole world:
- Orphaned Settings: settings owned by uninstalled modules.
- Orphaned World Flags: world document flags owned by uninstalled modules.
- Orphaned Compendium Flags: compendium document flags owned by uninstalled modules.
- Stale Settings: settings whose key is no longer declared by their module.
The cards report totals only. Bulk clean buttons appear in the window footer when matching data exists.
Settings
Section titled “Settings”Every world setting in storage, grouped by namespace. Each row shows the key, the stored value, and whether the key is currently registered by its module. You can delete one setting at a time or every setting in a namespace.
World Flags
Section titled “World Flags”Every flag scope found on world documents, grouped by the module that owns the scope. Each row points to a specific document and lists the top-level flag keys present on it. You can remove a scope from a single document or strip the scope from every world document at once.
Compendium Flags
Section titled “Compendium Flags”Every flag scope found on documents inside world compendium packs, grouped the same way as World Flags. Removing compendium flags temporarily unlocks the affected packs.
Recommended workflow
Section titled “Recommended workflow”- Back up your world. Snoot deletes settings and removes flags, and there is no undo.
- Open the Overview tab and review the orphaned and stale counts.
- Inspect what each namespace owns in the Settings, World Flags, and Compendium Flags tabs before cleaning.
- Clean orphaned data first, then review inactive modules and stale settings individually.
See Cleanup for what each delete and remove action does, and Settings for the scan options that control which modules appear.