https://github.com/sean-clayton/two-swords

A dark fantasy expansion for the Cairn adventure game.
https://github.com/sean-clayton/two-swords

cairn cairnrpg dnd rpg ttrpg typst witcher

Last synced: 16 days ago
JSON representation

A dark fantasy expansion for the Cairn adventure game.

• Host: GitHub
• URL: https://github.com/sean-clayton/two-swords
• Owner: sean-clayton
• License: agpl-3.0
• Created: 2023-10-22T20:36:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-18T01:56:16.000Z (11 months ago)
• Last Synced: 2024-05-02T04:25:52.535Z (8 months ago)
• Topics: cairn, cairnrpg, dnd, rpg, ttrpg, typst, witcher
• Language: Typst
• Homepage: https://seanclayton.itch.io/two-swords
• Size: 10.7 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING-AGPL

Awesome Lists containing this project

README

        


[![Deploy to Itch](https://github.com/sean-clayton/two-swords/actions/workflows/itch-deploy.yml/badge.svg?event=release)](https://github.com/sean-clayton/two-swords/actions/workflows/itch-deploy.yml) [![Nightly Build](https://github.com/sean-clayton/two-swords/actions/workflows/nightly-build.yml/badge.svg?event=schedule)](https://github.com/sean-clayton/two-swords/releases/tag/nightly)

---

# Two Swords

A dark fantasy expansion to use with the second edition of the [Cairn] adventure game.

## Contributing

It's pretty technical, but you need to install [typst] and [just].

`two-swords.typ` is the main typst document.

`lib.typ` is a little helper document to keep the main document clean.

To build the PDF, run `just build` in root project.

This will produce a `TwoSwords-dev.pdf` file that you can open in a PDF viewer.

To watch files and continuously build the PDF, run `just` in the root project directory.

PDF viewers often will automatically refresh if they detect an opened PDF has changed on disk.

This means when running the `just` command, if you open `TwoSwords-dev.pdf` in a PDF viewer,

it likely will keep refreshing the viewer with your changes as you make them.

Any `.typ` or `.yaml` file change will trigger a new PDF build.

All of the stats live in the `stats` directory.

They are yaml files that the typst document consumes and renders stat blocks out of.

## COPYING

If you're just copying the content of the PDF, CC-BY-SA works just fine.

If you are copying the code, AGPLv3 is what you should use.

CC-BY-SA is compatible with AGPLv3.

[Cairn]: https://cairnrpg.com/

[typst]: https://github.com/typst/typst

[just]: https://github.com/casey/just