🌈️ apply a wallpaper based on the weather outside
fix(docs): update
Angel Wang
(Jun 23, 2026, 5:05 PM -0600)
01272db9
c9c59c3d
+17
-18
+16
-17
README.md
+16
-17
README.md
···
15
15
- [ImageMagick](https://imagemagick.org)
16
16
- Bash
17
17
18
+
## compatibility
19
+
20
+
- Linux ✅
21
+
- Darwin (macOS/OSX) ❓
22
+
- Windows ✅
23
+
18
24
## installing
19
25
20
26
First, install [ImageMagick](https://imagemagick.org) using your method of choice. If you're on Windows, install Bash
···
45
51
46
52
### `apply-config.json`
47
53
48
-
| option | typeof | default | description |
49
-
| ----------------------- | -------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
50
-
| `latitude` | `number` | `0` | The latitude used to discover the weather outside. |
51
-
| `longitude` | `number` | `0` | The longitude used to discover the weather outside. |
52
-
| `weatherModel` | `string` | `"best_match"` | The weather model to calculate cloud cover and shortwave radiation with. Find the options on the [Open-Meteo](https://open-meteo.com/en/docs) site. |
53
-
| `lightnessRange` | `{ start: number; end: number }` | `{ start: 0; end: 1 }` | The range of lightness values to map shortwave radiation to. Use this if your images are all exceptionally light or dark, due to post-processing or other reasons. |
54
-
| `chromaRange` | `{ start: number; end: number }` | `{ start: 0; end: 1 }` | The range of chroma values to map cloud cover to. Use this if your images are all exceptionally saturated or desaturated, due to post-processing or other reasons. |
55
-
| `applyWallpaperCommand` | `string` | `hyprctl hyprpaper wallpaper , %s` | The command used to apply the wallpaper. See "applying the wallpaper" section below for more info. |
54
+
| option | typeof | default | description |
55
+
| ----------------------- | -------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
56
+
| `latitude` | `number` | `0` | The latitude used to discover the weather outside. |
57
+
| `longitude` | `number` | `0` | The longitude used to discover the weather outside. |
58
+
| `weatherModel` | `string` | `"best_match"` | The weather model to calculate cloud cover and shortwave radiation with. Find the options on the [Open-Meteo](https://open-meteo.com/en/docs) site. |
59
+
| `lightnessRange` | `{ start: number; end: number }` | `{ start: 0; end: 0.8 }` | The range of lightness values to map shortwave radiation to. Usually, the maximum lightness of the sky on a sunny day will usually only be 0.8. Edit this if your images are all exceptionally light or dark, due to post-processing or other reasons. |
60
+
| `chromaRange` | `{ start: number; end: number }` | `{ start: 0; end: 1 }` | The range of chroma values to map cloud cover to. Edit this if your images are all exceptionally saturated or desaturated, due to post-processing or other reasons. |
61
+
| `applyWallpaperCommand` | `string` | `hyprctl hyprpaper wallpaper , %s` | The command used to apply the wallpaper. **Unused on Windows.** See "applying the wallpaper" section below for more info. |
56
62
57
63
## applying the wallpaper
58
64
···
82
88
83
89
### Windows
84
90
85
-
...who knows?
86
-
87
-
## compatibility
88
-
89
-
- Linux ✅
90
-
- Darwin (macOS/OSX) ❓
91
-
- Windows ❌
92
-
- [ ] How does one set the wallpaper via CLI?
93
-
- [ ] `apply/index.ts @ L80, analyze/analysis.ts @ L20`: equivalent of POSIX eval?
91
+
`applyWallpaperCommand` is hardcoded to execute a PowerShell script, ensure ExecutionPolicy is at least RemoteSigned.
92
+
Otherwise, the application should work out of the box.