Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cheesecakeufo/komorebi

A beautiful and customizable wallpapers manager for Linux
https://github.com/cheesecakeufo/komorebi

animated background desktop linux vala wallpaper

Last synced: 8 days ago
JSON representation

A beautiful and customizable wallpapers manager for Linux

Awesome Lists containing this project

README 

        


Komorebi - Animated Wallpapers for Linux


(n) sunlight filtering through trees.





	Platform (GNU/Linux)

	Awesome

	Build Status






Komorebi Demo
Watch demo




## What is Komorebi?



Komorebi is an awesome animated wallpapers manager for all Linux platforms.

It provides fully customizeable image, video, and web page wallpapers that can be tweaked at any time!



![s1](https://raw.githubusercontent.com/cheesecakeufo/komorebi/master/screenshots/collage.jpg)



## How do I install Komorebi?



Two ways:



### Packaged install (easy)



1. Download `Komorebi` from the [Komorebi releases page](https://github.com/cheesecakeufo/komorebi/releases).

2. Install Komorebi using your favorite package installer (aka. double click on it)

3. Launch Komorebi!



### Manual Installing (advanced)



Run the following:

```

sudo add-apt-repository ppa:gnome3-team/gnome3 -y

sudo add-apt-repository ppa:vala-team -y

sudo add-apt-repository ppa:gnome3-team/gnome3-staging -y

sudo apt install cmake valac libgtk-3-dev libgee-0.8-dev libclutter-gtk-1.0-dev libclutter-1.0-dev libwebkit2gtk-4.0-dev libclutter-gst-3.0-dev

git clone https://github.com/cheesecakeufo/komorebi.git

cd komorebi

mkdir build && cd build

cmake .. && sudo make install && ./komorebi

```



## Change Wallpaper & Desktop Preferences

To change desktop preferences or your wallpaper, right click anywhere on the desktop to show the menu.



![s1](https://raw.githubusercontent.com/cheesecakeufo/komorebi/master/screenshots/preferences.jpg)



## How do I create my own wallpaper?



Komorebi provides a simple tool to create your own wallpapers! Simply, open your apps and search for 'Wallpaper Creator'



![s1](https://raw.githubusercontent.com/cheesecakeufo/komorebi/master/screenshots/wallpaper_creator.jpg)



You can use either an image, a video, or a web page as a wallpaper and you have many different options to customize your very own wallpaper!



## Uninstall



### If you installed a packaged version of Komorebi



1. Open Terminal

2. `sudo apt remove komorebi`



### If you manually installed Komorebi



1. Open Terminal

2. `cd komorebi/build`

3. `sudo make uninstall`



## Questions? Issues?



### Komorebi is slow. What can I do about it?



Komorebi includes support for video wallpapers that might slow your computer down. You can disable support for video wallpapers in 'Desktop Preferences' → uncheck 'Enable Video Wallpapers'.



_note: you need to quit and re-open Komorebi after changing this option_



### After uninstalling, my desktop isn't working right (blank or no icons)



The latest Komorebi should already have a fix for this issue. If you've already uninstalled Komorebi and would like to fix the issue, simply run this (in the Terminal):

`curl -s https://raw.githubusercontent.com/cheesecakeufo/komorebi/master/data/Other/postrm | bash -s`



If your issue has not already been reported, please report it *[`here`](https://github.com/cheesecakeufo/komorebi/issues/new)* and I'll try my best to fix them.



### Why does Komorebi install files in a macOS-like structure?



Komorebi was originally intended to run on an unreleased OS project. Since many people already use Komorebi, an update could potentially break Komorebi and custom-made wallpapers.



It is possible to change the file structure with code changes and a `postinst` script but I'd rather keep it as is for now or if you have the time to make one, feel free to do so and submit a PR!



## Status of Development



Komorebi still receives updates but they are not as frequent due to my involvement in other open-source projects.



### Thanks To:



Pete Lewis ([@PJayB](https://github.com/PJayB)) for adding mult-monitor support