build-app
Use when creating or restructuring a PlayCanvas app with the Engine API, @playcanvas/react, or @playcanvas/web-components, covering bootstrap, input, resize, physics, update loop, UI, and lifecycle.
Install
npx skills add https://github.com/playcanvas/skills/tree/main/skills/build-app
claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install playcanvas-skills@llmmart
git clone https://github.com/playcanvas/skills.git
The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole playcanvas/skills collection as a plugin from our marketplace. Git is the plain clone.
Skill manifest
Build an Engine application
Read package.json and the entry point, keep the surface that owns the lifecycle, and read only its
reference: direct Engine, React, or
Web Components. Choose from imports and markup, not dependencies.
Bootstrap
- Input is opt-in.
app.keyboard,mouse,touch,gamepads, andelementInputstaynullunless passed tonew Application(canvas, { ... }); UI buttons neednew ElementInput(canvas). - The Engine adds no window resize listener; call
app.resizeCanvas()from your own handler. graphicsDevice.maxPixelRatiodefaults to 1. Raise it, at most towindow.devicePixelRatio, only where the target holds its frame budget, callapp.resizeCanvas(), and confirm withcanvas.width / canvas.clientWidth.- Rigid bodies stay inert until Ammo loads through
WasmModule. Copy the loader from thephysics/falling-shapesexample withfind-examples. devtoolsdefaults totrue, so debugging tools can find the app (inspect-runtime). Set it tofalseonly to hide a production build.
Update loop
dtis already clamped byapp.maxDeltaTime(0.1 s); tune it instead of clamping by hand.app.timeScalescales it, and0pauses scaled time.- Keep app state explicit and owned in one place; advance time-dependent logic from
dt, and reset through the same setup used at start.
UI
- Render UI from app state; never keep the source of truth in the DOM or UI elements.
- Use a DOM or React overlay, or Engine
screenandelementcomponents adapted from auser-interfaceexample. - Hide unused elements with
enabled = false; an element at opacity 0 still draws.
Ownership
- Keep one owner for app creation, assets, entities, update callbacks, and teardown.
- Prefer the surface's declarative primitives. Put per-entity and per-frame behaviour in an Engine
Script. - Remove external events and resources in the lifecycle that created them.
Files (skills)
-
references
-
direct-engine.md 728 B
Loading… -
react.md 1.1 KB
Loading… -
web-components.md 2 KB
Loading…
-
-
SKILL.md 2.2 KB
--- name: build-app description: Use when creating or restructuring a PlayCanvas app with the Engine API, @playcanvas/react, or @playcanvas/web-components, covering bootstrap, input, resize, physics, update loop, UI, and lifecycle. --- # Build an Engine application Read `package.json` and the entry point, keep the surface that owns the lifecycle, and read only its reference: [direct Engine](references/direct-engine.md), [React](references/react.md), or [Web Components](references/web-components.md). Choose from imports and markup, not dependencies. ## Bootstrap - Input is opt-in. `app.keyboard`, `mouse`, `touch`, `gamepads`, and `elementInput` stay `null` unless passed to `new Application(canvas, { ... })`; UI buttons need `new ElementInput(canvas)`. - The Engine adds no window resize listener; call `app.resizeCanvas()` from your own handler. - `graphicsDevice.maxPixelRatio` defaults to 1. Raise it, at most to `window.devicePixelRatio`, only where the target holds its frame budget, call `app.resizeCanvas()`, and confirm with `canvas.width / canvas.clientWidth`. - Rigid bodies stay inert until Ammo loads through `WasmModule`. Copy the loader from the `physics/falling-shapes` example with `find-examples`. - `devtools` defaults to `true`, so debugging tools can find the app (`inspect-runtime`). Set it to `false` only to hide a production build. ## Update loop - `dt` is already clamped by `app.maxDeltaTime` (0.1 s); tune it instead of clamping by hand. `app.timeScale` scales it, and `0` pauses scaled time. - Keep app state explicit and owned in one place; advance time-dependent logic from `dt`, and reset through the same setup used at start. ## UI - Render UI from app state; never keep the source of truth in the DOM or UI elements. - Use a DOM or React overlay, or Engine `screen` and `element` components adapted from a `user-interface` example. - Hide unused elements with `enabled = false`; an element at opacity 0 still draws. ## Ownership - Keep one owner for app creation, assets, entities, update callbacks, and teardown. - Prefer the surface's declarative primitives. Put per-entity and per-frame behaviour in an Engine `Script`. - Remove external events and resources in the lifecycle that created them.
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.