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.2.0 (0.3.0 snapshots available via sonatype).
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.
To integrate using Maven, have a look at the Wiki page for Maven Integration. In that case you won't need to add the jars listed below.
To setup the purchasing API, you will need to add the corresponding jar files to your project. In your core project you have:
In your Android project you use. Please note if you use the jars, all dependencies such as the ouya-sdk.jar are already wired in:
- gdx-pay-android.jar
- gdx-pay-android-openiab.jar (to support GooglePlay, Amazon etc.)
- gdx-pay-android-ouya.jar (to support OUYA)
- 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.**
In your iOS project you use:
- gdx-pay-iosrobovm-apple.jar
- robovm.xml: add
<pattern>com.badlogic.gdx.pay.ios.apple.PurchaseManageriOSApple</pattern>inside<forceLinkClasses>...</forceLinkClasses>.
In your Desktop project you use:
- gdx-pay-desktop-apple.jar (to support the Mac App Store): needs implementation/volunteers wanted!
In your GWT project you use:
- gdx-pay-gwt-googlewallet.jar (to support Google Wallet): needs implementation/volunteers wanted!
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 without bothering making any code changes.
...
if (PurchaseSystem.hasManager()) {
// purchase system is ready to start. Let's initialize our product list etc...
PurchaseManagerConfig config = new PurchaseManagerConfig();
config.addOffer(...)
config.addOffer(...)
...
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() {
...
}
...
// 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 :)
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.
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 :)
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.
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!