Getting started with the WRLD Unity SDK
1. Sign up and get an API Key
If you don’t have an account yet, you will need to sign up and confirm your email address
Take note of the created key, you will need it soon
2. Get Unity & WRLD Unity SDK
Note: The WRLD Unity SDK currently supports Unity versions between 5.5.0f3 and 2018.1.0f2.
Download the WRLD Unity SDK
3. Import WRLD Unity SDK to your project
If you have an existing project, open it, otherwise create a new one.
Import the downloaded WRLD Unity SDK
.unitypackagefile into your project.
In the Project panel in Unity, open the UnityWorldSpace scene in Assets/Wrld/Scenes/ folder.
Select the WrldMap GameObject and paste your API Key into the field shown in the Inspector:
- Click the Play button in the Unity Editor
Congrats, you’re up and running! You should see the map stream in. Use the left mouse button to pan the map, the right mouse button to rotate, and the mouse wheel to zoom.
To deploy on other platforms, see the instructions and requirements below:
4. Add some features
Now that you have your first map, let’s add some features to it!
Take a look at some of our examples to get up and running:
If you are looking for hands-on examples, we have provided an
Examples.unity scene file which you can find in under
Got a question?
Feel free to email us at
firstname.lastname@example.org or use our Messenger to chat to us directly!
Got a feature request, or found a bug?
Feel free to submit to the WRLD Unity SDK issue tracker on GitHub.