Skip to content

Settings Other

Taiizor edited this page Jun 5, 2026 · 3 revisions

Settings — Other

The Other Settings page (OtherSettingPage, the MenuOther item in the Settings-mode navigation) collects the cross-cutting settings that don't belong to General, Personal, Performance, Wallpaper, or System: privacy/telemetry consent, Discord Rich Presence, the network user agent, your Personal Access Token, the entire auto-update configuration, and developer/remote-debugging options. These settings span several JSON files (General.json, Hook.json, Objectionable.json, Update.json, and Engine.json) under %AppData%\Sucrose\Setting\. Toggling the two data-consent switches starts or kills the Reportdog background process.

Contents

Page summary

Property Value
Portal page OtherSettingPage (Setting8, icon ContentSettings16)
Localization key Portal.MainWindow.MenuOther
JSON files General.json, Hook.json, Objectionable.json, Update.json, Engine.json
Areas Data, Hook, Priority, Update, Developer

Sucrose Portal — Other settings page

Privacy and telemetry

Setting Control Key (file) Default Effect
Report Data ToggleSwitch ExceptionData (General.json) true Crash-report consent. Toggling starts/kills the Reportdog process.
Statistics Data ToggleSwitch TelemetryData (General.json) true Analytics/telemetry consent. Toggling starts/kills the Reportdog process.

Both switches are opt-out (default on). When ExceptionData is on, crash reports collected by the Watchdog are uploaded; when TelemetryData is on, analytics and an online heartbeat are sent. Turn both off to disable all outbound reporting. For exactly what is collected and where it is sent, see Privacy-Telemetry.

Note: the search box (when telemetry is on) also POSTs search queries to the telemetry endpoint as SearchTelemetryData (active page + app version + query text). Disabling Statistics Data stops this too.

Discord Rich Presence

Discord Rich Presence shows your current Sucrose activity in your Discord profile. It is configured in Hook.json and requires the Discord (or Discord PTB) client to be running. The Discord application id is 1126294965950103612.

Setting Control Key (file) Default Range / options
Discord Hook ToggleSwitch DiscordConnect (Hook.json) true Enable Rich Presence.
Discord refresh ToggleSwitch DiscordRefreshConnect (Hook.json) true Periodically refresh the presence payload.
Discord delay NumberBox DiscordRefreshDelay (Hook.json) 60 60–3600 (seconds)

See Discord-Rich-Presence for what the presence card displays.

Network identity and access token

Setting Control Key (file) Default Range / notes
User Agent TextBox (read-only) UserAgent (General.json) Sucrose/2.3 (Windows NT 10.0; Wallpaper Engine) SucroseWebKit max 100 chars
Personal Key (token) TextBox PersonalAccessToken (Objectionable.json) empty Must be exactly 93 characters to save, otherwise it is cleared. Used for YouTube and private (Soferity) Store access. A link to a YouTube tutorial video on creating the access token is provided.

⚠️ The PersonalAccessToken is stored in plaintext in Objectionable.json. The log/backup bundle deliberately excludes this file, but be aware it is not encrypted on disk. See Privacy-Telemetry.

The default UserAgent is also how web wallpapers detect that they are running inside Sucrose — the JS bridge checks navigator.userAgent.startsWith('Sucrose'). See Create-JS-Bridge.

Update configuration

These settings live in Update.json and drive the auto-update pipeline.

Setting Control Key (file) Default Options / range
Update Server ComboBox ServerType (Update.json) Soferity GitHub, Soferity
Update Module ComboBox ModuleType (Update.json) Downloader Native, Downloader
Update Channel ComboBox ChannelType (Update.json) Release Release, PreRelease
Update Extension ComboBox ExtensionType (Update.json) Executable (.exe) Compressed (.7z), Executable (.exe)
Update download limit NumberBox + unit LimitValue / LimitType (Update.json) 500 / Megabyte value 0–99999999; unit ≥ Megabyte enabled
Auto Update ToggleSwitch Auto (Update.json) true Enable automatic updates.
Auto update type ComboBox AutoType (Update.json) (SSDMMU.AutoType) Visible, SemiSilent, UpdateSilent, CompleteSilent

The update type controls how visible the update is: Visible shows the full updater UI, SemiSilent shows minimal UI, and UpdateSilent / CompleteSilent run with progressively less interaction. For the full update flow, asset naming, and silent modes, see Updating-Sucrose and Update-Internals.

Developer options

Setting Control Key (file) Default Range
Developer Mode ToggleSwitch DeveloperMode (Engine.json) false Enables remote-debugging on the web engines (WebView/CefSharp).
Developer Port NumberBox DeveloperPort (Engine.json) 0 0–65535

With Developer Mode on and a non-zero Developer Port, you can attach a browser DevTools session to a running web wallpaper for debugging. This is the recommended way to debug a Web/Url/YouTube wallpaper you are authoring. See Create-Web-Architecture.

How changes are applied

  • Toggling ExceptionData or TelemetryData immediately starts or stops the Reportdog process.
  • Toggling Discord settings reconnects/refreshes Rich Presence on the next cycle (handled by the Launcher process, which owns the Discord connection).
  • Update settings take effect on the next update check (manual or scheduled).
  • Developer Mode/Port changes apply on the next engine (re)start.

Keys are constants in Sucrose.Memory.Manage.Constant.*; defaults live in Sucrose.Manager.Manage.{General,Hook,Update,Engine} and Sucrose.Manager.Manage.Objectionable (defined in Private.cs). Enums are stored as their string member name in the JSON.

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