/Macground

Create custom backgrounds with ease, from the command line

Primary LanguageRustMIT LicenseMIT

Macground

Macground Create custom backgrounds with ease, from the command line.

Usage • Options • Installation • Platforms

Usage

# Displays an image with a quote set in a random color
macground --random-image --text-color "random" --random-quote

# Displays "Macground" on a maroon background in a large font
macground --message "Macground" --color "maroon" --text-size 200

Installation

Install Macground using cargo.

cargo install --git https://github.com/DevinLeamy/Macground.git

Options

Usage: macground [OPTIONS]

Options:
      --background-image <BACKGROUND_IMAGE>
          Url of a background image [requires a valid `UNSPLASH_SECRET_KEY` environment variable - get one [here](https://unsplash.com/oauth/applications)]
      --random-image
          Flag to set the background to a random image
      --color <COLOR>
          Color of the background, if no image is set. Accepts: "<color-name>" | "rgb(...)" | "#FFAAEE" | "hsl(...)" | "random"
      --message <MESSAGE>
          Message to display to the screen
      --random-quote
          Random quote to display to the screen
      --random-word
          Random would to display to the screen
      --text-color <TEXT_COLOR>
          Color of the text, if any is displayed Accepts: "<color-name>" | "rgb(...)" | "#FFAAEE" | "hsl(...)" | "random"
      --text-size <TEXT_SIZE>
          Size of the text characters in pixels, defaults to filling the text's parent
  -h, --help
          Print help information

Platforms

Macground is supported on:

  • MacOS
  • Windows
  • Linux

Linux requirements

On Linux, you need to install libxcb and libxrandr

Debian/Ubuntu:

apt-get install libxcb1 libxrandr2

Alpine:

apk add libxcb1 libxrandr2