Here is how to use the echo3D Unity SDK. There are 2 ways depending on if your project is new or existing. We have done most of the setup for you in the SampleScene scene, all you have to do is try out both methods and add the API key & Entry ID.
- Don't have an echo3D API key? Make sure to register for FREE at echo3D.
- Download Unity 2020.3 or later. (Note: Our SDK supports Unity 2020.3 LTS and newer.)
- Clone this repo.
-
Open the SampleScene scene.
-
Upload your 3D assets to the echo3D cloud by clicking Add to Cloud. You can also search our console for some.
-
Download the echo3D Unity SDK and unzip the folder.
-
Copy the co.echo3d.unity subfolder into Unity’s Packages folder. Troubleshoot here. (Note: Do not drag the subfolder directly into Unity, please use your File Explorer.)
The echo3D Unity SDK is now ready to be used! There are 2 ways to implement it.
Option 1: If you’re integrating echo3D into an existing project
- Drag the
Echo3DHologram.csscript onto the game object that you want to host on the echo3D cloud.
-
On the
Echo3DHologram.csprefab, set the API key and Entry ID from the Inspector. -
Turn off the Mesh Renderer, or else you will have duplicate 3D objects at runtime. This allows all existing modifications in the Inspector to apply to the echo3D asset.
-
Drag the Echo3DService prefab into the Hierarchy.
Option 2: If you’re starting a Unity project from scratch
-
Drag both Echo3DHologram and Echo3DService prefabs into the Hierarchy from inside Packages/echo3D Unity SDK/Prefabs.
-
On the Echo3DHologram prefab, set the API key and Entry ID from the Inspector.
You have successfully connected the echo3D SDK! To see it in action, press Play in Unity. See below for more tools to manage your 3D asset in Unity.
-
Type your Secret Key as the value for the parameter secKey in the file Packages/co.echo3D.unity/Runtime/Echo3DHologram.cs. (Note: Secret Key only matters if you have the Security Key enabled). You can turn it off in the Security options in your echo3D console.
-
(Optional) To move or edit the assets live in your project, check the boxes for “Editor Preview” and “Ignore Model Transforms”. At the top of your project, click Echo3D > Load Editor Holograms
In Unity, go into Play mode.
Refer to our documentation to learn more about how to use Unity and echo3D.
Feel free to reach out at support@echo3D.co or join our support channel on Slack.
Visit our troubleshooting guide here.