iOS SDK Installation

1. Execution Environment

• IDE : Xcode 15.0 or higher.

• iOS : iOS 13.0 or higher.

2. SDK File Composition

Open

• KakaoGameFramework Folder

  • Contains the Kakao Game SDK framework and resource bundles.

• IDPFramework Folder

  • Includes IDP framework related to Kakao.

• External Library Versions

  • Kakao

    • KakaoSDK Version : 2.22.1

3. SDK Installation

This section explains the process of installing the SDK into an Xcode project with examples.

3.1. Adding Kakao Game SDK via Cocoapods

1. Open a new terminal window and navigate to the location of your Xcode project.

2. Open the Podfile and write the content referenced below. Use the specific lines based on the case.

   1. full package installation (including Firebase)

      iOS cocoapods

      # Install all Kakao Game frameworks pod 'KakaoGameSDK', '4.5.0'

   2. If only using the Kakao module

      iOS cocoapods

      # Install only the Kakao module pod 'KakaoGameSDK/KakaoGameKakao', '4.5.0'

3. Navigate to the terminal and install the Kakao Game framework using the following command.

   pod install

3.2. Adding the Kakao Game SDK (zip package)

1. Unzip the downloaded file, and add the "KakaoGameFramework" and "IDPFramework" folders to your Xcode project.

   Open

   

    

2. Make sure to check "Copy items if needed" so that the frameworks are copied if necessary.

    

3. Verify that the frameworks have been successfully added as shown below.

    

4. If haven't added it, manually add it as below. 

3.3. Setting Other Linker Flags

1. In the "Build Settings" tab of your project, add -ObjC and -lc++ to the "Other Linker Flags".

3.4. Setting Kakao Game SDK Properties

1. In the "Info" tab of your project, you need to add properties related to the Kakao Game SDK in the "Custom iOS Target Properties".

To configure Sign in with Apple, you need to add the relevant capabilities in your project settings.

3.5. Adding URLScheme

• Kakao Game

  • Add a string that combines "kakaogame" and the app ID (KakaoGameConfiguration-AppId). ex)kakaogame103815

• Kakao

  • Add a string that combines "kakao" and the native app key (app secret) obtained from the Kakao Developers site. ex)kakao951b75bf17fe0885ab5106ba2a9f9bc9

  • To support multi-app Kakao login, if you want to apply the multi-app login spec, configure it as follows. (Contact the technical PM, as this requires settings in the Kakao Developer Center.)

    • For the games where you want to apply the multi-app configure it in the Info.plist of each app project with the bundle IDs com.kakaogame.appOne / com.kakaogame.appTwo.

    • In the section where you add the URL Scheme, add "KakaoAppLogin" in the Identifier field and register the URL Scheme item in the format kakao{appSecret}-{bundleId}

      • kakao951b75bf17fe0885ab5106ba2a9f9bc9-com.kakaogame.appOne

      • kakao951b75bf17fe0885ab5106ba2a9f9bc9-com.kakaogame.appTwo

      • Refer to the screenshot

         

    • After adding as above, when you build each app, Kakao login will be possible in each app.

    •  

3.6. Setting LSApplicationQueriesSchemes

You need to add the "LSApplicationQueriesSchemes" (Queried URL Schemes) item to the Info.plist file.

1. Below is the content that needs to be added.

2. Right-click the Info.plist file as shown below, then select [Open As] - [Source Code]. Copy and paste the above XML. 
   Make sure to replace only the kakao[replace with app secret] part with your app secret.
    

3.7.1. Setting Access Permissions
 

1. he Kakao Game SDK requires access permissions for the camera and photo library. Therefore, you need to enter the access permission descriptions as follows.

If the developer needs additional access permissions, they can be added as necessary.

3.7.2. Setting Access Permissions Localization

By default, the permission setting description you create in info.plist does not apply to localization.

Additional work is required to set up localized resources.

1. Add the InfoPlist.strings file to the project.

2. Add a localization language to set up.

3. Add a key and enter a localizaed string.

InfoPlist.strings (ex : en.lproj)

InfoPlist.strings (ex : ja.lproj)

InfoPlist.strings (ex : ko.lproj)

InfoPlist.strings (ex : zh-hant.lproj)

3.8. Game Supported Language Resources

If there are additional language packs in the library that are not supported by the game and you want to remove them, you can delete the corresponding folder at the location below.

1. To load the language provided by the Kakao Game SDK according to the user's device language settings, you need to configure the Info.plist.

    

1. Find the KakaoGameResources.bundle file in the KakaoGameFramework folder and click 'Show Package Contents.'

1. Delete the folder for the language you want to remove.

3.9 (Reference) Guide on Supporting Multiple Bundle IDs

• You can use multiple bundle IDs for one app (app id).

  • We support cases where multiple bundle IDs are required, such as for test builds.

    However, the bundle ID registered in Game Center must match the live version (the build version uploaded to the market).

• Apps with bundle IDs that meet the following rules can call the Kakao Game API.
  However, there may be some restrictions on certain features.

3.10 Guide on SceneDelegate

• Currently, KakaoGameSDK not supports SceneDelegate.

• Therefore, if the project is made to use SceneDelegate, deletion is required.

1. Delete SceneDelegate.swift file.

2. Delete ‘Application Scene Manifest’ in info.plist.

3. Delete UISceneSession methods in AppDelegate

4. Add 'UIWindow” property in AppDelegate