Installation

The Uranus Tools SDK comes in the form of a regular PlayCanvas project. This project includes:

• The Uranus Tools scripts.

• The Uranus Tools Commons.

• Example scenes demonstrating the Uranus Tools functionality.

• Example scenes assets (models, materials, textures etc.).

Uranus Tools SDK contents

How to install the SDK?

There are two ways to get started using the SDK in your project:

1. If you are starting with a new project, the proposed way is to fork the Uranus Tools SDK project and remove everything not required (e.g. example assets and scenes). Make sure to keep the two folders uranus.tools and uranus.tools.commons in your project.

2. If you already have an existing project in the works, you can transfer the Uranus Tools SDK by coping and pasting the uranus.tools and uranus.tools.commons folders to your project.

Note if you are coping and pasting the SDK to your existing project the newly created assets will have new asset IDs.

That will break any references to assets in the ready to use templates included in the Commons folder. You will have to fix those references on your own by comparing each entity with the original entity in the SDK.

Some scripts (e.g. web worker scripts ending with the .worker.js suffix) need to have their preload flag set to false to be able to load in the web worker.

The uranus.tools/Libraries folder includes a number of open source third party libraries used by various SDK systems. You can reduce the file size of your application by removing one or more of these libraries when not in use.

For example the Ammo3 library is used solely in the open world terrain examples of the SDK. Feel free to remove it if it's not required in your project.

Consult with the Solar Games team to find the exact libraries that are required by your project.