Skip to content

Usage guide

This page describes the main LWE workflows.

Library

The Library is the daily-use home for local wallpaper content. Use it to review recognized wallpapers, inspect compatibility information, and apply supported items to monitors.

Library cards now expose the item's content type, compatibility level, and runtime availability. Video items that can run on the verified runtime path are labeled as runnable, while recognized-only scene/web items are labeled as not runnable by the current video runtime before you open the detail panel.

Typical Library flow:

  1. Open Library.
  2. Select a wallpaper.
  3. Review metadata and compatibility details.
  4. Apply it to a monitor, or clear the current assignment.

After applying, clearing, or restoring desktop assignments, LWE refreshes the selected Library detail where possible so assigned-monitor labels stay aligned with the Desktop page. If refresh fails, the populated detail view remains visible and the error is shown inline.

Workshop

Workshop features are designed around discovery and acquisition orchestration. LWE helps users find Wallpaper Engine content, understand whether it is useful on Linux, and move recognized content into a local workflow.

Workshop browsing requires a Steam Web API key configured in Settings. Steam may still be responsible for subscription, download, and account-owned content synchronization.

Online Workshop results are discovery-only. A result being visible in LWE does not mean the item is already synchronized locally, and LWE does not directly download Workshop content. Use Open in Steam as the acquisition and subscription handoff, then refresh local Workshop content after Steam finishes synchronizing.

Search result cards label inferred runtime expectations. Video results are the only currently runnable type after local sync. Scene and web results are recognized for metadata and compatibility reporting, but are not runnable by the current video runtime. Application results are outside the current runtime scope.

Workshop search cards keep a bounded card width even when a filter returns only one or two results, so sparse result sets keep the same visual scale as normal browsing pages.

When the Steam Web API key is missing, Workshop search points you back to Settings. Settings also distinguishes the common Steam integration states where possible: Steam not detected, Steam detected but Wallpaper Engine Workshop content missing, Wallpaper Engine present but no local Workshop items synchronized yet, and local Workshop content available.

Compatibility levels

Treat compatibility information as the source of truth for whether a wallpaper should work in the current app.

LWE's product model recognizes common Wallpaper Engine content categories:

  • video: primary first-release runtime focus and the only current runnable type on the verified path;
  • scene: recognized where metadata is available, but not a first-release runtime target until real support is implemented and verified;
  • web: recognized for reporting, not a first-release runtime target.

If the app reports that an item is unsupported or degraded, do not assume it can be fixed by reinstalling the package. It may be outside the current runtime scope.

Monitor assignment

LWE is desktop-app first. The intended workflow is:

  1. choose content from Library;
  2. select a monitor;
  3. apply the wallpaper;
  4. clear or replace the assignment when needed.

Monitor discovery and restore behavior depend on the Linux session. The verified path is Wayland with niri; other environments need explicit validation before they are documented as supported. LWE does not plan X11 wallpaper runtime support for v1. Future runtime expansion is based on Wayland protocol capabilities such as wl_output and zwlr_layer_shell_v1, not desktop-environment-specific integrations.

Settings

Use Settings for user preferences and integration state:

  • language;
  • theme;
  • Steam Web API key;
  • launch-on-login behavior where supported;
  • visible Steam integration state.

Settings are part of the user-facing product and must remain available in both English and Simplified Chinese.

Data and local state

LWE stores application state under the lwe configuration root used by the app. Contributors should avoid documenting internal paths as permanent user-facing API unless the path is intentionally stabilized.

Current limitations

The first release does not aim to provide:

  • full web wallpaper runtime parity;
  • creator tools;
  • cloud or community systems;
  • advanced automation rules;
  • guaranteed behavior on untested compositors or desktop environments;
  • X11 wallpaper runtime support.