Project Documentation

ClyoWallpaper Introduction

Welcome to the developer documentation for ClyoWallpaper.

What is ClyoWallpaper?

ClyoWallpaper is a native Android application designed to turn your self-hosted ClyoCloud server into an automated live wallpaper rotation engine. It downloads high-quality backgrounds directly from your server, manages custom layouts, and schedules wallpaper cycles.

System Flow

  • Android App: Connects and logs in to the self-hosted ClyoCloud API.
  • Configuration: The user chooses to cycle wallpapers from a custom playlist or all images available in storage.
  • Editor: The user adjusts scales and pans for each wallpaper.
  • Scheduler: Background services or WorkManager jobs coordinate downloads and update the device's system wallpapers at regular intervals.
  • Widget: Displays current/next wallpapers and hosts an interactive trigger to force a rotation cycle manually.

Key Features

  • Reliable Foreground Service: Uses WallpaperCycleService to guarantee wallpapers are downloaded and changed on schedule, preventing background execution limits from killing the routine.
  • Interactive Crop & Pan Canvas: Allows users to zoom, drag, and fit wallpapers manually to align them perfectly for their phone aspect ratio.
  • Flexible Source Selection: Cycle sequential or random items from a saved playlist or the full server archive.
  • Home Screen Widget: A beautiful dynamic home widget showing wallpaper status and a manual refresh trigger.
  • Target Choice: Configure wallpapers to target the Home Screen, Lock Screen, or both.