mirai is a lightweight, cross-platform wallpaper manager.

• Scheduled Wallpaper Rotation Mirai rotates wallpapers at fixed intervals, calculated from local midnight. For example:

  • If update_interval = 1440, wallpapers change once per day at midnight.
  • If update_interval = 60, they'll change hourly (00:00, 01:00, 02:00, etc.).
  • If it's set to 30, changes happen every half hour on the clock (00:00, 00:30, 01:00, etc.).

  This deterministic schedule ensures consistency across system reboots.

• Integration with swww (Linux) and Windows (experimental)

• TOML-based configuration

Linux:

• Wayland compositor
• swww installed and running

Windows:

• None, should just work

To install mirai via Home Manager:

1. Add mirai to your Nix flake inputs:

   inputs.mirai.url = "github:iAverages/mirai";

2. Import the Home Manager module and enable the service:

   {
     imports = [
       inputs.mirai.homeManagerModules.default
     ];
   
     services.mirai.enable = true;
   }

3. Then apply your configuration:

   home-manager switch

This will install and manage mirai as a background service that automatically rotates wallpapers according to your configuration.

git clone https://github.com/iAverages/mirai.git
cd mirai
cargo build --release

Binary will be in target/release/mirai.

Create a file at:

• Linux: ~/.config/mirai/mirai.toml
• Windows: %APPDATA%\\kirsi\\mirai\\config\\mirai.toml

Local example:

log_level = "info"
content_manager_type = "local"
update_interval = 1440 # 24 hours in minutes

[local]
# path on disk to your wallpapers folder
# can have nested folders
path = "/home/dan/dotfiles/wallpapers/"

Git example:

log_level = "info"
content_manager_type = "git"
update_interval = 1440 # 24 hours in minutes

[git]
# uri to git server, tested with Github, Gitlab, and Gitea.
# can be a https url, or ssh
# url = "git@github.com:iAverages/dotfiles.git"
url = "https://github.com/iAverages/dotfiles.git"

# path within the git repository to load wallpapers from
path = "wallpapers"

Simply run the binary:

./mirai

On Windows, use:

.\mirai.exe

Mirai will start rotating wallpapers based on your settings.

On Windows, you can setup auto start on boot using:

.\mirai.exe --autostart true

Licensed under the MIT License.