# mapbox-scenekit

**Repository Path**: mirrors_mapbox/mapbox-scenekit

## Basic Information

- **Project Name**: mapbox-scenekit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mapbox Scene Kit SDK for iOS

<img alt="Mapbox Scene Kit SDK" src="./docs/img/scenekit.jpg" width="272" align="right" />

Using Swift, bringing our rich 3D terrain into your iOS app is easy. SceneKit SDK benefits from Apple’s toolchain and tight integration with ARKit. Using Apple's built-in Scene Kit frameworks means you can leverage compelling virtual terrain experiences without bloating your app's size.

**Note this SDK is deprecated and no longer officially supported. The samples should continue to work but you should contact Mapbox if you intend to build a product incorporating the SDK**

## Requirements

The Mapbox SceneKit SDK is compatible with applications written in Swift 4 or Objective-C in Xcode 9.0, and require iOS 8 or above (the examples require iOS 11 or above).

## Installation

### Using CocoaPods

To install Mapbox Scene Kit using [CocoaPods](https://cocoapods.org/):

1. Create a [Podfile](https://guides.cocoapods.org/syntax/podfile.html) with the following specification:
   ```ruby
   pod 'MapboxSceneKit', :git => 'https://github.com/mapbox/mapbox-scenekit.git'
   pod 'MapboxMobileEvents'
   ```
   The platform specified in your Podfile should be `:iOS '11'`

1. Run `pod repo update && pod install` and open the resulting Xcode workspace.

1. In `Info.plist`, add `MGLMapboxAccessToken` with your [Mapbox Access Token](https://www.mapbox.com/studio/account/tokens/) as the value.

### Using Carthage

Alternatively, to install Mapbox SceneKit using [Carthage](https://github.com/Carthage/Carthage/):

1. Create a [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#github-repositories) with the following dependency:
   ```cartfile
   github "mapbox/mapbox-scenekit" "master"
   ```

1. Run `carthage update --platform iOS` to build just the iOS dependencies.

1. Follow the rest of [Carthage’s iOS integration instructions](https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos). Your application target’s Embedded Frameworks should include MapboxSceneKit.framework.

1. In `Info.plist`, add `MGLMapboxAccessToken` with your [Mapbox Access Token](https://www.mapbox.com/studio/account/tokens/) as the value.

1. Include `import MapboxSceneKit` at the top of your ViewController.

## Examples

1. Clone the repository or download the [.zip file](https://github.com/mapbox/mapbox-scenekit/archive/master.zip)
1. Run `carthage update --platform ios` to build just the iOS dependencies.
1. Open `MapboxSceneKit.xcodeproj`.
1. Sign up or log in to your Mapbox account and grab a [Mapbox Access Token](https://www.mapbox.com/studio/account/tokens/).
1. Open the Info.plist for `Example` and paste your [Mapbox Access Token](https://www.mapbox.com/studio/account/tokens/) into `MGLMapboxAccessToken`. (Alternatively, if you plan to use this project as the basis for a public project on GitHub, place the access token in a plain text file named `.mapbox` or `mapbox` in your home directory instead of adding it to Info.plist.)
1. Build and run the `Examples` target.

## Contributing

We welcome feedback and code contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.

You can join our Gitter community at [Gitter](https://gitter.im/mapbox-scenekit-sdk/Lobby)

## License

Mapbox SceneKit SDK for iOS is released under the ISC License. See [LICENSE.md](https://github.com/mapbox/mapbox-scenekit/blob/master/LICENSE.md) for details.