README.md

# Configurations and Templates

These config files make the BIND RPG books look and act the way they do.

# Dependencies

- `inkscape`
- `make`
- `texlive-most`
- `git-lfs`
- (optional) `imagemagick`

# Usage

To make a book, start a git, then do:

```bash
git submodule add https://gitlab.com/bindrpg/config config
git commit -m"add config submodule"
cp config/main.tex config/.gitignore .
```

Edit 'main.tex', and input your tex files by writing `\include{my_file.tex}`.

# Docs

You can create the [documentation][docs] with

```bash
make docs
```

Test your changes before committing with:

```bash
make test
```

## Issues

If you find issues, raise it on the [issues board][issues board], or [email][issues email] the issue.

# TeXnical Details

This thing's handled as a submodule in the other documents, so changing it will change all BIND books.
Any changes to the master branch should be tested in the `core` and `aif` projects first.

And when pulling, remember to do:

```bash
git pull --recurse-submodules
```

# Docker

Docker builds the books with a Gitlab pipeline, to check they compile properly.

Docker also lets people build the book with docker from anywhere.
List any BIND books you want, and build them locally like this:

```bash
books="core oneshot stories"
docker run -it --rm --name texbooks andonome/texbind gimme $books
```

[docs]: https://gitlab.com/bindrpg/config/-/jobs/artifacts/master/raw/docs.pdf?job=build
[rules]: https://gitlab.com/bindrpg/config/-/jobs/artifacts/master/raw/booklet.pdf?job=build
[cs]: https://gitlab.com/bindrpg/config/-/jobs/artifacts/master/raw/character_sheets.pdf?job=build
[issues board]: https://gitlab.com/bindrpg/config/-/issues/
[issues email]: contact-project+bindrpg-config-16527104-issue-@incoming.gitlab.com