Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckyturtledev/more-wallpapers
rust crossplatform library to set desktop wallpaper per screen
https://github.com/luckyturtledev/more-wallpapers
background desktop rust wallpaper
Last synced: 3 months ago
JSON representation
rust crossplatform library to set desktop wallpaper per screen
- Host: GitHub
- URL: https://github.com/luckyturtledev/more-wallpapers
- Owner: LuckyTurtleDev
- License: apache-2.0
- Created: 2022-05-13T14:49:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T13:27:23.000Z (10 months ago)
- Last Synced: 2024-10-11T02:33:27.540Z (3 months ago)
- Topics: background, desktop, rust, wallpaper
- Language: Rust
- Homepage: https://crates.io/crates/more-wallpapers
- Size: 112 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# more-wallpapers  [](https://crates.io/crates/more-wallpapers) [](https://docs.rs/more-wallpapers) [](https://github.com/LuckyTurtleDev/more-wallpapers) 
Yet another wallpaper crate, which can set a wallpapers per screen.
The main feature over other crates like [wallpaper][__link0] or [wall][__link1] is the ability to set **different wallpapers** on different screens. Currently this feature is only implemented for some environments. Because of this you can enable the `fallback` feature, to use a [custom version][__link2] of the [wallpaper][__link3] crate as a fallback on unsupported environments. This means you can use the additonal features of this crate and still support a large amount of environments.
Currently the following environments are supported:
| environment | set wallpaper | set wallpaper per screen | requirements |
| --- |:---:|:---:| --- |
| Windows | ✅ | ❌ | `features=["fallback"]`¹ |
| MacOS | ✅ | ❌ | `features=["fallback"]`¹ |
| X11³ | ✅ | ✅ | [xwallpaper][__link4], [libxrandr][__link5]² |
| Budgie(wayland) | ✅ | ❌ | `features=["fallback"]`¹ |
| Cinnamon⁴ | ✅ | ✅ | [xwallpaper][__link6], [libxrandr][__link7]² |
| Deepin(wayland) | ✅ | ❌ | `features=["fallback"]`¹ |
| GNOME(wayland) | ✅ | ❌ | `features=["fallback"]`¹ |
| KDE | ✅ | ✅ | |
| Mate(wayland) | ✅ | ❌ | `features=["fallback"]`¹ |
| Sway | ✅ | ✅ | |
| XFCE | ✅ | ✅ | |
¹ Please check also the requirements of the [wallpaper][__link8] crate.
² Normally already installed.
³ Wallpapers will be reset after restart.
⁴ Wallpapers will be reset to provided default after restart.
The information about the currently supported features are also provided by the [`Environment`][__link9] enum.
### QuickStart / Examples:
If you would like to set only a different wallpaper for each screen and don’t care which wallpaper is used on which screen, you can use [`set_wallpapers_from_vec()`][__link10] or [`set_random_wallpapers_from_vec()`][__link11] (only aviable with the `rand` feature):
```rust
use more_wallpapers::Mode;
let images = vec!["1.jpg", "/usr/share/wallpapers/2.jpg"];
more_wallpapers::set_wallpapers_from_vec(images, "default.jpg", Mode::Crop)?;
```
The `"default.jpg"` is used as wallpaper for [inactive screens][__link12]. If you do not know witch value you shoud use here, you can simple use the first elment of the images vec.
For advanced wallpaper settings you can use the [`WallpaperBuilder`][__link13]:
```rust
use more_wallpapers::{Mode, WallpaperBuilder};
let fallback_images = vec!["/usr/share/wallpapers/1.jpg", "/usr/share/wallpapers/2.jpg"];
let mut i = 0;
WallpaperBuilder::new()?.set_wallpapers(|screen| {
i += 1;
if i == 1 {
return ("first.jpg".to_owned(), Mode::default());
}
if screen.name == "HDMI1" {
return ("/usr/share/wallpapers/hdmi.jpg".to_owned(), Mode::Fit);
}
(
fallback_images[i % fallback_images.len()].to_owned(),
Mode::Tile,
)
})?;
```
[__cargo_doc2readme_dependencies_info]: ggGkYW0BYXSEG_W_Gn_kaocAGwCcVPfenh7eGy6gYLEwyIe4G6-xw_FwcbpjYXKEG9GIfJPZsn4fG2Jv3ZDwtk2wG3mXKLFhqSX8G07FLfx08l7TYWSBg29tb3JlLXdhbGxwYXBlcnNlMC40LjBvbW9yZV93YWxscGFwZXJz
[__link0]: https://crates.io/crates/wallpaper
[__link1]: https://crates.io/crates/wall
[__link10]: https://docs.rs/more-wallpapers/0.4.0/more_wallpapers/?search=set_wallpapers_from_vec
[__link11]: `set_random_wallpapers_from_vec()`
[__link12]: https://docs.rs/more-wallpapers/0.4.0/more_wallpapers/?search=Screen::active
[__link13]: https://docs.rs/more-wallpapers/0.4.0/more_wallpapers/struct.WallpaperBuilder.html
[__link2]: https://github.com/LuckyTurtleDev/wallpaper.rs
[__link3]: https://crates.io/crates/wallpaper
[__link4]: https://github.com/stoeckmann/xwallpaper
[__link5]: https://gitlab.freedesktop.org/xorg/app/xrandr
[__link6]: https://github.com/stoeckmann/xwallpaper
[__link7]: https://gitlab.freedesktop.org/xorg/app/xrandr
[__link8]: https://crates.io/crates/wallpaper
[__link9]: https://docs.rs/more-wallpapers/0.4.0/more_wallpapers/enum.Environment.html