> For the complete documentation index, see [llms.txt](https://docs.viverse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viverse.com/playcanvas-toolkit/publish-from-playcanvas-editor.md).

# Publish from the PlayCanvas Editor

Initialize a PlayCanvas project with the VIVERSE Toolkit v4 and publish it to VIVERSE directly from the PlayCanvas Editor, without downloading a build.

The VIVERSE PlayCanvas Toolkit can publish your project to VIVERSE from inside the PlayCanvas Editor. This page shows how to initialize a project, test it locally, and publish it without downloading and re-uploading a build.

***

You need:

* The VIVERSE PlayCanvas Toolkit v4 or later installed in Chrome. See [Toolkit Setup](https://docs.viverse.com/playcanvas-toolkit/toolkit-setup.md).
* A PlayCanvas account and a VIVERSE account that use the same email address. The Toolkit can fail to sign in when the emails differ.

## Initialize your project

Initializing adds the VIVERSE Framework to your project and creates a matching project in VIVERSE Studio. You do this once per PlayCanvas project.

{% stepper %}
{% step %}

### Open your project and enable the Toolkit

Open an existing project in the PlayCanvas Editor, or create a new one. Then click the **Extensions** icon in the Chrome toolbar and select **VIVERSE PlayCanvas Toolkit**.
{% endstep %}

{% step %}

### Sign in to VIVERSE

Select **Log In to VIVERSE** in the left-hand toolbar and complete the VIVERSE sign-in.
{% endstep %}

{% step %}

### Create a VIVERSE world

Select **VIVERSE PlayCanvas Toolkit Settings** in the left-hand toolbar, then select **Create New World**. Wait for the Toolkit to add its scripts and assets to your project. They're added under the `.viverse` folder.

Creating a world also creates a project for it in [VIVERSE Studio](https://studio.viverse.com/) under your account. Your published builds go to that project.
{% endstep %}

{% step %}

### Add something to stand on

Add an entity with a **Collision** component and a static **Rigidbody**, such as a floor plane. Adding physics imports the Ammo physics library, which the VIVERSE player system needs to move around.
{% endstep %}

{% step %}

### Test locally

Select **Launch** in the PlayCanvas Editor. The local session runs the VIVERSE Framework, so you can test movement, avatars, and multiplayer audio before you publish.
{% endstep %}
{% endstepper %}

## Publish from the Editor

Publishing from the Editor builds your project and uploads it to its VIVERSE Studio project in one step. New uploads start in staging, where only you and your collaborators can see them.

{% stepper %}
{% step %}

### Open the Builds window

Select **Publish / Download** in the left-hand toolbar to open the **Builds** window.
{% endstep %}

{% step %}

### Publish to VIVERSE

Select **Publish to VIVERSE** and wait for the upload to finish. A progress bar shows the upload status, and it can take a few minutes for larger projects.
{% endstep %}

{% step %}

### Preview your world

When the upload finishes, select **Preview** to open your world on VIVERSE in a new tab. Check that everything works the way it did in your local session.
{% endstep %}

{% step %}

### Keep iterating

Return to the PlayCanvas Editor, make changes, and publish again. Each publish replaces the build in your VIVERSE Studio project.
{% endstep %}
{% endstepper %}

## Make your world public

Publishing from the Editor puts your world in staging. To make it public, open your project in [VIVERSE Studio](https://studio.viverse.com/), complete its settings, and select **Submit for Review**. For what review checks and how long it takes, see [How content review works on VIVERSE](https://docs.viverse.com/content-review.md).

After your world is indexed, each new publish goes through the same review before it goes live.

## Export and upload instead

If you'd rather manage builds yourself, you can still download a build and upload it to VIVERSE Studio:

1. In the PlayCanvas Editor, open **Publish / Download** and create a new build.
2. Download the build's `.zip` file.
3. Open [VIVERSE Studio](https://studio.viverse.com/) and upload the `.zip` to the project the Toolkit created for your world. See [How to Publish](https://docs.viverse.com/how-to-publish.md).

> Sometimes issues in the installation process can produce persistent bugs that are only fixed by fully resetting the Extension. If you're experiencing these bugs please follow the steps below

{% stepper %}
{% step %}

### Sign in and out of VIVERSE

Sign out of your account on viverse.com and then sign back in. **MAKE SURE** you are using the same email account as the one associated with your PlayCanvas account
{% endstep %}

{% step %}

### Delete VIVERSE entities from PlayCanvas project

Go back to your PlayCanvas project and delete:

* The `Extension` Entity from your scene hierarchy
* The `.viverse` folder from your project assets
* The `.index.mjs` folder from your scripts folder
  {% endstep %}

{% step %}

### Clear Application Storage

Open the [Developer Tools](https://elfsight.com/blog/how-to-work-with-developer-console/) in your Chrome broswer, go to "Application", select "Storage" in the left hand toolbar and click the "Delete Site Data" button
{% endstep %}

{% step %}

### Refresh the page

Refresh your PlayCanvas project page with the VIVERSE extension enabled
{% endstep %}

{% step %}

### Sign in back to PlayCanvas

Sign in to PlayCanvas when prompted. **MAKE SURE** you are using the same email account as the one associated with your VIVERSE account
{% endstep %}

{% step %}

### Sign in back to VIVERSE

Sign in to VIVERSE from within your PlayCanvas project using the VIVERSE Scene Settings
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.viverse.com/playcanvas-toolkit/publish-from-playcanvas-editor.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
