mirrors/linux-wallpaperengine
1
0
Fork 0
mirror of https://github.com/Almamu/linux-wallpaperengine.git synced 2025-09-14 13:56:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

~ doc: minor formatting changes and typo fixes

Browse Source
This commit is contained in:
Tarulia 2022-04-04 13:49:18 +02:00 committed by Alexis Maiquez
parent dd54abd9ba
commit 4c0322d9e6
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -5,7 +5,7 @@
This projects aims to reproduce the background functionality of Wallpaper Engine on Linux systems. Simple as that. This projects aims to reproduce the background functionality of Wallpaper Engine on Linux systems. Simple as that.
# 3. What is Wallpaper Engine? # 3. What is Wallpaper Engine?
Wallpaper Engine is a software designed by [Kristjan Skutta](https://store.steampowered.com/search/?developer=Kristjan%20Skutta&snr=1_5_9__400) that provides live wallpaper functionality to Windows Systems, allowing It's users to animate their own backgrounds and sharing their own creations. You can find more about it on their [Steam page](https://store.steampowered.com/app/431960/Wallpaper_Engine/) Wallpaper Engine is a software designed by [Kristjan Skutta](https://store.steampowered.com/search/?developer=Kristjan%20Skutta&snr=1_5_9__400) that provides live wallpaper functionality to Windows Systems, allowing It's users to animate their own backgrounds and sharing their own creations. You can find more about it on their [Steam page](https://store.steampowered.com/app/431960/Wallpaper_Engine/).
# 4. Compilation requirements # 4. Compilation requirements
## linux-wallpaperengine ## linux-wallpaperengine
@ -35,13 +35,20 @@ Once Wallpaper Engine is downloaded, open the installation folder (Right-Click t
![folder](docs/images/screenshot_folder.png) ![folder](docs/images/screenshot_folder.png)
The assets folder itself can be copied to the same folder where the binary lives. The assets folder itself **must** be copied to the same folder where the binary lives.
## 5.3. Getting the sources ## 5.3. Getting the sources
You can download a zipped version of the repository here: https://github.com/Almamu/linux-wallpaperengine/archive/refs/heads/main.zip You can download a zipped version of the repository here: https://github.com/Almamu/linux-wallpaperengine/archive/refs/heads/main.zip
You can also clone the repository using git like this: You can also clone the repository using git like this:
```git clone git@github.com:Almamu/linux-wallpaperengine.git``` ```
git clone git@github.com:Almamu/linux-wallpaperengine.git
```
Or using the HTTPS method if you haven't set up SSH:
```
https://github.com/Almamu/linux-wallpaperengine.git
```
## 5.4. Compilation steps ## 5.4. Compilation steps
The project is built on CMake as build engine. First we need to create the directory where the build will be stored and get into it: The project is built on CMake as build engine. First we need to create the directory where the build will be stored and get into it:
@ -51,7 +58,7 @@ mkdir build
cd build cd build
``` ```
Once the folder is created and we're in it, cmake has to generate the actual Makefiles. This can be done this way Once the folder is created and we're in it, CMake has to generate the actual Makefiles. This can be done this way:
``` ```
cmake .. cmake ..
``` ```
@ -62,7 +69,7 @@ Finally we can compile the project to generate the actual executable
make make
``` ```
**REMEMBER: The assets folder has to be at the same folder as the executable** **REMEMBER: The assets folder has to be in the same folder as the executable**
## 5.5. Running a background ## 5.5. Running a background
### 5.5.1. Getting the theme files ### 5.5.1. Getting the theme files
@ -76,7 +83,7 @@ Currently both compressed and uncompressed backgrounds are supported. Loading th
./wallengine /home/almamu/Development/backgrounds/1845706469/ ./wallengine /home/almamu/Development/backgrounds/1845706469/
``` ```
Where ```/home/almamu/Development/backgrounds/1845706469/``` is the background's path. Where `/home/almamu/Development/backgrounds/1845706469/` is the background's path.
### 5.5.3. Running as a screen's background ### 5.5.3. Running as a screen's background
Only screens configured with the XRandr extension are supported. To specify the screen names (as reported from xrandr tool) just use the ```--screen-root``` switch. You can specify multiple screens at the same time, for example: Only screens configured with the XRandr extension are supported. To specify the screen names (as reported from xrandr tool) just use the ```--screen-root``` switch. You can specify multiple screens at the same time, for example:
@ -92,7 +99,7 @@ To reduce the performance hit to your system you can reduce (or increase) the FP
./wallengine --fps 30 ./wallengine --fps 30
``` ```
###### Example background ## 6. Example background
This was the first background to even be compatible with the software. And It's not 100% compatible yet. Both textures and shaders are properly loaded, but there are still particles missing. This was the first background to even be compatible with the software. And It's not 100% compatible yet. Both textures and shaders are properly loaded, but there are still particles missing.
![example](docs/images/example.gif) ![example](docs/images/example.gif)