summaryrefslogtreecommitdiff
path: root/README.md
blob: 5c3377783b62c82e5887171222b6f90c8bb26e75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
![kjagave logo](./archlinux/kjagave.png)

# kjagave 

a GTK3 color scheme generator inspired by classic Agave, rewritten in Go

<img width="554" height="467" alt="recent screenshot" src="https://github.com/user-attachments/assets/efbea3f0-9d1f-45b1-865b-bb82a3ddc443" /><br>


![screenshot of kjagave](./pics/readme-greeter.png)

## features

- agave-style scheme generator modes:
	- triads
	- complements
	- split complements
	- tetrads
	- analogous
	- monochromatic
- compact top swatch cards with centered overlay metadata:
	- hex
	- rgb
	- hsv
- dynamic overlay text contrast (light/dark text based on background luminance)
- toolbar actions: back, forward, random, lighten, darken, saturate, desaturate, paste
- click a top swatch to promote it to the active base color
- right-click on top swatches and palette swatches to copy:
	- hex
	- hsv
	- rgb
- 12 built-in palettes:
	- Web-safe (legacy)
	- Material Design
	- Tailwind CSS
	- Flat UI
	- Pastel
	- Nord
	- Dracula
	- Solarized
	- Gruvbox
	- One Dark
	- Monokai
	- KiJiSH Dark Pastel Terminal
- favorites panel with add/remove/rename/clear
- clipboard copy/paste support
- screen picker support on X11 via `xcolor` or `grabc`
- persisted state in `~/.config/kjagave.json` (last color, scheme, palette, favorites)

## requirements

- go 1.21 or higher
- gtk3 development libraries
- `gotk3` Go bindings
- optional for pick-from-screen: `xcolor` or `grabc`

## installation

### arch linux

```bash
cd archlinux
makepkg -si
```

### manual build

```sh
cd src
go build -o kjagave .
```

## running

```bash
./kjagave
```

## usage

1. pick a base color with the color button, hex entry, palette swatches, or screen picker
2. choose a scheme type
3. click a preview swatch to make it the active base color
4. right-click a swatch to copy hex/hsv/rgb
5. use favorites controls (`+`, `-`, rename, clear) to manage saved colors