git clone https://github.com/SlumberDemon/sofa.git
sudo cp sofa/sofa /usr/local/bin
sudo chmod +x /usr/local/bin/sofa
Verify that
sofa
is installed by running the following.
sofa sofa
If successful,
sofa
should return 'sofa'.
sofa setup
Default setup contains examples
.sofa/config.json
{
"mode": "light",
"wallpath": "Pictures",
"templates": [
{
"name": "example",
"path": ".config/example/example.conf",
"type": "hex",
"actions": ["app -q", "app"]
}
]
}
Light or dark, the choice is yours
Define where
sofa
fetches wallpapers from. (Note: must be accessible via$HOME
)
Color templates for anything. Looking for more examples, check out my dotfiles
{
"name": "example",
"path": ".config/example/example.conf",
"type": "hex",
"actions": ["app -q", "app"]
}
Name of the template in
.sofa/templates
. (Note: must be without file extension)
Path where the generated template gets saved to. (Note: must include file name and extension and be accessible via
$HOME
)
Execute commands after styles are generated (Note: commands are run in order of array)
Format in which color data is represented.
Type | Format |
---|---|
hex | #ffffff |
argb | 4286130513 |
rgb | (0, 0, 0) |
Value | Variable |
---|---|
primary | {primary} |
onPrimary | {onPrimary} |
primaryContainer | {primaryContainer} |
onPrimaryContainer | {onPrimaryContainer} |
secondary | {secondary} |
onSecondary | {onSecondary} |
secondaryContainer | {secondaryContainer} |
onSecondaryContainer | {onSecondaryContainer} |
tertiary | {tertiary} |
onTertiary | {onTertiary} |
tertiaryContainer | {tertiaryContainer} |
onTertiaryContainer | {onTertiaryContainer} |
error | {error} |
onError | {onError} |
errorContainer | {errorContainer} |
onErrorContainer | {onErrorContainer} |
background | {background} |
onBackground | {onBackground} |
surface | {surface} |
onSurface | {onSurface} |
surfaceVariant | {surfaceVariant} |
onSurfaceVariant | {onSurfaceVariant} |
outline | {outline} |
shadow | {shadow} |
inverseSurface | {inverseSurface} |
inverseOnSurface | {inverseOnSurface} |
inversePrimary | {inversePrimary} |
sofa --help
Install with
yay
yay -S python-material-color-utilities fzf swww jq python-pywal gradience pywalfox hyprpaper
- End_4's config, for inspirations
and code snippets - Lemon, for improving the python code