Skip to content

Home

Jump to bottom
Matt edited this page Sep 19, 2025 · 11 revisions

Scribe Engine User Guide

Welcome to Scribe Engine, a powerful and modern text-based game engine that combines the simplicity of traditional interactive fiction with the flexibility of Python scripting and web technologies.

What is Scribe Engine?

Scribe Engine is designed for developers who want to create rich, interactive text-based games without the complexity of traditional game engines. Whether you're building a simple branching story or a complex RPG with inventory systems, character stats, and dynamic storytelling, Scribe Engine provides the tools you need.

Key Features

  • Modern IDE Integration: Full-featured integrated development environment with syntax highlighting, live preview, and debugging.

  • Python-Powered Logic: Embed Python code directly in your story passages for complex game mechanics.

  • Object-Oriented State Management: Use custom Player classes and natural Python syntax for game state.

  • Live Preview: See your changes instantly without rebuilding.

  • Flexible Theming: Customize the look and feel with CSS or use built-in themes.

  • Desktop Distribution: Build standalone executables for easy distribution.

How to Use This Guide

This guide is organized to take you from your first project to advanced development techniques in a logical progression. We recommend reading the documents in order.

  1. Getting Started - Install the engine, create your first project, and run your first game.

  2. Using the IDE - Master the integrated development environment for a fast and efficient workflow.

  3. Game Structure and Syntax - Learn the .tgame file format, passage structure, links, and special syntax.

  4. Python and Templates - Embed Python logic and use the Jinja2 templating engine to create dynamic content.

  5. State Management and Classes - Manage game state effectively with custom Python classes and objects.

  6. Theming and Styling - Customize the visual appearance of your games with CSS.

  7. Advanced Concepts - Explore custom Python modules, complex systems, and game distribution.

  8. CLI Development Workflow - Learn an alternative workflow for using external editors like VS Code or Vim.

Clone this wiki locally