-
-
Notifications
You must be signed in to change notification settings - Fork 60
Home
Sucrose is a versatile, fully open-source wallpaper engine for Windows. It brings a wide range of interactive wallpapers to life on your desktop — Gif, Video, Web, Url, YouTube, and Application types — with light and dark themes, multi-monitor and all-resolution support, and a built-in Store for discovering community creations.
Sucrose is completely free: no feature is paywalled. You can build media-responsive wallpapers with the Sucrose Audio API, surface live system status with the Sucrose System API, and turn any website into a wallpaper using the CefSharp and WebView engines. Create your own wallpapers simply or in detail, then share them with friends or publish them to the Sucrose Store. Under the hood, Sucrose optimizes CPU and GPU usage, auto-pauses wallpapers when fullscreen apps or games are running, and includes a power-saving mode for laptops on battery.
Installation · Quick-Start · Create-Overview · Architecture-Overview · FAQ
- Six wallpaper types — Gif, Video, Web (HTML/JS), Url, YouTube, and Application, each backed by one or more render engines.
- Eight render engines — MpvPlayer, WebView, CefSharp, Nebula, Vexana, Xavier, Aurora, and VlcPlayer, selectable per wallpaper type.
- Sucrose Audio API — drive visuals from a live 128-band WASAPI loopback FFT spectrum plus now-playing metadata.
- Sucrose System API — read processor, graphics, memory, network, battery, storage, motherboard, BIOS, and date data inside web wallpapers.
- Built-in Store — browse, search, and install community wallpapers directly from the Portal.
- Multi-monitor & all resolutions — per-display, span, and per-screen layouts.
- Performance rules — auto close, pause, and resume based on fullscreen, lock, battery, sleep, and CPU/GPU/RAM/network conditions.
- Theming, tray, and startup — light/dark/system themes, Mica/Acrylic backdrops, and flexible startup modes.
- Wallpaper cycling — slideshow rotation by time, random or sequential, with an exclusion list.
This wiki is organized into 11 sections. Start with the one that matches what you want to do.
- Getting Started — Install Sucrose, set it up, and apply your first wallpaper. Installation · Quick-Start · Portal-Interface-Tour
- Wallpaper Types — The six types and which engine renders each. Wallpaper-Types · Type-Video · Type-Web
- Using Sucrose — Manage your library, customize wallpapers, and tune day-to-day use. Managing-Library · Customizing-Wallpaper · Performance-Rules
- Settings Reference — Every Portal setting, page by page, with keys and defaults. Settings-Overview · Settings-Wallpaper · Settings-All-Keys
- Creating Wallpapers — Author wallpapers, the package format, and the JS APIs. Create-Overview · Create-Package-Format · Create-Audio-API
- Engine Reference — Deep dives on each render engine and a comparison matrix. Engines-Overview · Engine-MpvPlayer · Engine-Comparison
- Automation & Command Line — The advanced/internal command interface. Command-Reference · Automation-Examples
- Architecture & Internals — How the multi-process app is built. Architecture-Overview · IPC · Lifecycle
- Data, Files & Diagnostics — Where files live and how to diagnose issues. Data-Locations · Backup-Restore-Reset · Logs-Diagnostics
- Building & Contributing — Build from source, conventions, and contributing. Building-From-Source · Code-Conventions · Contributing
- Help & Support — FAQ, troubleshooting, and getting help. FAQ · Troubleshooting-Common · Getting-Help
- Issues — https://github.com/Taiizor/Sucrose/issues
- Discussions — https://github.com/Taiizor/Sucrose/discussions
- Discord — https://discord.gg/nxG977byXb
- Store — https://github.com/Taiizor/Store
- Website — https://sucrose.soferity.com
Getting Started
- Installation
- System Requirements
- Quick Start
- Portal Interface Tour
- Updating Sucrose
- Uninstalling Sucrose
Wallpaper Types
Using Sucrose
- Managing Library
- Using Store
- Customizing Wallpaper
- Multi-Monitor
- Wallpaper Cycling
- Choosing Engines
- Performance Rules
- Theme, Tray & Startup
- Discord Rich Presence
Settings Reference
- Settings Overview
- Settings: General
- Settings: Personal
- Settings: Performance
- Settings: Wallpaper
- Settings: System
- Settings: Other
- Settings: All Keys
Creating Wallpapers
- Create Overview
- Create: Step By Step
- Create: Package Format
- Create: Customization Controls
- Create: JS Bridge
- Create: Audio API
- Create: System API
- Create: Property Listener & Filters
- Create: Web Architecture
- Create: Compatibility
- Create: Example Wallpapers
- Create: Sharing & Publishing
Engine Reference
- Engines Overview
- Engine: MpvPlayer
- Engine: VlcPlayer
- Engine: WebView
- Engine: CefSharp
- Engine: Nebula
- Engine: Vexana
- Engine: Xavier
- Engine: Aurora
- Engine Comparison
Automation & Command Line
Architecture & Internals
- Architecture Overview
- Lifecycle
- Commandog Dispatcher
- Single-Instance Mutexes
- IPC
- Backgroundog Service
- Crash Reporting
- Update Internals
- Property Service
- Undo Internals
Data, Files & Diagnostics
Building & Contributing
- Building From Source
- Repository Layout
- Shared Item Projects
- Code Conventions
- Preprocessor Symbols
- Publish Pipeline
- Bundle Installer Internals
- Extending Sucrose
- Contributing
- Translating with Localizer
- Localization Coverage
- Security Policy
- Privacy & Telemetry
Help & Support
