https://github.com/maximnara/cordova-plugin-google-play-games
Google Play Games services for ionic and cordova apps
https://github.com/maximnara/cordova-plugin-google-play-games
Last synced: 4 months ago
JSON representation
Google Play Games services for ionic and cordova apps
- Host: GitHub
- URL: https://github.com/maximnara/cordova-plugin-google-play-games
- Owner: maximnara
- License: mit
- Created: 2022-04-27T21:56:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-17T18:40:11.000Z (almost 3 years ago)
- Last Synced: 2025-02-01T04:31:35.288Z (4 months ago)
- Language: Java
- Homepage:
- Size: 41 KB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Play Games services for Ionic and Cordova apps.
You can login, make game saves, have leaderboard and achievements.
## Demos:
- [Leaderboard Demo Video](https://drive.google.com/file/d/1F-UGff5QaxCH72_c7DEqMqIWonb221g-/view?usp=sharing)
- [Achievements Demo Video](https://drive.google.com/file/d/1Ey5ZkDWz-bduMlXoPr5NgKCwxy9VnVaK/view?usp=sharing)
- [Game Saves Demo Video](https://drive.google.com/file/d/1F0YhgkF81IvN3d_N2-ezjhxEJN8xy34X/view?usp=sharing)
--------
## Table of Contents
- [State of Development](#state-of-development)
- [Install](#install)
- [Usage](#usage)
## State of Development
- [x] 
- [x] 
- [x] 
- [x] 
- [x] 
- [x] 
- [x] 
- [ ] 
--------
## Install
```bash
npm i cordova-plugin-google-play-games --save
```
You should add few lines in AndroidManifest.xml (app/src/main/res/AndroidManifest.xml) in application tag
```
```
And in strings.xml (app/src/main/res/values/strings.xml):
```
999999999999
```
--------
## Usage
- [Sign In](#sign-in)
- [Achievements](#achievements)
- [Unlock achievement](#unlock-achievement)
- [Increment achievement](#increment-achievement)
- [Show achievements](#show-achievements)
- [Reveal achievement](#reveal-achievement)
- [Set steps in achievement](#set-steps-in-achievement)
- [Leaderboards](#leaderboards)
- [Update player score](#update-player-score)
- [Load player score](#load-player-score)
- [Show leaderboard](#show-leaderboard)
- [Show all leaderboards](#show-all-leaderboards)
- [Game Savings](#game-savings)
- [Save game](#save-game)
- [Load game save](#load-game-save)
- [Show saved games](#show-saved-games)
- [Saved Games Events](#saved-games-events)
- [Friends](#friends)
- [Get friend list](#get-friend-list)
- [Show another players profile](#show-another-players-profile)
- [Players](#players)
- [Player stats](#player-stats)
- [Player search](#player-search)
- [Get player](#get-player)
- [Events](#events)
- [Increment event](#increment-event)
- [Get all events](#get-all-events)
- [Get event by id](#get-event-by-id)
This library is Promise style, you can use .then or await to fetch results
### Sign In
```javascript
import * as GooglePlayGames from 'cordova-plugin-google-play-games';
let { id } = await GooglePlayGames.login(); // userId returned
```
***
### Achievements
#### Unlock achievement
```javascript
await GooglePlayGames.unlockAchievement({ id: 'your-id-from-google-play-console' });
```
#### Increment achievement
```javascript
await GooglePlayGames.incrementAchievement({ id: 'your-id', count: 1 }); // Count is how much increment achievement
```
#### Show achievements
This method is show native Google Games UI
```javascript
await GooglePlayGames.showAchievements();
```
#### Reveal achievement
Reveals a hidden achievement to the currently signed-in player. If the achievement has already been unlocked, this will have no effect.
```javascript
await GooglePlayGames.revealAchievement({ id: 'your-id-from-console' })
```
#### Set steps in achievement
Sets an achievement to have at least the given number of steps completed for current user. Calling this method while the achievement already has more steps than the provided value is a no-op. Once the achievement reaches the maximum number of steps, the achievement will automatically be unlocked, and any further mutation operations will be ignored.
```javascript
await GooglePlayGames.setStepsInAchievement({ id: 'your-id-from-console', count: 3 })
```
***
### Leaderboards
#### Update player score
This method updates player score in specified leaderboard
```javascript
await GooglePlayGames.updatePlayerScore({ id: 'your-leaderboard-id-from-google-play-console', score: 30 }); // Score you want to set
```
#### Load player score
```javascript
const { score } = await GooglePlayGames.loadPlayerScore({ id: 'your-leaderboard-id' });
```
#### Show leaderboard
This method is show native Google Games UI
```javascript
await GooglePlayGames.showLeaderboard({ id: 'your-leaderboard-id' });
```
#### Show all leaderboards
This method opens native window of all leaderboards list.
```javascript
await GooglePlayGames.showAllLeaderboards();
```
***
### Game Savings
#### Save game
```javascript
await GooglePlayGames.saveGame({
snapshotName: 'unique-id-this-for-save',
snapshotDescription: 'ANY NAME YOU WANT',
snapshotContents: { any: 'data', format: 'object' }
});
```
***
#### Load game save
```javascript
let data = await GooglePlayGames.loadGameSave({ snapshotName: 'unique-id-this-for-save' });
// Data will contain { any: 'data', format: 'object' }
```
***
#### Show saved games
This method is show native Google Games UI
```javascript
await GooglePlayGames.showSavedGames({
/**
* This is title for native UI window
*/
title: 'My saved games 777',
/**
* Whether or not to display a "create new snapshot" option.
* After clicking on add button event will be fired.
*/
allowAddButton: true,
/**
* Whether or not to provide a delete overflow menu option for each snapshot.
* After clicking on add button event will be fired.
*/
allowDelete: true,
/**
* The maximum number of snapshots to display in native UI
*/
maxSnapshots: 3,
});
```
#### Saved Games Events
All events called after user clicks some button from native Google Games UI.
Example: he can ask to create new game saving or set game progress to specified save id.
**Load Game Request**
User requested to set his progress on some specified save id.
```javascript
window.addEventListener("loadSavedGameRequest", async (event) => {
console.log('User requested to set his progress on save id: ', event.id)
});
```
**New Game Save Request**
User requested game to created new Saving. No data passed here.
```javascript
window.addEventListener("saveGameRequest", async () => {
});
```
**Save Game Conflict**
Some conflict happened when trying to save game.
I think this is not common used event, but think it should exist.
```javascript
window.addEventListener("saveGameConflict", async (event) => {
console.log('Conflicting id is: ', event.conflictId)
});
```
***
### Friends
#### Get friend list
This method will return array of users objects. Inside objects all available info.
Method can
```javascript
window.addEventListener("friendsListRequestSuccessful", async () => {
try {
let list = await GooglePlayGames.getFriendsList();
} catch (e) {
console.log('No resolution')
}
});
try {
let list = await GooglePlayGames.getFriendsList();
} catch (e) {
const ERROR_CODE_HAS_RESOLUTION = 1;
const ERROR_CODE_NO_RESOLUTION = 2;
if (e.code === ERROR_CODE_HAS_RESOLUTION) {
// That's all right, user will be asked for Friends permission
// After he give access event "friendsListRequestSuccessful" will be fired.
} else if (e.code === ERROR_CODE_NO_RESOLUTION) {
console.log('No resolution: ' + e.message);
}
}
```
```json
[
{
"id":"a_99999",
"name":"Maxim L.",
"title":"Летчик-ас",
"retrievedTimestamp":1658298688691,
// If you have idea how to deal with content:// URI you can use it
"bannerImageLandscapeUri":"content://com.google.android.gms.games.background/images/a19ec21b/1005",
"bannerImagePortraitUri":"content://com.google.android.gms.games.background/images/a19ec21b/1006",
"iconImageUri":"content://com.google.android.gms.games.background/images/a19ec21b/1003",
"hiResImageUri":"content://com.google.android.gms.games.background/images/a19ec21b/1004",
"levelInfo": {
"currentLevel":11,
"maxXp":90000,
"minXp":70000,
"hashCode":2300362
},
"friendStatus":4, // Have no idea what is that yet
// Use that to show user pic in ![]()
tag
"iconImageBase64":"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAA..."
}
]
```
***
#### Show another players profile
This method will show standard Play Games menu with user info.
```javascript
await GooglePlayGames.showAnotherPlayersProfile({ id: result[0].id });
```
***
### Players
#### Player stats
This method will resolve 6 available current player stats:
— Average session length: The average session length of the player in minutes. Session length is determined by the time that a player is signed in to Google Play Games services.
— Days since last played: The approximate number of days since the player last played.
— Number of purchases: The approximate number of in-app purchases for the player.
— Number of sessions: The approximate number of sessions of the player. Sessions are determined by the number of times that a player signs in to Google Play Games services.
— Session percentile: The approximation of sessions percentile for the player, given as a decimal value between 0 to 1 inclusive. This value indicates how many sessions the current player has played in comparison to the rest of this game's player base. Higher numbers indicate that this player has played more sessions.
— Spend percentile: The approximate spend percentile of the player, given as a decimal value between 0 to 1 inclusive. This value indicates how much the current player has spent in comparison to the rest of this game's player base. Higher numbers indicate that this player has spent more.
```javascript
let stats = await GooglePlayGames.getCurrentPlayerStats();
if (stats.daysSinceLastPlayed > 7) {
console.log("It's been longer than a week");
}
if (stats.numberOfSessions > 1000) {
console.log("Veteran player");
}
if (stats.numberOfPurchases == 0) {
console.log("Show user special offer");
}
```
***
#### Player search
This method opens native window with player search. When user clicks on player he found player profile will be opened.
```javascript
await GooglePlayGames.showPlayerSearch();
```
#### Get player
This method returns player object.
```javascript
let player = await GooglePlayGames.getPlayer({ id: 'id-from-other-methods' });
```
This is demo of object will be returned:
```json
{
"id":"a_108",
"name":"luzhkov.max",
"title":"Newbie",
"retrievedTimestamp":1658301492400,
"bannerImageLandscapeUri":"content://com.google.android.gms.games.background/images/a19ec21b/1001",
"bannerImagePortraitUri":"content://com.google.android.gms.games.background/images/a19ec21b/1002",
"iconImageUri":"content://com.google.android.gms.games.background/images/a19ec21b/1000",
"hiResImageUri":"content://com.google.android.gms.games.background/images/a19ec21b/6",
"levelInfo": {
"currentLevel":1,
"maxXp":1000,
"minXp":0,
"hashCode":31752
},
"iconImageBase64":"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAX..."
}
```
***
### Events
Events it is basically place where you can store some data about user: balance, level and something like this.
#### Increment event
Value should be more than 0. Increment raw integer, money or time here.
```javascript
await GooglePlayGames.incrementEvent({ id: 'id-from-play-console', amount: 10 })
```
#### Get all events
```javascript
// Returns array of objects here, what inside object check below
let events = await GooglePlayGames.getAllEvents();
```
#### Get event by id
```javascript
let event = await GooglePlayGames.getEvent({ id: 'id-from-play-console' });
```
```json
{
"id":"id-from-play-console", // Id by what you can identify events in your app
"name":"Test event",
"value":1012, // This is amount you increment on previous step
"player": { // Some info about player you can use instantly
"id":"a_108",
"name":"luzhkov.max",
"title":"Newbie",
"retrievedTimestamp":1658301492400,
"bannerImageLandscapeUri":"content://com.google.android.gms.games.background/images/a19ec21b/1001",
"bannerImagePortraitUri":"content://com.google.android.gms.games.background/images/a19ec21b/1002",
"iconImageUri":"content://com.google.android.gms.games.background/images/a19ec21b/1000",
"hiResImageUri":"content://com.google.android.gms.games.background/images/a19ec21b/6",
"levelInfo": {
"currentLevel":1,
"maxXp":1000,
"minXp":0,
"hashCode":31752
},
"iconImageBase64":"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAX..."
}
}
```
### Feel free to make your PRs for code structure or new functions or text me in Telegram @luzhkov