Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 3.55 KB

CLI.md

File metadata and controls

66 lines (46 loc) · 3.55 KB

🚀 ArchPapers-CLI

Installation

Build From Source

  1. Install Rust & Cargo
  2. Build The Crate with the following command
cargo install arch_papers

Download a Binary

Head over to Releases and download the executable.

Bonus points if you verify it with GPG. My key is here.

Usage

Running with the flag --help will show the following help message

Generate Arch Linux Wallpapers

Usage: arch_papers.exe [OPTIONS] <INPUT> <OUTPUT>

Arguments:
  <INPUT>   The image to use as the background / foreground
  <OUTPUT>  The output file to write to

Options:
  -i, --invert                   Invert the mask. By using this option, your supplied image will be used as the foreground
  -o, --original                 Whether to use the original image as background
  -t, --translate <TRANSLATE>    The translation to apply to the background image. (x, y) [default: 0,0]
  -m, --mask <MASK>              Lets you use your own mask, not just the arch logo. The file MUST be a SVG with the alpha channel being used as the mask
  -S, --mask-scale <MASK_SCALE>  The scale to apply to the mask. Useful for use with custom masks [default: 1.0]
      --bg-scale <BG_SCALE>      [default: 1.0]
  -s, --size <SIZE>              The size of the output image. By default, this is the same as the input image. (width, height)
  -b, --blur <BLUR>              How much to blur the background image. None by default
  -d, --darken <DARKEN>          How much to darken the background image. None by default
  -h, --help                     Print help
  -V, --version                  Print version

Example usage:

arch_papers image.png archified.png

Or to blur, dim, and translate the background image

arch_papers -b 10 -d 10 -t 1240,-80 image.png archified.png

Examples

Here are some examples of wallpapers generated with ArchPapers - that don't use the the default arch logo mask.
Background with the rust-lang logo and Nautical from James Sypniewski.
arch_papers nautical.png out.png --mask rust.svg -s 3840,2160 -S 0.5 -t 1000,0		 Background with the regolith DE logo and Dreams from James Sypniewski.
arch_papers dreams.png out.png --mask regolith.svg -s 3840,2160 -S 0.5 -t 1055,140