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.
When using the SOOMLA framework, you always start by initializing the core module from your main activity:
Soomla.initialize(this, "[YOUR SOOMLA SECRET HERE]");This sets up the local on-device database used by SOOMLA. The secret is used for encrypting the data, make sure to choose a good one.
This core library holds common features and utilities used by all other modules of the SOOMLA framework. It includes:
- An encrypted key-value storage (SQLite based) for persisting data locally on devices.
- Utilities for
StringandJSONObjectmanipulation. - Utilities for Logging and encryption.
- An event bus (using Square's otto) for publish-subscribe events.
SoomlaEntity- the base class from which all SOOMLA domain objects derive- Reward domain objects and events - used to grant your users rewards.
SOOMLA modules internally use these features, though we encourage you to use them for your own needs as well. For example, use our key-value storage for custom game data for usage across game sessions.
- Clone this repository recursively:
git clone --recursive https://github.com/soomla/soomla-android-core.git - Run
./build_allfrom project directory - Take created binaries from
builddirectory and use it!
Other open-source projects that we use:
- FBEncryptor
- Otto - by Square
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.
Apache License. Copyright (c) 2012-2014 SOOMLA. http://soom.la