Installation
The recommended way to get started is to use the official create-playcanvas scaffolding tool and choose the React format:
npm create playcanvas@latest my-app -- -f react
Choose one of the 12 runnable starters when prompted. The generated TypeScript project includes Vite, development and production scripts, and PlayCanvas Skills for compatible AI coding agents.
We recommend following this guide to start building your first project.
Manual Installation
If you have an existing project, just install @playcanvas/react using your preferred package manager.
- npm
- yarn
- pnpm
npm install @playcanvas/react playcanvas
yarn add @playcanvas/react playcanvas
pnpm add @playcanvas/react playcanvas
Once installed, you can start using it in your project. As the next step, we recommend following the building a scene guide to create your first project.
Starter Templates
Explore the complete starter catalogue, or quickly spin up a project from the StackBlitz template.