Menu ▾ ▴

Installation

Bayram Emekli

Installation

Sucrose is a free, open-source wallpaper engine for Windows. It ships as a single self-extracting Bundle installer (Sucrose.Bundle, built on .NET Framework 4.8) that carries the entire compressed application payload and unpacks it into your user profile — no administrator rights are required and nothing is written to Program Files. This page lists every official way to install Sucrose, the exact package ids and commands for each channel, what the installer does on disk, the silent-install switches, and how to recover from a checksum-mismatch error. For hardware/OS prerequisites, see System Requirements; to get a wallpaper running afterwards, see Quick Start.

Table of contents

Choosing an architecture

Every distribution channel offers Sucrose in three Windows architectures. The installer file name encodes the architecture:

Architecture Installer token Use when
x64 ..._x64_... Most modern 64-bit Intel/AMD PCs (the typical choice).
x86 ..._x86_... 32-bit Windows installs.
ARM64 ..._ARM64_... Windows on ARM devices (e.g. Surface Pro X).

The package managers (Chocolatey, Scoop, WinGet) pick the correct architecture automatically. You only choose manually when downloading directly from GitHub, SourceForge, or the website.

Microsoft Store

The Store edition keeps itself current through the Store's own update mechanism and is the simplest option for most users.

  • Product ID: XP8JGPBHTJGLCQ
  • Deep link: https://apps.microsoft.com/detail/XP8JGPBHTJGLCQ?launch=true&mode=full

Click Get / Install in the Store, then launch Sucrose Wallpaper Engine.

📷 Screenshot needed: The Sucrose listing on the Microsoft Store (apps.microsoft.com) showing the Get/Install button.

GitHub Releases (direct installer)

The canonical source. Each release is tagged v<version> (version format yy.MM.dd.0, e.g. v26.6.4.0).

Download the installer that matches your architecture from:

https://github.com/Taiizor/Sucrose/releases/download/v<version>/Sucrose_Bundle_.NET_Framework_4.8_<arch>_<version>.exe

where <arch> is one of x64, x86, ARM64. For example, version 26.6.4.0:

Architecture File name
x64 Sucrose_Bundle_.NET_Framework_4.8_x64_26.6.4.0.exe
x86 Sucrose_Bundle_.NET_Framework_4.8_x86_26.6.4.0.exe
ARM64 Sucrose_Bundle_.NET_Framework_4.8_ARM64_26.6.4.0.exe

Double-click the downloaded .exe to install. The Bundle requires .NET Framework 4.8 to run (see System Requirements).

📷 Screenshot needed: The GitHub Releases asset table for the latest Sucrose tag, showing the three per-architecture .exe files.

Chocolatey

  • Package id: sucrose

    :::powershell
    choco install sucrose

What the Chocolatey package does:

  • Terminates any running Sucrose* processes first.
  • Downloads the architecture-correct GitHub Release .exe (selected from $env:PROCESSOR_ARCHITECTURE and 64-bit detection: ARM64 / x64 / x86).
  • Runs it with silentArgs = '/s', verifying checksumType = 'sha256'; valid exit code 0.
  • Declares a hard dependency on dotnetfx >= 4.8.0.20220524 (so Chocolatey installs .NET Framework 4.8 if missing).

To uninstall, the package reads HKCU:\Software\Microsoft\Windows\CurrentVersion\Uninstall\Sucrose → UninstallString and runs it (see Uninstalling Sucrose).

Scoop

  • App name: sucrose

    :::powershell
    scoop install sucrose

(after adding the bucket that contains the sucrose manifest). The Scoop manifest defines per-architecture (32bit / 64bit / arm64) downloads of the same GitHub Release .exe, each with a SHA256 hash, and an installer script that runs:

Start-Process "$dir\Sucrose_Bundle_.NET_Framework_4.8_<arch>_$version.exe" -ArgumentList '/s' -Wait

License: GPL-3.0. Homepage: https://github.com/Taiizor/Sucrose.

WinGet

  • Package identifier: Taiizor.SucroseWallpaperEngine (Moniker: Sucrose)

    :::powershell
    winget install Taiizor.SucroseWallpaperEngine

or explicitly by id:

winget install --id Taiizor.SucroseWallpaperEngine

The WinGet manifest (schema 1.12.0) declares InstallerType: exe with InstallerSwitches: { Silent: /s, SilentWithProgress: /s } and three installer entries (x86 / x64 / arm64), each pointing at the GitHub Release .exe with its SHA256. Publisher: Taiizor. License: GPL-3.0 License.

All three package managers (Chocolatey, Scoop, WinGet) are thin wrappers — they download and silently run the same GitHub Release .exe. They are not independent builds.

Other official mirrors

If GitHub is blocked or slow, the same per-architecture installer is mirrored at:

Mirror URL pattern
SourceForge https://sourceforge.net/projects/sucrose/files/v<version>/Sucrose_Bundle_.NET_Framework_4.8_<arch>_<version>.exe/download?use_mirror=autoselect
Soferity (official download server) https://sucrose.soferity.com/Release/v<version>/Sucrose_Bundle_.NET_Framework_4.8_<arch>_<version>.exe
Official website https://sucrose.dev

Silent / unattended install

The Bundle installer accepts any of the following switches to run silently (no UI window, hidden, not shown in the taskbar):

Switch Notes
/s Primary silent switch (used by all package managers).
-s Equivalent.
-silent Equivalent.
/silent Equivalent.

Example:

Sucrose_Bundle_.NET_Framework_4.8_x64_26.6.4.0.exe /s

The installer localizes its UI at startup based on CurrentUITwoLetterISOLanguageName (48 language resource files ship with it), defaulting to English.

What the installer does on disk

Installation is per-user (everything lands under your profile; uninstall entries go into HKCU). The Bundle performs these steps in order:

  1. Terminates any running Sucrose processes (twice, with short delays).
  2. Refreshes the desktop.
  3. Cleans the staging and install directories.
  4. Extracts the embedded app payload (Sucrose.7z) into the install path.
  5. Verifies file integrity against an embedded SHA256 manifest (Hashes.json).
  6. On success: creates shortcuts, writes the uninstall registry key, and launches Sucrose.

Key locations the installer uses:

Item Path
Install path (binaries) %LocalAppData%\Sucrose
Launcher executable (entry point) %LocalAppData%\Sucrose\Sucrose.Launcher\Sucrose.Launcher.exe
Uninstaller %LocalAppData%\Sucrose\Sucrose.Undo\Sucrose.Undo.exe
Starter wallpapers (Showcase) %AppData%\Sucrose\Showcase
Desktop & Start Menu shortcut Sucrose Wallpaper Engine.lnk → the Launcher

The shortcut name is Sucrose Wallpaper Engine and points at Sucrose.Launcher.exe. The uninstall registry key is written under HKCU\Software\Microsoft\Windows\CurrentVersion\Uninstall\Sucrose (with DisplayName = "Sucrose Wallpaper Engine", Publisher = "Taiizor", UninstallString → Sucrose.Undo.exe, QuietUninstallString = "<Uninstall>" -s). For the full layout of files and folders, see Data Locations.

Checksum-mismatch recovery

After extraction, the installer hashes every installed file (SHA256) and compares it against the embedded Hashes.json manifest. If a file is missing or its hash does not match (for example, a corrupted or incomplete download), the install fails and the installer opens a localized "Installation Error / ERROR_CHECKSUM_MISMATCH" page (Template.html).

To recover:

  1. Delete the partially downloaded installer.
  2. Re-download a fresh copy from one of the official sources offered on that error page — GitHub, Microsoft Store, SourceForge, or the Official Website.
  3. Run the installer again.

If checksum errors persist across multiple downloads, your antivirus or a corporate proxy may be modifying the file in transit; try a different mirror.

See also

Related

Wiki: Bundle Installer Internals
Wiki: FAQ
Wiki: Glossary
Wiki: Home
Wiki: Publish Pipeline
Wiki: Quick Start
Wiki: Runtime Dependencies
Wiki: Security Policy
Wiki: System Requirements
Wiki: Uninstalling Sucrose
Wiki: Update Internals
Wiki: Updating Sucrose
Wiki: _Sidebar

Auth0 Logo