The PlayCanvas VS Code Extension is a realtime editing environment for text-based assets from the PlayCanvas Editor platform.
Usage
Download the VS Code Extension from the VS Code marketplace.
Click the popup link to sign in with your PlayCanvas account.
Open the command palette (Ctrl/Cmd + P) and run the command PlayCanvas: Open Project to load a project.
Compatibility
Editor
Supported
VS Code
✅
Cursor
✅
Features
Realtime file updating in VS Code
File system operations (create/delete/rename/move)
Integrated types with type checking
Branch switching
List view for currently online collaborators per file
Ignore file support (Beta)
Create a file in the root of your project called .pcignore
Syntax follows for .gitignore using file blobs (e.g. *.ts)
Reload project to re-parse ignore file
Local Development
To initialize a local development environment for the Editor Frontend, ensure you have Node.js 18 or later installed. Follow these steps:
Clone the repository:
git clone https://github.com/playcanvas/vscode-extension.git
cd vscode-extension
Install dependencies for extension and plugin
npm install
cd plugin
npm install
Run and Debug (F5) with the Run Extension configuration to start the extension a development environment. More information about how to develop extensions can be found here
To test your extension switch the launch configuration to Test Extension to run the testing suite
