Installation
The recommended way to get started is to use the official PlayCanvas scaffolding tool, and follow the prompts.
npm create playcanvas@latest -t react-ts
This creates a new project with everything set up and ready to go. If you've followed the prompts, you'll have a new PlayCanvas React project running in your browser.
We recommend following this guide to start building your first project.
We’re working on adding more React templates. Currently, only TypeScript is available.
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
Alternatively you can grab one of the templates directly or quickly spin a project up from our StackBlitz template