Getting Started iOS

Cocos2d-x plugin for Helpshift SDK helps you utilize Helpshift from your game's C++ codebase.


  • Xcode 10.2 and above.
  • Supported iOS versions:
    • iOS iOS 13, 12, 11 and 10

With version 5.0.0 (SDK version 7.5.3), Helpshift SDK has dropped support for iOS 9. If you wish to keep supporting iOS 9 devices for your apps, please read the KB Article to support Helpshift on older OS versions.

If you have a project with Xcode version prior to Xcode 9, you could use the build mentioned here.

Download the Cocos2d-x plugin for Helpshift

Helpshift Cocos2d-x package comes in two variants:

1. Standard SDK - In-app Customer Service

Download SDK v5.3.1

2. Campaigns-enabled SDK - Proactive In-app Customer Service

Download SDK v5.3.1-withCampaigns

The zip file contains:

Folder containing the files for Cocos2dx version 3.x
Folder containing the files for Cocos2dx version 2.x

Adding the Helpshift iOS plugin

  1. Add the following frameworks to Link Binary with Libraries -

    • CoreGraphics
    • QuartzCore
    • CoreText
    • SystemConfiguration
    • CoreTelephony
    • UIKit
    • libsqlite3.tbd
    • libicucore.tbd
    • libz.tbd
    • Security
    • QuickLook
    • CoreLocation
    • MobileCoreServices
    • CoreSpotlight
    • Photos
    • WebKit
    • GameController (required by cocos2d-x)
    • MediaPlayer (required by cocos2d-x)
  2. Add the contents of the ios/Classes folder into your Xcode project.

  3. Add the ios/sdk folder to your Xcode project to add the Helpshift iOS native SDK.

In the Build Settings of your Xcode project, '-ObjC' flag should be added in the 'Other linker flags' section. show me

  • If your app does not contain any swift code, follow the additional steps:

    • Set Always Embed Swift binaries in the build settings to YES
    • Add /usr/lib/swift to the runpath search paths in the build settings. Make sure it is above the $(inherited) and @executable_path/Frameworks flags
    • Add $(TOOLCHAIN_DIR)/usr/lib/swift-5.0/$(PLATFORM_NAME) for Xcode 11.x or $(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME) for Xcode 10.x to the Library Search Paths in the build settings.
  • With version 5.3.0, End-users will be able to send files such as pdf, video, etc. where before 5.3.0 end-users could only send images. For iOS 10 and below, to access files in the “Files” app of iOS, developers will need to add iCloud capability with iCloud Documents services enabled. For more info please refer the Prerequisites section here.    show me

Initializing Helpshift in your App

Helpshift SDK uniquely identifies your App with the combination of:

Your unique developer API Key.
Domain Name
Your Helpshift domain name. For example :
App ID
A unique ID assigned to your app.

To get the API Key, Domain Name and the App ID, navigate to Settings>SDK (for Developers) in your agent dashboard and scroll down to "Initializing Helpshift" section. show me

Select your App from the dropdown and copy the three tokens to be passed when initializing Helpshift.

Initialize Helpshift by including HelpshiftCocos2dx.h and calling HelpshiftCocos2dx::install in the AppDelegate::applicationDidFinishLaunching() function of your AppDelegate.cpp:

#include "HelpshiftCocos2dx.h"

bool AppDelegate::applicationDidFinishLaunching() {



Start using Helpshift

Helpshift is now integrated in your app. You should now use the support APIs to present FAQ or conversation screens inside your app.

Run your app, and try starting a test conversation using the showConversation API call. Then goto your Helpshift agent dashboard and reply to experience the in-app messaging.

Sample usage for FAQs and conversation APIs:

// Presenting FAQs to your customers
void GameSettingsScene::menuHelpCallback(CCObject* pSender)

// Starting a conversation with your customers
void GameSettingsScene::menuConversationCallback(CCObject* pSender)

Next up

Helpshift APIs

Discover ways to do customer support via Helpshift.


Configure Push and In-app notifications.


Track events and user actions. Attach custom metadata to every conversation.

Reviews & Feedback

Asking for reviews and feedback.