- Python 89%
- Jinja 11%
|
All checks were successful
Build and Publish Package / Build and Publish Package (push) Successful in 11s
Bumped version to 0.4.2 |
||
|---|---|---|
| .forgejo/workflows | ||
| .vscode | ||
| src/jltg_cards | ||
| tests | ||
| .gitignore | ||
| .python-version | ||
| LICENSE.txt | ||
| pyproject.toml | ||
| README.md | ||
| uv.lock | ||
jltg-cards
A library and commands to read the Jet Lag: The Game - Hide + Seek card definitions for the KAM House Rules.
How to use
This packaged is designed to be used with uv. To run it, with uv installed, you just need to execute:
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 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 to render it.
You can also install the command with:
uv tool install jltg-cards --index https://code.moof.space/api/packages/JetLag/pypi/simple/
That then allows you to run
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 for details.