Recent changes to Getting Help

Getting Help modified by Bayram Emekli

Bayram Emekli — Sat, 04 Jul 2026 04:15:51 -0000

--- v4
+++ v5
@@ -21,7 +21,7 @@
 | **GitHub Discussions** | Questions, ideas, "how do I…", general help | `https://github.com/Taiizor/Sucrose/discussions` |
 | **Discord** | Real-time community chat and support | Linked from the project README / `_Footer` |
 | **The Store** | Finding and reporting community wallpapers | In-app Store (see [Using-Store](Using-Store)) |
-| **Official website** | News, downloads, mirrors | `https://taiizor.github.io/Sucrose` (Soferity download/API backend: `https://sucrose.soferity.com`) |
+| **Official website** | News, downloads, mirrors | `https://sucrose.dev` (Soferity download/API backend: `https://sucrose.soferity.com`) |

 Notes:

Getting Help modified by Bayram Emekli

Bayram Emekli — Sat, 04 Jul 2026 04:15:51 -0000

--- v3
+++ v4
@@ -21,7 +21,7 @@
 | **GitHub Discussions** | Questions, ideas, "how do I…", general help | `https://github.com/Taiizor/Sucrose/discussions` |
 | **Discord** | Real-time community chat and support | Linked from the project README / `_Footer` |
 | **The Store** | Finding and reporting community wallpapers | In-app Store (see [Using-Store](Using-Store)) |
-| **Official website** | Downloads, news, mirrors | `https://sucrose.soferity.com` and `https://taiizor.github.io/Sucrose` |
+| **Official website** | News, downloads, mirrors | `https://taiizor.github.io/Sucrose` (Soferity download/API backend: `https://sucrose.soferity.com`) |

 Notes:

Getting Help modified by Bayram Emekli

Bayram Emekli — Sat, 04 Jul 2026 04:15:45 -0000

--- v2
+++ v3
@@ -34,7 +34,7 @@

 A good report lets a maintainer reproduce the problem without a back-and-forth. Include:

-1. **Sucrose version.** Open the **About** dialog (top toolbar → Other Options → About) — it shows the version, framework, and architecture. The version format is `yy.MM.dd(.0)`.
+1. **Sucrose version, framework & architecture.** The Portal's **bottom status bar** shows the release channel, framework (e.g. `.NET 10.0`), architecture (e.g. `x64`), and version (`yy.MM.dd.0`) together. The **About** dialog (top toolbar → Other Options → About) also shows the version, the last-checked time, and a **Release Notes** link — but not the framework/architecture.

 2. **Windows version & architecture.** e.g. Windows 11 24H2, x64 (or ARM64).
 3. **What you did, expected, and got.** Exact steps to reproduce, the expected result, and the actual result.
 4. **The wallpaper involved.** Its **type** (Gif/Url/Web/Video/YouTube/Application) and the **engine** in use for that type (Settings → Wallpaper). Many issues are engine-specific. See [Engine-Comparison](Engine-Comparison).
@@ -42,7 +42,9 @@
 6. **Logs.** Attach the log bundle (next section). This is the single most helpful thing you can include.
 7. **Screenshots/recording** if it's a visual problem (black screen, layout, flicker).

-> 📷 **Screenshot needed:** Portal → About dialog showing the version, framework, and architecture fields to include in a bug report.
+![Portal About dialog (top toolbar, Other Options, About) showing the version, the Last Checked time, and the Release Notes button](.images/Getting-Help-1.png)
+
+![The Portal bottom status bar showing the release channel, framework (.NET 10.0), architecture (x64), and version](.images/Getting-Help-2.png)

 ---

Getting Help modified by Bayram Emekli

Bayram Emekli — Sat, 04 Jul 2026 04:15:44 -0000

--- v1
+++ v2
@@ -34,7 +34,7 @@

 A good report lets a maintainer reproduce the problem without a back-and-forth. Include:

-1. **Sucrose version.** Open the **About** dialog (footer toolbar → Other Options → About) — it shows the version, framework, and architecture. The version format is `yy.MM.dd(.0)`.
+1. **Sucrose version.** Open the **About** dialog (top toolbar → Other Options → About) — it shows the version, framework, and architecture. The version format is `yy.MM.dd(.0)`.

 2. **Windows version & architecture.** e.g. Windows 11 24H2, x64 (or ARM64).
 3. **What you did, expected, and got.** Exact steps to reproduce, the expected result, and the actual result.
 4. **The wallpaper involved.** Its **type** (Gif/Url/Web/Video/YouTube/Application) and the **engine** in use for that type (Settings → Wallpaper). Many issues are engine-specific. See [Engine-Comparison](Engine-Comparison).

Getting Help modified by Bayram Emekli

Bayram Emekli — Sat, 04 Jul 2026 04:15:29 -0000

Getting Help

If the wiki didn't answer your question, here is where to ask, and how to ask so you get a fast, useful answer. Before opening a new issue, please check the FAQ, Troubleshooting-Common, and Troubleshooting-Settings-Startup-GPU — most problems are already covered there.

Where to get help
How to file a good bug report
How to collect logs
Reporting a crash
Requesting a feature
Security issues

Where to get help

Channel	Best for	Where
GitHub Issues	Reproducible bugs, with logs attached	`https://github.com/Taiizor/Sucrose/issues`
GitHub Discussions	Questions, ideas, "how do I…", general help	`https://github.com/Taiizor/Sucrose/discussions`
Discord	Real-time community chat and support	Linked from the project README / `_Footer`
The Store	Finding and reporting community wallpapers	In-app Store (see Using-Store)
Official website	Downloads, news, mirrors	`https://sucrose.soferity.com` and `https://taiizor.github.io/Sucrose`

Notes:

Blank issues are disabled. Use one of the issue templates (Bug report / Feature request). For open-ended questions use Discussions instead of Issues. See Contributing.
For contribution questions (building, conventions, PRs) start with Contributing and Building-From-Source.

How to file a good bug report

A good report lets a maintainer reproduce the problem without a back-and-forth. Include:

Sucrose version. Open the About dialog (footer toolbar → Other Options → About) — it shows the version, framework, and architecture. The version format is yy.MM.dd(.0).
Windows version & architecture. e.g. Windows 11 24H2, x64 (or ARM64).
What you did, expected, and got. Exact steps to reproduce, the expected result, and the actual result.
The wallpaper involved. Its type (Gif/Url/Web/Video/YouTube/Application) and the engine in use for that type (Settings → Wallpaper). Many issues are engine-specific. See Engine-Comparison.
Whether a different engine helps. Trying the alternate engine for the type narrows the cause fast. See Choosing-Engines.
Logs. Attach the log bundle (next section). This is the single most helpful thing you can include.
Screenshots/recording if it's a visual problem (black screen, layout, flicker).

📷 Screenshot needed: Portal → About dialog showing the version, framework, and architecture fields to include in a bug report.

How to collect logs

Sucrose writes a per-process log file per day to %AppData%\Sucrose\Log\<Process>-yy.MM.dd.log (for example Portal-yy.MM.dd.log, CefSharpLive-yy.MM.dd.log, Backgroundog-yy.MM.dd.log). To package them for a report:

Open Settings → System → Log Temporary → Create. This saves a zip (named sucrose_log_yyyyMMdd_HHmmss.zip) of your Log and Setting folders. The sensitive Objectionable.json (which holds your Personal Access Token) is excluded from the bundle.
Attach the resulting zip to your GitHub issue.

You can also open the log folder directly to grab a single engine's log. See Logs-Diagnostics for the log line format and the full process list, and Data-Locations for where everything lives.

Reporting a crash

When a Sucrose process throws an unhandled exception, the Watchdog shows a themed error dialog and writes a structured crash report to %AppData%\Sucrose\Cache\Report\<Guid>.json. If you have opted in to Report Data (ExceptionData, on by default), the Reportdog service uploads and deletes those reports automatically.

To help diagnose a crash:

Note the message shown in the Watchdog error dialog (it includes the log/source/help text).
If the dialog mentions a missing VC++ Redistributable or .NET Desktop Runtime, see Runtime-Dependencies.
Attach the relevant log and, if asked, the Report\<Guid>.json file (note it can contain device/OS identifiers — see Privacy-Telemetry).

See Crash-Reporting for the full crash pipeline.

Requesting a feature

Use the Feature request issue template on GitHub. Helpful things to include:

The problem you're trying to solve (not just the proposed solution).
Whether it relates to a wallpaper type, an engine, settings, or creation/publishing.
Any prior art (how Lively/Wallpaper Engine does it), if relevant.

For larger ideas, open a Discussion first to gauge interest before filing an issue. See Contributing and Extending-Sucrose.

Security issues

Do not open a public issue for a security vulnerability. Report it privately by email to taiizor@vegalya.com, keep it confidential, and do not disclose it publicly until it has been fixed. See Security-Policy.

Recent changes to Getting Help

Getting Help modified by Bayram Emekli

Getting Help modified by Bayram Emekli

Getting Help modified by Bayram Emekli

Getting Help modified by Bayram Emekli

Getting Help modified by Bayram Emekli

Getting Help

Contents

Where to get help

How to file a good bug report

How to collect logs

Reporting a crash

Requesting a feature

Security issues

See also