Backup Restore Reset

Backup, Restore & Reset

This page covers how to back up your Sucrose configuration, restore it on another machine (or after a reinstall), and reset it to factory defaults. All three operations work on the JSON files in %AppData%\Sucrose\Setting\ and are surfaced in the Portal under Settings → System. It also explains hand-editing JSON and clearing the cache/log/store folders.

Contents

• Where these actions live
• Export (backup)
• Import (restore)
• Reset (factory defaults)
• What each action does to running processes
• Resetting a single category by hand
• Hand-editing settings JSON
• Clearing cache, logs, and store

Where these actions live

Open the Portal, then go to Settings → System. The System page exposes the Export, Import, and Reset actions, plus the "clear" actions for the cache/store/log folders. These actions are implemented in Sucrose.Shared.Space.Helper (Export.cs, Import.cs, Reset.cs). See Settings-System for the full page reference.

📷 Screenshot needed: Portal → Settings → System page showing the Export / Import / Reset buttons and the clear-cache/store/log actions with their live size hints.

Export (backup)

The Export action backs up your settings:

1. It kills all Sucrose processes first (so nothing is mid-write).
2. It copies every *.json file from %AppData%\Sucrose\Setting\ into a destination folder you choose.

The result is a folder containing files like General.json, Engine.json, Portal.json, Library.json, etc. — the complete set listed in Data-Locations. Keep this folder as your backup, or move it to another machine to migrate your configuration.

Note: Export copies only the settings files. It does not copy your wallpaper Library, downloaded Store content, or cache. To back those up, copy %AppData%\Sucrose\Library\ (or your relocated library location) and %AppData%\Sucrose\Cache\Store\ separately.

Privacy note: the backup includes Objectionable.json, which holds PersonalAccessToken in plaintext. Treat the backup folder as sensitive. See Privacy-Telemetry.

Import (restore)

The Import action restores a backup:

• It copies external *.json files from a folder you select back into %AppData%\Sucrose\Setting\, overwriting the current settings.

Use this to restore from an Export backup or to clone configuration onto a new machine. Because every settings file is self-healing (an invalid or partial file is reset to defaults on next launch — see Settings-Persistence), importing a partial set is safe: any missing or malformed category simply reverts to defaults.

Reset (factory defaults)

The Reset action restores defaults:

• It deletes every *.json file in %AppData%\Sucrose\Setting\.

On next launch, each manager recreates its file as the empty envelope { "Properties": {} }, and every accessor falls back to its built-in default. This is the cleanest way to recover from a misconfigured install. It does not touch your wallpaper Library or downloaded Store content.

What each action does to running processes

All three actions (Export, Import, Reset) stop the running Sucrose processes and then restart the Portal directly on the System Setting page afterward (via the SystemSetting argument command — see Command-Reference). You do not need to relaunch the Portal yourself; it reopens where you left off.

Resetting a single category by hand

Because settings are split per category, you can reset just one area without a full factory reset:

1. Fully exit Sucrose (close the Portal and let the tray icon disappear).
2. Delete the single file in %AppData%\Sucrose\Setting\ — for example, delete Engine.json to reset only the engine/volume/screen settings.
3. Relaunch Sucrose. The deleted file is recreated with defaults; all other categories keep their values.

Reset just…	Delete
Language, startup, telemetry consent	General.json
Volume, screen layout, per-type engine choice	Engine.json
UI layout, pagination, Store filter	Portal.json
Performance rules / thresholds	Backgroundog.json
Slideshow / cycling	Cycling.json
Discord Rich Presence	Hook.json

See Data-Locations for the complete file→category map.

Hand-editing settings JSON

You can edit the JSON files directly, but follow the Settings-Persistence rules:

• Stop Sucrose first so a running process does not overwrite your edit.
• Keep the { "Properties": { … } } envelope intact — a file missing it is treated as invalid and reset.
• Use enum member names, not integers (e.g. "BackdropType": "Mica"), because enums are serialized as their string name.
• Numeric values outside the allowed range are silently clamped at read time, so stay within the documented range in Settings-All-Keys.
• Writes from the app swallow errors silently; verify your edit survived by restarting and re-checking.

Clearing cache, logs, and store

The System page also offers folder-clearing actions (with live size hints). These remove transient data only — they never touch your settings:

Action	Folder removed
Clear Store temp	%AppData%\Sucrose\Cache\Store
Clear Cache	%AppData%\Sucrose\Cache
Clear Log	%AppData%\Sucrose\Log
Clear Setting (this is Reset)	%AppData%\Sucrose\Setting

For more on what lives in the cache and what is safe to delete, see Cache-Management; for logs see Logs-Diagnostics.

See also

• Settings-Persistence
• Data-Locations
• Settings-System
• Cache-Management
• Logs-Diagnostics
• Settings-All-Keys