diff --git a/README.md b/README.md new file mode 100644 index 0000000..5a51093 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# viscolourchanger + +## Intro +viscolourchanger is a program to dynamically change the colourscheme used by [cli-visualizer](https://github.com/dpayne/cli-visualizer) (herein referred to as 'vis'), as generated by [pywal](https://github.com/dylanaraps/pywal). + +viscolourchanger + + + +##Setup and Configuration +###Initial Setup +To make vis recognise the generated colour scheme, it is necessary to add the line + +> colors.scheme=wal + +to the vis config file located at $HOME/.config/vis.config. + +(It is also helpful to add the line + +>audio.stereo.enabled=false + +in order to see a broader range of colours in the base vis config, but this is just personal taste and far more complex configurations are possible.) + +###Further Suggestions +That is all there is to viscolourchanger itself, and in absence of something further, pywal and viscolourchanger run separately. However, it is useful to make a wrapper for pywal. A simple wrapper which I have written is located [here](https://git.lynnesbian.space/petra-fied/viscolourchanger/src/branch/master/wal), and will allow for on-the-fly colour changes as pywal is run. + +![program in action (the jitters here are an artifact of ffmpeg)](video.gif) diff --git a/video.gif b/video.gif new file mode 100644 index 0000000..2a892cd Binary files /dev/null and b/video.gif differ diff --git a/wal b/wal new file mode 100644 index 0000000..52b8061 --- /dev/null +++ b/wal @@ -0,0 +1,5 @@ +#!/bin/bash +# this wrapper should go in your /usr/local/bin or higher in order to supercede the default "wal" command. +/usr/bin/wal $@ +genzathurarc +viscolourchanger