Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.56 KB

README.md

File metadata and controls

23 lines (16 loc) · 1.56 KB

Templates

This directory contains the templates that are used by the tool. These are included in the executables you find in releases so unless you are tinkering with your own templates you need not even look here. However if you are looking to tinker with the templates keep reading.

Internal templates

As mentioned previously these templates can be compiled in statically into the executable. Wasteful? perhaps but greatly reduces the hassle of setting up the tool and allows for older versions to remain functional after updates to this directory. By default they are not compiled in and you need to set the internal flag on compilation like this RUSTFLAGS="--cfg internal" to be able to use them. You can force the use of the internal templates via the --internal flag on runtime, and they will be used by default if the templates directory is not in the cwd.

External templates

If the templates directory is present then the tool will attempt to load the templates located there. It's looking for files with the following names homeTemplate, cultureTemplate, dynastyTemplate, faithTemplate, homeTemplate, timelineTemplate, titleTemplate ignoring extensions so you can theoretically provide, for example, Markdown templates and have the utility create Markdown files.

Custom templates

Creation of custom templates is something I greatly encourage. I would love to see template packs or other similar things. Just be sure you use the same Jinja variables as I do and your templates should work fine.