Skip to content

Commit

Permalink
update readMe
Browse files Browse the repository at this point in the history
  • Loading branch information
FreshTiti committed Dec 4, 2013
1 parent cabaf6a commit 7717eb8
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
Air Native Extension for Google Play Games Services (Android)
======================================

This is an [Air native extension](http:https://www.adobe.com/devnet/air/native-extensions-for-air.html) for [Google Play Games Services](http:https://developer.android.com/google/play-services/games.html/) SDK on Android. It has been developed by [FreshPlanet](http:https://freshplanet.com) and is used in the game [MoviePop](http:https://moviepop.net).


Installation
---------

The ANE binary (AirGooglePlayGamesService.ane) is located in the *bin* folder. You should add it to your application project's Build Path and make sure to package it with your app (more information [here](http:https://help.adobe.com/en_US/air/build/WS597e5dadb9cc1e0253f7d2fc1311b491071-8000.html)).


Usage
-----

You need to add the following in your AIR manifest, and replace YOUR_APP_ID by the app id of your Google Play Games Services (don't remove the "\ " at the beginning, otherwise it won't work):

<application>
<!-- GooglePlay Games Services -->
<meta-data android:name="com.google.android.gms.games.APP_ID" android:value="\ YOUR_APP_ID" />
<activity android:name="com.freshplanet.googleplaygames.SignInActivity" android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
</application>



```actionscript
// Initialize
AirGooglePlayGames.getInstance().addEventListener(AirGooglePlayGamesEvent.ON_SIGN_IN_SUCCESS, onSignInSuccess);
AirGooglePlayGames.getInstance().addEventListener(AirGooglePlayGamesEvent.ON_SIGN_OUT_SUCCESS, onSignOutSuccess);
AirGooglePlayGames.getInstance().addEventListener(AirGooglePlayGamesEvent.ON_SIGN_IN_FAIL, onSignInFail);
AirGooglePlayGames.getInstance().startAtLaunch();
// Update Achievement
// with steps
AirGooglePlayGames.getInstance().reportAchievement(achievementId, step);
// without steps
AirGooglePlayGames.getInstance().reportAchievement(achievementId);
// Update HighScore
AirGooglePlayGames.getInstance().reportScore(leaderbordId, value);
// Show Achivements
AirGooglePlayGames.getInstance().showStandardAchievements();
```


Build script
---------

Should you need to edit the extension source code and/or recompile it, you will find an ant build script (build.xml) in the *build* folder:

```bash
cd /path/to/the/ane/build
mv example.build.config build.config
#edit the build.config file to provide your machine-specific paths
ant
```


Authors
------

This ANE has been written by [Thibaut Crenn]. It belongs to [FreshPlanet Inc.](http:https://freshplanet.com) and is distributed under the [Apache Licence, version 2.0](http:https://www.apache.org/licenses/LICENSE-2.0).

0 comments on commit 7717eb8

Please sign in to comment.