# playcanvas-editor

**Repository Path**: cqjsc_admin/playcanvas-editor

## Basic Information

- **Project Name**: playcanvas-editor
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: feat-enhanced-script-parse
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-05
- **Last Updated**: 2025-08-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<img width="200" src="https://s3-eu-west-1.amazonaws.com/static.playcanvas.com/platform/images/logo/playcanvas-logo-medium.png"/>

# PlayCanvas Editor

[User Manual](https://developer.playcanvas.com) | [Forum](https://forum.playcanvas.com)

The PlayCanvas Editor is a visual editing environment for building WebGL/WebGPU/WebXR apps. It can be accessed at https://playcanvas.com.

[![Average time to resolve an issue][resolution-badge]][isitmaintained-url]
[![Percentage of issues still open][open-issues-badge]][isitmaintained-url]
[![Twitter][twitter-badge]][twitter-url]

![Editor](https://raw.githubusercontent.com/playcanvas/editor/refs/heads/main/images/editor.png)

You can see more projects build using the Editor on the [PlayCanvas website](https://playcanvas.com/explore).

</div>

## Local Development

To initialize a local development environment for the Editor Frontend, ensure you have [Node.js](https://nodejs.org/) 18 or later installed. Follow these steps:

1. Clone the repository:

   ```sh
   git clone https://github.com/playcanvas/editor.git
   cd editor
   ```

2. Install dependencies:

   ```sh
   npm install
   ```

3. Build Editor and start a local web server on port 51000:

   ```sh
   npm run develop
   ```

4. Append the query parameter `use_local_frontend` to load the development build:

    ```
    https://playcanvas.com/editor/project/2535?use_local_frontend
    ```

> [!NOTE]
> This query parameter is also supported in the code editor and launch page

## Library integration testing

The Editor is built on the following open source libraries:

| Library                                                       | Details                                     |
| ------------------------------------------------------------- | ------------------------------------------- |
| [PlayCanvas Engine](https://github.com/playcanvas/engine)     | Powers the Editor's 3D View and Launch Page |
| [Observer](https://github.com/playcanvas/playcanvas-observer) | Data binding and history                    |
| [PCUI](https://github.com/playcanvas/pcui)                    | Front-end component library                 |
| [PCUI-Graph](https://github.com/playcanvas/pcui-graph)        | PCUI plugin for rendering node-based graphs |
| [Editor API](https://github.com/playcanvas/editor-api)        | Public API for Editor automation            |

To test the integration of these libraries use [npm link](https://docs.npmjs.com/cli/v9/commands/npm-link). Follow these steps:

1. Create a global link from source

    ```sh
    cd <library>
    npm run link
    ```

2. Create a link to the global link

    ```sh
    cd editor
    npm run link <library>
    ```

[resolution-badge]: https://isitmaintained.com/badge/resolution/playcanvas/editor.svg
[open-issues-badge]: https://isitmaintained.com/badge/open/playcanvas/editor.svg
[isitmaintained-url]: https://isitmaintained.com/project/playcanvas/editor
[twitter-badge]: https://img.shields.io/twitter/follow/playcanvas.svg?style=social&label=Follow
[twitter-url]: https://twitter.com/intent/follow?screen_name=playcanvas