diff --git a/README.md b/README.md index 5a6a760d94570c5fa4573a63a0e93687b4d3e9b1..984ac5cb73c0bcadcae0d656730904291bcc1e92 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,9 @@ <div align="center"> <p align="center"> - <a href="#installation">Installation</a> • - <a href="#configuration">Configuration</a> • - <a href="#run-modes">Run modes</a> • - <a href="#completions">Completion</a> + <a href="#installation">Installation</a> • + <a href="#configuration">Configuration</a> • + <a href="#examples">Examples</a> </p> </div> @@ -26,8 +25,44 @@ makepkg -fsi If you want to add music_bg as systemd unit run: ```bash cp systemd/music_bg.service /usr/lib/systemd/user/ +systemctl --user enable music_bg.service ``` -# Configuraion +run `music_bg --version` to verify your installation. -After installation run `music_bg config`. This command will generate default config in your $HOME folder. +# Configuration + +After installation run `'music_bg config'`. This command will generate default config in your `$HOME` folder. +After that you free to edit your configuration `~/.mbg.toml`; + +### Cofiguration format. +You can read more about TOML format [here](https://github.com/toml-lang/toml). +Main variables are `blender`, `reset_command` and `processors`. + +`blender` is an array that shows how layers need to be merged. + +`reset_command` - command that will be executed when music stops. + +`processors` - array of filter instructions. + +Each `processor` has several fields: +- effect - actual image filter +- layer - number of layer +- strength - effect strength. + +## Available filters +#TODO! + +### None + +### Crop + +### Blur + +### Border + + +# Examples + +With this [config](/example_confiigs/example1.toml), you would get images like this: + \ No newline at end of file diff --git a/example_confiigs/example1.toml b/example_confiigs/example1.toml new file mode 100644 index 0000000000000000000000000000000000000000..50a9da7281b5cdf6acae56d3a0f4d26dcfb06b72 --- /dev/null +++ b/example_confiigs/example1.toml @@ -0,0 +1,39 @@ +blender = [0, 1, 2] + +[logger] +level = "debug" +time_format = '[%Y-%m-%d][%H:%M:%S]' + +[[processors]] +effect = 'Scale' +strength = 1.0 +layer = 0 + +[[processors]] +effect = { Crop = { fit = true } } +layer = 0 + +[[processors]] +effect = 'Blur' +strength = 6.2 +layer = 0 + +[[processors]] +effect = 'Scale' +strength = 0.29 +layer = 1 + +[[processors]] +effect = 'Blur' +strength = 3.2 +layer = 1 + +[[processors]] +effect = {Border = {circle=true, color = "96b7e8"}} +strength = 1.0 +layer = 1 + +[[processors]] +effect = {Border = {circle=false, color = "0E0B7C", width = 7}} +strength = 1.0 +layer = 2 diff --git a/example_confiigs/example1_res.png b/example_confiigs/example1_res.png new file mode 100644 index 0000000000000000000000000000000000000000..25bae01690e102d2328054adc963de2160daa89d Binary files /dev/null and b/example_confiigs/example1_res.png differ diff --git a/logo.png b/logo.png index fc0e6c5aaf3ac506547a0b37de842e26d5c87682..5ee970221811a3609ecdbd1c443f4447dac250ee 100644 Binary files a/logo.png and b/logo.png differ