Wallpaper Lively X - source code
================================

This archive is the complete source code of the released build. It is published under
the GNU General Public License v3 (see LICENSE) because the application is a derivative
work of Lively Wallpaper (https://github.com/rocksdanister/lively).

Layout
------
  src/livelywpf/livelywpf.sln        the solution (open this)
  src/livelywpf/livelywpf            the WPF application
  src/livelywpf/wallpaper.package    the MSIX packaging project
  src/livelywpf/livelympvplayer, libVLCPlayer, livelySubProcess,
  livelyScreenSaver, livelyCmdUtility, UWP/*   supporting projects
  LICENSE                            GPL-3.0
  README.md, PRIVACY.md              project documentation

Not included (kept out on purpose)
---------------------------------
  * bin/ obj/ .vs/ and other build output - regenerate by building
  * the bundled VLC runtime (src/livelywpf/livelywpf/plugins/libVLCPlayer/libvlc)
    - install VLC 3.x for the architecture you build, or copy its libvlc folder there
  * mpv binaries for video playback - see https://mpv.io for a matching build
  * the sample wallpaper packs that the upstream repository ships under
    src/livelywpf/livelywpf/bundle - this product takes its content from the store,
    which is why the application does not need them
  * packaging identity files (certificates, Partner Center association) - a build you
    make yourself uses its own packaging identity

Building
--------
  1. Visual Studio 2022 with ".NET desktop development" and "Windows application
     packaging" workloads, plus the Windows 10/11 SDK
  2. Open src/livelywpf/livelywpf.sln and restore NuGet packages
  3. Build livelywpf for an unpackaged development run, or wallpaper.package for an MSIX

The application targets .NET Core 3.1 and uses Windows Store APIs, so the packaged
build needs a package identity; the unpackaged build runs without one.

Third-party components and their license texts are listed in the application under
Settings -> About -> Attribution, and online at
https://winappcenter.com/products/wallpaper-lively-x/source/

Questions: softsunion@outlook.com

Catalogue API key
-----------------
The wallpaper catalogue used by the store is operated by the publisher and requires a client
key. That key is not published with this source: LivelyWallpapersNetClient.cs carries a
REPLACE-WITH-YOUR-API-KEY placeholder instead, because the key belongs to the service
operator rather than to the application. Set your own value there to build a store that talks
to the catalogue; every other part of the application builds and runs without it.
