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

The Vapor SDK Book

Status: target outline.

This book is for people creating, building, validating, packaging, and publishing Vapor content or first-party Vapor app-root updates.

Quick Start

Status: target outline.

Show the shortest successful SDK authoring path.

Installation And App Root

Status: target outline.

Explain Steam-installed SDK roots, local development roots, and activation.

Workspaces

Status: target outline.

Explain workspace kinds and SDK workspace discovery.

Vapor.toml

Status: target outline.

Explain human-authored workspace and content intent files.

Templates

Status: target outline.

Explain SDK templates once they are real.

Content Authoring

Status: target outline.

Explain authoring engines, games, mods, and packs.

Packs And Packagepacks

Status: target outline.

Explain pack composition from the authoring side.

Toolchain

Status: target outline.

Explain the Vapor-managed Rust/Cargo toolchain.

Managed Cargo

Status: target outline.

Explain how SDK-managed Cargo differs from plain system Cargo.

Check, Format, Build

Status: target outline.

Explain SDK check, fmt, and build workflows.

Deploy

Status: target outline.

Explain deploying first-party tool binaries into an app root.

Package

Status: target outline.

Explain packaging app-root or content artifacts.

Publish

Status: target outline.

Explain publish flows and their boundaries.

SteamCMD

Status: target outline.

Explain SteamCMD login, state, and root publishing.

Workshop

Status: target outline.

Explain future Workshop publishing from the SDK side.

Command Reference

Status: target outline.

List SDK commands when their semantics are stable enough.

File Layout

Status: target outline.

Describe app-root, workspace, output, cache, and generated file layout.

Troubleshooting

Status: target outline.

Collect common SDK failures and repairs.

Limits

Status: target outline.

Explain what the SDK cannot guarantee.