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 ?!
[[StoreController getInstance] buyAppStoreItemWithProcuctId:@"[Your product id here]"]
The ios-store is our iOS-flavored code initiative part of The SOOMLA Project. It is an iOS SDK that simplifies the App Store's in-app purchasing API and complements it with storage, security and event handling. The project also includes a sample app for reference. As an optional (and currently EXPERIMENTAL) part of our open-source projects you can also get the storefront's theme which you can customize with your own game's assets. To use our storefront, refer to Get your own Storefront.
If you also want to create a storefront you can do that using our Store Designer.
Check out our Wiki for more information about the project and how to use it better.
Getting Started (using source code)
WE USE ARC !
Before doing anything, SOOMLA recommends that you go through Selling with In-App Purchase.
Clone ios-store. Copy all files from ../ios-store/SoomlaiOSStore/SoomlaiOSStore into your iOS project:
git clone email@example.com:soomla/ios-store.git
We use JSONKit but it doesn't use ARC. Go to your project's "Build Phases" and expand "Compile Sources". Add the flag "-fno-objc-arc" to the file JSONKit.m.
Make sure you have the following frameworks in your application's project: Security, libsqlite3.0.dylib, StoreKit.
Change the value of SOOM_SEC in StoreConfig.m to a secret of you choice. Do this now! You can't change this value after you publish your game!
Create your own implementation of IStoreAssets in order to describe your specific game's assets. Initialize StoreController with the class you just created:
[[StoreController getInstance] initializeWithStoreAssets:[[YourStoreAssetsImplementation alloc] init] andCustomSecret:@"[YOUR CUSTOM SECRET HERE]"];
The custom secret is your encryption secret for data saved in the DB. This secret is NOT the secret from step 4 (select a different value).
StoreControllerONLY ONCE when your application loads.
Now, that you have
StoreControllerloaded, just decide when you want to show/hide your store's UI to the user and let
StoreControllerknow about it:
When you show the store call:
[[StoreController getInstance] storeOpening];
When you hide the store call:
[[StoreController getInstance] storeClosing];
And that's it ! You have Storage and in-app purchasing capabilities... ALL-IN-ONE.
What's next? In App Purchasing.
ios-store provides you with VirtualCurrencyPacks. VirtualCurrencyPack is a representation of a "bag" of currency units that you want to let your users purchase in the App Store. You define VirtualCurrencyPacks in your game specific assets file which is your implementation of
IStoreAssets (example). After you do that you can call
StoreController to make actual purchases and ios-store will take care of the rest.
Lets say you have a VirtualCurrencyPack you call
TEN_COINS_PACK, a VirtualCurrency you call
COIN_CURRENCY and a VirtualCategory you call
VirtualCurrencyPack* TEN_COINS_PACK = [[VirtualCurrencyPack alloc] initWithName:@"10 Coins" andDescription:@"A pack of 10 coins" andItemId:@"10_coins" andPrice:0.99 andProductId:TEN_COINS_PACK_PRODUCT_ID andCurrencyAmount:10 andCurrency:COIN_CURRENCY];
Now you can use
StoreController to call the App Store's in-app purchasing mechanism:
[[StoreController getInstance] buyAppStoreItemWithProcuctId:TEN_COINS_PACK.productId];
And that's it! ios-store knows how to contact the App Store for you and redirect the user to the purchasing mechanism. Don't forget to subscribe to events of successful or failed purchases (see Event Handling).
Storage & Meta-Data
When you initialize StoreController, 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 tha 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.
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. Stay tuned... this is just one of the goodies we prepare for you.
Add 10 coins to the virtual currency with itemId "currency_coin":
VirtualCurrency* coin = [[StoreInfo getInstance] currencyWithItemId:@"currency_coin"]; [[[StorageManager getInstance] virtualCurrencyStorage] addAmount:10 toCurrency:coin];
Remove 10 virtual goods with itemId "green_hat":
VirtualGood* greenHat = [[StoreInfo getInstance] goodWithItemId:@"green_hat"]; [[[StorageManager getInstance] virtualGoodStorage] removeAmount:10 fromGood:greenHat];
Get the current balance of green hats (virtual goods with itemId "green_hat"):
VirtualGood* greenHat = [[StoreInfo getInstance] goodWithItemId:@"green_hat"]; int greenHatsBalance = [[[StorageManager getInstance] virtualGoodStorage] getBalanceForGood:greenHat];
If you want to protect your application 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. StoreConfig's STORE_CUSTOM_SECRET is one of them. SOOMLA recommends that you change this value 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.
SOOMLA lets you get notifications on various events and implement your own application specific behaviour.
Your behaviour is an addition to the default behaviour implemented by SOOMLA. You don't replace SOOMLA's behaviour.
In order to observe store events you need to import EventHandling.h and then you can add a notification to NSNotificationCenter:
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(yourCustomSelector:) name:EVENT_VIRTUAL_CURRENCY_PACK_PURCHASED object:nil];
OR, you can observe all events with the same selector by calling:
[EventHandling observeAllEventsWithObserver:self withSelector:@selector(yourCustomSelector:)];
Our way of saying "Thanks !"
Other open-source projects that we use:
We want you!
Fork -> Clone -> Implement -> Test -> Pull-Request. We have great RESPECT for contributors.
SOOMLA, Elsewhere ...
MIT License. Copyright (c) 2012 SOOMLA. http://project.soom.la