taiizor/sucrose

Sucrose is a versatile wallpaper engine that brings life to your desktop with a wide range of interactive themes.

Sucrose Wallpaper Engine

Sucrose is a versatile wallpaper engine that brings a wide range of interactive themes to life on your desktop. With light and dark theme options, you can choose the appearance that suits your personal preferences. You can create your own wallpapers simply or in detail, and it supports multiple screens and all screen resolutions for a seamless experience across various display configurations.

Completely open-source and free, Sucrose doesn't require any payments for any features, granting users full access. You can create media-responsive wallpapers using the Sucrose Audio API and design wallpapers with system status indicators using the Sucrose System API. Additionally, you can use any website as a wallpaper using CefSharp and WebView.

Sucrose allows you to create your own custom themes and share them with friends or the Sucrose Community. You can explore and download themes offered by users directly from the Sucrose Store.

In terms of performance, it ensures smooth performance by optimizing CPU and GPU usage. It automatically pauses wallpapers when fullscreen applications/games are running to conserve resources, and it has a power-saving mode that pauses wallpapers when running on battery power, such as on laptops.

Sucrose is a powerful tool for personalizing and animating your desktop. It enables users to express their creativity and fully customize their desktop experiences.

Issues ● Discussions ● Documentation ● Store ● Preview ● Tutorial ● Discord

Features

Take a moment, preview GIF clips may take some time to load.

Wallpaper Varieties

Theme Type	Example	Interactive	Resolution	Performance
Gif	Asus ROG Theme	No	Variable	Fixed
Url	Taiizor Theme	Yes	Fixed	Variable
Web	Cat vs Ball of Wool Theme	Yes	Fixed	Variable
Video	The Last of Us Part II Theme	No	Variable	Fixed
YouTube	Floating in Space Theme	No	Fixed	Variable
Application	Santa's Helper Theme	No	Fixed	Variable

More Features

● Light and Dark theme feature.

● Create your own wallpapers simply or in detail.

● Supports multiple screens and all screen resolutions.

● Customize various wallpaper engines and plugins freely.

● Completely open-source and free, no feature requires payment.

● Create media-responsive wallpapers using the Sucrose Audio API.

● Determine the fate of the wallpaper based on system performance.

● Create wallpapers that display system status using the Sucrose System API.

● You can use any website you want as a wallpaper with CefSharp and WebView.

Create and Share Themes

● Create your own custom themes and share them with friends or the Sucrose community.

● Explore a gallery of user-submitted themes and download them directly from the Sucrose store.

Performance

● Optimize CPU and GPU usage for smooth performance.

● Auto-pause wallpapers when fullscreen applications/games run to conserve resources.

● Power-saving mode to pause wallpapers when running on battery (laptops).

Download

Microsoft Store

.NET	x64	x86	ARM64
.NET Framework 4.8

GitHub

.NET	x64	x86	ARM64
.NET Framework 4.8
.NET Framework 4.8.1
.NET 6.0
.NET 7.0
.NET 8.0
.NET 9.0

Support

We appreciate any contribution to Sucrose. Here are some ways to support the project:

Developer

● Contribute to the codebase and help improve Sucrose.

Designer

● Improve the UI/UX of Sucrose for a better user experience.

Localization

● Help translate Sucrose into more languages to reach a broader audience.

Feedback & Bug Reports

● Suggest new features or report bugs to help us improve Sucrose.

Spread the Word

● Star this repository and share your experiences with Sucrose on social media.

sucrose's Issues

crashing again and again when i am opening it

Bug Description
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected Behavior
A clear and concise description of what you expected to happen.

Screenshots/Video
If applicable, add screenshots/video to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. Windows 10 1909]
• Which wallpaper was running at the time if any.

Additional Context
Add any other context about the problem here.

Log File (Important)
Share the diagnostic files by:
Open Sucrose settings (Gear icon) top-right -> System -> Log Files -> Create
or
Navigate to the Appdata folder C:\Users\<UserName>\AppData\Roaming\Sucrose\Log

All Known Issues 7: Paused Wallpaper

If a wallpaper that is enabled based on performance settings is stopped, the desktop becomes partially unusable. An example of this issue is available in the following video:

Untitled.Project.mp4

All Known Issues 3: gRPC ARM64 Support

The Sucrose application may not work partially on Windows 10-11 operating systems with ARM64 architecture due to the lack of Windows ARM64 support for the gRPC library.

There is an issue mentioned below regarding this, but the solution is only supported for the .NET framework infrastructure, with no solution for the .NET Framework infrastructure. There are two possible solutions for this problem:

Option 1: Consider using an alternative library instead of the gRPC library or prepare an alternative infrastructure.
Option 2: Discontinue support for .NET Framework and revise the gRPC infrastructure with the solution provided for .NET.

Opened Issue and Solution

Launcher-23.10.06.log

Duplicate Same Wallpaper wont work

Bug Description
Duplicate Same Wallpaper do not duplicate screens one screen is black

To Reproduce
Steps to reproduce the behavior:
Attached video

Expected Behavior
In both screen should show the same wallpaper

Screenshots/Video
If applicable, add screenshots/video to help explain your problem.
https://github.com/Taiizor/Sucrose/assets/147877928/3d13c62a-4c00-4efa-83fa-1ffd67eab6e8

Desktop (please complete the following information):
OS: Windows 10 21H2
Sucrose: Pre-Release .NET Framework 4.8 x64 v24.3.7.0
BTW with the .NET Framework 9.0 happen the same problem

Log File (Important)
Backgroundog-24.03.13.log
CefSharpLive-24.03.13.log
Launcher-24.03.13.log
Portal-24.03.13.log
Watchdog-24.03.13.log
WebViewLive-24.03.13.log

All Known Issues 5: Open Copilot

When Copilot is opened, the active wallpaper becomes semi-transparent and comes to the foreground, rendering the desktop unusable.

Record.2023-10-14.152708.mp4

All Known Issues 1: Changing Screen Resolution

When the screen resolution is changed, the active wallpaper becomes semi-transparent and comes to the foreground, rendering the desktop unusable.

Record.2023-10-13.212558.mp4

The app bugs out and crashes

Bug Description
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected Behavior
A clear and concise description of what you expected to happen.

Screenshots/Video
If applicable, add screenshots/video to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. Windows 10 1909]
• Which wallpaper was running at the time if any.

Additional Context
Add any other context about the problem here.

Log File (Important)
Share the diagnostic files by:
Open Sucrose settings (Gear icon) top-right -> System -> Log Files -> Create
or
Navigate to the Appdata folder C:\Users\<UserName>\AppData\Roaming\Sucrose\Log

animation stops when software is open and stop option is not showing

All Known Issues 2: Open Task View

When Task View is opened, the active wallpaper becomes semi-transparent and comes to the foreground, rendering the desktop unusable.

Record.2023-10-13.213139.mp4

All Known Issues 6: Windows 11 Preview 26XXX Version

In users with Windows 11 Insider build 26x, some plugins and engines are not working as expected.

List of plugins and engines working smoothly: Aurora, MpvPlayer, and WebView.
List of plugins and engines experiencing issues: CefSharp, Nebula, and Vexana.

The app bugs out and hangs

Bug Description
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected Behavior
A clear and concise description of what you expected to happen.

Screenshots/Video
If applicable, add screenshots/video to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. Windows 10 1909]
• Which wallpaper was running at the time if any.

Additional Context
Add any other context about the problem here.

Log File (Important)
Share the diagnostic files by:
Open Sucrose settings (Gear icon) top-right -> System -> Log Files -> Create
or
Navigate to the Appdata folder C:\Users\<UserName>\AppData\Roaming\Sucrose\Log

All Known Issues 4: Console Application Wallpaper

If the themes in the Application type are prepared for Console (CMD [Command-Line]) type applications, they may not work properly.

Record.2023-10-13.220409.mp4

This is the case in the Windows 11 operating system. In Windows 10, it partially works.

Normally, the expected behavior is as follows:

Record.2023-10-13.221214.mp4