Genvid SDK Unity Editor Package¶
The engine-integration/unity/genvid_editor.unitypackage
adds a new window to the Unity editor.
This window lets you to access the same set of functionalities as Cluster UI and Bastion UI.
Note
The editor package adds optional functionality to the Unity editor. It isn’t required for integrating the Genvid SDK.
In This Section
Package Contents¶
Genvid/Editor/Plugins/GenvidRESTCSharp.dll
This is a wrapper around our Toolbox REST API which allows control of the Genvid Stack from the Unity Editor. It depends on two external third party libraries: RESTCSharp Library and Newtonsoft JSON.Net Library, also included in that same folder.
We use version 8.0 of the Newtonsoft library, so it can be replaced with the JSON.Net for Unity assets.
Genvid/Editor/Scripts/GenvidWindow.cs
- This file contains the code behind the Genvid editor window. It allows you to interact with the different clusters managed by your bastion.
Genvid/Editor/Ressources/Textures/*.png
- These are textures used for the Genvid Window UI.
Before You Begin¶
To see the content in this window:
You need a working Genvid cluster and
Your Unity project loaded.
This gives you some direct access to the different websites available, as well as the ability to control some jobs running in your local cluster.
Building the Package¶
The package source is available under /engine-integration/unity/editor
.
You can use the package.py script to build the full Unity
package by using the editor option.
py package.py editor
You can also use the pre-built asset package
engine-integration/unity/genvid_editor.unitypackage
.
Installing the Package¶
You can use the unity.py
script from the cube sample to install the
package in your project. You’ll find it in the /samples/cube/unity
folder.
py unity.py prepare
You can also manually add the Genvid SDK to your Unity project.
Open your project in the Unity Editor.
Select
.Click genvid_editor.unitypackage located in the
/engine-integration/unity
folder.