Porting from Unity to PlayCanvas

This document provides information and guides related to the tools needed to migrate a Unity project to PlayCanvas.

---

Install Unity Export Tool

Instructions for using the Unity plugin that will export data, images, models, etc. from Unity and outputs the resources to a folder inside the Unity project

1

Install the Unity Export Tool package into the Unity project

To install the Unity Export Tool package, open up the Unity project and go to menu option Assets > Import Package > Custom Package.

2

Select Unity package to install

Navigate to the location of the PlayCanvasSceneCreator Unity package and select it. Click Open.

3

Review and confirm files for installation

Click Import

4

Confirm installation was successful

Confirm the PlayCanvas folder has been created in the Assets window.

5

Open up window for Unity Export Tool

In Unity project, go to menu option Window > Playcanvas > Playcanvas Transform Window.

6

Start the export process

Move the PlaycanvasTransformWindow tab beside the Inspector tab for easy access. Click the Export Playcanvas button.

7

Locate the generated folder

The PlaycanvasBuild folder will be created inside the parent folder of the Unity project. If the Unity project's location is D:\Projects\Unity\Unity_PlayCanvas_Export_Sample, then the PlaycanvasBuild folder should be located in D:\Projects\Unity.

8

Confirm the export was successful

The files that will be imported into PlayCanvas can be found in the PlaycanvasBuild\ExportedAssets folder.

Install Unity2PlayCanvas Browser Extension

Instructions for installing the Unity2PlayCanvas browser extension

Download the Unity2PlayCanvas browser extension. There are two ways install to install the extension. Use only one method of installation (Important!).

Method 1 for installing the Unity2PlayCanvas browser extension using Google Chrome installation method (Recommended).

1

Open Chrome browser extensions page

Open chrome browser and go to url: chrome://extensions/

2

Configure Chrome browser for Developer Mode

Click the Developer mode button on the Extensions page to enable Developer Mode

3

Install browser extension

Click the Load unpacked button to install the extension (select folder ‘{Release file}/Extension’)

4

Confirm browser extension was installed successfully

The browser extension will be added to the All Extensions list with remove and reload button.

Method 2 for installing the Unity2PlayCanvas browser extension using Tampermonkey installation method.

1

Download Tampermonkey browser extension

The Tampermonkey browser extension can be downloaded here: https://www.tampermonkey.net

2

Open Tampermonkey dashboard

Open plugin dashboard (this example uses chrome)

3

Install Unity2PlayCanvas browser extension

Drag the Unity2PlayCanvas.js file into the Tampermonkey dashboard. The file location should be ‘{Release file}/Extension/Unity2Playcanvas.user.js’ script.

4

Refresh PlayCanvas editor

Refresh the PlayCanvas editor after adding or updating the script. Delete the old script before updating to new version of the script.

5

Uninstalling the Unity2PlayCanvas browser extension

In order to uninstall the Unity2PlayCanvas browser extension, open the Tampermonkey dashboard and click the trash can icon.

Import Unity Scene into PlayCanvas

Instructions for using the PlayCanvas browser extension that will recreate the Unity scene in PlayCanvas editor from the resources generated by the Unity Export Tool

Integrate the Unity scene into the PlayCanvas editor by creating assets (materials, state graphs) and entities.

1

Create/select an output folder in PlayCanvas

In PlayCanvas editor, create/select an empty folder under root of Assets folder (Important!).

2

Upload generated files to output folder

Under path ‘{Unity project's Parent folder}\PlaycanvasBuild\ExportAssets’, select all files generated by Unity tool then drag into the folder in PlayCanvas editor.

3

Wait for uploading to complete

4

Start process

Click the Unity2PlayCanvas dropdown to expand/hide the panel and click the ‘Run Progress’ button

5

Wait for process to complete

6

Check for errors in the process

Hover over the error messages to read them and click ‘view’ button to check problem entity or asset.

7

Rerun the process if needed

If you want to rerun the process, scroll down in the panel to the bottom and click ‘Clear Created’ button, then wait for progress to delete all created entities and assets

Unity Export Tool and Unity2PlayCanvas Browser Extension Release Notes

Installation Package and Release Notes

Download:

5MB

PlayCanvasSceneCreator_v1.0.10.zip

archive

Please refer to Unity Export tool for usage instructions of the PlayCanvasSceneCreator.unitypackage.

Please refer to Install Unity2PlayCanvas Browser Extension for instructions on how to use the files under the 'Extension' folder.

We provide a document for querying currently supported components and properties, please see ‘/Document/API/index.html’.

Release Date	Version	Release Notes
10/18/2024	1.0.10	add support text alignment canvas group fix element use input
9/6/2024	1.0.9	add auto upload tool add support ui raw image text element wrapLines fix null case of state motion, scrollbar skip hide game object scrollview / image / layout on same gameobject image mask opacity ui entity add layer ui
8/16/2024	1.0.8	add support skybox cubemap fix invalid template name material opacity adjust material missing map export animation on disable gameobject light type string
8/2/2024	1.0.7	add support particle system MainModule fix model without material remove unused component when use template
7/19/2024	1.0.6	fix assets file name add id improve animation improve material reflection
6/28/2024	1.0.5	fix Quad extension fix find render Asset Null handle
6/7/2024	1.0.4	add components text add support material opacity map material skybox reflection fix layout particles color mesh renderer active mesh load fail shader color property template id sequence extension api fail
5/27/2024	1.0.3	add components Scroll view Improve 3d animation file size
5/3/2024	1.0.2	add components Layer & tag Skybox Layout group Settings
4/8/2024	1.0.1	add components Collider Rigidbody Particle system
3/12/2024	1.0.0	first version