B4A Library Google Play Game Services

First off, my apologies on my Wrapping Skill, this is no where near as polished as from the big boys of wrapping here. Also, many thanks to Erel for helping me get through this.

The story: I need this library, and it is working for me. If you know what it is, and have been waiting for it, hopefully my tutorial will help you get going with it. If you don't know what this library does, or if you need it, check out here

Right now, this library can handle Leaderboards, Achievements, Room Creation/Communication (have not done RealTimeSocket yet), One-Click signIn, and Anti-Piracy Checks. Did not implement Cloud Save.

Still interested? Read on.

First, please review Google's branding guidelines, as there is no way I can keep that up to date on this thread. Here

Next, I recommend just studying the flow of events here particularly the Developer's Guide section.

Still awake? Good.

Before any of this works, you need to register your app within your Developer Account, to get the OAuth necessary. The Google/Java speak instructions are in that developer's guide.

For B4A speak. Must do the following:

1. Follow these directions for adding your app to the console here.

** EDIT - See Erel's post below on how to grab SHA1 fingerprint straight from B4A... **

When you get to the part about adding your SHA1 fingerprint, it's time to break out your command prompt. (If you already know how to get your SHA1 fingerprint, then continue on) First, find out where (or make a new) password file for B4A is kept by looking at your B4A->Tools->Private Sign Key.

Then in your command prompt, change to the directory with keytool in it (for me that is "c:\Program Files\Java\jre6\bin") and type
B4X:
keytool -exportcert -keystore <path-to-debug-or-production-keystore> -list -v
which for me would be
B4X:
keytool -exportcert -keystore C:\Programming\b4a.keystore -list -v
A prompt asking for your password should then pop up. Type your password in that you used to create it(shown on your B4A->Private Sign Key window)

Then, enter that SHA1 fingerprint (type it, copy paste it... I copy the whole command prompt to notepad, and then copy/paste it from there) into the final OAUTH Step and you should get back that your app is linked.
Note the code back will look something like this -> 211205627476-74off6bsgue1qbcka2878p3lurctabft.apps.googleusercontent.com ONLY THE FIRST PART BEFORE THE HASH IS YOUR APP_ID FOR USE IN THE XML FILE

2. Create your new B4A project and include this in your manifest:
AddApplicationText(
<meta-data android:name="com.google.android.gms.games.APP_ID"
android:value="@string/app_id" />
)

3. Create an XML file in your B4A (using your favorite text editor) project called ids.xml in your projectdirectory-> Objects -> res -> values folder, and put something like this in it
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (C) 2013 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<resources>
<!-- TODO: Replace this by your app's app ID! -->
<string name="app_id">ReplaceME</string>
</resources>

Put your AppID obtained from before in the ReplaceMe section and then make sure to set the file to read only (just edit the file included in the sample app)

4. Now it is time for the achievements/leaderboard ID's Need to do that here and here

In the sample app created I use two leaderboards (easy and hard) and four achievements (put in five if you need to continue in your Developer account, but not required to use them all) the four achievements are:
B4X:
Dim easyLeaderboard As String = "ReplaceMe"
Dim hardLeaderboard As String = "ReplaceMe"
Dim EasyAchievement As String = "ReplaceMe" 'for playing a game of easy level
Dim HardAchievement As String = "ReplaceMe" 'for playing a game of hard leve
Dim IncrementAchievement As String = "ReplaceMe" 'for playing 10 games (either hard or easy)
Dim HiddenAchievement As String = "ReplaceMe" 'not visibile until hard and easy games played

Follow these directions, but use these sample Achievements and Leaderboards for the sample application and fill in with your own pithy comments, and Replace the ReplaceMe's for each one in the sample app **Note the IncrementAchivement is of type increment and I used 10 as the amount. The HiddenAchivement is of type Hidden, and you can see in the code how I went about unlocking it**

5. Now time for a choice, either download the attached xml/jar files that go in your library, or (advanced mode) download and compile the attached project source files. Either way, must have gameplayservices.jar, gameplayservices.xml (which are the library wrappers) installed in your Libraries folder and then have gameplayservices selected in B4A. Also, I am a big fan of having a bit of something in my demos, so you will also need Informatix' most excellent AnimationPlus library installed (do search for latest link) and Agraham's superbly efficient ByteConverter library (again, do search).

6. Not sure why, but in order to get the required dependency file "googleplayservices.jar" You must follow the directions here to download the SDK. Then, grab that file and put it in your library. (the file itself is a bit above the limit for me to include here, and I'm not sure about the legal ramifications of including it by itself after reading here) If anybody can tell me otherwise, I'll post it someplace else for easier access to download.

7. Three modules are included in the sample app. The main module is just the basics of logging in (once you get past that, then it's time for the other two) and displaying the SignIn button. The other two modules are my own take on the Type A Number and Button Clicker sample apps (no typing of numbers in my version, but I do add displaying player icons, more robust message passing)

8. Logic/documentation. As I said, trying to figure out how to wrap all of this was a very good challenge/learning process for me. As some of these wrappers included nested classes, and I didn't know exactly how to approach, I made the nested classes separate classes for exposing to B4A. What does that mean? Well, some of the things that happen "behind the scenes" in the original library, I had to make a choice on where they happen in my wrapper. I finally decided that almost anything to do with Room Stuff, happens in the gRoomConfig wrapper (As opposed to RoomConfig, Room and GamesClient in original flow). My samples show a lot of what was wrapped, but if you have a question about a function, and you go to look for more detail on Google's developer site, Where that function is exposed may be different in this library, and sometimes not at all. (If not exposed, it is generally something I didn't see how to write a wrapper for that functionality, at least not yet, but again... it's working for me with a lot of what I wanted to accomplish) I am also including all of the source files, which may help out for those looking to try and learn how to wrap things in the future. Please forgive my poor coding logic in advance. Also, some things are exposed that don't do anything (at least not for me) and are there to show where I think they should be exposed moving forward (most notably the RealTimeSocket stuff), but they are annotated with the hint system as not being ready for prime time!

Of note, many, many listeners in this, and I did include code in the Java to explain many of them, but I don't see how to bring up those hints when using the "Sub "space-Tab" auto-fill" feature.

9. Going forward - I am sure I will be updating some things as I go along, but I don't know at what pace, and who knows, maybe RTS's are really, really important to someone, or the ability to do cloud saving. So, I also am including the source files that I used to wrap. While a learning tool in and of themselves, I do ask, that if you add any functionality, that you pass those additions back to the community. I think we all benefit from using these libraries that others create, and let's face it, sometimes having that 1 library wrapped makes all the difference.. and until Erel figures out how to auto-wrap any library out there... some of us come to a halt going down certain paths unless someone out there can help boot strap our project. (which is why I started this in the first place :) ) Also, please note you'll probably see some ("why is THAT there") in the source code, and it's because I learned a LOT doing this, and changed how some implementations worked as I kept building wrapper classes. I would do it all from scratch to make it cleaner... but I need to get going on the projects that I built this for!
 

Attachments

  • GoogleGameServiceSampleApp.zip
    20.5 KB · Views: 449
  • GamePlayServicesLibraryFiles.zip
    56.3 KB · Views: 535
  • EclipseSourceFiles.zip
    87.6 KB · Views: 372
Last edited:

Computersmith64

Well-Known Member
Licensed User
Longtime User
Ok, I'm going to check that. Thanks for the report.

OK - thanks. While you're at it, I just found another issue. When checking the state of an achievement you need to use getState() & then compare it to one one of the state constants. I can see that getState() is in AchievementWrapper.java, but for some reason it's not exposed in the method list in the GPlayAchievement object - so I can't access it in my code.

- Colin.
 

Informatix

Expert
Licensed User
Longtime User
OK - thanks. While you're at it, I just found another issue. When checking the state of an achievement you need to use getState() & then compare it to one one of the state constants. I can see that getState() is in AchievementWrapper.java, but for some reason it's not exposed in the method list in the GPlayAchievement object - so I can't access it in my code.

- Colin.
I didn't wrap getState for now (once done, it will appear as the State property in the class).
I don't know how you can see it in AchievementWrapper.java...
 

Computersmith64

Well-Known Member
Licensed User
Longtime User
I didn't wrap getState for now (once done, it will appear as the State property in the class).
I don't know how you can see it in AchievementWrapper.java...

Oh yeah, I was looking in the wrong library... oops! OK - so until the state is available, I won't be able to test any more on Achievements because you need to know the state of an achievement to be able to process it correctly. Everything else (login, leaderboards, score submission, viewing achievements) is looking good though.

Thanks - Colin.
 

Informatix

Expert
Licensed User
Longtime User
Hi Informatix,

So following your steps, I'm getting the following error on the GC.CreateRoom(Config) line (I've included the debug messages from the library leading up to the error):



Maybe it doesn't like the Null being passed in the InitializeWithAutoMatch?

- Colin.
I copied/pasted the code given in the post #38 and I had no problem to create a room. The second device connected to the room without any issue. Here's the log of events (I removed the end of some lines) after the creation of an automatch:

device 1:
RoomCfg_InitializeWithAutoMatch: Bundle[{max_automatch_players=1, min_automatch_players=1, exclusive_bit_mask=0}]
CreateRoom: flm.b4a.googleplay.RoomConfigWrapper@41f55b30
onRoomCreated: 0 room=...

device 2:
RoomCfg_InitializeWithAutoMatch: Bundle[{max_automatch_players=1, min_automatch_players=1, exclusive_bit_mask=0}]
CreateRoom: flm.b4a.googleplay.RoomConfigWrapper@40554550
onRoomCreated: 0 room=...
onPeerJoined: RoomEntity{...
onRoomConnecting: RoomEntity{...
onP2PDisconnected: p_CO6kwornqPq70QEQAQ
onPeersDisconnected: RoomEntity{...

I cannot say whether the last two events are normal or not (they appeared after a few seconds).
 

Informatix

Expert
Licensed User
Longtime User
Oh yeah, I was looking in the wrong library... oops! OK - so until the state is available, I won't be able to test any more on Achievements because you need to know the state of an achievement to be able to process it correctly. Everything else (login, leaderboards, score submission, viewing achievements) is looking good though.

Thanks - Colin.
That means it will be missing for me too. Ok, I will post a new Alpha version soon.
 

Computersmith64

Well-Known Member
Licensed User
Longtime User
I copied/pasted the code given in the post #38 and I had no problem to create a room. The second device connected to the room without any issue. Here's the log of events (I removed the end of some lines) after the creation of an automatch:

device 1:
RoomCfg_InitializeWithAutoMatch: Bundle[{max_automatch_players=1, min_automatch_players=1, exclusive_bit_mask=0}]
CreateRoom: flm.b4a.googleplay.RoomConfigWrapper@41f55b30
onRoomCreated: 0 room=...

device 2:
RoomCfg_InitializeWithAutoMatch: Bundle[{max_automatch_players=1, min_automatch_players=1, exclusive_bit_mask=0}]
CreateRoom: flm.b4a.googleplay.RoomConfigWrapper@40554550
onRoomCreated: 0 room=...
onPeerJoined: RoomEntity{...
onRoomConnecting: RoomEntity{...
onP2PDisconnected: p_CO6kwornqPq70QEQAQ
onPeersDisconnected: RoomEntity{...

I cannot say whether the last two events are normal or not (they appeared after a few seconds).

OK - I see the problem now. I was using GPlayGamesClient.CreateRoom & you were using GPlayConnection.GamesClient.CreateRoom...
 

Informatix

Expert
Licensed User
Longtime User
OK - I see the problem now. I was using GPlayGamesClient.CreateRoom & you were using GPlayConnection.GamesClient.CreateRoom...
I use also the GPlayGamesClient but I initialized it in GPC_onSignInSucceeded with "GC = GPC.GamesClient".

After connecting to a room, you have to do that in "onRoomCreated" or the process will fail (that's why I had the disconnected events the first time):
Dim i As Intent = GC.GetRealTimeWaitingRoomIntent(Room, MIN_PLAYERS)
GC.StartActivityForResult(i, "WaitingRoom")
 

Computersmith64

Well-Known Member
Licensed User
Longtime User
I use also the GPlayGamesClient but I initialized it in GPC_onSignInSucceeded with "GC = GPC.GamesClient".

After connecting to a room, you have to do that in "onRoomCreated" or the process will fail (that's why I had the disconnected events the first time):
Dim i As Intent = GC.GetRealTimeWaitingRoomIntent(Room, MIN_PLAYERS)
GC.StartActivityForResult(i, "WaitingRoom")

Haha! Yeah, while you were writing your reply above, I realized that my GPlayGamesClient wasn't initialized (because there is no initializer so I had left it since I hadn't needed to use it up to this point), so I did a "GGS = GPC.GamesClient" (mine is named GGS - a hangover from the old library) & it worked fine doing the call the same way as you... I haven't implemented the waitingroom yet, but will do so now.
 

Computersmith64

Well-Known Member
Licensed User
Longtime User
Haha! Yeah, while you were writing your reply above, I realized that my GPlayGamesClient wasn't initialized (because there is no initializer so I had left it since I hadn't needed to use it up to this point), so I did a "GGS = GPC.GamesClient" (mine is named GGS - a hangover from the old library) & it worked fine doing the call the same way as you... I haven't implemented the waitingroom yet, but will do so now.

Hmmm - onRoomCreated is returning null for the Room. Did you get a room returned in your test? (I can't tell from the logs you pasted because the lines were truncated).
 

Informatix

Expert
Licensed User
Longtime User
Since I tested the real-time, I'm unable to sign-in in my app with one of my accounts. I get "RESULT_APP_MISCONFIGURED, Unable to sign in - application does not have a registered client ID". Despite this message, the bug is on the Google side (my app is properly configured as I can test it and start matches with another account). I don't know how to get my account back in function. I tried all the 'fixes' found on Internet, to no avail.

Edit: some progress... I can now use this account on one of my devices, not on the other. But it's still a complete mystery...

Edit: I removed Google+ from the device and my account works again !
 
Last edited:

Computersmith64

Well-Known Member
Licensed User
Longtime User
STATUS_OPERATION_IN_FLIGHT
Trying to start a join/create operation while another is already in flight.

Seems to alternate between 7007 & 7000 (STATUS_REAL_TIME_CONNECTION_FAILED) - Failed to initialize the network connection for a real-time room.

Dunno...
 

Computersmith64

Well-Known Member
Licensed User
Longtime User
Since I tested the real-time, I'm unable to sign-in in my app with one of my accounts. I get "RESULT_APP_MISCONFIGURED, Unable to sign in - application does not have a registered client ID". Despite this message, the bug is on the Google side (my app is properly configured as I can test it and start matches with another account). I don't know how to get my account back in function. I tried all the 'fixes' found on Internet, to no avail.

Edit: some progress... I can now use this account on one of my devices, not on the other. But it's still a complete mystery...

Edit: I removed Google+ from the device and my account works again !

Yeah - I've seen posts on the internet about this issue, but never experienced it myself.
 

Informatix

Expert
Licensed User
Longtime User
Here's the Alpha 4 with a few functions added to Achievements. I finished GetRealTimeWaitingRoomIntent (you can now get the extra data with Room.WrapIntentExtra). I also improved some functions where I called two times the same method and fixed a problem with events that could be fired when the activity was in pause (they were lost).

[File deleted]
 
Last edited:

Computersmith64

Well-Known Member
Licensed User
Longtime User
It seems you have a problem with your connection to Internet. This error is "outside" the library.

Well I don't think it's an internet connection issue because all the other functions are working fine, plus I can get this functionality to work fine with the old library. I'll keep looking.
 
Top