Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Vapor Books

Status: target outline.

The Vapor docs are split by reader and job. The root book only routes you to the right book.

Which Book Should I Read?

Status: target outline.

  • Read The Vapor Book to understand the whole system.
  • Read The SDK Book to make and publish content.
  • Read The Launcher Book to install, compose, lock, and launch content.
  • Read The Distribution Book to understand Steam, Workshop, Registry, trust, and release flows.
  • Read The Internals Book to work on Vapor itself.
  • Read The Cookbook when you want a concrete recipe.

Status And Scope

Status: target outline.

These books may describe the intended finished system. They must clearly mark unfinished behavior when they are used as current documentation.

The Vapor Book

Status: routing page.

Book folder: docs/books/vapor/

Use this book for the whole Vapor concept/product story.

The Vapor SDK Book

Status: routing page.

Book folder: docs/books/sdk/

Use this book for SDK authoring, build, packaging, and publishing workflows.

The Vapor Launcher Book

Status: routing page.

Book folder: docs/books/launcher/

Use this book for installing, composing, locking, and launching content.

The Vapor Distribution Book

Status: routing page.

Book folder: docs/books/distribution/

Use this book for Steam, Workshop, Registry, trust, and release workflows.

The Vapor Internals Book

Status: routing page.

Book folder: docs/books/internals/

Use this book for repo architecture, invariants, and implementation work.

The Vapor Cookbook

Status: routing page.

Book folder: docs/books/cookbook/

Use this book for concrete recipes.