xkcd-wallpaper 0.0.1

CLI Tool to download and generate wallpapers from xkcd comics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# xkcd-wallpaper

[![MIT License](https://img.shields.io/github/license/filipepcampos/xkcd-wallpaper)](LICENSE)
![Build status](https://img.shields.io/github/actions/workflow/status/filipepcampos/xkcd-wallpaper/rust.yml)

Turn any XKCD comic into a wallpaper.

Fetches a comic (latest or by number), lays it on a canvas, replaces the background with your chosen hex colour, and saves the finished image -- ready to set as your desktop background. This can be combined with a startup script to replace your wallpaper daily.


## Install

### Stable release (planned)
> [!CAUTION]
> This is planned for the future, as of this moment, this is still not possible

```bash
cargo install xkcd-wallpaper
```

### From source

```sh
git clone https://github.com/filipepcampos/xkcd-wallpaper.git
cd xkcd-wallpaper
cargo install --path .
```

## Usage

Print the full CLI reference:

```
xkcd-wallpaper --help
```

Generate a 2560 × 1440 wallpaper from comic 3084 with a dark‑green background:

```
xkcd-wallpaper \
  --width 2560 --height 1440 \
  --bg "#1F241F" \
  --fg light \
  --comic 3084
```

## Example output

Original comic             |  Wallpaper |
:-------------------------:|:-------------------------:|
![Original commit](assets/comic_1.png)  |  ![Wallpaper](assets/wallpaper_1.png) |
![Original commit](assets/comic_2.png)  |  ![Wallpaper](assets/wallpaper_2.png) |
![Original commit](assets/comic_3.png)  |  ![Wallpaper](assets/wallpaper_3.png) |


## License

Distributed under the [MIT License](LICENSE). 

[XKCD comics](https://xkcd.com) © Randall Munroe; used here under the terms of the [XKCD license](https://xkcd.com/license.html).