Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Android in-app purchase & virtual economy library. Part of The SOOMLA Framework - for game design, economy modeling and faster development.
Java

README.md

This project is a part of The SOOMLA Framework, which is a series of open source initiatives with a joint goal to help mobile game developers do more together. SOOMLA encourages better game design, economy modeling, social engagement, and faster development.

Haven't you ever wanted an in-app purchase one liner that looks like this!?

StoreInventory.buy("[itemId]");

android-store

SOOMLA's Store Module for Android

December 3rd, 2014: Migrating Amazon IAP from v1.0 to v2.0. Read more about IAP v2.0

September 15th, 2014: NonConsumableItem class was removed. To create a non-consumable item in your IStoreAssetes implementation, use LifeTimeVG with PurchaseType of PurchaseWithMarket.

The current virtual economy model is called modelV3. Want to learn more about it? Try these:

android-store is the Android flavor of SOOMLA's Store Module.

Check out our Wiki for more information about the project and how to use it better.

Download

Pre baked jars:

android-store v3.6.11

Getting Started

  1. Add the jars from the downloaded zip to your project.

  2. Make the following changes to your AndroidManifest.xml:

    Set SoomlaApp as the main Application by placing it in the application tag:

      <application ...
                   android:name="com.soomla.SoomlaApp">
  3. Initialize Soomla with a secret that you chose to encrypt the user data. (For those who came from older versions, this should be the same as the old "customSec"):

     Soomla.initialize("[YOUR CUSTOM GAME SECRET HERE]");

    The secret is your encryption secret for data saved in the DB.

  4. Create your own implementation of IStoreAssets in order to describe your specific game's assets (example). Initialize SoomlaStore with the class you just created:

     SoomlaStore.getInstance().initialize(new YourStoreAssetsImplementation());

    Initialize SoomlaStore ONLY ONCE when your application loads.

  5. Refer to the next section for information of selecting your Billing Service and setting it up.

And that's it ! You have storage and in-app purchasing capabilities... ALL-IN-ONE.

What's next? Selecting a Billing Service

android-store can be used on all Android based devices meaning that you might want to use IAP with different billing services.

We've created two billing services for you: Google Play and Amazon (according to your demand).

The billing service is automatically started and stopped for every operation you're running on SoomlaStore (buyWithMarket, restoreTransactions ...).

Be careful with that. Don't leave the service running in the background without closing it.

You must select a billing service for android-store to work properly. The integration of a billing service is very easy:

Google Play

  1. Add AndroidStoreGooglePlay.jar from the folder billing-services/google-play to your project.
  2. Make the following changes in AndroidManifest.xml:

    Add the following permission (for Google Play):

    <uses-permission android:name="com.android.vending.BILLING" />

    Add the IabActivity to your application element, the plugin will spawn a transparent activity to make purchases. Also, you need to tell us what plugin you're using so add a meta-data tag for that:

    <activity android:name="com.soomla.store.billing.google.GooglePlayIabService$IabActivity"
              android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"/>
    <meta-data android:name="billing.service" android:value="google.GooglePlayIabService" />
  3. After you initialize SoomlaStore, let the plugin know your public key from the dev console:

    GooglePlayIabService.getInstance().setPublicKey("[YOUR PUBLIC KEY FROM THE MARKET]");
  4. If you want to allow the test purchases, all you need to do is tell that to the plugin:

    GooglePlayIabService.AllowAndroidTestPurchases = true;

For Google Play, We recommend that you open the IAB Service and keep it open in the background in cases where you have an in-game storefront. This is how you do that:

When you open the store, call:

  SoomlaStore.getInstance().startIabServiceInBg();

When the store is closed, call:

  SoomlaStore.getInstance().stopIabServiceInBg();

Amazon

  1. Add in-app-purchasing-2.0.1.jar and AndroidStoreAmazon.jar from the folder billing-services/amazon to your project.

  2. Make the following changes in AndroidManifest.xml:

    Add Amazon's ResponseReceiver to your application element. Also, you need to tell us what plugin you're using so add a meta-data tag for that:

    <receiver android:name = "com.amazon.device.iap.ResponseReceiver" >
      <intent-filter>
          <action android:name = "com.amazon.inapp.purchasing.NOTIFY"
                  android:permission = "com.amazon.inapp.purchasing.Permission.NOTIFY" />
      </intent-filter>
    </receiver>
    <meta-data android:name="billing.service" android:value="amazon.AmazonIabService" />

Important read: In App Purchasing.

When we implemented modelV3, we were thinking about ways people buy things inside apps. We figured many ways you can let your users purchase stuff in your game and we designed the new modelV3 to support 2 of them: PurchaseWithMarket and PurchaseWithVirtualItem.

PurchaseWithMarket is a PurchaseType that allows users to purchase a VirtualItem with Google Play.
PurchaseWithVirtualItem is a PurchaseType that lets your users purchase a VirtualItem with a different VirtualItem. For Example: Buying 1 Sword with 100 Gems.

In order to define the way your various virtual items (Goods, Coins ...) are purchased, you'll need to create your implementation of IStoreAsset (the same one from step 4 in the "Getting Started" above).

Here is an example:

Lets say you have a VirtualCurrencyPack you call TEN_COINS_PACK and a VirtualCurrency you call COIN_CURRENCY:

VirtualCurrencyPack TEN_COINS_PACK = new VirtualCurrencyPack(
        "10 Coins",                                     // name
        "A pack of 10 coins",                           // description
        "10_coins",                                     // item id
        10,                                             // number of currencies in the pack
        COIN_CURRENCY_ITEM_ID,                          // the currency associated with this pack
        new PurchaseWithMarket("com.soomla.ten_coin_pack", 1.99));

Now you can use StoreInventory to buy your new VirtualCurrencyPack:

StoreInventory.buy(TEN_COINS_PACK.getItemId());

And that's it! android-store knows how to contact Google Play for you and will redirect your users to their purchasing system to complete the transaction. Don't forget to define your IStoreEventHandler in order to get the events of successful or failed purchases (see Event Handling).

Debugging

In order to debug android-store, set SoomlaConfig.logDebug to true. This will print all of android-store's debugging messages to logcat.

Storage & Meta-Data

When you initialize SoomlaStore, it automatically initializes two other classes: StorageManager and StoreInfo. StorageManager is the father of all storage related instances in your game. Use it to access the balances of virtual currencies and virtual goods (usually, using their itemIds). StoreInfo is the mother of all meta data information about your specific game. It is initialized with your implementation of IStoreAssets and you can use it to retrieve information about your specific game.
We've also added StoreInventory which is a utility class to help you do store related operations even easier.

The on-device storage is encrypted and kept in a SQLite database. SOOMLA is preparing a cloud-based storage service that will allow this SQLite to be synced to a cloud-based repository that you'll define.

Example Usages

  • Give the user 10 pieces of a virtual currency with itemId "currency_coin":

    StoreInventory.giveVirtualItem("currency_coin", 10);
  • Take 10 virtual goods with itemId "green_hat":

    StoreInventory.takeVirtualItem("green_hat", 10);
  • Get the current balance of a virtual good with itemId "green_hat" (here we decided to show you the 'long' way. you can also use StoreInventory):

    VirtualGood greenHat = (VirtualGood)StoreInfo.getVirtualItem("green_hat");
    int greenHatsBalance = StorageManager.getVirtualGoodsStorage().getBalance(greenHat);

Security

If you want to protect your game from 'bad people' (and who doesn't?!), you might want to follow some guidelines:

  • SOOMLA keeps the game's data in an encrypted database. In order to encrypt your data, SOOMLA generates a private key out of several parts of information. The Soomla Secret (before v3.4.1 is was called customSec) is one of them. SOOMLA recommends that you provide this value when initializing SoomlaStore and before you release your game. BE CAREFUL: You can change this value once! If you try to change it again, old data from the database will become unavailable.
  • Following Google's recommendation, SOOMLA also recommends that you split your public key and construct it on runtime or even use bit manipulation on it in order to hide it. The key itself is not secret information but if someone replaces it, your application might get fake messages that might harm it.

Event Handling

For event handling, we use Square's great open-source project otto. In ordered to be notified of store related events, you can register for specific events and create your game-specific behavior to handle them.

Your behavior is an addition to the default behavior implemented by SOOMLA. You don't replace SOOMLA's behavior.

In order to register for events:

  1. In the class that should receive the event create a function with the annotation '@Subscribe'. Example:

    @Subscribe
    public void onMarketPurchaseEvent(MarketPurchaseEvent marketPurchaseEvent) {
        ...
    }
  2. You'll also have to register your class in the event bus (and unregister when needed):

    BusProvider.getInstance().register(this);
    BusProvider.getInstance().unregister(this);

If your class is an Activity, register in 'onResume' and unregister in 'onPause'

You can find a full event handler example here.

List of events

Full documentation and explanation of otto

Contribution

SOOMLA appreciates code contributions! You are more than welcome to extend the capabilities of SOOMLA.

Fork -> Clone -> Implement -> Add documentation -> Test -> Pull-Request.

IMPORTANT: If you would like to contribute, please follow our Documentation Guidelines. Clear, consistent comments will make our code easy to understand.

SOOMLA, Elsewhere ...

License

Apache License. Copyright (c) 2012-2014 SOOMLA. http://project.soom.la

Something went wrong with that request. Please try again.