Docs Index

Perro reference map

Index-first docs. Jump by subsystem. Expand sections. Open any topic for purpose, API source map, field/type links, and related references.

project loopCLI

perro new --path D:\GameProjects --name MyGameperro check --path D:\GameProjects\MyGameperro dev --path D:\GameProjects\MyGameperro build --path D:\GameProjects\MyGame

Quick Jump

Start Write Build Scenes Input Runtime APIs Resource APIs Assets Ship

Start

Create a project, run the script pipeline, launch dev builds, export release output, and keep project files outside the engine repo when the game becomes real.

CLInew, check, dev, build, profile Script Shaperes/**/*.rs + generated crates Downloadget Perro GitHubengine source

Write

Build gameplay in Rust with state, lifecycle hooks, callable methods, explicit context objects, and short macros for common runtime work.

ScriptsRust gameplay module flow State#[State] + defaults Lifecycleinit/update/fixed/removal hooks Methodscallable script behavior Call Modelbehavior/data split + borrow-safe runtime access Contextsruntime, resources, input ScriptContextsingle callback context shape Macrosstate, node, signal helpers Project Modulesgenerated script namespace Math Typesvectors, quats, color, transforms

Build Scenes

Compose nodes, templates, UI, and runtime node searches. Use query filters when gameplay needs to find groups by name, tag, concrete type, or base type.

Nodesbuilt-in node fields Scene.scn model + composition flow Query Systemname/tag/type/base filters Scene Templatesroot_of + merge rules Node Usageread/write node data UIUiBox, panels, buttons, labels

Input

Read keyboard, mouse, gamepad, Joy-Con, and player bindings through ScriptContext input window (`ctx.ipt`). Start at the input overview, then use device pages for exact macros.

Input Overviewall input modules Keysdown/pressed/released Mousebuttons, position, capture Gamepadsbuttons, sticks, gyro Joy-Conssplit controller helpers Playersstable player binding

Runtime APIs

Use runtime window APIs through `ctx.run` for scene mutation, signals, physics, animation playback, script calls, IDs, and time.

Runtime Overviewmodule map Signalsglobal pub/sub AnimationsAnimationPlayer control Physicsforce, impulse, events Scriptsstate vars + method calls Helpersids, params, Variant Timedelta/fixed timing

Resource APIs

Resource window APIs through `ctx.res` load and manage assets from scripts: audio, textures, meshes, materials, skeletons, localization, draw_2d, and animation clips.

Resource APImodule map Audiobuses, playback, cache Texturesload/reserve/drop MeshesglTF sub-assets Materialsload/create presets SkeletonsBone3D data loads Localizationlocale + text lookup Draw 2Dimmediate 2D helpers Animation Clipsload .panim resources

Assets

Author engine resources for animation, materials, shaders, particles, skeletons, post-processing, and visual accessibility.

Resource Mapall asset docs Particlesemitters + .ppart profiles Animation.panim clips + events Materials.pmat presets + custom shader params Particle Profiles.ppart profile expressions + presets Skeletons.pskel bone data + skinning ShadersWGSL material/post hooks Post Processingordered camera/global chains Accessibilityglobal final filter pass

Ship

Static builds pack resources and scripts into project output. DLC builds create runtime-loadable packs mounted under dlc:// names.

Build Outputperro build pipeline DLCdlc:// paths + packs Post FXcamera/global chains Accessibilityglobal final pass