This project aims to provide a cross-platform API for InApp purchasing. The gdx-pay project is a libGDX extension. Current release version is 0.11.2. Please use at least libGDX v1.9.6, Robovm 2.3.2 or multi-os-engine v1.3.8.
The purchasing API comes in two parts.
-
Client-Side API: This is what is integrated into your game or application and will handle the purchase flow for the application.
-
Server-Side API (optional): If you have a server running and would like to do a purchase verification on your server, you can use the API to verify purchases sent to your server.
The recommended way to use gdx-pay is via dependency management with Gradle or Maven. Artifacts are available in Maven Central. Guide for using gdx-pay with Maven.
Dependency can be configured using Gradle or by manually downloading the dependencies.
Configure dependencies using Gradle
project-root/build.gradle:
ext {
gdxPayVersion = '0.11.2'
}
core:
dependencies {
compile "com.badlogicgames.gdxpay:gdx-pay-client:$gdxPayVersion"
}
android:
dependencies {
compile "com.badlogicgames.gdxpay:gdx-pay-android:$gdxPayVersion"
compile "com.badlogicgames.gdxpay:gdx-pay-android-googleplay:${gdxPayVersion}@aar"
}
ios-robovm:
dependencies {
compile "com.badlogicgames.gdxpay:gdx-pay-iosrobovm-apple:$gdxPayVersion"
}
ios-moe:
dependencies {
compile "com.badlogicgames.gdxpay:gdx-pay-iosmoe-apple:$gdxPayVersion"
}
Configure dependencies manually
core:
android:
- gdx-pay-android.jar
- gdx-pay-android-googleplay.jar ( for Google Play with non-consumable products only, exclude this artifact when using other product types. See status)
- gdx-pay-android-openiab.jar (to support GooglePlay, Amazon etc. This component is deprecated! Do not use if you are using gdx-pay-android-googleplay.jar, they are mutually exclusive.))
- gdx-pay-android-ouya.jar (to support OUYA)
iOS RoboVM:
iOS MOE:
Desktop:
- gdx-pay-desktop-apple.jar (to support the Mac App Store): needs implementation/volunteers wanted!
GWT:
- gdx-pay-gwt-googlewallet.jar (to support Google Wallet): needs implementation/volunteers wanted!
Gdx-Pay configuration
iOS:
- robovm.xml: add
<pattern>com.badlogic.gdx.pay.ios.apple.PurchaseManageriOSApple</pattern>inside<forceLinkClasses>...</forceLinkClasses>.
android:
- AndroidManifest.xml:
<!--all-->
<uses-permission android:name="android.permission.INTERNET"/>
<!--Google Play-->
<uses-permission android:name="com.android.vending.BILLING"/>
<!--Open Store-->
<uses-permission android:name="org.onepf.openiab.permission.BILLING"/>
<!--Samsung Apps-->
<uses-permission android:name="com.sec.android.iap.permission.BILLING"/>
<!--Nokia-->
<uses-permission android:name="com.nokia.payment.BILLING"/>
<!--SlideME-->
<uses-permission android:name="com.slideme.sam.manager.inapp.permission.BILLING"/>
- proguard.cfg:
-keep class com.android.vending.billing.**
-keep class com.amazon.** {*;}
-keep class com.sec.android.iap.**
-keep class com.nokia.payment.iap.aidl.**
-keep class com.badlogic.gdx.pay.android.** { *; }
-dontwarn org.onepf.oms.appstore.FortumoBillingService
core: In any case, if the correct jar files are place, all you need is to initialize the purchase system in your core project as follows.
...
// Disposes static instances in case JVM is re-used on restarts
PurchaseSystem.onAppRestarted();
//If gdx-pay is called too early, a manager may not be registered which would be ONE of the reasons for hasManager to return false
if (PurchaseSystem.hasManager()) {
// purchase system is ready to start. Let's initialize our product list etc...
PurchaseManagerConfig config = new PurchaseManagerConfig();
//add items that can be purchased in the store, they must be listed before being purchased.
config.addOffer(new Offer().setType(OfferType.ENTITLEMENT).setIdentifier("ExamplePurchase"));
config.addOffer(new Offer().setType(OfferType.CONSUMABLE).setIdentifier("ExampleConsumablePurchase"));
...
//add any stores you are planning on using (Note, IOS_APPLE doesn't actually have an encoded key so pass any string as the second parameter)
config.addStoreParam(PurchaseManagerConfig.STORE_NAME_ANDROID_GOOGLE, "<Google key>");
config.addStoreParam(PurchaseManagerConfig.STORE_NAME_ANDROID_OUYA, new Object[] {
OUYA_DEVELOPER_ID,
KEYPATH
});
...
// let's start the purchase system...
PurchaseSystem.install(new PurchaseObserver() {
...
//implement all needed methods. Check for purchases in handleRestore and handlePurchase using the transactions argument. // e.g: if(transactions[i].getIdentifier().equals("ExamplePurchase"))
}, config);
...
// to make a purchase (results are reported to the observer)
PurchaseSystem.purchase("product_identifier");
...
// (*) to restore existing purchases (results are reported to the observer)
PurchaseSystem.restore();
...
// obtain localized product information (not supported by all platforms)
Information information = PurchaseSystem.getInformation("product_identifier");
...
}
...
(*) IMPORTANT: `PurchaseSystem.restore()' should not be called directly by your application. Restoring purchases shall only be
called when a user explicitly requests it. In your application add a [Restore Purchases] button which in turn will call this method.
This is a requirement by Apple iOS. If you don't provide a button for purchase restores your application will be rejected! You have
been warned :)
Please note: Gdx-Pay does not work on android emulators at all and will run on apple emulators but they will not be able to complete any purchases.
For keys you have to pass in have a look at OpenIAB's Sample Configuration. Please note you will not need to pass in any keys for Amazon as it doesn't require them.
Here is a user-guide in the wiki on how to implement gdx-pay in your libgdx project with using platform resolvers: Integration-example-with-resolvers
The gdx-pay-android-googleplay implementation supports cancellation of test purchases:
PurchaseManager mananager = PurchaseSystem.getManager();
if (manager instanceof PurchaseManagerTestSupport) {
((PurchaseManagerTestSupport) manager).cancelTestPurchases();
}
gdx-pay-server is optional and can be used for purchase verification on a server. It verifies if a purchase is valid by e.g. doing a post-back validation on a server. Place the following two jar-files onto your server (you won't need any other libGDX libraries on your server, all dependencies to libGDX have been removed for easy integration):
How to integrate in your server:
// create a manager which returns "true" by default
PurchaseVerifierManager verifier = new PurchaseVerifierManager(true);
// add the various purchase verifiers
verifier.addVerifier(new PurchaseVerifierAndroidGoogle(...));
verifier.addVerifier(new PurchaseVerifierAndroidAmazon(...));
verifier.addVerifier(new PurchaseVerifierAndroidOUYA(...));
verifier.addVerifier(new PurchaseVerifieriOSApple(...));
...
// verify a purchase
if (verifier.isValid(transaction)) {
// transaction appears valid
... add to BD etc. ...
}
else {
// transaction appears bogus
... punish user ...
}
Please note that the server-side functionality hasn't been fully developed yet as of this writing. PurchaseVerifieriOSApple is somewhat rudimentary implemented and will need some more work. There is a main(...) method in that fail if you want to run/test it :)
Release history for major milestones (available via Maven):
- 0.11.2: Bugfix release for #157 (MOE iOS 9), #158 (Robovm GC issue)
- 0.11.1: Copy currency-code from iOS backend to Information (Robovm and MOE)
- 0.11.0: Support for Multi-OS-Engine, update Robovm to 2.3.0, support more than 20 skus on Android
- 0.10.3: Bugfix release for issue #118 #120 #122
- Version 0.10.2: Bugfix release for issue #117
- Version 0.10.1: Bugfix release for issue #113
- Version 0.10.0: Bugfix release for issue #110
- Version 0.9.2: Bugfix release for issue #91
- Version 0.9.1: Bugfix release for issue #88
- Version 0.9.0: New Google Play Store implementation, no longer depends on OpenIAB (2016-02-06)
- Version 0.8.0: bugfix release (2015-12-16)
- Version 0.7.0: lastest updates/bugfixes integrated (2015-12-10)
- Version 0.6.0: iOS 9 support, bug fixes
- Version 0.5.0: Bugfixes for OpenIAB/Apple backends especially (2015-03-18)
- Version 0.3.0: Minor Updates and Bugfixes (2015-01-27)
- Version 0.2.0: iOS Added
- Version 0.1.0: Initial Release
Check the libGDX blog for news and updates. You can get help on the libGDX forum and talk to other users on the IRC channel #libgdx at irc.freenode.net.
Something not working quite as expected? Do you need a feature that has not been implemented yet? Check the issue tracker and add a new one if your problem is not already listed. Please try to provide a detailed description of your problem, including the steps to reproduce it.
When Gradle is used to manage dependencies, gdx-pay locally build SNAPSHOT binaries can be used via the Maven local repository.
Build gdx-pay with the following command:
./gradlew assemble uploadArchives -PLOCAL
1: add mavenLocal() as Gradle repository in the root build.gradle
allprojects {
repositories {
mavenLocal()
}
}
2: change the version of gdx-pay dependencies to the version variable value found in gdx-pay/build.gradle
Awesome! If you would like to contribute with a new feature or a bugfix, fork this repo and submit a pull request. Also, before we can accept substantial code contributions, we need you to sign the libGDX Contributor License Agreement.
The gdx-pay project is licensed under the Apache 2 License, meaning you can use it free of charge, without strings attached in commercial and non-commercial projects. We love to get (non-mandatory) credit in case you release a game or app using gdx-pay!