Exporting Content

The StudioBrain Export System allows you to convert your creative content into professional documents that can be shared, printed, or archived. This guide covers everything you need to know about exporting characters, locations, stories, and all other entity types.

Table of Contents

1. Overview
2. What Can Be Exported
3. Supported Formats
4. Export Process
5. Template Customization
6. Best Practices

Overview

StudioBrain’s Export System provides a seamless way to transform your in-game creative assets into professional documents. Whether you’re preparing a character sheet for a tabletop RPG, creating a world bible for your novel, or documenting game design elements, the export system handles it all.

Key Features

• Multiple Formats - Export to HTML, PDF, or Microsoft Word
• Professional Templates - Pre-designed layouts for different use cases
• Embedded Assets - Images and attachments included in exports
• Responsive Design - HTML exports look great on any device
• Print-Optimized - PDF exports formatted for high-quality printing

What Can Be Exported

Supported Entity Types

All entity types in StudioBrain can be exported:

Exporting Multiple Entities

You can export single entities or multiple entities at once:

1. Single Entity Export

   • Navigate to any entity detail page
   • Click the “Export” button
   • Choose your preferred format

2. Bulk Export

   • Go to the list view (e.g., /items, /characters)
   • Select multiple entities using checkboxes
   • Click the “Export Selected” button
   • Choose format and options

Supported Formats

HTML Export

Best for: Sharing online, printing manually, web archiving

Features:

• ✅ Fully self-contained (no external dependencies)
• ✅ Embedded CSS styling
• ✅ Responsive design (works on mobile and desktop)
• ✅ Embedded images (base64-encoded)
• ✅ Searchable text
• ✅ Selectable and copyable content

File Size: Typically 50KB - 500KB

When to use:

• Sharing with team members who have a web browser
• Quick printing without special software
• Archiving with preserved formatting

Limitations:

• Not as polished as PDF for professional printing
• File size includes all images

PDF Export

Best for: Professional documents, printing, formal presentations

Features:

• ✅ A4 page size with proper margins
• ✅ Professional typography
• ✅ Cover page with entity name and metadata
• ✅ Table of contents with page numbers
• ✅ Print-optimized styling
• ✅ Embedded images at high quality
• ✅ Consistent formatting across devices

File Size: Typically 100KB - 5MB (depending on images)

When to use:

• Printing to paper
• Sharing with clients or stakeholders
• Archiving official documents
• Formal presentations

Requirements:

• Server must have Playwright installed (playwright install)
• Slower export time (2-10 seconds)

DOCX (Microsoft Word) Export

Best for: Editing, collaboration, Word integration

Features:

• ✅ Fully editable in Microsoft Word
• ✅ Professional document styles
• ✅ Cover page
• ✅ Table of contents
• ✅ Embedded images
• ✅ Compatible with Google Docs and LibreOffice

File Size: Typically 100KB - 2MB

When to use:

• Making changes to the exported document
• Collaborating with teams using Word
• Integrating with other Word documents

Requirements:

• Server must have python-docx installed (pip install python-docx)

Export Process

Step 1: Navigate to Entity

1. Open the StudioBrain application
2. Navigate to the entity you want to export:
   • Characters: Go to /characters or click a character’s name
   • Locations: Go to /locations or click a location
   • Items: Go to /items or click an item

Step 2: Click Export Button

On the entity detail page, look for the Export button in the toolbar:

[📄 Character Sheet]  [💾 Save]  [📤 Export ▼]

Click the dropdown arrow next to “Export” to reveal format options.

Step 3: Choose Format

Select your desired format:

Step 4: Wait for Export

The export process happens automatically:

1. Quick export (HTML): 1-2 seconds
2. Standard export (DOCX): 2-5 seconds
3. Professional export (PDF): 5-10 seconds

You’ll see a loading indicator during this time.

Step 5: Download Result

Once export is complete, your browser will automatically:

1. Generate the file
2. Prompt you to save it
3. Use the filename format: EntityName_entitytype.format

Example: Aragorn_character.pdf

Export Options

Layout Templates

Choose the layout that best suits your needs:

GDD Standard Layout

Best for: General-purpose documentation, RPG handouts, world bibles

Features:

• Cover page with entity name and type
• Table of contents
• Overview section with entity header
• Details section with field-by-field breakdown
• Entity-specific sections (Background, Personality for characters)
• Assets section with embedded images

When to use:

• Character sheets for TTRPGs
• Location reference documents
• General entity documentation

Script Format Layout

Best for: Dialogue-heavy content, screenplay-style character sheets

Features:

• Title page
• Scene heading (entity description)
• Character name centered
• Dialogue blocks
• Action paragraphs

When to use:

• Characters with extensive dialogue
• Script-style reference sheets
• Story-focused documentation

Style Guide Layout

Best for: Visual references, brand guidelines, creative direction

Features:

• Cover page with version
• Overview with keywords
• Guidelines section
• Visual references with images
• Examples section

When to use:

• Brand and organization profiles
• Visual reference documents
• Creative direction guides

Theme Options

Choose a color theme:

• default (blue/gray) - Professional, neutral appearance
• dark - Dark background, light text
• light - Light background, dark text

Note: Themes primarily affect HTML exports. PDF and DOCX use professional black-and-white styling.

Image Embedding

Include images: ✅ Recommended

Embedding images includes all entity assets in the export:

Pros:

• Self-contained document
• No broken image links
• Consistent appearance across devices

Cons:

• Larger file size
• Longer export time

When to disable:

• Entity has many high-resolution images
• You only need text content
• Network bandwidth is limited

Template Customization

Customizing Existing Templates

You can modify the built-in templates to suit your needs. Templates are stored in:

/data/content/_Templates/Export/

Each template consists of two files:

1. {layout_name}.html.jinja - HTML template structure
2. {layout_name}.css - CSS styling

Template Structure

The GDD Standard template has these sections:

{/* Cover Page */}
<div class="cover-page">
    <h1>{{name}}</h1>
    <h2>{{entity_type|title}} Document</h2>
    <p>Status: {{status}}</p>
</div>
 
{/* Table of Contents */}
<div class="toc-page">
    <h2>Table of Contents</h2>
    <ul>
        <li><a href="#overview">1. Overview</a></li>
        <li><a href="#details">2. Details</a></li>
        <li><a href="#assets">3. Assets</a></li>
    </ul>
</div>
 
{/* Main Content */}
<div class="content">
    <section id="overview">
        <h1>Overview</h1>
        <p>{{fields.description}}</p>
    </section>
    
    <section id="details">
        <h1>Details</h1>
        {/* Field-by-field table */}
    </section>
    
    <section id="assets">
        <h1>Assets</h1>
        {/* Embedded images */}
    </section>
</div>

Available Template Variables

You can use these variables in your custom templates:

Adding Custom Sections

Add custom sections for entity-specific fields:

{% if entity_type == 'character' %}
<section id="background">
    <h1>Background</h1>
    <div class="content-block">
        {{fields.background}}
    </div>
</section>

<section id="personality">
    <h1>Personality</h1>
    <div class="content-block">
        {{fields.personality}}
    </div>
</section>
{% endif %}

Styling Custom Templates

Use CSS variables for consistent theming:

:root {
    --primary-color: #2c3e50;
    --secondary-color: #3498db;
    --font-family: 'Segoe UI', sans-serif;
}
 
.document {
    font-family: var(--font-family);
    color: var(--primary-color);
}

Creating New Templates

1. Navigate to _Templates/Export/
2. Create new files:
   • my_custom_layout.html.jinja
   • my_custom_layout.css
3. The layout will be automatically available in the export options

Best Practices

For Character Sheets

1. Include all relevant fields - Background, personality, relationships
2. Use appropriate layout - GDD Standard for general, Script for dialogue-heavy
3. Embed images - Character portraits add visual appeal
4. Review before printing - Check page breaks and image placement

For World Bibles

1. Use consistent templates - Same layout for all locations/brands
2. Organize by category - Export all locations in one session
3. Include cross-references - Link related entities in descriptions
4. Generate PDF - Best for physical reference books

For RPG Handouts

1. Keep it simple - GDD Standard layout works well
2. Focus on player-relevant info - Hide GM-only fields
3. Include visuals - Maps, portraits, icons
4. Test print - Verify formatting on your printer

For Technical Documentation

1. Use Word format - Easier for editing and collaboration
2. Include all fields - Complete technical specifications
3. Add custom sections - Technical notes, system details
4. Version control - Track changes across export versions

Performance Tips

1. For large entities: Disable image embedding for faster export
2. For bulk exports: Process one format at a time (HTML → PDF → DOCX)
3. For multiple entities: Export as individual files, then ZIP manually
4. Server resources: Schedule heavy PDF exports during low-usage periods

Troubleshooting

Export Takes Too Long

Cause: Large entity with many images

Solutions:

1. Disable “Embed images” option
2. Use HTML format instead of PDF
3. Export entities in smaller batches

Images Not Showing

Cause: Image file paths are incorrect

Solutions:

1. Check that assets are properly uploaded to /data/content/
2. Verify file paths in entity fields
3. Ensure file permissions allow reading

PDF Export Fails

Cause: Playwright not installed

Solution:

# On the server
playwright install
 
# Verify installation
playwright show-installation

DOCX Export Fails

Cause: python-docx not installed

Solution:

pip install python-docx

Wrong Layout Appears

Cause: Template file corrupted or missing

Solution:

1. Check /data/content/_Templates/Export/ directory
2. Verify .html.jinja and .css files exist
3. Review template syntax for errors

See Also

• Export API Reference
• Export System Architecture
• Frontend Components