playcanvas/skills

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.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/playcanvas/skills --skill find-examples

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

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.

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.

Tâches connexes

du même dépôt

Autres Skills

Tous les Skills