find-examples
Use when implementing a PlayCanvas feature the project does not use yet, to find and adapt the official example matching the installed version.
Install
npx skills add https://github.com/playcanvas/skills/tree/main/skills/find-examples
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
Official examples
Examples are version-matched recipes to adapt, not modules to import. When the Engine ships a script
for the behaviour, use reuse-scripts first.
Find the example
If node_modules/playcanvas/examples/src/examples exists, it is a linked or source checkout: read
it locally. The npm package omits examples/, so otherwise fetch from the installed tag:
TAG="v$(node -p "JSON.parse(require('fs').readFileSync('node_modules/playcanvas/package.json')).version")" || exit 1
gh api "repos/playcanvas/engine/git/trees/$TAG?recursive=1" | grep -o '"examples/src/examples/[^"]*example\.mjs"'
gh api "repos/playcanvas/engine/contents/<listed path>?ref=$TAG" --jq .content | base64 --decode
Read the resolved package, not the dependency list; playcanvas is often transitive. An empty list
means an invalid tag: stop rather than guess. Use main only when the version has no tag. From
2.24, each Engine example is a folder with the shaders and other files it imports; earlier tags use
<name>.example.mjs with sibling <name>.* files.
| Surface | Repository | Ref | Example paths |
|---|---|---|---|
| direct Engine | playcanvas/engine |
v<version> |
examples/src/examples/<category>/<name>/example.mjs |
| Web Components | playcanvas/web-components |
v<version> |
examples/<name>.html |
| React | playcanvas/developer-site |
main |
docs/user-manual/react/examples/<name>.mdx |
Search the surface's catalog first, then the Engine's. React pages track the latest package; verify
each prop against the installed declarations. Fetch example assets, including the Draco, Basis, and
Ammo decoders under examples/assets/wasm, from the same ref.
Adapt it
Keep component options, scene setup, materials, shaders, assets, and update logic; drop the example browser's controls and imports. When one example joins several systems, such as layers, depth, camera frame, and sky, get that baseline rendering before customizing it.
Read only the reference matching the code: direct Engine, React, or Web Components.
Files (skills)
-
references
-
direct-engine.md 764 B
Loading… -
react.md 841 B
Loading… -
web-components.md 975 B
Loading…
-
-
SKILL.md 2.3 KB
--- name: find-examples description: Use when implementing a PlayCanvas feature the project does not use yet, to find and adapt the official example matching the installed version. --- # Official examples Examples are version-matched recipes to adapt, not modules to import. When the Engine ships a script for the behaviour, use `reuse-scripts` first. ## Find the example If `node_modules/playcanvas/examples/src/examples` exists, it is a linked or source checkout: read it locally. The npm package omits `examples/`, so otherwise fetch from the installed tag: ```sh TAG="v$(node -p "JSON.parse(require('fs').readFileSync('node_modules/playcanvas/package.json')).version")" || exit 1 gh api "repos/playcanvas/engine/git/trees/$TAG?recursive=1" | grep -o '"examples/src/examples/[^"]*example\.mjs"' gh api "repos/playcanvas/engine/contents/<listed path>?ref=$TAG" --jq .content | base64 --decode ``` Read the resolved package, not the dependency list; `playcanvas` is often transitive. An empty list means an invalid tag: stop rather than guess. Use `main` only when the version has no tag. From 2.24, each Engine example is a folder with the shaders and other files it imports; earlier tags use `<name>.example.mjs` with sibling `<name>.*` files. | Surface | Repository | Ref | Example paths | | --- | --- | --- | --- | | direct Engine | `playcanvas/engine` | `v<version>` | `examples/src/examples/<category>/<name>/example.mjs` | | Web Components | `playcanvas/web-components` | `v<version>` | `examples/<name>.html` | | React | `playcanvas/developer-site` | `main` | `docs/user-manual/react/examples/<name>.mdx` | Search the surface's catalog first, then the Engine's. React pages track the latest package; verify each prop against the installed declarations. Fetch example assets, including the Draco, Basis, and Ammo decoders under `examples/assets/wasm`, from the same ref. ## Adapt it Keep component options, scene setup, materials, shaders, assets, and update logic; drop the example browser's controls and imports. When one example joins several systems, such as layers, depth, camera frame, and sky, get that baseline rendering before customizing it. Read only the reference matching the code: [direct Engine](references/direct-engine.md), [React](references/react.md), or [Web Components](references/web-components.md).
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.