-
-
Notifications
You must be signed in to change notification settings - Fork 60
Wallpaper Cycling
Wallpaper Cycling turns your library into a slideshow: Sucrose automatically switches to a different installed wallpaper on a timer, either in order or at random. You configure it in the Wallpaper Cycling dialog from the top toolbar, and you can exclude individual wallpapers from the rotation. This page documents the cycling settings (active flag, transition time, transition type), how to build the exclusion list, and where the configuration is stored.
- Opening Wallpaper Cycling
- Cycling settings
- Transition types
- The exclusion list
- Resetting the exclusion list
- Where cycling is stored
- Related per-wallpaper playback settings
- See also
Open the Wallpaper Cycling dialog from the Portal top toolbar (icon PlayCircle48, command WallpaperCyclingCommand). Its settings are stored in Cycling.json. See Portal Interface Tour for the toolbar layout.
📷 Screenshot needed: The Wallpaper Cycling dialog showing the active toggle, transition-time number box, transition-type dropdown, and the reset-exclusion button.
| Setting | Control | Key | Default | Range / options |
|---|---|---|---|---|
| Cycling active | ToggleSwitch | Active |
false |
on / off |
| Transition time | NumberBox | TransitionTime |
30 |
1–999 minutes |
| Transition type | ComboBox | TransitionType |
(default from SSDMMC.TransitionType) |
Random, Sequential
|
| Reset exclusion list | Button | Exclusion |
[] |
clears all per-wallpaper exclusions |
Turn Cycling active on, set how many minutes each wallpaper stays up via Transition time, and choose how the next wallpaper is picked with Transition type.
| Type | Behavior |
|---|---|
| Sequential | Walks through the eligible library wallpapers in order. |
| Random | Picks the next wallpaper at random from the eligible set. |
Only wallpapers that are not on the exclusion list participate in either mode.
By default every installed wallpaper is eligible for cycling. To keep a specific wallpaper out of the rotation, open its library card context menu and use the Add to Cycle / Remove from Cycle command — Remove from Cycle puts the wallpaper on the Exclusion list in Cycling.json (taking it out of rotation), and Add to Cycle removes it from the Exclusion list, bringing it back into rotation. This is the per-wallpaper control; the cycling dialog itself holds the global active flag, timing, and order.
The Reset exclusion list button in the Wallpaper Cycling dialog clears every entry from the Exclusion list ([]), making all library wallpapers eligible again in one step. Use it if you have excluded several wallpapers and want to start the rotation over with everything included.
All cycling configuration lives in %AppData%\Sucrose\Setting\Cycling.json (the active flag, transition time, transition type, and the exclusion list). See Data Locations and Settings Persistence for how Sucrose stores and reloads these JSON settings.
Cycling chooses which wallpaper plays; two separate Settings → Wallpaper toggles govern how the currently playing media behaves and should not be confused with cycling:
| Setting | Key | Default | Effect |
|---|---|---|---|
| Loop Mode | WallpaperLoop |
true |
Loop the current video/GIF when it reaches the end. |
| Shuffle Mode | WallpaperShuffle |
true |
Shuffle within a multi-item wallpaper. |
These apply to the active wallpaper regardless of whether cycling is on. See Settings: Wallpaper and Choosing Engines.
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