You can download the latest SDK here.
This SDK is fully compatible with the following Unity versions
- 2020.3 LTS
- 2021.3 LTS
- 2022.3 LTS
In addition to installing this package, it is also necessary to install glTFast v4.8.5. Before installing glTFast, make sure that git LFS is installed on your computer. Install glTFast using the Package Manager with the option Install from a git URL and
https://github.com/atteneder/glTFast.git#v4.8.5 in the URL box.
Installing the SDK
Create a new Unity project and install the Geopipe Unity SDK custom package using the Package Manager. The Geopipe Unity SDK is provided as a .tar.gz file. Use the option Install package from tarball.
- The Standard Renderer Pipeline (SRP) and the High Definition Render Pipeline (HDRP) are supported.
- Unity version 2020.3 and higher is supported.
Loading a Sample Project
Choose your sample based on your render pipeline. From within the Package Manager, you can install the following samples into your project:
- Standard Renderer Sample.
- HDRP Sample.
Each sample will provide a scene for your project that is set up (minus API credentials) and can be used out of the box to explore our demo New York region.
Adding User Credentials to the SDK
A screenshot of the GeopipeModelEngine component in Unity. The API, Latitude, and Longitude boxes are filled in using the values from a download configuration.
When you’re ready to build a binary with the Geopipe Unity SDK, you can either bake in the cache you populated during testing (the ModelCache~, DirCache~, TreeCache~, and other *Cache~ folders), or you can let the Unity SDK dynamically fetch models from Geopipe’s API.
If you’re building a binary with the standard rendering pipeline, be sure to include the ShaderRetention scene in your binary. Although you should not explicitly load this scene, its presence in the binary will force Unity to include necessary shaders it might otherwise omit (causing no models to load or render).