WRLD 3D Maps example app
Switch branches/tags
Clone or download
MichaelTKHChan Fix for MPLY-10381
Before re-running a text search as a tag search, check that the last tag search text is the same.
Buddy: Jordan
Latest commit 515c81a Nov 13, 2018

README.md

WRLD Example App

WRLD

This example app showcases the WRLD SDK, a cross-platform, OpenGL-based library for displaying beautiful and engaging 3D maps. It is also contains the source for the WRLD App on iOS and Android.

What does the WRLD mapping platform have to offer?

  • Detailed 3D coverage for the whole of Canada, UK & Ireland, Scandinavia, the United States, and more
  • Indoor maps in full 3D
  • Flexible themes, allowing you to change the style of your map
  • Customisable pins and markers
  • Support for custom 3D models and animation
  • Compatibility with iOS, Android, Windows, and OS X
  • Continuous deployment, meaning you get the latest features as they're developed

Download our app, WRLD, on Google Play or the App Store to see what the WRLD SDK can do. Or read on to build the app yourself.

Support

If you have any questions, bug reports, or feature requests, feel free to submit to the issue tracker for this repository.

Getting Started

This example app demonstrates the use of the WRLD SDK to display beautiful 3D maps on iOS, Android, and Windows PCs (deprecated). It can be used as the basis for your own app, or can be used as a reference when integrating WRLD's maps into an existing app.

The WRLD SDK is distributed as a C++ static library with headers. Most of this example application is also written in C++ and shared between platforms to reduce code duplication.

This section will walk you through the process of getting up and running quickly on each platform.

  1. Clone this repo: git clone https://github.com/wrld3d/wrld-example-app
  2. Obtain a WRLD API key and place it in the configuration file for the platform you are building:
  3. Choose a platform from the table below to see detailed instructions for building the app.
Platform Languages UI
Getting started on Android C++, Java Android UI
Getting started on iOS C++, Objective-C Cocoa Touch
Getting started on Windows (deprecated) C++, C# WPF

WRLD API Key

In order to use the WRLD 3D Maps SDK, you must sign up for a free developer account at https://www.wrld3d.com/developers. After signing up, you'll be able to create an API key for your apps.

To run this example app, you must place the API key in the application configuration file for each of the platforms you are building, specifying the value of "EegeoApiKey":

Optional Steps

This app uses third-party search service providers to allow users to search for places like cafés, restaurants, and bars and have the results show up on the map. To enable this, you will to supply the credentials for those services.

  1. Obtain Yelp credentials to enable Yelp search results in the app. Place them in the application config file appropriate for the platform you are building:
  2. Obtain a GeoNames username to enable GeoNames search results in the app. Place it in the application config file appropriate for the platform you are building:

Features

The WRLD Example App demonstrates a variety of SDK features and is a good starting point to learn how the SDK works.

WRLD Example App features

See here to learn more about what the WRLD SDK has to offer.

SDK Documentation

See the WRLD API reference for documentation on the individual C++ SDK types.

License

The WRLD 3D Maps Example App is released under the Simplified BSD License. See the LICENSE.md file for details.