Xlauncher SDK for iOS is the most simple way to intergrate user and payment to XCT system.Xlauncher SDK provide solution for payment such as: SMS, card, internet banking và Apple Payment.
1. Setup Xlauncher SDK
2. Config SDK - Payment function
3. Xlauncher SDK flow
- Drag and drop Xlauncher.framework into your project.
- Tick on checkbox: “Copy items into destination group's folder (if needed)”.
- Embedded Binaries with SDK
- Add the following url schemes for Facebook(“fb” + facebook app id) and Google sign in (Reverse client id) from XlauncherConfig.plist file
- Add facebook app id, facebook display name and application queries scheme as below. Please replace app id and display name with the value in the XlauncherConfig.plist file
- Add file XlauncherConfig.plist to your root project
-
Import SDK : import XLauncher/XLauncher.h into UnityAppController.m
-
Add these lines of code in Application didFinishLaunchingWithOptions function in AppDelegate class, after window setup. You can get Google Signin client ID in the XlauncherConfig.plist.
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Project configure
XLauncher *launcher = [XLauncher getInstance];
[launcher setupWithWindow:window usingFacebookSDK:YES]; // YES is using facebook
//
// if using facebook API, you need to implement
// [launcher setPermissionFacebook:@"public_profile"]; // string is the permission you want to
//
// Handle login callback
[launcher handleLoginWithCompletion:^(NSDictionary *data) {
NSString *userID = data[kParamUserID];
NSString *userName = data[kParamUserName];
NSString *accessToken = data[kParamAccessToken];
}];
// Handle logout callback
[launcher handleLogoutWithCompletion:^{
//do something
}];
// handle payment callback
[launcher handlePaymentWithCompletion:^(NSDictionary *data){
//NSLog(@"Payment success! %@", data);
}];
[launcher setDomainDebug:NO]; // if you want to build in the TEST mode, pass it to TRUE
NSDictionary *dict = @{kParamApplication: ATNonNilObject(application), kParamOptions: ATNonNilObject(launchOptions)};
ATDispatchEvent(Event_AppDidFinishLaunching, dict);
return YES;
}
Read here for more detail about how to setup the TEST enviroment
-
In the previous code, we provide two callback functions. There are handleLoginWithCompletion and handleLogoutWithCompletion. You may use these functions to call login or logout with your server
-
Add function handle Facebook schemes
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)
sourceApplication annotation:(id)annotation {
NSDictionary *dict = @{kParamApplication: ATNonNilObject(application), kParamUrl: ATNonNilObject(url),
kParamSourceApplication: ATNonNilObject(sourceApplication), kParamAnnotation: ATNonNilObject(annotation)};
ATDispatchEvent(Event_AppOpenUrl, dict);
return YES;
}
-
This example code is apply for landscape mode.You can set it through "didFinishLaunchingWithOptions"
[Xlauncher getInstance].isPotrait = YES (Potrait only); // else landscape is NO;
Base on your game orientation, if your game support both portrait and landscape then you must replace UIInterfaceOrientationMaskLandscape with UIInterfaceOrientationMaskAll, if you game is only support portrait mode, then you don’t need to add this function.
- (UIInterfaceOrientationMask)application:(UIApplication *)application supportedInterfaceOrientationsForWindow:(UIWindow *)window
{
if ([[XLauncher getInstance] isScreenRotateToPortrait]) {
return UIInterfaceOrientationMaskPortrait;
} else
return UIInterfaceOrientationMaskLandscape;
}
- Here is the list of public functions you can call to customize the Xlauncher in your game:
-
setLauncherStickySide: You can specific the side that launcher can stick to via the or bitwise. Ex: ATButtonStickySideTop | ATButtonStickySideBottom
-
silentLogin: When open the app, maybe user is already logged in. Call this function to check if user is logged in or not, if not, you must call showLoginScreen function to show the login screen.
if([[Xlauncher getInstance] silentLogin])
// Move direct to game
else {
// Show login screen
[[Xlauncher getInstance] showLoginScreen];
}
- showButtonLauncherWithAnimation
- hideButtonLauncherWithAnimation
- showLoginScreen: Show the login screen, if user not logged in yet
- showPaymentScreen: You may want to show payment screen from your game
- handleShowSDKCompletion: You can get the event show SDK here
- handleCloseSDKCompletion: You can get the event show SDK here
Payment extra data (PED) is the data you send to game server when user make payment success. For example: if your game have multiple servers or multiple characters, you may want to send this data to game server, so its will know which character get the gold. The format is defined on your demand.
Note*:
- It must be unique string
- Maximum is 50 characters
- There's no special character in string
To implement PED, you create a class that implement PaymentExtraDataProtocol with function
- (NSString *)getPaymentExtraData {
return @“server12-id1001”; // ex: server 12, userid = 1001
}
Then you create an PaymentExtraDataImp object and set it to XLauncher
[launcher setPaymentExtraDataObject:[PaymentExtraDataImp new]];
Please input full information in Xcode before build the product
- Display Name: name appear on the device
- Bundle identifier: bundle id of your game which provided by XCT
- Version: string, for example: 1.0.0
- Build: number, for example: 100
