# find-examples

Finds the official PlayCanvas example that matches your installed Engine version, and adapts it for a feature your project lacks.

Skill by PlayCanvas. Category: Knowledge.

## Install

Project (for this project only):

```sh
npx skills add playcanvas/skills --skill find-examples
```

Works with: Claude Code, Codex CLI, Cursor, Antigravity, Copilot CLI, opencode.

Global (for every project on this machine):

```sh
npx skills add playcanvas/skills --skill find-examples -g
```

Works with: Claude Code, Codex CLI, Cursor, Antigravity, Copilot CLI, opencode.

## Tags

- Runs on your computer: It runs as a program on your machine, with your access.

## Security audits

- Gen Agent Trust Hub: Pass
- Socket: Pass
- Snyk: Pass

Installs: 230. Installs counted by skills.sh. [Open on skills.sh](https://www.skills.sh/playcanvas/skills/find-examples)

## Source

[Open the source](https://github.com/playcanvas/skills/tree/HEAD/skills/find-examples). Checked 2026-10-10. This summary may contain AI-generated text, so it can be wrong. Check the source before you rely on it.

## SKILL.md

````markdown
---
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/examples/src/examples/<category>/<name>.example.mjs?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.

| 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).
````

- Previous: [inspect-glb](https://syn4pse.dev/terminal/playcanvas-inspect-glb.md)
- Next: [assemble-scene](https://syn4pse.dev/terminal/playcanvas-assemble-scene.md)
- [Terminal](https://syn4pse.dev/terminal.md)
- [Suggest a change](mailto:terminal@syn4pse.dev?subject=Terminal%20suggestion)
