CaveFormat

About this project

CaveFormat is the complete reference guide for CAVE — the Contextual Adventure Verbose Engine markup language. Just as FountainFormat serves screenwriters learning Fountain syntax, CaveFormat gives interactive fiction authors everything they need to master CAVE.

The documentation covers every element of the language: room definitions, object properties, conversation trees, puzzle logic, conditional text, and runtime triggers. Each concept includes clear examples showing both the markup and the resulting gameplay.

Building a markup language without proper documentation is asking writers to reverse-engineer your intentions. CaveFormat ensures CAVE remains accessible to anyone who wants to create text adventures, regardless of their technical background.

Features

• Complete CAVE syntax reference with interactive examples
• Side-by-side markup and gameplay demonstrations
• Tutorials progressing from simple rooms to complex puzzles
• Pattern library for common interactive fiction scenarios
• Quick-reference cards for syntax lookup while writing
• Mobile-friendly for reading alongside CaveDraft

Documentation Structure

The guide follows a natural learning path. Start with rooms and descriptions, add objects and interactions, introduce characters and dialogue, then layer in puzzles and game logic. Each section builds on the previous.

Advanced topics cover state management, conditional text, timed events, and multi-path narratives. The goal is supporting both beginners writing their first room and experienced authors building complex worlds.

Living Documentation

CaveFormat evolves alongside CAVE itself. As the language grows and CaveDraft adds features, the documentation updates to match. Version notes track changes so existing authors can adapt their projects.

Community patterns will eventually join the official documentation — clever solutions discovered by CAVE authors that deserve wider sharing.

The Companion to CaveDraft

CaveFormat and CaveDraft work as a pair. Write in CaveDraft, reference CaveFormat when you need syntax help. The editor links directly to relevant documentation sections, making lookup seamless.

Together with Blackout-Game.com as a playable example, the three sites form a complete ecosystem for interactive fiction creation.