Metadata-Version: 2.3
Name: jltg-cards
Version: 0.4.2
Summary: A library and script to render JLTG cards
Author: Giles Antonio Radford
Author-email: Giles Antonio Radford <moof@jltg.eu>
Requires-Dist: click>=8.4.1
Requires-Dist: jinja2>=3.1.6
Requires-Dist: pyyaml>=6.0.3
Requires-Python: >=3.14
Description-Content-Type: text/markdown

# jltg-cards

A library and commands to read the Jet Lag: The Game - Hide + Seek card definitions for the [KAM House Rules](https://code.moof.space/JetLag/house-rules).

## How to use

This packaged is designed to be used with [uv](https://docs.astral.sh/uv/). To run it, with uv installed, you just need to execute:

```sh
uvx --from jltg-cards --index https://code.moof.space/api/packages/JetLag/pypi/simple/ rulebook -c Cards -t Curse
```

This will output a markdown file to sdout. You can also specify an output file with `-o`. 

You must specify a directory that contains Card Description files with `-c`, this can include subdirectories. See the [Card Documentation](https://code.moof.space/JetLag/house-rules/src/branch/main/Cards/README.md) for more details.

You must specify the type of card with `-t`, whcih must be one of `Curse`, `PowerUp` or `TimeBonus`. 

You can also specify a template directory with Jinja2 templates using `--template`, that must contain a file called `card.md.jinja2` which will be used to render individual cards. Otherwise it will use the [default template](./src/jltg_cards/templates/card.md.jinja2) to render it.

You can also install the command with:

```sh
uv tool install jltg-cards --index https://code.moof.space/api/packages/JetLag/pypi/simple/
```

That then allows you to run
```sh
rulebook -c Cards -t Curse
```


## AI Disclosure

Some of the code has been created with the help of LLM tools running on the programmer's local machine. They have been used to assist the programmer in creating and understanding code, but any changes or modifications have been reviewed and approved by a human programmer. 

As can be seen by inspection, this repository contains no real cards, and no LLMs have been used in the creation of game cards, or in rule rewrites.

## Licence

This code is released under the MIT license. See [LICENSE.txt](./LICENSE.txt) for details.