This project is a part of The SOOMLA Project which is a series of open source initiatives with a joint goal to help mobile game developers get better stores and more in-app purchases.
Haven't you ever wanted an in-app purchase one liner that looks like this ?!
StoreInventory.BuyItem("[itemId]");The new Virtual Economy model V3 is merged into master. The new model has many new features and it works better than the old one. Old applications may break if they use in this new model so already published games with unity3d-store from before May 1st, 2013 needs to clone the project with tag 'v0.23' and not 'v1.0'.
Want to learn more about modelV3? Try these:
- Economy Model Objects - android-store
- Handling Store Operations - android-store (The same model objects from android-store exist in unity3d-store)
The unity3d-store is the Unity3D flavour of The SOOMLA Project. This project uses android-store and ios-store in order to provide game developers with in-app billing for their Unity3D projects.
Before you start, we suggest that you go over the information in ios-store and android-store so you get acquainted with the SOOMLA framework:
If you also want to create a storefront you can do that using SOOMLA's In-App Purchase Store Designer.
We've created a unitypackage and an example project:
####unity3d-store v1.03 (release version)
Unity 4.0 - unity3d-store v1.03
Unity 3.5 - unity3d-store v1.03
####unity3d-store v1.03 example
- The example project is mostly what you have in this Github repo. You can either download it or clone unity3d-store.
Unity 4.0 - unity3d-store v1.03 example
Unity 3.5 - unity3d-store v1.03 example
The download packages and the code in the repo uses the "release" versions of android-store and ios-store. Also, Unity debug messages will only be printed out if you build the project with Development Build checked.
If you want to see full debug messages from android-store and ios-store you'll have to use the debug builds of those libraries. You can find those builds in the repo, in the folder soomla-native (android ios).
Test purchases on Android will not work (even in the debug library) if you won't switch its Test Mode on. In order to do that, check the box next to "Android Test Mode" in the Soomla prefab when it's added to your scene. (The example project works with test purchases. Make sure it's running on Test Mode)
-
Download the unity3d-store unityproject file you want and double-click on it. It'll import all the necessary files into your project.
-
Drag the "Soomla" Prefab into your scene. You should see it listed in the "Hierarchy" panel.
-
Click on the "Soomla" Prefab you just added and in the "Inspector" panel change the values for "Custom Secret", "Public Key" and "Soom Sec":
- Custom Secret - is an encryption secret you provide that will be used to secure your data.
- Public Key - is the public key given to you from Google. (iOS doesn't have a public key).
- Soom Sec - is a special secret SOOMLA uses to increase your data protection.
Choose both secrets wisely. You can't change them after you launch your game!
-
Create your own implementation of IStoreAssets in order to describe your specific game's assets (example). Initialize StoreController with the class you just created:
StoreController.Initialize(new YourStoreAssetsImplementation());
Initialize StoreController ONLY ONCE when your application loads.
Initialize StoreController in the "Start()" function of a 'MonoBehaviour' and NOT in the "Awake()" function. SOOMLA has its own 'MonoBehaviour' and it needs to be "Awakened" before you initialize.
-
Now, that you have StoreController loaded, just decide when you want to show/hide your store's UI to the user and let StoreController know about it:
When you show the store call:
```cs
StoreController.storeOpening();
```
When you hide the store call:
```cs
StoreController.storeClosing();
```
> Don't forget to make these calls. _StoreController_ has to know that you opened/closed your in-app purchase store. Just to make it clear: the in-app purchase store is where you sell virtual goods (and not Google Play or App Store).
- You'll need an event handler in order to be notified about in-app purchasing related events. refer to the Event Handling section for more information.
And that's it ! You have storage and in-app purchasing capabilities... ALL-IN-ONE.
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 or the App Store.
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.buyItem(TEN_COINS_PACK.ItemId);And that's it! unity3d-store knows how to contact Google Play or the App Store for you and will redirect your users to their purchasing system to complete the transaction. Don't forget to subscribe to store events in order to get the notified of successful or failed purchases (see Event Handling).
When you initialize StoreController, it automatically initializes two other classes: StoreInventory and StoreInfo:
- StoreInventory is a convenience class to let you perform operations on VirtualCurrencies and VirtualGoods. Use it to fetch/change the balances of VirtualItems in your game (using their ItemIds!)
- StoreInfo is where all meta data information about your specific game can be retrieved. It is initialized with your implementation of
IStoreAssetsand you can use it to retrieve information about your specific game.
ATTENTION: because we're using JNI (Android) and DllImport (iOS) you should make as little calls as possible to StoreInfo. Look in the example project for the way we created a sort of a cache to hold your game's information in order to not make too many calls to StoreInfo. We update this cache using an event handler. (see ExampleLocalStoreInfo and ExampleEventHandler).
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
-
Get VirtualCurrency with itemId "currency_coin":
VirtualCurrency coin = StoreInfo.GetVirtualCurrencyByItemId("currency_coin");
-
Give the user 10 pieces of a virtual currency with itemId "currency_coin":
StoreInventory.GiveItem("currency_coin", 10);
-
Take 10 virtual goods with itemId "green_hat":
StoreInventory.TakeItem("green_hat", 10);
-
Get the current balance of green hats (virtual goods with itemId "green_hat"):
int greenHatsBalance = StoreInventory.GetItemBalance("green_hat");
SOOMLA lets you subscribe to store events, get notified and implement your own application specific behaviour to those events.
Your behaviour is an addition to the default behaviour implemented by SOOMLA. You don't replace SOOMLA's behaviour.
The 'Events' class is where all event go through. To handle various events, just add your specific behaviour to the delegates in the Events class.
For example, if you want to 'listen' to a MerketPurchase event:
Events.OnMarketPurchase += onMarketPurchase;
public void onMarketPurchase(PurchasableVirtualItem pvi) {
Debug.Log("Going to purchase an item with productId: " + pvi.ItemId);
}We want you!
Fork -> Clone -> Implement -> Test -> Pull-Request. We have great RESPECT for contributors.
MIT License. Copyright (c) 2012 SOOMLA. http://project.soom.la