Documents

Documents are structured, long-form content in StudioBrain — game design documents, story bibles, style guides, lore compendiums, and more. Unlike entities (which are field-based records), documents use a rich text editor with sections, headings, and formatted prose.

Documents vs Entities

Both entities and documents are stored as markdown files with YAML frontmatter. The template_category field in the template determines which editing experience is used.

Built-in Document Templates

StudioBrain ships with document templates for common creative workflows.

Game Design Document (GDD)

A structured template for game design documentation with pre-defined sections.

Sections:

• Executive Summary
• Game Overview (concept, genre, target audience, platform)
• Gameplay Mechanics (core loop, controls, progression)
• Story & Narrative
• Art Direction
• Audio Design
• Technical Requirements
• Monetization
• Production Timeline

Story Bible

A comprehensive reference document for narrative consistency.

Sections:

• World Overview
• History & Timeline
• Geography & Locations
• Cultures & Societies
• Magic / Technology Systems
• Character Archetypes
• Narrative Rules & Conventions
• Glossary

Style Guide

A visual and tonal reference for creative consistency.

Sections:

• Brand Identity
• Color Palette
• Typography
• Iconography
• Tone & Voice
• Writing Conventions
• Visual Examples

Lore Compendium

A living encyclopedia of world lore and history.

Sections:

• Creation Myths
• Ages & Eras
• Notable Events
• Legends & Prophecies
• Artifacts & Relics
• Factions & Orders
• Languages & Scripts

Color Guide

A reference for color usage across production assets.

Sections:

• Primary Palette
• Secondary Palette
• Character Palettes
• Environment Palettes
• UI Palettes
• Accessibility Notes

Creating a Document

1. Click + New in the sidebar
2. Select the Document category tab
3. Choose a document template (or start with a blank document)
4. Enter a title and click Create

The document opens in the rich text editor with the template’s pre-defined sections. Each section is a heading that you can expand, collapse, or reorder.

The Rich Text Editor

Documents use a TipTap-based rich text editor with support for:

Formatting

• Headings (H1 through H4) — define document structure
• Bold, italic, strikethrough, inline code
• Bullet lists, numbered lists, checklists
• Block quotes
• Code blocks with syntax highlighting
• Horizontal rules

Rich Content

• Images — drag and drop or paste from clipboard
• Tables — insert and edit tables with row/column controls
• Entity mentions — type @ followed by an entity name to create a linked mention
• Callouts — info, warning, and tip callout boxes
• Embedded entities — inline previews of linked entities

Keyboard Shortcuts

Sections and Outline

Section Outline

The left sidebar shows a hierarchical outline of your document based on heading levels. Click any heading in the outline to scroll to that section.

Reordering Sections

Drag sections in the outline to rearrange them. All content under a heading moves with it when reordered.

Collapsing Sections

Click the chevron next to a heading to collapse its content. Collapsed sections still appear in the outline and in exports — they are just hidden in the editor for focus.

Adding Sections

Type a heading (# Heading or use the toolbar heading buttons) to create a new section. The outline updates automatically.

Export

Documents can be exported in multiple formats from the Export menu in the toolbar.

PDF

Produces a formatted PDF with:

• Title page (document name, project name, date)
• Table of contents (generated from headings)
• Page numbers
• Styled headings, body text, and embedded images

DOCX

Produces a Microsoft Word document with:

• Heading styles mapped to Word heading levels
• Images embedded inline
• Tables preserved
• Editable in Word, Google Docs, or LibreOffice

HTML

Produces a self-contained HTML file with:

• Embedded CSS styling
• Images as base64 data URIs
• Responsive layout
• Suitable for sharing via email or static hosting

Markdown

Produces a standard markdown file with:

• YAML frontmatter preserved
• Headings, lists, code blocks as markdown syntax
• Images as relative paths
• Compatible with any markdown viewer or static site generator

Creating Custom Document Templates

Create a file at _Templates/Standard/{NAME}_TEMPLATE.md with template_category: "document":

---
template_version: "2.0"
id: "brand_guide"
entity_type: "brand_guide"
template_category: "document"
name: "Brand Guide"
description: "Brand identity and usage guidelines"
icon: "Palette"
 
# Document-specific settings
capabilities:
  - outline_view
  - export_pdf
  - rich_text
 
# Metadata fields (shown in sidebar, not in editor body)
client_name: ""
version: "1.0"
status: "draft"
last_reviewed: ""
---
 
# Brand Guide
 
## Brand Identity
 
Describe the brand's core identity, mission, and values.
 
## Logo Usage
 
### Primary Logo
 
Insert the primary logo and describe usage rules.
 
### Logo Clear Space
 
Define minimum clear space around the logo.
 
## Color Palette
 
### Primary Colors
 
Define primary brand colors with hex codes.
 
### Secondary Colors
 
Define secondary and accent colors.
 
## Typography
 
### Headings
 
Define heading typefaces and sizes.
 
### Body Text
 
Define body text typefaces and sizes.

The markdown body below the frontmatter becomes the default content when a user creates a new document from this template. Section headings and placeholder text guide the user (and AI generation) on what to write in each section.

See Also

• Template Categories — How entity, document, and map templates differ
• Exporting Content — All export options
• Template Authoring — Technical reference for template frontmatter
• Rich Text Editor — Developer reference for the TipTap editor