Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ifl0w/RandomWallpaperGnome3
Random Wallpapers for Gnome 3
https://github.com/ifl0w/RandomWallpaperGnome3
Last synced: 3 months ago
JSON representation
Random Wallpapers for Gnome 3
- Host: GitHub
- URL: https://github.com/ifl0w/RandomWallpaperGnome3
- Owner: ifl0w
- License: mit
- Created: 2014-08-20T00:21:43.000Z (over 10 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-20T16:51:09.000Z (3 months ago)
- Last Synced: 2024-10-20T19:29:59.103Z (3 months ago)
- Language: TypeScript
- Size: 6.83 MB
- Stars: 176
- Watchers: 7
- Forks: 42
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome - RandomWallpaperGnome3 - Random Wallpapers for Gnome 3 (Desktop Customization / VoIP)
README
RandomWallpaperGnome3
=====================
Random Wallpapers for Gnome 3 is a gnome-shell extension that fetches a random wallpaper from an online source and sets it as desktop background.
Install and try the extension at [extensions.gnome.org](https://extensions.gnome.org/extension/1040/random-wallpaper/).
## Features
* Various configurable wallpaper sources
* [Unsplash](https://unsplash.com/)
* [Wallhaven](https://wallhaven.cc/)
* [Reddit](https://reddit.com)
* Basically any JSON API/File ([Examples](https://github.com/ifl0w/RandomWallpaperGnome3/wiki/Generic-JSON-Source))
* Chromecast Images
* NASA Picture of the day
* Bing Picture of the day
* Google Earth View
* Local folders
* Static URLs
* Multiple sources to create a pool of sources
* History of previous images
* Save your favourite wallpaper
* Add images to a block list
* Set the lock screen background
* Timer based renewal (Auto-Fetching)
* Load a new wallpaper on startup
* Pause the timer when desired
* Support for multiple monitors using third party tools
* [Hydra Paper](https://hydrapaper.gabmus.org/)
* [Superpaper](https://github.com/hhannine/superpaper)
* Execute a custom command after every new wallpaper ([Examples](https://github.com/ifl0w/RandomWallpaperGnome3/wiki/Post-commands))
## Installation
### Release Archives
Archives from the [release page](https://github.com/ifl0w/RandomWallpaperGnome3/releases) can be installed and uninstalled using the gnome-extensions command line tool with the commands below.
```
gnome-extensions install
```
```
gnome-extensions uninstall [email protected]
```
### Symlink to the Repository
__Installing this way has following advantages:__
* Updating the extension using git (`git pull && ./build.sh`)
* Switching between versions and branches using git (run `./build.sh` after switching branch).
Requires [`blueprint-compiler`](https://repology.org/project/blueprint-compiler/versions) and [`npm`](https://repology.org/project/npm/versions) at install and update time.
Clone the repository and run `./build.sh && ./install.sh` in the repository folder to make a symbolic link from the extensions folder to the git repository.
This installation will depend on the repository folder, so do not delete the cloned folder.
Then open the command prompt (Alt+F2) end enter `r` to restart the gnome session.
In the case you are using Wayland, then no restart should be required.
Now you should be able to activate the extension through the gnome-tweak-tool.
To uninstall the extension, run `./install uninstall` or manually delete the corresponding symbolic link.
## Build From Source
Requires [`blueprint-compiler`](https://repology.org/project/blueprint-compiler/versions) and [`npm`](https://repology.org/project/npm/versions) at install and update time.
Clone or download the repository and copy the folder `[email protected]` in the repository to `$XDG_DATA_HOME/gnome-shell/extensions/` (usually `$HOME/.local/share/gnome-shell/extensions/`).
Run `./build.sh` inside the repository.
Then open the command prompt (Alt+F2) end enter `r` to restart the gnome session.
In the case you are using Wayland, then no restart should be required.
Now, you should be able to activate the extension through the gnome-tweak-tool.
## Debugging
You can follow the output of the extension with `./debug.sh`. Information should be printed using the existing logger class but can also be printed with `global.log()` (not recommended).
To debug the `prefs.js` use `./debug.sh prefs`.
## Compiling individual parts
### Schemas
This can be done with the command:
~~~
glib-compile-schemas --targetdir="[email protected]/schemas/" "src/schemas"
~~~
### UI
Requires [`blueprint-compiler`](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/):
~~~
blueprint-compiler batch-compile "src/ui" "[email protected]/ui" "src"/ui/*.blp
~~~
### TypeScript
Requires [`npm`](https://repology.org/project/npm/versions):
~~~
npm install
npx --silent tsc
~~~
## Adding new sources
1. Build UI for settings using the [blueprint-compiler](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/) language in `src/ui/mySource.blp` - see [Workbench](https://apps.gnome.org/app/re.sonny.Workbench/) for a live preview editor.
1. Create and add a settings layout to the `src/schemas/….gschema.xml`. Also add your source to the `types` enum.
1. Create your logic hooking the settings in a `src/ui/mySource.ts`
1. Add the new source to `src/ui/sourceRow.ts:_getSettingsGroup()`, don't forget the import statement.
1. Create a adapter to read the settings and fetching the images and additional information in `src/adapter/mySource.ts` by extending the `BaseAdapter`.
1. Add your adapter to `src/wallpaperController.ts:_getRandomAdapter()`, don't forget the import statement.
## Support Me
If you enjoy this extension and want to support the development, then feel free to buy me a coffee. :wink: :coffee:
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RBLX73X4DPS7A)