forest/README.md

27 lines
975 B
Markdown

***Status: Work In Progress / Unreleased***
# Forest Game
this is a place where i am writing a game about a forest. I'm going to try to focus on writing, and not too much on tooling. so hopefully there won't be much here
## Requirements
- m4: https://www.gnu.org/software/m4/m4.html
- just: https://github.com/casey/just
- pandoc: https://pandoc.org/
- entr: https://eradman.com/entrproject/
## Writing
Anything with a `.txt` extension will be built. if you want to create some notes or something not included in the build, give it any kind of other extension, or none
## Macros
there's a macros file. I don't know if it will be much use. but it's there. It will be used when building the text. So you can use `__monstername` if you don't know the name of the monster yet. Define a new definition for it in `macros`--e.g. define(__monstername, `jethro')--and it will appear where you need it.
## Building
there is a justfile: run `just` to see available commands