⚙️How to Use Yuku Creator Toolkit
Last updated
Last updated
Welcome to the Yuku Creator Toolkit! The Creator Toolkit is the easiest way to build, publish, and monetize your Unity games and experiences. You can publish your creations to web, mobile, and VR in one click.Ready to get started? You'll need a free Yuku account and a supported version of Unity.
Click here to create a new Yuku.app account. It's 100% free and always will be. A Yuku account is required to test and publish Creator Toolkit projects to the Yuku platform.
Click here to download the Unity Hub installer. Unity Hub lets you download and manage different Unity Editor versions. The Creator Toolkit requires Unity 2022.3.21f. Other versions of Unity are not supported.You must include the WebGL Build Support module during the installation.
Once you've created a Yuku account and installed Unity, you're ready to start building
Click here to download the Starter Template. The Yuku Starter Template is required to use the Creator Toolkit, even if you plan on using an existing Unity project. Extract the .zip
archive and open the project inside Unity Hub.
Once the project is open and loaded, you're ready to set up your first project!
Yuku packages are raw assets that can be loaded into the Yuku app. Packages are created in Unity, and published to Yuku using the Yuku portal inside the Unity editor.To create your first package open the Yuku portal by clicking the gear on the Unity toolbar.
Inside the Config
tab new packages can be created by selected a type then pressing the Create
button.
Each package type has a different configuration panel where you can define the contents and properties of the package. It also has a field that requires a reference to the corresponding asset type. When you publish the package, the contents of this asset will be uploaded and replace the package with a new version.
Space packages allow you to create full experiences using the Unity editor. Each space package represents a single space that users can join in the Yuku app.
Inside Unity you can create a new space package by navigating to the project config window.In the configuration menu, select Space
from the create new dropdown and click the Create
button.
Each space package requires you define a singular Unity Scene
. Drag Scene file to Scene row
To test your package click the Test Scene
button in the Unity toolbar. You may need to link your Yuku account in the portal if you haven't already.
Once your space is built it will be uploaded to Yuku and you will automatically join the Yuku Sandbox in your browser where you can preview your space.
When using assets from an existing Unity project it is recommended to export them as a unityPackage, then re-import them inside of your Yuku project.A scene and all its dependencies can be exported by right clicking and selecting Export Package
.
When a space package is published for the first time, a space for that asset is automatically created on your Yuku account. Additionally an SKU is created which links your Unity package asset to the space as it exists on Yuku. Spaces created this way can not have the environment changed without re-publishing the package.Yuku My World
Creator Toolkit spaces can be easily tested in the Yuku sandbox. You should not test your space in the Unity editor.A space package can be uploaded to your sandbox by clicking the Test Scene
button inside the Unity Editor.
The "active scene" is based on which package you currently have selected in the Yuku portal.You can also change the active package on the gear on the toolbar itself.Once your space is uploaded it should automatically open in your web browser.
After you've built and tested your project, publish it to Yuku to share it with the world. Be sure to thoroughly test your project before publishing it!To publish a package:
Click the Publishing
button in the Unity toolbar to open the Yuku Portal.
Click the Publish
button!
Publishing a project packages it up and uploads it to Yuku. We process the package on our backend. You can check the status of your published package in the Yuku Studio.If you have previously published this project before, we will automatically update the existing package with the new changes. Yuku uses the assigned SKU to find and update your package. Otherwise, a new package will be created in Yuku Studio.