Almanach

API guides, software patterns, styling, and accessibility conventions for building interactive SceneryStack simulations — 420 pages, browsable here or ingestible by LLM agents.

Use the sidebar to navigate the full knowledge base, or jump into a section below.

Getting Started

New to SceneryStack? Start with the framework overview, set up a project, and build your first simulation.

• What is SceneryStack?
• Installation and Setup
• Your First Simulation

Guides

In-depth tutorials on scenery, layout, input, sound, i18n, phet-io, and more.

• Scenery Basics
• Building Your First Screen
• Scenery Layout

API Reference

Per-class and per-module reference for every SceneryStack library — axon, dot, scenery, sun, joist, and dozens more. Browse by library in the sidebar.

• Property (axon)
• Node (scenery)
• Sim (joist)

Patterns

Recurring design patterns used across SceneryStack simulations.

• Model–View Separation
• Options Pattern
• Dispose and Memory Management

Styling

Visual design conventions: color profiles, typography, spacing, panels, and responsive layout.

• Color Profiles
• Typography and Fonts
• Spacing and Sizing Constants

Accessibility

PDOM, voicing, keyboard input, screen reader testing, and sound design for inclusive simulations.

• PDOM
• Voicing
• Keyboard Input and Hotkeys

Examples

End-to-end walkthroughs and sample simulations that tie multiple topics together.

• Demo Simulation Walkthrough
• Building a Two-Screen Simulation
• Full Accessible Multi-Screen Sim

Cookbook

Focused recipes for common tasks — drag listeners, custom sliders, sound effects, chart binding, and more.

• Draggable Node Bounded to an Area
• Custom Slider Thumb and Track
• Animating a Property Value on a Timer

For LLM agents

Three machine-readable views of Almanach are generated from the same Markdown sources and served at the site root:

File	Purpose
/llms.txt	Index of every page with a one-line description (llms.txt convention)
/llms-full.txt	Full text of every page in a single file, for one-shot ingestion
/manifest.json	Structured metadata (title, category, tags, related pages, word counts)

The raw Markdown sources live in the GitHub repository under docs/.

---

Contributors: see the Authoring Guide for frontmatter schema and how to add pages.