/lwp

Multi-platform parallax wallpaper engine

Primary LanguageCMIT LicenseMIT

Layered WallPaper

Layered WallPaper allows You to create multi-layered parallax wallpapers.
Each layer moves with Your mouse cursor, creating this beautiful effect.

InstallationConfigurationCreating Wallpapers

a.mp4

Installation

Linux

Dependencies

  • Install SDL2 using Your package manager
  • If You are using Wayland, You also must install XWayland

Installation steps

  • Download .tar.gz package from releases
  • Extract the content to /usr/local:
sudo tar -o -xvf [archive name].tar.gz --directory /usr/local
  • Note that if You install lwp somewhere else than /usr/local, You need to set LWP_PREFIX env before running lwp.
  • Test Layered WallPaper by running lwp
  • Run lwp, then run it again to open the configuration window. Select wallpaper for each monitor.
  • If You can't see any wallpaper try setting Draw on root window in application settings. This may be necessary on some distributions for Layered WallPaper to work properly (see configuration)
  • To make Layered WallPaper run on startup, add lwp & command to Your desktop enviroment .rc file

Build from source instead

  • In some distributions SDL2 doesn't contain development files, so it may be also necessary to install development version of SDL2
  • Install CMake
  • Clone the repository and prepare a build directory:
git clone https://github.com/jszczerbinsky/lwp
cd lwp
mkdir build
cd build
  • Compile the project and generate a .tar.gz package
cmake ../
cmake --build .
cpack
  • After this .tar.gz package should appear. Follow the installation steps
Windows

Installation steps

  • Download and run the installer from releases
  • Layered WallPaper should run immediately after the installation
  • Click the tray icon on the right side of Your taskbar to show the configuration window. Set the wallpapers for each monitor

Build from source instead

To compile Layered WallPaper on Windows you need to install MSYS2. After the installation follow the guide for setting up GTK development enviroment. From now on continue using MSYS2 MinGW terminal (make sure you're using MSYS2 MINGW64/MSYS2 MINGW32 instead of MSYS2).

Install the remaining dependencies
# For 64bit:
pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-SDL2 mingw-w64-x86_64-gcc mingw-w64-x86_64-gtk3 mingw-w64-x86_64-libconfig

# For 32bit:
pacman -S mingw-w64-i686-cmake mingw-w64-x86_i686-SDL2 mingw-w64-x86_i686-gcc mingw-w64-x86_i686-gtk3 mingw-w64-x86_i686-libconfig
Clone the repository
git clone https://github.com/jszczerbinsky/lwp
cd lwp
mkdir build
cd build
Compile and install
  • Download SDL2 runtime package and unpack it.
  • Compile the program
# Remember to use unix path format (instead of C:/path/to/dir use /c/path/to/dir)
cmake -DSDL2_RUNTIME_DIR=/path/to/dir ../
cmake --build .
# Prepare the DLLs, that will be shipped with the program.
# The script is going to ask you which version of gdbus.exe should it use (32bit or 64bit)
../distributeDLLs.sh
cpack

After this the installer should appear in the current directory.

Configuration

Open configuration window

  • On Linux when lwp is already running in the background, run lwp again to show the window.
  • On Windows You can click the icon on the right side of the task bar.

Installing wallpapers

  • To install wallpaper, copy the directory to %LOCALAPPDATA%\lwp\wallpapers\

Creating Wallpapers

Want to share Your wallpaper? Join our discord!

Parallax wallpapers are not popular. Because of this if You want some cool parallax wallpaper, You have to either find a parallax game background on the internet and use it as a wallpaper or cut some real wallpaper into layers using Gimp or Photoshop.

How to create a wallpaper for Layered WallPaper

  • Create a directory for Your wallpaper
  • Save each layer to this directory as .bmp file and name them 1.bmp, 2.bmp ... (1.bmp is bottom most layer)
  • Create a wallpaper config file and name it wallpaper.cfg (You can make a copy from C:\Program Files\lwp\wallpapers\default-fullhd\wallpaper.cfg)

Example:

File structure:

C:
 └  MyCoolWallpaperDirectory
         └  wallpaper.cfg
         └  1.bmp
         └  2.bmp
         └  3.bmp

Config file:

Type Name Description
int count Wallpaper layers count
float movement_x Mouse sensitivity in X axis
float movement_y Mouse sensitivity in Y axis
int repeat_x Repeat the wallpaper in X axis
int repeat_y Repeat the wallpaper in Y axis

License

MIT License

Copyright (c) 2022 Jakub Szczerbiński

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.