# PlayCanvas Editor API

[![NPM Version](https://img.shields.io/npm/v/@playcanvas/editor-api)](https://www.npmjs.com/package/@playcanvas/editor-api)
[![NPM Downloads](https://img.shields.io/npm/dw/@playcanvas/editor-api)](https://npmtrends.com/@playcanvas/editor-api)
[![License](https://img.shields.io/npm/l/@playcanvas/editor-api)](https://github.com/playcanvas/editor-api/blob/main/LICENSE)
[![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white&color=black)](https://discord.gg/RSaMRzg)
[![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=flat&logo=reddit&logoColor=white&color=black)](https://www.reddit.com/r/PlayCanvas)
[![X](https://img.shields.io/badge/X-000000?style=flat&logo=x&logoColor=white&color=black)](https://x.com/intent/follow?screen_name=playcanvas)

| [User Manual](https://developer.playcanvas.com/user-manual/editor) | [API Reference](https://api.playcanvas.com/editor) | [Blog](https://blog.playcanvas.com) | [Forum](https://forum.playcanvas.com) |

This is the PlayCanvas Editor API. You can find API documentation [here](https://api.playcanvas.com/modules/Editor.html).

## Installing

Run:

```sh
npm install
```

## Building

Run:

```sh
npm run build
```

This will create a UMD build under `dist/index.js` and an ES6 module under `dist/index.mjs`.

## Docs

To build the documentation run:

```sh
npm run docs
```

## Tests

To run tests run:

```sh
npm test
```

To step through the tests using Chrome run:

```sh
npm run test:debug
```