PixelBullet Documentation

Table of Contents

• Surface Authorities
• Products
• Architecture
• Modules
• Guides
• Decisions And Roadmaps
• API Documentation
• Build The Site

This is the current documentation map for the PixelBullet workspace. The root README.md provides onboarding; these pages define durable ownership, interfaces, workflows, limitations, and future work.

Surface Authorities

• Applications, tools, examples, labs, and products
• BulletSketch and generic scene execution
• Representative-scene matrix
• Authored labs: Level Slice, World Sandbox, Behavior Lab, and Combat Lab

These pages own classification, example dispositions, lab identity, current packaging status, and automated proof. Architecture pages link to them rather than restating that taxonomy.

Products

• Boundless Vector Arena: overview, GDD, implementation status, content and asset policy, Phase 6 presentation/audio policy, and maintenance contract

Arena is a current repository product rooted at products/boundless_vector_arena. Its native //products/boundless_vector_arena:boundless-vector-arena executable owns the complete product session and interactive lifecycle over product-owned simulation, encounter, presentation, HUD, configuration, and asset surfaces. The default launch runs the complete 31-position campaign with four bosses, perk drafts, checkpoints, replay, and an authoritative completed-run result; --single-encounter preserves the finite Phase 3 reference surface. Arena is now feature-frozen as a maintained reference product and technology demonstrator. It is not a release candidate and has no intentional distribution package. Its product pages distinguish normative design intent, implemented capability, deliberately deferred polish, and allowed maintenance.

Architecture

• Repository model
• Engine and framework layers
• Dependency and API surfaces
• Runtime and scene play
• Rendering and UI
• Assets and serialization

Modules

• Graphics and asset contract
• Audio runtime
• Weapon combat and loadouts
• Weapon presentation
• Renderer and shader implementation notes are generated from engine/src/graphics/module_notes.md.

Guides

• Build and validation
• Authored scene workflows
• Logging
• Packaging and distribution

Decisions And Roadmaps

• Architecture decisions
• Arena reference-product closure
• Graphics roadmap
• External Project Workspace and Installed Editor/Runtime Contract v1

Decisions record durable constraints. Git history records implementation chronology. Roadmaps contain only incomplete future work.

API Documentation

Generated API/source documentation covers the public engine include tree and the private implementation inventory selected by the Doxygen Bazel target. Public headers are backend-neutral source-level workspace API, not a packaged SDK. Repository-internal integration and concrete backend boundaries are defined in Dependency and API Surfaces.

Build The Site

Use the repository-owned validation path:

bash ci/local.sh docs_build

Local validation assembles the site under <bazel-output-base>/pixelbullet-docs-public, prints the resolved path, and leaves the source checkout clean. Hosted CI owns the repository-root public/ artifact used by deployment.

Or build the raw Doxygen target:

bazel build //doxygen:html

The build and validation guide links the current first lanes and affected validation suites.