60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
# Priduck Theme CLI
|
|
|
|
_A CLI for generating a tri-color theme based on a single hue and an even rotation around the color wheel._
|
|
|
|
Priduck (name is nonscense) is a color theme originally designed for [Fedran](https://fedran.com) where the base color is a hue (in degrees, 0-360) with with nine colors based on an even distribution around the wheel with nine-levels of brightness ranging from a near-black to a near-white.
|
|
|
|
## Installation
|
|
|
|
This tool is currently not available on npmjs. To install it, modify your project's `.npmrc` file to include:
|
|
|
|
```
|
|
@priduck-color-theme:registry=https://src.mfgames.com/api/packages/priduck-color-theme/npm/
|
|
```
|
|
|
|
Once that is done, the CLI can be installed as a development package with `npm`:
|
|
|
|
```shell
|
|
npm install --only-dev @priduck/cli`
|
|
```
|
|
|
|
Once installed, this will produce a CLI in the `node_modules/.bin` folder called `priduck`.
|
|
|
|
## Commands
|
|
|
|
### "css variables [--hue HUE] [--output PATH] [--selector SELECTOR]"
|
|
|
|
Generate a CSS file using variables. The thirty colors all follow the pattern of `--color-priduck-cXbY` where `X` is a number between 0 and 9 (inclusive) and `Y` is the brightness (also in the range of 0 to 9, inclusive).
|
|
|
|
All of the colors are calculated based on the variable `--color-priduck-hue`, which is not included by default. If `--hue` is provided with a number between 0 and 360, then `--color-priduck-hue` will be set to the given color.
|
|
|
|
If `--selector` is included, the colors will be wrapped in a selector and slightly indented:
|
|
|
|
```css
|
|
// priduck css variables
|
|
--color-priduck-c0b0: lch(5.0 50.0 calc(var(--color-priduck-hue) + 0));
|
|
--color-priduck-c0b1: lch(15.0 45.0 calc(var(--color-priduck-hue) + 0));
|
|
```
|
|
|
|
```css
|
|
// priduck css variables --selector ":root"
|
|
:root {
|
|
--color-priduck-c0b0: lch(5 50 calc(var(--color-priduck-hue) + 0));
|
|
--color-priduck-c0b1: lch(15 45 calc(var(--color-priduck-hue) + 0));
|
|
}
|
|
```
|
|
|
|
### "palette gpl --hue HUE [--output PATH] [--secondary 5] [--tertiary 8]"
|
|
|
|
Generate a GNU Imp or Inkscape file. `--hue` is required in this situation. This assumes up to two additional colors (secondary, and tertiary).
|
|
|
|
Both of these are numbers in the range of 0-9 with 0 being an identical color to the base hue (which is always 0).
|
|
|
|
## Debugging
|
|
|
|
The CLI uses [debug](https://github.com/debug-js/debug) for logging and (relatively) minor output. The CLI will produce no output unless the `DEBUG` environment variable is set, such as:
|
|
|
|
```shell
|
|
export DEBUG="*"
|
|
```
|