Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 3.79 KB

README.md

File metadata and controls

122 lines (87 loc) · 3.79 KB

linux-wallpaperengine-player

A script tool for playing and checking live wallpapers with wallpaperengine and linux-wallpaperengine.

Features

  • Pick and play a single wallpaper using Wallpaper Engine's UI.
  • Batch check wallpapers using Wallpaper Engine's folders.
  • Play wallpapers using a playlist.

Requirement

  • linux-wallpaperengine
  • Steam(Linux)
  • wallpaperengine on Steam
  • run wallpaperengine using proton
  • cargo >= 1.81.0

Installation

Clone this repo, and just run using cargo run

    git clone https://github.com/DI-HUO-MING-YI/linux-wallpaperengine-player.git
    cd linux-wallpaperengine-player
    cargo run -- --help

Usage

  • Pick and play a single wallpaper using Wallpaper Engine's UI.

  1. open the wallpaperengine UI, pick a wallpaper and click Displays watch_1 *Now only one display is supported, multi displays supporting is comming soon.
  2. save as a profile with the name test_m_1 watch_2 watch_3
  3. run cargo run to start display wallpaper
cargo run -- --watch --profile test_m_1
  1. the wallpaper will display now.
  2. you can pick a new wallpaper and save profile with the same name.
  3. wait 1 scond, and new wallpaper will replace the last one.

  • Batch check wallpapers using Wallpaper Engine's folders.

  1. create a new folder named test, and put wallpapers that you want to check. check_1

    NOTE:

    * MUST CLOSE THE WALLPAPER ENGINE
    * It is recommend to close it using Steam stop function

  2. run cargo run to batch check. chose which fold to check, and play wallpapers one by one. check_2 check_3

    NOTE:

    * folders named with suffix "_piecked" and "_skipped" will not be checked
    * type y / n to check a wallpaper, if y , the wallpaper will be moved to a new folder named test_picked
    * if n, the wallpaper will be moved to a new folder named test_skipped
    * if type nothing and just press enter, the wallpaper will not be moved

  3. test_skipped and test_picked will be created and wallpapers will be moved to them by your choise. check_4 check_5 check_6

  • Play wallpapers using a playlist.

  1. open the wallpaperengine UI, pick some wallpapers and add to playlist, then click Configure. play_1

  2. set playlist settings, not all settings is available, but they are comming soon.

    only timer play mode is available now, and you can set times now
    Oreder is also supported now play_2

  3. save as a playlist with the name test_p_1 play_3 play_4

  4. run cargo run to start display wallpapers using playlist seetings

cargo run -- --play --playlist test_p_1
  1. the wallpaper will display now.
  2. you can pick some wallpapers and save playlist with the same name.
  3. rerun cargo run to apply new playlist settings.

  • set sddm video background

    just run :
cargo run -- --sddm --folder test_f_1

NOTE:

* Only for this sddm theme: theme

Configration

Roadmap

  • add play mode for folders.
  • support more playlist options.
  • support multi display in profile.
  • upload to AUR.
  • move current wallpaer to a folder when run this tool, not always to open wallpaperengine's UI.
  • try to chage wallpaper by click wallpaer icons just like what shows in windows.
  • more logs and error handler.

NOTE: I only test this tool on Archlinux with Hyprland.

If you have any questions, just post an issue.