mcpField
F
find-examples

find-examples

github.com/playcanvasDevelopment31312 installsUpdated 1w ago
Repository

About find-examples

find-examples is a development skill for locating version-matched PlayCanvas examples and adapting them to an Engine, React, or Web Components project. It guides searches across local sources and versioned repositories, and advises checking APIs against the installed package.

Key features

  1. 01Locate examples matching the installed version
  2. 02Search the relevant surface catalog first
  3. 03Fetch example code and matching assets
  4. 04Adapt setup while removing browser controls
  5. 05Verify React props against installed declarations

Use cases

  1. 01Find a version-compatible rendering recipe
  2. 02Adapt an Engine example to a project
  3. 03Check React example props against the installed package

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/playcanvas/skills --skill find-examples

After installing, type/find-examplesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
direct-engine.md
react.md
web-components.md

Details

From the project README

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/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.

SurfaceRepositoryRefExample paths
direct Engineplaycanvas/enginev<version>examples/src/examples/<category>/<name>.example.mjs
Web Componentsplaycanvas/web-componentsv<version>examples/<name>.html
Reactplaycanvas/developer-sitemaindocs/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.

Comments

Markdown supported