Skip to content

Latest commit

 

History

History
140 lines (90 loc) · 5.24 KB

README.md

File metadata and controls

140 lines (90 loc) · 5.24 KB
Raw

ConkyMatic

ConkyMatic is a shell script that:

Automatically generates a Conky and weather icons that are color-matched to the current wallpaper.

YouTube Video

When you run ConkyMatic it does the following:

  • Automatically gets the path to your current wallpaper (or the path can be passed manually).

  • Creates a 16 color palette image from the current wallpaper (look at the bottom of the Conky in the screenshots)

  • Extracts the hex color value of each of the 16 images in the color palette.

  • Generates a .conkyrc file using colors randomly selected from that palette.

  • Exports a set of colorized weather icons.

  • Copies the new .conkyrc file to the home folder and relaunches the Conky application.

The entire sequence takes the script about 10 seconds, making it very fast and easy to build a fresh conky every time you change your wallpaper. And since the colors are randomly selected (with some logic), running the script multiple times with the same wallpaper will yield different results.

Note: The automatic path gathering feature only works if you use XFCE desktop, or if you use feh to set your wallpaper. Read the configuration section below for more info.

Requirements

  • A Linux installation with Conky installed.

  • ImageMagick to generate the color palette PNG and weather icons. Note: If you have Inkscape is installed, ConkyMatic will use it for the weather icon rendering since it has better SVG handling. However, ImageMagick is still necessary for the palette generation.

  • Curl to download JSON weather data.

  • jq to parse JSON weather data.

  • Roboto Font. The default Conky template uses Roboto.

Installation

Just clone or download the package.

Configuration

If you open conkymatic.sh with a text editor you'll see the following user configuration variables near the top of the file:

# Your city
YOUR_CITY="miami"

# Your US state (two letter abbreviation. Example: NY)
# If you are NOT in the US enter your country. Example: france
YOUR_REGION="fl"

# Temperature format
# f = fahrenheit
# c = celcius
TEMP_FORMAT="f"

# AUTOMATIC PATH MODE
# Sets the way in which ConkyMatic should get the path to your wallpaper. The options are:
#
#   PATH_MODE="xfce"  # Use this if you run XFCE Desktop
#   PATH_MODE="feh"   # Use this if you use feh to set your wallpaper
# 
# NOTE: You can also pass the wallpaper path manually as an argument to the script:
#
#   ./conkymatic.sh /path/to/your/wallpaper.jpg
#
# This setting will be ignored when a path is manually passed.
# 
AUTO_PATH_MODE="xfce"

Usage

Point your terminal to the directory containing cokymatic and run it using:

$   ./conkymatic.sh

You can also manually pass the path to your wallpaper as an argument:

$   ./conkymatic.sh /path/to/your/wallpaper.jpg

Important: Before running ConkyMatic make a backup copy of your .conkyrc file since it will get overwritten.

ConkyMatic Terminal Alias

To make running the script more convenient you can add the following alias to your .bashrc file, and then just enter conkymatic from your terminal.

function conkymatic() {
    $HOME/path/to/ConkyMatic/conkymatic.sh $@
}

Note: Make sure you change the path in the function to reflect your particular path.

Customization

In the Templates directory you'll find the default.conky template. This is a normal .conkyrc file, except it contains some pseudo-variables that get replaced by the script with random color values. A list of available variables can be found below.

Additional templates can be created and added to the Templates folder. If more than one template is in the folder, when you run the conkymatic.sh script via your terminal you'll be given a choice of templates. Hitting ENTER in the terminal will auto-select the template named default.conky, or you can type the name of the one you prefer to run.

IMPORTANT: all templates must be named with the .conky file extension: Example: foobar.conky

Template Variables

The template variables are just text placeholders which get replaced when the script gets run. The following variables are available for use. The colors will be assigned automatically from your wallpaper colors.

_VAR:COLOR_TIME_
_VAR:COLOR_DATE_
_VAR:COLOR_WEATHER_
_VAR:COLOR_HEADING_
_VAR:COLOR_SUBHEADING_
_VAR:COLOR_TEXT_
_VAR:COLOR_DATA_
_VAR:COLOR_HR_
_VAR:COLOR_BARS_NORM_
_VAR:COLOR_BARS_WARN_
_VAR:COLOR_BORDER_
_VAR:COLOR_BACKGROUND_

In addition, the following path variables are available:

_VAR:JSON_FILEPATH_
_VAR:CACHE_DIRECTORY_
_VAR:WEATHER_ICONS_PNG_DIRECTORY_
_VAR:COLOR_PALETTE_FILEPATH_

License

MIT License

https://opensource.org/licenses/MIT

You may use the source code in any manner you choose, as long as appropriate credit is given.