Appodeal Integration Guide
For the Lua version of cocos2d-x v3.x - (all other versions)
SDK Version
- ios: 2.4.4.2-Beta
- android: 1.15.9
Prerequisites
Certain SDKBOX plugins do not work together. If you use Appodeal, then you cannot also use the Flurry Analytics and Chartboost services, in the same project.
NOTE: Please note that Appodeal only supports iOS 8.0+
Integration
Open a terminal and use the following command to install the SDKBOX Appodeal plugin. Make sure you setup the SDKBOX installer correctly.
$ sdkbox import appodeal
Important Notice
Please make sure the following settings in your project to make the plugin work well.
Disable App Transport Security
Adding the following entry to the info.plist
file:
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
It should look like this:
Disable Bitcode support
You have to turn off Bitcode support. If you don't, cocos2d-x will fail to build.
Set your game requires full screen
If your game doesn't support all screen orientations, you will need to check Requires full screen
in Xcode. If you do not, your app will fail Apple's submission process.
Whitelist canOpenURL function
This setting depends on what plugins are in your project. You may need to add the required entry to the info.plist
, under LSApplicationQueriesSchemes
.
Add this key in Info.plist , if you use this function in your app
<key>NSBluetoothPeripheralUsageDescription</key>
<string>Advertising</string>
<key>NSCalendarsUsageDescription</key>
<string>Advertising</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>Advertising</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>Advertising</string>
JSON Configuration
SDKBOX Installer will automatically inject a sample configuration to your res/sdkbox_config.json
, that you have to modify it before you can use it for your own app
Here is an example of the Appodeal configuration, you need to replace <app_key>
items with your specific Appodeal Key account information.
"Appodeal":{
"app_key":"2cfc9cc638980eb7f5ff35d6eb63dbe404503151ccc451ed"
}
Usage
Initialize Appodeal
Modify your Lua code to init()
the plugin. This can be done anyplace, however it must be done before trying to use the plugin's features.
sdkbox.PluginAppodeal:init()
Using Appodeal
After initialization you can begin to use the Appodeal functionality:
local plugin = sdkbox.PluginAppodeal
plugin:init()
plugin:setUserVkId("user id");
plugin:cacheAd(15);
Catch Appodeal events (optional)
This allows you to catch the Appodeal
events so that you can perform operations based upon responses. A simple example might look like this:
local plugin = sdkbox.PluginAppodeal
plugin:setListener(function(args)
local event = args.event
dump(args, "appodeal listener info:")
end)
plugin:init()
API Reference
Methods
sdkbox.PluginAppodeal:init(adType)
initialize the plugin instance.
sdkbox.PluginAppodeal:setListener(listener)
Set listener to listen for appodeal events
sdkbox.PluginAppodeal:getSDKVersion()
sdkbox.PluginAppodeal:disableNetworkForAdType(adType, networkName)
deprecated
sdkbox.PluginAppodeal:disableLocationPermissionCheck()
sdkbox.PluginAppodeal:setAutocache(autocache, types)
sdkbox.PluginAppodeal:isAutocacheEnabled(types)
sdkbox.PluginAppodeal:confirmUsage(adTypes)
sdkbox.PluginAppodeal:setDebugEnabled(debugEnabled)
sdkbox.PluginAppodeal:showAd(style)
sdkbox.PluginAppodeal:cacheAd(type)
sdkbox.PluginAppodeal:hideBanner()
sdkbox.PluginAppodeal:isReadyForShowWithStyle(showStyle)
sdkbox.PluginAppodeal:setSmartBannersEnabled(smartBannerEnabled)
sdkbox.PluginAppodeal:setBannerBackgroundVisible(bannerBackgroundVisible)
sdkbox.PluginAppodeal:setBannerAnimationEnabled(bannerAnimationEnabled)
sdkbox.PluginAppodeal:setUserVkId(vkId)
sdkbox.PluginAppodeal:setUserFacebookId(facebookId)
sdkbox.PluginAppodeal:setUserEmail(email)
sdkbox.PluginAppodeal:setUserBirthday(birthday)
sdkbox.PluginAppodeal:setUserAge(age)
sdkbox.PluginAppodeal:setUserGender(gender)
sdkbox.PluginAppodeal:setUserOccupation(occupation)
sdkbox.PluginAppodeal:setUserRelationship(relationship)
sdkbox.PluginAppodeal:setUserSmokingAttitude(smokingAttitude)
sdkbox.PluginAppodeal:setUserAlcoholAttitude(alcoholAttitude)
sdkbox.PluginAppodeal:setUserInterests(interests)
Listeners
onBannerDidLoadAd()
trigger when banner ad load
onBannerDidFailToLoadAd()
trigger when banner ad fail to load
onBannerDidClick()
trigger when banner ad clicked
onBannerPresent()
trigger when banner ad present
onInterstitialDidLoadAd()
trigger when interstitial ad load
onInterstitialDidFailToLoadAd()
trigger when interstitial ad fail to load
onInterstitialWillPresent()
trigger when interstitial ad present
onInterstitialDidDismiss()
trigger when interstitial dismiss
onInterstitialDidClick()
trigger when interstitial ad clicked
onInterstitialDidFailToPresent()
trigger when interstitial ad fail to present
onVideoDidLoadAd()
trigger when video load deprecated
onVideoDidFailToLoadAd()
trigger when video fail to load deprecated
onVideoDidPresent()
trigger when video present deprecated
onVideoWillDismiss()
trigger when video dismiss deprecated
onVideoDidFinish()
trigger when video finish deprecated
onRewardVideoDidLoadAd()
trigger when reward video load
onRewardVideoDidFailToLoadAd()
trigger when reward video fail to load
onRewardVideoDidPresent()
trigger when reward video present
onRewardVideoWillDismiss()
trigger when reward video dismiss
onRewardVideoDidFinish(amount, name)
trigger when reward video finish
onRewardVideoDidFailToPresent()
trigger when reward video fail to present
onSkippableVideoDidLoadAd()
trigger when skippable video load
onSkippableVideoDidFailToLoadAd()
trigger when skippable video fial to load
onSkippableVideoDidPresent()
trigger when skippable video present
onSkippableVideoWillDismiss()
trigger when skippable video dismiss
onSkippableVideoDidFinish()
trigger when skippable video finish
onSkippableVideoDidClick()
trigger when skippable video click
onNonSkippableVideoDidLoadAd()
trigger when nonskippable video load
onNonSkippableVideoDidFailToLoadAd()
trigger when nonskippable video fial to load
onNonSkippableVideoDidPresent()
trigger when nonskippable video present
onNonSkippableVideoWillDismiss()
trigger when nonskippable video dismiss
onNonSkippableVideoDidFinish()
trigger when nonskippable video finish
onNonSkippableVideoDidClick()
trigger when nonskippable video click
onNonSkippableVideoDidFailToPresent()
trigger when nonskippable video fail to present
Manual Integration
If the SDKBOX Installer fails to complete successfully, it is possible to integrate SDKBOX manually. If the installer complete successfully, please do not complete anymore of this document. It is not necessary.
These steps are listed last in this document on purpose as they are seldom needed. If you find yourself using these steps, please, after completing, double back and re-read the steps above for other integration items.
Manual Integration For iOS
Drag and drop the following frameworks from the plugins/ios folder of the Appodeal
bundle into your Xcode project, check Copy items if needed
when adding frameworks:
sdkbox.framework
PluginAppodeal.framework
Appodeal.framework
plugin_appodeal_res_bundle
add the following system frameworks, if you don't already have them:
AdSupport.framework
AudioToolbox.framework
AVFoundation.framework
CFNetwork.framework
CoreFoundation.framework
CoreGraphics.framework
CoreImage.framework
CoreLocation.framework
CoreMedia.framework
CoreMotion.framework
CoreTelephony.framework
EventKit.framework
EventKitUI.framework
libc++.tbd
libsqlite3.tbd
libxml2.2.tbd
libz.tbd
MediaPlayer.framework
MessageUI.framework
MobileCoreServices.framework
QuartzCore.framework
Security.framework
Social.framework
StoreKit.framework
SystemConfiguration.framework
Twitter.framework
UIKit.framework
WebKit.framework
GameController.framework
Copy all source and header files from plugin/luabindings/
to your projects Classes
folder.
Add these same files, that you just copied, to Xcode by either dragging and dropping them into Xcode or by using File -> Add files to....
Manual Integration For Android
SDKBOX supports three different kinds of Android projects command-line, eclipse and Android Studio.
proj.android
will be used as our<project_root>
for command-line and eclipse projectproj.android-studio
will be used as our<project_root>
for Android Studio project.
Copy Files
Copy the following jar files from plugin/android/libs
folder of this
bundle into your project's
PluginAppodeal.jar
sdkbox.jar
android-support-v4-22.2.1.jar
applovin-sdk-6.0.1.jar
appodeal-1.13.1.jar
chartboost-5.2.0.jar
my-target-4.0.13.jar
unity-ads-1.4.7.jar
-
If you're using cocos2d-x from source copy the jar files to:
Android command-line:
cocos2d/cocos/platform/android/java/libs
Android Studio:
cocos2d/cocos/platform/android/java/libs cocos2d/cocos/platform/android/libcocos2dx/libs
-
If you're using cocos2d-js or lua copy the jar files to:
Android command-line:
frameworks/cocos2d-x/cocos/platform/android/java/libs
Android Studio:
frameworks/cocos2d-x/cocos/platform/android/java/libs frameworks/cocos2d-x/cocos/platform/android/libcocos2dx/libs
-
If you're using prebuilt cocos2d-x copy the jar files to:
Android command-line:
proj.android/libs
Copy jni libs
Copy and overwrite all the folders from plugin/android/jni
to your <project_root>/jni/
directory.
Edit AndroidManifest.xml
Include the following permissions above the application tag:
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
There are also necessary meta-data and activity tags that also need to be added:
<meta-data android:name="com.appodeal.framework" android:value="sdkbox" />
<activity android:name="com.appodeal.ads.InterstitialActivity"
android:configChanges="orientation|screenSize"
android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<activity android:name="com.appodeal.ads.VideoActivity"
android:configChanges="orientation|screenSize"
android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<activity android:name="com.appodeal.ads.LoaderActivity"
android:configChanges="orientation|screenSize"
android:theme="@android:style/Theme.Translucent.NoTitleBar" />
<meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
<activity android:name="com.google.android.gms.ads.AdActivity"
android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
android:theme="@android:style/Theme.Translucent" />
<activity android:name="com.chartboost.sdk.CBImpressionActivity"
android:theme="@android:style/Theme.Translucent"
android:excludeFromRecents="true" />
<activity android:name="com.applovin.adview.AppLovinInterstitialActivity"
android:theme="@android:style/Theme.Translucent" />
<activity android:name="com.mopub.mobileads.MoPubActivity"
android:configChanges="keyboardHidden|orientation|screenSize"
android:theme="@android:style/Theme.Translucent" />
<activity android:name="com.mopub.common.MoPubBrowser"
android:configChanges="keyboardHidden|orientation|screenSize" />
<activity android:name="com.mopub.mobileads.MraidActivity"
android:configChanges="keyboardHidden|orientation|screenSize" />
<activity android:name="com.mopub.mobileads.MraidVideoPlayerActivity"
android:configChanges="keyboardHidden|orientation|screenSize" />
<activity android:name="org.nexage.sourcekit.mraid.MRAIDBrowser"
android:configChanges="orientation|keyboard|keyboardHidden|screenSize"
android:theme="@android:style/Theme.Translucent" />
<activity android:name="com.amazon.device.ads.AdActivity"
android:configChanges="keyboardHidden|orientation|screenSize"/>
<activity android:name="com.unity3d.ads.android.view.UnityAdsFullscreenActivity"
android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen"
android:theme="@android:style/Theme.NoTitleBar.Fullscreen"
android:hardwareAccelerated="true" />
<activity android:name="ru.mail.android.mytarget.ads.MyTargetActivity"
android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"/>
<activity android:name="org.nexage.sourcekit.vast.activity.VASTActivity"
android:theme="@android:style/Theme.NoTitleBar.Fullscreen" />
<activity android:name="com.facebook.ads.InterstitialAdActivity"
android:configChanges="keyboardHidden|orientation|screenSize" />
<activity android:name="com.jirbo.adcolony.AdColonyOverlay"
android:configChanges="keyboardHidden|orientation|screenSize"
android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
<activity android:name="com.jirbo.adcolony.AdColonyFullscreen"
android:configChanges="keyboardHidden|orientation|screenSize"
android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" />
<activity android:name="com.jirbo.adcolony.AdColonyBrowser"
android:configChanges="keyboardHidden|orientation|screenSize"
android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" />
<activity android:name="com.vungle.publisher.FullScreenAdActivity"
android:configChanges="keyboardHidden|orientation|screenSize"
android:theme="@android:style/Theme.NoTitleBar.Fullscreen"/>
Edit Android.mk
Edit <project_root>/jni/Android.mk
to:
Add additional requirements to LOCAL_WHOLE_STATIC_LIBRARIES:
LOCAL_WHOLE_STATIC_LIBRARIES += PluginAppodeal
LOCAL_WHOLE_STATIC_LIBRARIES += sdkbox
Add a call to:
$(call import-add-path,$(LOCAL_PATH))
before any import-module statements.
Add additional import-module statements at the end:
$(call import-module, ./sdkbox)
$(call import-module, ./pluginappodeal)
This means that your ordering should look similar to this:
$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginappodeal)
Note: It is important to make sure these statements are above the existing $(call import-module,./prebuilt-mk)
statement, if you are using the pre-built libraries.
Modify Application.mk
(Cocos2d-x v3.0 to v3.2 only)
Edit <project_root>/jni/Application.mk
to make sure APP_STL is defined
correctly. If Application.mk
contains APP_STL := c++_static
, it should be
changed to:
APP_STL := gnustl_static
Copy all source and header files from plugin/luabindings/
to your projects Classes
folder.
Add all .cpp
files, that you just copied, to Android.mk
in the LOCAL_SRC_FILES section. Example
LOCAL_SRC_FILES := hellocpp/main.cpp \
../../Classes/AppDelegate.cpp \
../../Classes/HelloWorldScene.cpp \
../../Classes/NewSourceFile.cpp
Modify AppActivity.java
Plugin >= 2.4.0.3
- Find the AppActivity.java
find . -name "AppActivity.java"
- Replace
extends Cocos2dxActivity
withextends com.sdkbox.plugin.SDKBoxActivity
Example of the directory where the AppActivity.java file is located:
cpp
- proj.android/src/org/cocos2dx/cpp/AppActivity.java
- proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
- proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)
lua
- frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
- frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
- frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)
js
- frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
- frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)
Plugin < 2.4.0.3
-
If you're using cocos2d-x from source, assuming you are in the proj.android directory, Cocos2dxActivity.java is located:
../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/ lib/Cocos2dxActivity.java
-
If you're using the prebuilt cocos2d-x libraries assuming you are in the
proj.android
directory, Cocos2dxActivity.java is located:./src/org/cocos2dx/lib/Cocos2dxActivity.java
Note: When using Cocos2d-x from source, different versions have Cocos2dxActivity.java in a different location. One way to find the location is to look in proj.android/project.properties. Example:
android.library.reference.1=../../cocos2d-x/cocos/platform/android/java
In this case, Cocos2dxActivity.java should be located at:
../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java
- Modify Cocos2dxActivity.java to add the following imports:
import android.content.Intent;
import com.sdkbox.plugin.SDKBox;
- Second, modify Cocos2dxActivity.java to edit the
onCreate(final Bundle savedInstanceState)
function to add a call toSDKBox.init(this);
. The placement of this call is important. It must be done after the call toonLoadNativeLibraries();
. Example:
onLoadNativeLibraries();
SDKBox.init(this);
-
Last, we need to insert the proper overrides code. There are a few rules here.
-
If the method listed has not been defined, add it.
-
If the method listed has been defined, add the calls to
SDKBox
in the same existing function.
-
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
super.onActivityResult(requestCode, resultCode, data);
}
}
@Override
protected void onStart() {
super.onStart();
SDKBox.onStart();
}
@Override
protected void onStop() {
super.onStop();
SDKBox.onStop();
}
@Override
protected void onResume() {
super.onResume();
SDKBox.onResume();
}
@Override
protected void onPause() {
super.onPause();
SDKBox.onPause();
}
@Override
public void onBackPressed() {
if(!SDKBox.onBackPressed()) {
super.onBackPressed();
}
}
Manual Integration for Google Play Services SDK (dependent library only)
Suggestion
Please try the SDKBOX installer first. It will do all the following step for you automatically.
$ sdkbox import googleplayservices
Modify project.properties
An Android Library Reference for Google Play Services is required. The path will be different depending upon your setup. Also, this is an additional download that does not come as part of a standard install. To install use the sdk installer and choose extras->google play services. Here is an example of what this line could look like:
android.library.reference.1=
../android/sdk.latest/extras/google/google_play_services/libproject/
google-play-services_lib
Note: if you already have an android.library.reference.1
you can add
another by incrementing the number as android.library.reference.2
, etc.
Integration manually
We make a lite version of Google Play Services, the project repo is https://github.com/darkdukey/Google-Play-Service-Lite
Copy Files
Copy the gps
folder from plugin
folder of this bundle into your project's
-
If you're using cocos2d-x from source copy the
gps
folder to:Android command-line:
cocos2d/cocos/platform/android/java/libs
Android Studio:
cocos2d/cocos/platform/android/libcocos2dx/libs
-
If you're using cocos2d-js or lua copy the
gps
folder to:Android command-line:
frameworks/cocos2d-x/cocos/platform/android/java/libs
Android Studio:
frameworks/cocos2d-x/cocos/platform/android/libcocos2dx/libs
-
If you're using prebuilt cocos2d-x copy the
gps
folder to:Android command-line:
<project_root>/libs
Modify files for Eclipse
- Modify project.properties
# For source project
android.library.reference.2=../cocos2d/cocos/platform/android/java/libs/gps/
# Or
# For framework project
android.library.reference.1=libs/gps/
Modify files for Android Studio
1. Modify cocos2d/cocos/platform/android/libcocos2dx/build.gradle
dependencies {
+ compile project(':gps')
compile fileTree(dir: '../java/libs', include: ['*.jar'])
}
2. Modify proj.android-studio/app/project.properties
# Project target.
target=android-14
+android.library.reference.1=../cocos2d/cocos/platform/android/java/libs/gps/
3. Modify proj.android-studio/settings.gradle
project(':libcocos2dx').projectDir = new File(settingsDir, '../cocos2d/cocos/platform/android/libcocos2dx')
include ':your_project_name'
project(':your_project_name').projectDir = new File(settingsDir, 'app')
+
+include ':gps'
+project(':gps').projectDir = new File(settingsDir, '../cocos2d/cocos/platform/android/java/libs/gps')
Proguard (optional)
- Edit
project.properties
to specify aProguard
configuration file. Example:
proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt
- Edit the file you specified to include the following:
# appodeal
-keep class com.appodeal.** { *; }
-keep class com.amazon.** { *; }
-keep class com.mopub.** { *; }
-keep class org.nexage.** { *; }
-keep class com.applovin.** { *; }
-keep class com.chartboost.** { *; }
-keep class com.unity3d.ads.** { *; }
-keep class com.applifier.** { *; }
-keep class com.yandex.** { *; }
-keep class com.inmobi.** { *; }
-keep class ru.mail.android.mytarget.** { *; }
-keep class com.google.android.gms.ads.** { *; }
-keep class com.google.android.gms.common.GooglePlayServicesUtil { *; }
-keep class * extends java.util.ListResourceBundle {
protected Object[][] getContents();
}
-keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
public static final *** NULL;
}
-keepnames @com.google.android.gms.common.annotation.KeepName class *
-keepclassmembernames class * {
@com.google.android.gms.common.annotation.KeepName *;
}
-keepnames class * implements android.os.Parcelable {
public static final ** CREATOR;
}
-dontwarn com.facebook.ads.**
-dontwarn com.jirbo.adcolony.**
-dontwarn com.vungle.**
-dontwarn com.startapp.**
-dontwarn com.yandex.**
-dontwarn com.inmobi.**
-keep class android.support.v4.app.Fragment { *; }
-keep class android.support.v4.app.FragmentActivity { *; }
-keep class android.support.v4.app.FragmentManager { *; }
-keep class android.support.v4.app.FragmentTransaction { *; }
-keep class android.support.v4.content.LocalBroadcastManager { *; }
-keep class android.support.v4.util.LruCache { *; }
-keep class android.support.v4.view.PagerAdapter { *; }
-keep class android.support.v4.view.ViewPager { *; }
-dontwarn com.appodeal.**
-dontwarn ru.mail.android.mytarget.**
# cocos2d-x
-keep public class org.cocos2dx.** { *; }
-dontwarn org.cocos2dx.**
-keep public class com.chukong.** { *; }
-dontwarn com.chukong.**
# google play service
-keep public class com.google.android.gms.** { public *; }
-dontwarn com.google.android.gms.**
-keep class * extends java.util.ListResourceBundle {
protected Object[][] getContents();
}
-keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
public static final *** NULL;
}
-keepnames @com.google.android.gms.common.annotation.KeepName class *
-keepclassmembernames class * {
@com.google.android.gms.common.annotation.KeepName *;
}
-keepnames class * implements android.os.Parcelable {
public static final ** CREATOR;
}
#sdkbox
-keep class com.sdkbox.** { *; }
-dontwarn com.sdkbox.**
Note: Proguard only works with Release builds (i.e cocos run -m release
) debug builds do not invoke Proguard rules.