docs: Update colorscheme docs

pull/133/head
Miguel Mota 3 years ago
parent fa1fdca5e7
commit f5adceea65
No known key found for this signature in database
GPG Key ID: 67EC1161588A00F9

@ -19,12 +19,14 @@ $ git clone git@github.com:cointop-sh/colors.git
Then edit your config `~/.config/cointop/config.toml` and set the colorscheme you want to use:
```toml
colorscheme = "<colorscheme>"
colorscheme = "cointop"
```
The colorscheme name is the name of the colorscheme TOML file.
For example, if you have `matrix.toml` in `~/.cointop/colors/` then the `colorscheme` property should be set to:
By default, the colorscheme files should go under `~/.config/cointop/colors/`
For example, if you have `matrix.toml` under `~/.config/cointop/colors/matrix.toml` then the `colorscheme` property in `config.toml` should be set to:
```toml
colorscheme = "matrix"
@ -37,3 +39,96 @@ $ cointop --colorscheme matrix
```
To create your own colorscheme; simply copy an existing [colorscheme](https://github.com/cointop-sh/colors/blob/master/cointop.toml), rename it, and customize the colors.
The default `cointop` colorscheme is shown below:
```toml
colorscheme = "cointop"
base_fg = "white"
base_bg = "black"
chart_fg = "white"
chart_bg = "black"
chart_bold = false
marketbar_fg = "white"
marketbar_bg = "black"
marketbar_bold = false
marketbar_label_active_fg = "cyan"
marketbar_label_active_bg = "black"
marketbar_label_active_bold = false
menu_fg = "white"
menu_bg = "black"
menu_bold = false
menu_header_fg = "black"
menu_header_bg = "green"
menu_header_bold = false
menu_label_fg = "yellow"
menu_label_bg = "black"
menu_label_bold = false
menu_label_active_fg = "yellow"
menu_label_active_bg = "black"
menu_label_active_bold = true
searchbar_fg = "white"
searchbar_bg = "black"
searchbar_bold = false
statusbar_fg = "black"
statusbar_bg = "cyan"
statusbar_bold = false
table_column_price_fg = "cyan"
table_column_price_bg = "black"
table_column_price_bold = false
table_column_change_fg = "white"
table_column_change_bg = "black"
table_column_change_bold = false
table_column_change_down_fg = "red"
table_column_change_down_bg = "black"
table_column_change_down_bold = false
table_column_change_up_fg = "green"
table_column_change_up_bg = "black"
table_column_change_up_bold = false
table_header_fg = "black"
table_header_bg = "green"
table_header_bold = false
table_header_column_active_fg = "black"
table_header_column_active_bg = "cyan"
table_header_column_active_bold = false
table_row_fg = "white"
table_row_bg = "black"
table_row_bold = false
table_row_active_fg = "black"
table_row_active_bg = "cyan"
table_row_active_bold = false
table_row_favorite_fg = "yellow"
table_row_favorite_bg = "black"
table_row_favorite_bold = false
```
Supported colors are:
- `black`
- `blue`
- `cyan`
- `green`
- `magenta`
- `red`
- `white`
- `yellow`
- `default` - system default

@ -41,6 +41,14 @@ draft: false
Copy an existing [colorscheme](https://github.com/cointop-sh/colors/blob/master/cointop.toml) to `~/.config/cointop/colors/` and customize the colors. Then run cointop with `--colorscheme <colorscheme>` to use the colorscheme.
## How do I make the background color transparent?
Change the background color options in the colorscheme file to `default` to use the system default color, eg. `base_bg = "default"`
## Why don't colorschemes support RGB or hex colors?
Some of the cointop underlying rendering libraries don't support true colors. See [issue](https://github.com/nsf/termbox/issues/37).
## Where is the config file located?
The default configuration file is located under `~/.config/cointop/config.toml`

Loading…
Cancel
Save