Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/rickellis/ConkyMatic

Automatic Conky color scheme changer based on the current wallpaper colors. Written in Bash.
https://github.com/rickellis/ConkyMatic

color-palette conky weather-icons

Last synced: about 5 hours ago
JSON representation

Automatic Conky color scheme changer based on the current wallpaper colors. Written in Bash.

Awesome Lists containing this project

README 

        
# ConkyMatic






## ConkyMatic is a shell script that:



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



### [YouTube Video](https://youtu.be/th6-7pRe-l4)



### 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](#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](https://www.dafont.com/roboto.font).



## 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.