Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jszczerbinsky/lwp

Multi-platform parallax wallpaper engine
https://github.com/jszczerbinsky/lwp

animated-wallpaper customizable customization linux live-wallpaper macos parallax-scrolling wallpaper windows

Last synced: 5 days ago
JSON representation

Multi-platform parallax wallpaper engine

Host: GitHub
URL: https://github.com/jszczerbinsky/lwp
Owner: jszczerbinsky
License: mit
Created: 2022-09-18T11:14:27.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-07-09T16:52:49.000Z (4 months ago)
Last Synced: 2024-08-02T16:32:12.138Z (3 months ago)
Topics: animated-wallpaper, customizable, customization, linux, live-wallpaper, macos, parallax-scrolling, wallpaper, windows
Language: C
Homepage:
Size: 12.3 MB
Stars: 873
Watchers: 8
Forks: 12
Open Issues: 8
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

awesome - jszczerbinsky/lwp - Multi-platform parallax wallpaper engine (C)

README

# Layered WallPaper

Layered WallPaper allows You to create multi-layered parallax wallpapers.

Each layer moves with Your mouse cursor, creating this beautiful effect.

[![](https://img.shields.io/github/v/release/jszczerbinsky/lwp?style=for-the-badge)](https://github.com/jszczerbinsky/lwp/releases/latest)
[![](https://img.shields.io/github/downloads/jszczerbinsky/lwp/total?style=for-the-badge)](https://github.com/jszczerbinsky/lwp/releases/latest)
[![](https://img.shields.io/github/actions/workflow/status/jszczerbinsky/lwp/build.yml?style=for-the-badge)](https://github.com/jszczerbinsky/lwp)
[![](https://img.shields.io/discord/1077955077974794322?label=DISCORD&style=for-the-badge)](https://discord.gg/JmkCqjYFQa)

[Installation](#installation) •
[Configuration](#configuration) •
[Creating Wallpapers](#creating-wallpapers)

https://user-images.githubusercontent.com/38699473/220888934-09788a6b-873c-469b-b147-b345e8a8949a.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](https://github.com/jszczerbinsky/lwp/releases/latest)
- Extract the content to `/usr/local`:
```shell
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](#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:

```shell
git clone https://github.com/jszczerbinsky/lwp
cd lwp
mkdir build
cd build
```
- Compile the project and generate a `.tar.gz` package
```shell
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](https://github.com/jszczerbinsky/lwp/releases/latest)
- 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](https://www.msys2.org/). After the installation follow the guide for setting up [GTK development enviroment](https://www.gtk.org/docs/installations/windows#using-gtk-from-msys2-packages). From now on continue using MSYS2 MinGW terminal (make sure you're using `MSYS2 MINGW64`/`MSYS2 MINGW32` instead of `MSYS2`).

##### Install the remaining dependencies
```shell
# 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
```shell
git clone https://github.com/jszczerbinsky/lwp
cd lwp
mkdir build
cd build
```

##### Compile and install
- Download [SDL2](https://github.com/libsdl-org/SDL/releases/latest) runtime package and unpack it.
- Compile the program
```shell
# 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](https://discord.gg/JmkCqjYFQa)!

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

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.