Skip to content

Settings System

Taiizor edited this page Jun 5, 2026 · 3 revisions

Settings — System

The System Settings page (SystemSettingPage, the MenuSystem item in the Settings-mode navigation) is the maintenance console for Sucrose. Unlike the other Settings pages, it stores no toggles or values of its own — every card is an action (a button) that creates a log bundle, clears a cache folder, backs up/restores your settings, or performs a factory reset. Each card shows a live folder-size hint that refreshes every 3 seconds so you can see how much space a given folder is using before you clear it. All actions operate on the data folders under %AppData%\Sucrose\.

Contents

Page summary

Property Value
Portal page SystemSettingPage (Setting6, icon PuzzleCube16)
Localization key Portal.MainWindow.MenuSystem
JSON file none (action-only page)
Areas Log, Cache, Library, Backup, Reset
Dispatch Most actions run through the Commandog process

Sucrose Portal — System settings page

Log maintenance

Card Action(s) What it does
Log Temporary Create / Delete Create saves a zip of the Log + Setting folders (excluding Objectionable.json, which holds the sensitive Personal Access Token) using Zip.Compress. Delete clears %AppData%\Sucrose\Log via the Commandog Temp command.

The exported log bundle is named sucrose_log_yyyyMMdd_HHmmss.zip. Attach it when filing a bug report. See Logs-Diagnostics.

The log archive deliberately excludes Objectionable.json so your Personal Access Token is not shipped in a support bundle.

Cache clearing

Each "clear" card targets a specific on-disk folder:

Card Action Folder cleared
Cache Temporary Start (clear) %AppData%\Sucrose\Cache
Store Temporary Start (clear) %AppData%\Sucrose\Cache\Store
Library Temporary Start (clear) the active library folder (Library.Location, default %AppData%\Sucrose\Library)

Library Temporary clears your installed wallpaper library folder. Use it deliberately — it removes installed wallpapers, not just throwaway cache. For details on the cache subfolders and their expiry, see Cache-Management.

Backup, restore, and reset

Card Action(s) What it does
Setting Backup Export / Import A folder picker, then the Commandog Export / Import command. Export copies every *.json from %AppData%\Sucrose\Setting\ into the chosen folder. Import copies external *.json back into the Setting folder.
Setting Reset Start The Commandog Reset command — a factory reset that deletes every *.json in %AppData%\Sucrose\Setting\, restoring all defaults.

All three operations (Export, Import, Reset) kill all Sucrose processes first, perform the file operation, then reopen the Portal on the System Settings page (via ArgumentCommandType.SystemSetting). Unlike the log bundle, Export does not exclude Objectionable.json -- it copies every *.json in the Setting folder verbatim, so a settings backup includes your Personal Access Token. Import and Reset apply no exclusion either; only the log-bundle path (Zip.Compress with an Excludes list) omits it. For the exact semantics see Backup-Restore-Reset.

What the folders contain

The action cards operate on these paths:

Path Contents
%AppData%\Sucrose\Setting\ All settings JSON files (General.json, Engine.json, Portal.json, etc.)
%AppData%\Sucrose\Log\ Per-process date-stamped log files (<Process>-yy.MM.dd.log)
%AppData%\Sucrose\Cache\ Update/store/report/engine caches
%AppData%\Sucrose\Cache\Store\ Store catalog (Store.json, Pattern.json) and downloaded themes
%AppData%\Sucrose\Library\ Installed wallpapers (the default library location)

For the complete folder map, see Data-Locations.

Behavior notes

  • This page intentionally has no persisted settings; nothing here is written to a JSON key.
  • Because backup/restore/reset terminate every Sucrose process, your active wallpaper stops and the Portal relaunches afterward — expect a brief flash.
  • Hand-editing or restoring Setting\*.json is safe to do while the app is closed; the settings managers self-heal a missing/empty/invalid file by resetting it to { "Properties": {} } on next read. See Settings-Persistence.
  • The folder-size hints refresh roughly every 3 seconds, so the displayed sizes may lag a fast-growing cache by a moment.

See also

Home

Getting Started

Wallpaper Types

Using Sucrose

Settings Reference

Creating Wallpapers

Engine Reference

Automation & Command Line

Architecture & Internals

Data, Files & Diagnostics

Building & Contributing

Help & Support

Clone this wiki locally