ruin

Crates.ioruin
lib.rsruin
version1.6.0
sourcesrc
created_at2024-01-07 23:41:24.639575
updated_at2024-04-13 18:32:48.648874
descriptionBattery indicator as wallpaper
homepage
repositoryhttps://github.com/unixpariah/ruin.git
max_upload_size
id1092088
size64,085
unixpariah (unixpariah)

documentation

README

Ruin - The battery indicator

Prerequisites

Supported Environments

Usage

  1. Install Ruin:

    cargo install ruin
    
  2. Run the script:

    ruin
    
  3. If you want to set the wallpaper for specific screens (the default behavior is to set the wallpaper on all screens), use the following command:

    ruin -s 0 1
    
  4. If you want to modify the refresh interval (the default is every 5 seconds), use this command:

    ruin -t 1
    

Adding Custom Battery Indicator

  1. Create an image with a #8FBCBB color. Use the following ImageMagick command to convert your image:

    convert input_image.png -fill "#8fbcbb" -colorize 100% output_image.png
    
  2. Copy your image to the config directory:

    cp ./output_image.png ~/.config/ruin/images
    
  3. Run Ruin with the name of your image as an argument:

    ruin output_image
    

Custom Color Scheme

  1. Open the colorschemes.yaml file:

    vim ~/.config/ruin/colorschemes.yaml
    
  2. Add your custom color scheme (colors should be in rgb):

    example:
      charging: [r, g, b]
      default: [r, g, b]
      low_battery: [r, g, b]
      background: [r, g, b]
    
  3. Run the script

    ruin example
    

Inspired by bain.

Commit count: 65

cargo fmt