Your WRLD, In Unity

Getting started

  1. First ensure that your Unity version is between 5.5.0f3 and 2017.3.1.
  2. If you are updating from a previous version of WRLD Unity SDK, ensure that you have restarted the Unity Editor. We recommend backing up your projects before proceeding.
  3. Download the WRLD Unity SDK from the Unity Asset Store and import it into your project. Restart the Unity Editor.
  4. In order to use the WRLD Unity SDK, you must sign up for a free developer account. After signing up, create a WRLD API Key. Your API key is a token containing 32 alpha-numeric characters.
  5. Open the UnityWorldSpace scene under Assets/Wrld/Scenes/ in the Project panel.
  6. Select the WrldMap GameObject and paste your API Key into the field shown in the Inspector:

    API key field

  7. Click the Play button in the Unity Editor and 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.
  8. To deploy on other platforms, see the instructions and requirements below:


See more examples ➜


If you have any questions, bug reports, or feature requests, feel free to submit to the WRLD Unity SDK issue tracker on GitHub.