{"id":6846,"date":"2012-12-12T12:00:32","date_gmt":"2012-12-12T03:00:32","guid":{"rendered":"http:\/\/labs.gree.jp\/blog\/?p=6846"},"modified":"2021-04-27T15:03:56","modified_gmt":"2021-04-27T06:03:56","slug":"integrate-gree-platform-sdk-into-your-cocos2dx-game-for-android","status":"publish","type":"post","link":"https:\/\/labs.gree.jp\/blog\/2012\/12\/6846\/","title":{"rendered":"Integrate GREE Platform SDK into your cocos2dx game for Android"},"content":{"rendered":"

Hi everyone, I'm kazuma from GREE. I have a strong interest in cross-platform development tools that allow developers to write code once and deploy to multiple platforms.<\/p>\n

Integrate GREE Platform SDK into your cocos2dx game for Android (will support iOS in the future)<\/h3>\n

This guide provides step-by-step instructions on how to integrate GREE SNS features (User information, FriendList, Payment, Achievement, Leaderboard and so on) with your cocos2dx applications.<\/p>\n

This article is a little bit lengthy, but I hope it will be interesting for you, and inspire you to try it out yourself.<\/p>\n

\"\"<\/a><\/p>\n

Requirements<\/span><\/h4>\n

You should have Eclipse with the Android Developer Tools installed. If not, please setup your environment with the instructions at:
\nhttp:\/\/developer.android.com\/sdk\/installing\/installing-adt.html<\/a><\/p>\n

Get GREE Platform SDK for Android<\/span><\/h4>\n

The latest version of the GREE Platform SDK is available from:
\nhttps:\/\/developer.gree.net<\/a>
\nhttps:\/\/developer.gree.net\/en\/<\/a>
\nPlease download the SDK for Android. Instructions in this article are written for GREE SDK version v3-3-8.<\/p>\n

You can also find a Developer's Guide at the URL above. Please follow the instructions in the guide and import the SDK into Eclipse.
\nTo activate your GREE Application, you need a GREE Application Id, Consumer Key, Consumer Secret, and edit your config files so that they are properly set. I will show you how to do that later in this guide.
\nDetailed instructions can also be found in the Developer's Guide at the URL above.<\/p>\n

Get AndroidNDK<\/span><\/h4>\n

Cocos2dx is written in C++ and needs to be built with AndroidNDK.
\nAndroidNDK is available from:
\nhttp:\/\/developer.android.com\/tools\/sdk\/ndk\/index.html<\/a>
\nPlease download and extract it to the proper location on your machine.<\/p>\n

Get Cocos2d-x and GREE Platform SDK for Cocos2d-x<\/span><\/h4>\n

Now that you've finished setting up the basic environment for developing a cocos2dx application, its time to start building it. Get GREE Platform SDK for Cocos2d-x.<\/p>\n

\n$git clone https:\/\/github.com\/gree\/GreePlatformSDKCocos2dx.git\n$cd GreePlatformSDKCocos2dx    # top of the cloned directory\n$.\/setup.sh<\/pre>\n
setup.sh downloads cocos2dx source code and adds GREE Platform SDK for Cocos2d-x code to it. It also provides a sample application which connects to the GREE Platform.<\/p>\n
Create a cocos2dx project<\/span><\/h4>\n
\n$cd cocos2dx-2.0-x-x.x.x<\/pre>\n
Normally you would create a cocos2dx application project with create-android-project.sh. With this binding however, we shall use create-android-gree-project.sh to create a cocos2dx application that connects to the GREE Platform. create-android-gree-project.sh requires both Android NDK and Android SDK, so you need specify their paths for the script to execute properly. You can directly modify create-android-gree-project.sh, or set their paths as as environmental variables.<\/p>\n
\n$export NDK_ROOT=\/home\/hoge\/xxxx; export ANDROID_SDK_ROOT=\/home\/hoge\/....; .\/create-android-gree-project.sh<\/pre>\n
You will get a couple of prompts. Please provide values for the fields requested.
\n\"Name of package\"
\n\"API version your app support\"
\n\"Project name of your app\"<\/p>\n
\nuse global definition of NDK_ROOT: \/Users\/hoge\/Work\/android-ndk-r8b\/\nuse global definition of ANDROID_SDK_ROOT: \/Users\/hoge\/Work\/android-sdk-macosx\/\nInput package path. For example: org.cocos2dx.example\norg.cocos2dx.greetest\nNow cocos2d-x supports Android 2.2 or upper version\nAvailable Android targets:\n----------\nid: 1 or \"android-12\"\nName: Android 3.1\nType: Platform\nAPI level: 12\nRevision: 3\nSkins: WXGA (default)\nABIs : armeabi\n----------\n. . .\n----------\ninput target id:\n1\ninput your project name:\ngreetest\nCreated project directory: \/Users\/hoge\/Work\/GreePlatformSDKCocos2dx\/cocos2d-2.0-x-2.0.4\/greetest\/proj.android\n. . .\nResolved location of library project to: \/Users\/hoge\/Work\/GreePlatformSDKCocos2dx\/cocos2d-2.0-x-2.0.4\/cocos2dx\/platform\/android\/java\nUpdated project.properties\nUpdated local.properties\nUpdated file \/Users\/hoge\/Work\/GreePlatformSDKCocos2dx\/cocos2d-2.0-x-2.0.4\/greetest\/proj.android\/proguard-project.txt<\/pre>\n
Now you have a cocos2dx sample application that connects to the GREE Platform.
\n\"\"<\/a><\/p>\n
Build the project<\/span><\/h4>\n
 Add the project<\/h5>\n
Launch Eclipse, and add the created project and cocos2dx java files.
\nFile -> New -> Others
\n\"\"<\/a><\/p>\n
Select Android -> Android Project from Existing Code.
\n\"\"<\/a><\/p>\n
Select the \"proc.android\" directory of the created project.
\n\"\"<\/a><\/p>\n
Select the \".\/cocos2dx\/platform\/android\/java\" directory under cocos2dx source code.
\n\"\"<\/a><\/p>\n
 Project Setup<\/h5>\n
From the project explorer window, choose \"java\" project and select Properties. Set GreeSDK as reference library.
\n\"\"<\/a>
\n\"\"<\/a><\/p>\n
Now you should have no errors with java. Next, you have to configure the build environment for native code.<\/p>\n
 Configure the build environment for native code<\/h5>\n
(You can skip this step if you are going to build native code with the command line)
\nTo build native code on Eclipse, you have to install CDT for Eclipse.
\nSelect Help -> Install New Software.... from the main menu, and select http:\/\/download.eclipse.org\/releases\/xxxxx, check \"C\/C++ Development Tools\", and install it.
\n\"\"<\/a><\/p>\n
Select File -> New -> Others and select C\/C++ -> Convert to a C\/C++ Project (Adds C\/C++ Nature)
\n\"\"<\/a><\/p>\n
Check the project you created, and select the Makefile project from the Project type window.
\n\"\"<\/a><\/p>\n
From the Project Explorer window, select your project -> Properties.
\nSelect C\/C++Build -> Environment and add NDK_ROOT environment variable.
\n\"\"<\/a><\/p>\n
Select C\/C++Build, uncheck Use default build command and set \"bash < path of the build_native.sh on your machine >\"
\n\"\"<\/a><\/p>\n
The steps above need to be done only once for each project.<\/p>\n
Now, you can build your native code with the button below.
\n\"\"<\/a><\/p>\n
 Set information required for GREE Platform<\/h5>\n
Set your Application Id, Consumer Key, and Consumer Secret in res\/xml\/gree_platform_configuration.xml.<\/p>\n
\n    xxxxx\n    xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx<\/consumerKey>\n    xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx<\/consumerSecret><\/pre>\n
Also replace \"xxxxx\" in AndroidManifest.xml with your Application Id.<\/p>\n
\n    \n    <\/pre>\n
These steps are the same as the steps performed when creating an android application for the GREE platform.<\/p>\n
 Launch Application<\/h5>\n
Your are now ready to run the application. It should show up like this:
\n\"\"<\/a><\/p>\n
You can log in to GREE Platform by clicking on the icon in the top right corner.
\n\"\"<\/a><\/p>\n
The default sample app, \"GreeBasicSample\", includes Authorizer, Dashboard, User, Friends, Payment, Achievement, Leaderboard APIs.
\n\"\"<\/a><\/p>\n
How to use each API<\/span><\/h4>\n
General<\/h5>\n
To use GREE Platform SDK extensions,<\/p>\n
\n#include \"cocos-gree-ext.h\"\nUSING_NS_CC_GREE_EXT;\n....<\/pre>\n
Callbacks<\/h5>\n
GREE Platform SDK uses callbacks for several APIs.  To implement them, please inherit CCGreePlatformDelegate class. In the default sample:<\/p>\n
\nclass Helloworld : public cocos2dx::gree_extension::CCGreePlatformDelegate {<\/pre>\n
Next, call the setDelegatexxxx method,  and implement callback method to be called.
\nIf you'd like to catch authorizeAuthorized, authorizeError, and authorizeCancel callbacks of the Authorizer APIs -- authorizeAuthorized, authorizeCancel, authorizeError --.  please override them in HelloWorld.h.<\/p>\n
\nvirtual void authorizeAuthorized();\nvirtual void authorizeError();\nvirtual void authorizeCancel();<\/pre>\n
If you don't need to handle a specific callback, you don't have to implement it. (for example, it is okay to leave the authorizeCancel method without implementing it, if you don't need to catch the cancel callback)<\/p>\n
In HelloWorld.cpp:<\/p>\n
\n\nxxxxx {\n    CCGreePlatform::setAuthorizerDelegate(this);\n}\n\nvoid HelloWorld::authorizeAuthorized(){\n}\nvoid HelloWorld::authorizeError(){\n}<\/pre>\n
The available callbacks are shown in the corresponding CCGreeXXXXDelegate class in each CCGreeXXXX.h file.  For example, if you'd like to get loadThumbnail callback, the prototype of the method is:<\/p>\n
\nvirtual void loadThumbnailSuccess(CCGreeUser *user, CCImge *img)<\/pre>\n
This callback returns thumbnail data as a CCImage. You can use it for example in the following way:<\/p>\n
\n    CCTexture2D *tex = CCTextureCache::sharedTextureCache()->addUIImage(img, \"key_name\");\n    CCSprite *icon = CCSptite::spriteWithTexture(tex);<\/pre>\n
You can do anything with it as you could with a sprite; draw, move, scale and so on.
\nNote: Callbacks don't run on the UI thread, so you cannot perform draws in callbacks.<\/strong><\/p>\n
Authorizer API<\/h5>\n
The basic usage of the Authorizer API is:<\/p>\n
\nxxxxx{\nCCGreePlatform::setAuthorizerDelegate(this);\n    if(CCGreeAuthorizer::isAuthorized() != true){\n        CCGreeAuthorizer::authorize();\n    }\n}\n\n\/\/To get Callbacks\nvoid HelloWorld::authorizeAuthorized(){\n}\nvoid HelloWorld::authorizeError(){\n}\nvoid HelloWorld::authorizeCancel(){\n}<\/pre>\n
If you'd like to log out, call the logout method:<\/p>\n
\nxxxxx{\n    CCGreeAuthorizer::logout();\n}\n\n\/\/ To get Callbacks\nvoid HelloWorld::logoutLogouted(){\n}\nvoid HelloWorld::logoutError(){\n}\nvoid HelloWorld::logoutCancel(){\n}<\/pre>\n
\"\"<\/a><\/p>\n
You can also get Authorizer related information.<\/p>\n
\nCCString *token = CCGreeAuthorizer::getOAuthAccessToken();\nCCString *secret = CCGreeAuthorizer::getOAuthAccessTokenSecret();<\/pre>\n
Currently supported APIs are:<\/p>\n
\nclass CCGreeAuthorizer\n{\n    public:\n        static void authorize();  \/\/ async\n        static void authorize(int user_grade); \/\/ async\n        static bool isAuthorized();\n        static bool hasOAuthAccessToken();\n        static CCString *getOAuthAccessToken();\n        static CCString *getOAuthAccessTokenSecret();\n\n        static void logout(); \/\/ async\n}<\/pre>\n
User and Friend APIs<\/h5>\n
With User and Friend APIs, you can get user information (e.g. name, age, gender and so on) of users,  as well their friends' information.
\nTo get login user information:<\/p>\n
\n     CCGreeUser *user = CCGreePlatform::getLocalUser();\n     CCString *nickName = user->getNickname();\n     CCString *dispName = user->getDisplayName();\n     CCString *id = user->getId();\n     CCString *region = user->getRegion();\n     CCString *subRegion = user->getSubregion();\n     CCString *lang = user->getLanguage();\n     CCString *timeZone = user->getTimezone();\n     CCString *me = user->getAboutMe();\n     CCString *birthDay = user->getBirthday();\n     CCString *gender = user->getGender();\n     CCString *age = user->getAge();\n     CCString *blood = user->getBloodType();\n     bool hasApp = user->getHasApp();\n     CCString *hash = user->getUserHash();\n     CCString *type = user->getUserType();\n     int grade = user->getUserGrade();<\/pre>\n
To load the user's avatar thumbnail:<\/p>\n
\n    user->loadThumbnail(THUMBNAIL_SIZE_HUGE); \/\/ you can specify the size of the thumbnail to be downloaded.\n\n\/\/Refer to the information regarding thumbnail callbacks to handle the response.<\/pre>\n
To get a list of friends:<\/p>\n
\n    user->loadFriends(1, 10); \/\/first argument specifies the startIndex, second argument specifies the number of friends to load.\n\n\/\/ Callbacks for loadFriends\nvoid HelloWorld::loadFriendsSuccess(CCGreeUser *user, int index, int count, CCArray *userArray){\n}\nvoid HelloWorld::loadFriendsFailure(CCGreeUser *user, int responseCode, CCString *response){\n}\n\/\/ Friends information retrieved will be stored in a CCArray which can be easily iterated over.<\/pre>\n
\"\"<\/a><\/p>\n
Currently supported APIs are:<\/p>\n
\nclass CC_DLL CCGreeUser : public CCObject\n{\n    public:\n        CCString *getNickname();\n        CCString *getDisplayName();\n        CCString *getId();\n        CCString *getRegion();\n        CCString *getSubregion();\n        CCString *getLanguage();\n        CCString *getTimezone();\n        CCString *getAboutMe();\n        CCString *getBirthday();\n        CCString *getGender();\n        CCString *getAge();\n        CCString *getBloodType();\n        bool      getHasApp();\n        CCString *getUserHash();\n        CCString *getUserType();\n        int getUserGrade();\n\n        bool     loadThumbnail(int size);  \/\/ async\n        void     loadFriends(int offset, int count); \/\/ async\n        void     loadIgnoredUserIds(int offset, int count); \/\/async\n        void     isIgnoringUserWithId(CCString *pid); \/\/async\n}<\/pre>\n
Payment APIs<\/h5>\n
You can create Payment items and submit Payment requests. To submit a Payment request, you have to create Payment Items first, and specify them in the request.<\/p>\n
\n    CCGreePaymentItem *item1 = CCGreePaymentItem::create(\"01234\", \"TestItem1\", 100, 20);\n    CCGreePaymentItem *item2 = CCGreePaymentItem::create(\"56789\", \"TestItem2\", 200, 30);\n    \/\/ arg1 : itemId, arg2 : itemName, arg3 : unitPrice, arg4 : quantity\n\n    CCArray *itemArray = new CCArray();\n    itemArray->addObject(item1);\n    itemArray->addObject(item2);\n\n    \/\/ to enable callbacks\n    CCGreePlatform::setPaymentDelegate(this);\n\n    CCGreePayment *pay = CCGreePayment::create(\"Payment Test\", itemArray);\n    \/\/ arg1 : message to be displayed on payment screen\n\n    pay->request();\n}\n\n\/\/ Callbacks\nvoid HelloWorld::paymentRequestSuccess(CCGreePayment *payment, int responseCode, CCString* paymentId){\n}\nvoid HelloWorld::paymentRequestCancel(CCGreePayment *payment, int responseCode, CCString* paymentId){\n}\nvoid HelloWorld::paymentRequestFailure(CCGreePayment *payment, int responseCode, CCString *paymentId, CCString *response){\n}<\/pre>\n
\"\"<\/a><\/p>\n
Implement callback methods as required.<\/p>\n
Currently supported APIs are:<\/p>\n
\nclass CCGreePaymentItem : public CCObject\n{\n        public:\n                void setImageUrl(const char *url);\n                void setDescription(const char *desc);\n                CCString *getItemId();\n                CCString *getItemName();\n                double getUnitPrice();\n                int getQuantity();\n                CCString *getImageUrl();\n                CCString *getDescription();\n}\n\nclass CCGreePayment\n{\n        public:\n                void request();  \/\/ async\n\n                void setCallbackUrl(const char *url);\n                void verify(const char *paymentId);  \/\/ async\n}<\/pre>\n
Achievement APIs<\/h5>\n
You can load a list of Achievements:<\/p>\n
\n    \/\/ to get callback\n    CCGreePlatform::setAchievementDelegate(this);\n\n    CCGreeAchievement::loadAchievements(1, 10);\n    \/\/ arg1 : start index to be loaded, arg2 : the number of the list to be loaded<\/pre>\n
Get the achievement list by implementing the success callback.
\nAs with the friends list, achievement items retrieved are stored in a CCArray.<\/p>\n
\nvoid HelloWorld::loadAchievementsSuccess(int index, int count, CCArray *elementArray)\n{\n     CCObject *it;\n        CCARRAY_FOREACH(elementArray, it){\n            CCGreeAchievement *element = dynamic_cast(it);\n        }\n    }\n}<\/pre>\n
You can lock\/unlock the achievements:<\/p>\n
\n    if(element->isUnlocked() == true){\n        element->lock();\n    }else{\n        element->unlock();\n    }<\/pre>\n
And get the corresponding lock\/unlock icon as a CCImage:<\/p>\n
\n    CCImage* icon = element->getIcon();<\/pre>\n
Currently supported APIs are:<\/p>\n
\nclass CCGreeAchievement : public CCObject\n{\n        public:\n                static void loadAchievements(int index, int count);\n\n                CCString *getId();\n                CCString *getName();\n                CCString *getDescription();\n                int getScore();\n                bool isUnlocked();\n                bool isSecret();\n                bool loadThumbnail();  \/\/ async\n                CCImage *getIcon();\n\n                void unlock();  \/\/ async\n                void lock();   \/\/ async\n}\n<\/pre>\n
\"\"<\/a><\/p>\n
Dashboard API<\/h5>\n
To launch Dashboard, simply use:<\/p>\n
\n    CCGreeDashboard::launch()\n    CCGreeDashboard::launch(int type, CCDictionary *params)<\/pre>\n
\"\"<\/a><\/p>\n
Leaderboard API<\/h5>\n
You can load the Leaderboard list, and get information on each item in the list:<\/p>\n
\n{\n    \/\/Load Leaderboard\n    CCGreePlatform::setLeaderboardDelegate(this);\n    CCGreeLeaderboard::loadLeaderboards(1, 10);\n}\n\/\/callback\nvoid HelloWorld::loadLeaderboardsSuccess(int index, int count, CCArray *leaderboardArray){\nCCGreeLeaderboard *board = dynamic_cast(leaderboardArray->objectAtIndex(1));\nCCString *id = board->getId();\nCCString *name = board->getName();\nCCString *url = board->getThumbnailUrl();\n}<\/pre>\n
Also you can set the score for each leaderboard you loaded:<\/p>\n
\n    board->createScore(10000);<\/pre>\n
\"\"<\/a><\/p>\n
 Dialogs(InviteDialog, RequestDialog, ShareDialog)<\/h5>\n
You can create and display dialogs with this library.  Below is an example that shows how to display an InviteDialog. Pass parameters as CCDictionary, as how you would do normally with cocos2dx.<\/p>\n
\n    CCGreeInviteDialog *dialog = CCGreeInviteDialog::create();\n    CCDictionary *dict = CCDictionary::create();\n    dict->setObject(new CCString(xxxxxxxxxx), GD_INVITE_DIALOG_PARAM_KEY_TOUSERID);\n    dict->setObject(new CCString(xxxxxxxxxx), GD_INVITE_DIALOG_PARAM_KEY_BODY);\n    dialog->setParams(dict);\n    dialog->show();<\/pre>\n
\"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Hi everyone, I'm kazuma from GREE. I have a strong interest in cross-platform development tools that allow dev […]<\/p>\n","protected":false},"author":42,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[9],"tags":[171],"class_list":["post-6846","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-info","tag-info"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/posts\/6846","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/users\/42"}],"replies":[{"embeddable":true,"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/comments?post=6846"}],"version-history":[{"count":3,"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/posts\/6846\/revisions"}],"predecessor-version":[{"id":21170,"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/posts\/6846\/revisions\/21170"}],"wp:attachment":[{"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/media?parent=6846"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/categories?post=6846"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/labs.gree.jp\/blog\/wp-json\/wp\/v2\/tags?post=6846"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}