# 🖥️ i3 wallpaper manager

**i3 wallpaper manager** is a command-line tool designed to change the wallpaper depending of active workspaces on [i3](https://i3wm.org/).

## 📗 How to install the project

Pre-compiled versions are available in the [Releases](https://gitnet.fr/deblan/i3-wallpaper-manager/releases). For Debian users, a package is also provided.

If you want to compile the project from source, you will need at least the GO compiler version 1.22. Clone the project and run the make command. The compiled output will be located in the `build` directory.

```
$ git clone https://gitnet.fr/deblan/i3-wallpaper-manager
$ make
```

## 🧪 How to use the project

To start, you need to create a configuration file in YAML format. This file consists of two keys: `default` to define the path of the default wallpaper, and `workspaces` which allows you to associate each workspace with its corresponding wallpaper.

```
default: /home/alice/wallpapers/default.jpg
workspaces:
  "Name of the workspace 1": /home/alice/wallpapers/1.jpg
  "Name of the workspace 2": /home/alice/wallpapers/2.jpg
  "Name of the workspace 3": /home/alice/wallpapers/3.jpg
```

Next, you simply need to run `i3-wallpaper-manager` while specify the path to the configuration file.

```
i3-wallpaper-manager /path/to/config.yaml
```

To run it when i3 starts, add this to your i3 configuration:

```
exec_always i3-wallpaper-manager /path/to/config.yaml
```