mkdocs.yml

site_name: ThePrototype Docs
site_url: https://docs.theprototype.app/
nav:
  - Getting Started:
    - Welcome: index.md
    - Controls: controls.md
    - The Interface: interface.md
    - Touch Controls: touch-controls.md
    - Tours: tours.md
    - Units: units.md
    - Themes & Appearance: appearance.md
    - Accessibility: accessibility.md
    - Settings: settings.md
    - Tools & connections: tools-and-connections.md
    - Privacy & Error Reports: privacy.md
    - Security & Self-hosting: security.md
    - Your Character: avatars.md
    - Connection: connection.md
    - Invite People and Agents: invites.md
    - Sign in from Another Device: sign-in-from-another-device.md
    - Users & Moderation: people.md
    - Sharing into the App: sharing-into-the-app.md
  - Building:
    - Explorer: explorer.md
    - Importing Big Models: import-optimize.md
    - Edit in Blender: edit-in-blender.md
    - "Free Assets (CC0)": free-assets.md
    - Packs: packs.md
    - Levels of Detail: lod.md
    - Prefabs: prefabs.md
    - Material Presets: materials.md
    - Architecture: architecture.md
    - Mesh Editing: mesh-editing.md
    - Splines: splines.md
    - 3D Text: 3d-text.md
    - Snapping: snapping.md
    - Measure, Align & Distribute: measure-align.md
    - Reference Images: reference-images.md
    - UV & Textures: uv-editor.md
    - Image Editor: image-editor.md
    - Shader Graph: shader-graph.md
    - Shader Nodes: shader-nodes.md
    - Scene Look (Post-processing): post-processing.md
    - Animation: animation.md
    - Characters and motion: characters-and-motion.md
    - Timeline (Cutscenes): timeline.md
    - Film with your phone: film.md
    - Physics & Simulation: physics.md
    - Colliders: colliders.md
    - Particle Effects: particles.md
    - Water: water.md
    - Fluid Tank & Jiggle: simulation.md
    - "Fluids: Emitters & Flow Paths": fluids.md
    - Terrain & Sculpting: terrain.md
    - Scatter: scatter.md
    - Saving & Sessions: saving.md
    - Checkpoints: checkpoints.md
    - Loading Placeholders: loading.md
    - Projects: projects.md
  - Viewport:
    - Camera & View: camera.md
    - Export a Video or GIF: recording.md
    - Notifications & Notes: notifications.md
    - Performance & Budgets: performance.md
    - Profiler & Recordings: profiler.md
  - Flow Graph:
    - Node System: node-system.md
    - Main Graph & Node Properties: main-graph.md
    - "Node Editor: Keyboard, Groups & Notes": node-editor.md
    - Node Graph Debugger: debugger.md
    - Code Workspace: code-workspace.md
    - Flow Nodes: nodes.md
    - Object Flows: object-flows.md
    - Nodes:
      - Input:
        - Slider: nodes/slider.md
        - Color Picker: nodes/colorpicker.md
        - Switcher: nodes/switcher.md
        - Number: nodes/number.md
        - Vector3: nodes/vector3.md
        - Toggle: nodes/toggle.md
        - Random: nodes/random.md
        - Time: nodes/time.md
      - Scene:
        - Object Selector: nodes/objectselector.md
        - Velocity: nodes/velocity.md
        - Measure: nodes/measure.md
        - Spawn: nodes/spawn.md
      - Object Flow:
        - Flow Input: nodes/flowinput.md
        - Flow Output: nodes/flowoutput.md
        - Object Flow: nodes/objectflow.md
      - Game:
        - Set Game State: nodes/setgamestate.md
        - On Game State: nodes/ongamestate.md
        - Set Active Camera: nodes/setcamera.md
        - Camera Rig: nodes/camerarig.md
        - Set Look: nodes/setlook.md
        - Game Start: nodes/gamestart.md
        - Travel to scene: nodes/travel.md
        - All Players: nodes/allplayers.md
        - Set Variable: nodes/setvariable.md
        - Get Variable: nodes/getvariable.md
        - Store Value: nodes/storevalue.md
        - Stored Value: nodes/storedvalue.md
        - Announce: nodes/announce.md
        - Game Sound: nodes/gamesound.md
        - Effect Burst: nodes/effectburst.md
        - Controller Buzz: nodes/hapticpulse.md
        - Game Music: nodes/gamemusic.md
        - Game Setting: nodes/gamesetting.md
        - Point Grab: nodes/pointgrab.md
        - On Clap: nodes/onclap.md
        - Game Time: nodes/gametime.md
        - Player Variable: nodes/peervariable.md
      - Character:
        - Character Controller: nodes/charcontroller.md
        - Move Input: nodes/moveinput.md
        - Possess Object: nodes/possessnode.md
        - Camera Follow: nodes/camerafollow.md
        - Move Speed: nodes/movespeed.md
      - HUD:
        - HUD Screen: nodes/hudscreen.md
        - HUD Text: nodes/hudtext.md
        - HUD Bar: nodes/hudbar.md
        - HUD Button: nodes/hudbutton.md
        - HUD Timer: nodes/hudtimer.md
        - HUD List: nodes/hudlist.md
        - HUD Rows: nodes/hudrows.md
        - Leaderboard: nodes/leaderboard.md
        - HUD Input: nodes/hudinput.md
        - HUD Set Input: nodes/hudset.md
      - Logic:
        - Script: nodes/script.md
        - Custom Node: nodes/customnode.md
        - Behaviour: nodes/behaviour.md
        - Code link: nodes/coderef.md
        - Math: nodes/math.md
        - Compare: nodes/compare.md
        - Gate: nodes/gate.md
        - Map Range: nodes/maprange.md
        - Select: nodes/select.md
        - Latch: nodes/latch.md
        - Delay: nodes/delay.md
        - Sequence: nodes/sequence.md
        - Once: nodes/once.md
        - Counter: nodes/counter.md
        - Loop: nodes/loop.md
        - Timer: nodes/timer.md
        - Distance: nodes/distance.md
        - Proximity: nodes/proximity.md
        - Look At: nodes/lookat.md
        - Set Color: nodes/setcolor.md
        - Visibility: nodes/visibility.md
        - Set Shader Uniform: nodes/setuniform.md
      - Triggers:
        - On Click: nodes/onclick.md
        - On Grab: nodes/ongrab.md
        - Key Press: nodes/keypress.md
        - On Hit: nodes/onhit.md
        - On Rest: nodes/onrest.md
        - Gamepad Button: nodes/gamepadbutton.md
        - Gamepad Axis: nodes/gamepadaxis.md
      - Animation:
        - Shake: nodes/shake.md
        - Spin: nodes/spin.md
        - Rotate / Motor: nodes/rotor.md
        - Float Along Flow: nodes/flowfloat.md
        - Bounce: nodes/bounce.md
        - Orbit: nodes/orbit.md
        - Path Patrol: nodes/pathpatrol.md
        - Follow Path: nodes/followpath.md
        - Wander: nodes/wander.md
        - Orient to Velocity: nodes/orientvelocity.md
        - Body Wave: nodes/bodywave.md
        - Animation Finished: nodes/animfinished.md
        - Animation Marker: nodes/animmarker.md
        - Animation State: nodes/animstate.md
        - Play Animation: nodes/playanim.md
        - Play Sequence: nodes/playseq.md
        - On Sequence Event: nodes/onseqevent.md
      - Physics:
        - On Impact: nodes/onimpact.md
        - On Enter: nodes/onenter.md
        - On Exit: nodes/onexit.md
        - Mass: nodes/mass.md
        - Bounciness: nodes/bounciness.md
        - Friction: nodes/friction.md
        - Angular Velocity: nodes/angularvelocity.md
        - Collider: nodes/collider.md
        - Motor: nodes/motor.md
        - Impulse: nodes/impulse.md
        - Set Velocity: nodes/setvelocity.md
        - Joint: nodes/joint.md
      - Effects:
        - Pulse: nodes/pulse.md
        - Blink: nodes/blink.md
        - Sound: nodes/sound.md
        - Particles: nodes/particle.md
        - Jiggle: nodes/jiggle.md
      - Music:
        - Device Param: nodes/deviceparam.md
        - Device Level: nodes/devicelevel.md
        - Transport: nodes/transportbeat.md
        - Note Trigger: nodes/notetrigger.md
  - Audio:
    - Music & Sound: audio.md
    - Music Playground: music.md
  - Games:
    - The Games Tab: games.md
    - Play Here: play-here.md
    - Game Rules on the Main Graph: game-rules.md
    - Build a Game Loop: build-a-game.md
    - Making Your Game Accessible: making-your-game-accessible.md
    - HUD Editor: hud-editor.md
    - Game Kit: game-kit.md
    - Behaviours: behaviours.md
    - VR Football: football.md
    - Race: race.md
  - Community:
    - Publish, Play, Remix: community.md
    - Publish & Export: publish-export.md
    - Share a Game: share-a-game.md
  - VR:
    - VR Guide: vr.md
    - Building in VR: building-in-vr.md
    - Colocation (shared room): colocation.md
    - Play on a Table (AR, Android): ar-table.md
  - AI:
    - Assistant: ai/assistant.md
    - Build with an AI agent: ai/build-with-an-agent.md
    - Materials and looks with an agent: ai/agent-look.md
    - HUD, sky and play with an agent: ai/agent-scene.md
    - Undo, pivots and images with an agent: ai/agent-assist.md
    - Test and fix a game with an agent: ai/agent-runtime.md
    - Here, this and you (pings): ai/agent-spatial.md
    - Talk to your agent: ai/talk-to-your-agent.md
    - "Recipe: better models with img2threejs": ai/img2threejs.md
    - "Recipe: pixel art with Pixling": ai/pixling.md
    - "Recipe: Agents + Blender": ai/agents-and-blender.md
    - Shapes and modelling with an agent: ai/agent-geometry.md
    - Worlds with an agent: ai/agent-world.md
    - Use theprototype from claude.ai and voice: ai/claude-connector.md
    - Providers: ai/providers.md
    - Local & Small Models: ai/local-models.md
    - 3D Generation: ai/generation.md
    - Give the AI pictures and shaders: ai/pictures-and-shaders.md
    - Console Agent: ai/console-agent.md
  - Extending:
    - Modules: modules.md
    - Module SDK: module-sdk.md
    - Module Packages: module-package.md
    - UI kit for modules: ui-kit.md

theme:
  name: material
  custom_dir: overrides
  favicon: logo.svg
  logo: logo.svg
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: indigo
      accent: green
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - content.action.edit
    - navigation.top
    # Collapsible nav: navigation.sections + navigation.expand are intentionally
    # omitted so nested groups (e.g. the node pages under Flow Graph > Nodes)
    # collapse behind a chevron instead of rendering fully expanded.
    # - navigation.tabs
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

repo_url: https://github.com/theprototype-app/docs
edit_uri: edit/docs/

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.superfences
  - pymdownx.magiclink
  - pymdownx.tabbed
  - pymdownx.details
  - pymdownx.tilde
  # roadmap 83: figure captions under screenshots and loops
  - pymdownx.blocks.caption

plugins:
  - search
  - git-revision-date
  # roadmap 83: click a screenshot to see it full size
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      width: auto
      height: auto
      zoomable: true
      draggable: false
      auto_caption: false
      skip_classes:
        - no-lightbox

# roadmap 83: screenshot frames + cut-side fades, loops that respect reduced motion
extra_css:
  - stylesheets/shots.css
extra_javascript:
  - javascripts/loops.js

# roadmap 83 V8: every "Try it" link must name a check in tools/shots/tryit.yml (the build fails
# otherwise); tools/shots/tryit-check.cjs opens each link and asserts the controls exist
hooks:
  - tools/hooks/tryit.py
  # roadmap 83 V9/V10: the owner's image rules (1:1 interface, figure + caption, key = badges) fail the build;
  # llms.txt, llms-full.txt, a .md beside every page and a small JSON-LD block for AI readers
  - tools/hooks/shots.py
  - tools/hooks/readable.py