# base16-builder

<!-- markdownlint-disable MD013 -->

This repo provides a `builder.sh` to create your base16 colorschemes.

## Dependecies

- [lustache](https://luarocks.org/modules/olivine-labs/lustache);
- [lustache-cli](https://github.com/djmattyg007/lustache-cli);
- [tinty](https://github.com/tinted-theming/tinty).

## Preparation

Make sure you have the following structure for your project:

```bash
├── colors
└── templates
```

Folder `templates` must contain the following files:

```bash
├── body.mustache
├── config.yaml
└── head.mustache
```

with the following content:

### config.yaml

```mustache
default:
  supported-systems: [base16]
  filename: "colors/{{scheme-system}}-{{scheme-slug}}.theme"
```

### *.mustache

The file `body.mustache` must contain a template for the program for which the color scheme is made, for example, for the program [wlr-which-key](https://github.com/MaxVerevkin/wlr-which-key) it will be as follows:

```yaml
background: "#{{base00-hex}}"
color: "#{{base06-hex}}"
border: "#{{base0D-hex}}"
```

The file `head.mustache` contains metadata about the colorscheme:

```yaml
#
#
# name: {{scheme-name}}
# author: {{{scheme-author}}}
# slug: {{scheme-slug}}
# slug-underscored: {{scheme-slug-underscored}}
# system: {{scheme-system}}
# variant: {{scheme-variant}}
# is-{{scheme-variant}}-variant: {{hasVariant}}
#
#
```

> If you will use this file, change the comment symbols to match the extensions of the final colorscheme file, if for example the colorscheme will be `base16-google-light.css`, then replace the symbol `#` with `/* */`, etc.

## Usage

Put `builder.sh` in your project directory, make it executable and launch it:

```bash
cp base16-builder/builder.sh /path/to/your/project

chmod +x builder.sh

./builder.sh
```

## Summary

I tried to make this build according to the [official spec](https://github.com/tinted-theming/home/blob/main/builder.md), i may have missed something, if so - create a ticket in [todo](https://todo.sr.ht/~blueingreen/base16-builder).

## License

MIT