Getting started with the WRLD iOS SDK

The WRLD iOS SDK is a framework for displaying beautiful, interactive 3D map views in Cocoa Touch apps for iPhone or iPad. Map views can be embedded into apps using iOS 8.0 or above, using Objective-C, or by simply hooking up in Xcode Interface Builder.

1. Sign up and get an API Key


2. Get the WRLD iOS SDK

Requirements: XCode 7.3 or later.

Install using CocoaPods

  1. Install CocoaPods.
  2. Create a Podfile in the root folder of you app project (replacing ‘MyAppTargetName’ as appropriate for your app)

    platform :ios, '8.0'
    
     target 'MyAppTargetName' do
       pod 'WRLD'
     end
     
  3. In Terminal, run pod install. This will download the SDK and create an xcworkspace file. Open this file in Xcode.


Install using direct download

  1. From the latest GitHub release page, download the wrld-ios-sdk zip file.
  2. In Xcode, select your app’s project in Project Navigator to display Project Editor. Select the app’s target, then on the General tab, find the Embedded Binaries section.
  3. Unzip the wrld-ios-sdk zip file and drag WRLD.framework into the Embedded Binaries section. Check “Copy items if needed” in the resulting dialog box, then click “Finish”. This links the WRLD.framework with your project.


3. Use a map view in your app

To provide your app with an API key, in Xcode, open your app’s Info.plist file (select it in the Project Navigator).

Add an entry with the columns set as follows:

  • Key: WrldApiKey
  • Type: String
  • Value: [your api key]

See our walkthrough guide for simple step-by-step instructions.


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:

Support

The WRLD iOS SDK is undergoing active development - we will be expanding with further features and improvements.

The example GitHub repository contains an open-source iOS app that illustrates the API features.

Got a question?

Feel free to email us at support@wrld3d.com or use our Messenger to chat to us directly!

Got a feature request, or found a bug?

Feel free to submit to the WRLD iOS SDK issue tracker on GitHub.

v0.0.1115