Typst Gamedev

A Typst toolkit for writing documents related to game development. While it currently only supports a simple set of widgets and a template for basic written documents, this repository will eventually have support for more parts of the game development lifecycle. In the end, it will be used for everything from designing the high concept to the tiniest of technical specifications.

The repository is meant to be used as a template when making a documentation hub for your project.

What's Included

• Document template defining basic defaults like using A4 paper, including the table of contents, settling on a page-number design, a title block, etc.

• Includes a basic color palette. Currently this is static, but it will allow overriding values eventually.

• Initial widget library focusing on game design and basic visualizations like tables, diagrams, callout boxes, timelines, and more.

• The content manifest system allows nested directories of content while ensuring the content directory hierarchy is reflected in heading levels.

• Includes scripts and justfile for building and linting.

Requirements

• Typst
• Tinymist
• just
• Standard developer tooling like Bash and a CLI environment

Writing Content

• Every directory under content/ contains a manifest.typ. This allows importing other Typst modules as content as long as it's defined in a manifest.typ.

• main.typ calls render(manifest.content), and then each manifest below that receives an increased depth.

• Section ordering is defined explicitly.

Roadmap

• Customizable templates
• Rendering multiple documents from the same content
• Additional widgets for other kinds of documents
• More template customization and more templates for different purposes