SlumberDemon / sofa

Soft Organic Furniture Arrangement

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sofa

Soft Organic Furniture Arrangement

Install

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

Setup

sofa setup

Default setup contains examples

Configuration

.sofa/config.json

{
  "mode": "light",
  "wallpath": "Pictures",
  "templates": [
    {
      "name": "example",
      "path": ".config/example/example.conf",
      "type": "hex",
      "actions": ["app -q", "app"]
    }
  ]
}

mode

Light or dark, the choice is yours

wallpath

Define where sofa fetches wallpapers from. (Note: must be accessible via $HOME)

templates

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

Name of the template in .sofa/templates. (Note: must be without file extension)

path

Path where the generated template gets saved to. (Note: must include file name and extension and be accessible via $HOME)

actions

Execute commands after styles are generated (Note: commands are run in order of array)

type

Format in which color data is represented.

Type Format
hex #ffffff
argb 4286130513
rgb (0, 0, 0)

Usables

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}

Usage

sofa --help

Dependencies

linux

Install with yay

yay -S python-material-color-utilities fzf swww jq python-pywal gradience pywalfox hyprpaper

Extra pywal theming for Vscode, Firefox, Rofi

Thank you

About

Soft Organic Furniture Arrangement

License:MIT License


Languages

Language:Shell 66.8%Language:Python 33.2%