Skip to main content

iOS SDK Installation

This guide covers installing VLPlay SDK for iOS using Swift Package Manager or CocoaPods. [PLACEHOLDER] VLPlay SDK for iOS is distributed as an XCFramework supporting arm64 (device) and x86_64/arm64 (simulator). It requires iOS 13.0+ and Xcode 15+.

[PLACEHOLDER] We recommend Swift Package Manager as the preferred installation method. CocoaPods support is provided for teams that have not yet migrated to SPM.

  1. In Xcode, select File → Add Package Dependencies…
  2. Enter the repository URL: 
    SDK package provided by your VLPlay representative
  3. Select Up to Next Major Version from 1.0.0
  4. Add the VLPlaySDK product to your target

Option B: CocoaPods​

Podfile
platform :ios, '13.0'
use_frameworks!

target 'YourGame' do
  pod 'VLPlaySDK', '~> 1.0'
end

Run pod install after editing the Podfile.

Info.plist Entries​

Add the following keys to enable VLPlay's authentication flow:

Info.plist
<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoadsInWebContent</key>
    <true/>
</dict>

<!-- Required for Sign in with Apple (if enabled) -->
<key>com.apple.developer.applesignin</key>
<array>
    <string>Default</string>
</array>

URL Scheme​

Register a URL scheme for OAuth callback:

Info.plist
<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>vlplay-YOUR_APP_ID</string>
        </array>
    </dict>
</array>

Next: Initialization