Info

This documentation site is a work in progress. The official BitKat Interactive website is also under active development. Content here may change as we ship updates, rework features, or reorganize how we present things. If something is missing, it is probably because we have not shipped it yet or have not gotten around to writing up documentation for it. Please check back later, or keep an eye out on any changelog items!

BitKat Interactive¶

Welcome to the official documentation vault for BitKat Interactive! This is where we keep everything we write about our games, products, tools and work we do on a day to day basis. BitKat operates as a startup with absolute freedom, being able to pivot between high-performance software engineering and creative game development.

We tend to build many things at once, we don't like having to choose between one thing or the other especially when we have the opportunity to do both! Here you will see our documentation for games, products, and tools we will plan to release to the public.

With that being said, if you are looking for release notes, setup guides, design writeups or anything else we have documented it will live here.

What Lives Here?¶

For the most part, we plan to only have a couple folders for the most important things we plan to document. Here are the root folders that will exist no matter what we work on in the future and document:

Section	Description
Games `/games`	One or multiple folders per game. Each folder will have overviews, feature lists, system requirements and their own changelog folder.
Products `/products`	One or multiple folders per product. Each folder will have setup guides, links to the each individual product, API references, and their own changelog folder.
Drafts `/drafts`	One or multiple folders per draft. Each folder will have things that we don't quite know whether it should be worked on or not. They stay as drafts until we see a reason to be working on it further and prioritizing the work as either a game or product.

As we continue to develop our portfolio of software and games, you may notice that active development on certain projects occasionally slows down or pauses. When a project is deprioritized or retired, we will update its changelog and keep the repository available for reference. While we strive to drive every concept toward a solid MVP, the reality of development requires us to manage our resources carefully.

Not every project will reach the finish line, as we have to focus our time and resources on products or games that we believe have the move impact. We appreciate your understanding and deeply apologize for any inconvenience this may cause.

Folder Structure¶

Every project will get its own folder, and every project folder follows mostly the same layout provided below:

vault/
├── index.md                    # You are here!
├── changelog.md                # Changelog index file for game/products
├── games/
│   └── <slug>/
│       ├── index.md            # Game overview/details, root
│       └── changelogs/
│           └── YYYY-MM-DD-changelog-<shortform>.md
├── products/
│   └── <slug>/
│       ├── index.md            # Product overview/details, root
│       └── changelogs/
|           └── index.md        # Changelog overview/details, root
│           └── YYYY-MM-DD-changelog-<shortform>.md
├── drafts/
│   └── <slug>/
│       └── index.md            # Draft overview/details, often misformatted
│           
└── */...

A few things to note about this structure:

<slug> is a short, url-safe name for the project (e.g. starfall, backstage).
<shortform> is an even shorter label used in changelog filenames to describe the update (e.g. starfall-hotfixes, backstage-v2).
Dates in changelog filenames use YYYY-MM-DD format so they sort chronologically in any file listing.
The */... wildcard at the bottom means we are not limited to games and products. Anything else we want to document (internal tooling, design systems, research) can slot in at the same level.

This helps us to keep things relatively predictable and makes sure to avoid confusion behind a game or product we are actively working on.

Changelogs¶

Every game and product will have a changelogs/ folder. Each time we ship an update or deploy a new version, we add a new file with the following convention below:

YYYY-MM-DD-changelog-<shortform>.md

For example, a hotfix for Starfall that we shipped on August 11^th 2026 would be something like this:

games/starfall/changelogs/2026-08-11-changelog-starfall-hotfixes.md

Each changelog file follows the same format. We track what was added, changed, and fixed, and we link to the GitHub release page for that specific version. Additionally, a template is available within the codebase for our documentation but will not be found here. If you would like to know more about the template, please consider sending us an email at:

hello@bitkat.dev

The Changelogs Index file pulls together the latest version from every project/game/product we have worked on so you are able to see the state of everything at a glance without digging through subfolders to find something you are looking for.

How We Write Docs¶

We use Obsidian to write and organize all of our documentation. Every file is plain Markdown with optional YAML frontmatter for metadata. Most frontmatter fields aren't optional as Zensical (our documentation tool of choice) requires specific frontmatter to show on our deployed sit such as the title, description, status, etc.

When adding a new project/game/product, simple follow the steps below:

Create the folder under games/<slug>/ or products/<slug>/ or whichever folder you prefer.
Add an index.md with the project overview.
Add a changelogs/ folder for release notes.
Use the changelog template for your first entry.