Meet react-native-game-center
React Native Game Center
hire me!
Contents
Getting Started
- Install
react-native
first
npm i react-native -greact-native init myAppcd myAppyarn add react-native-game-centerreact-native linkreact-native run-ios
Basic Usage
- In your
index.js
, use:
import RNGameCenter from "react-native-game-center"
Installation
- From project root
yarn add react-native-game-centerreact-native linkreact-native run-ios
then Follow setup Instructions
Set Up
See SETUP.md
Example
or clone the repo and play with the example project
$ git clone https://github.com/garrettmac/react-native-game-center$ cd react-native-game-center/GameCenterExample$ yarn install$ npm start
Init Method
init() <Promise?>
Details
Initiates your app with Game Center.
Add this to the top of your app before your AppRegister
.
ITUNES CONNECT APP DASHBOARD
https://itunesconnect.apple.com/WebObjects/iTunesConnect.woa/ra/ng/app
Then
SELECT APP > Feature > Game Center
Parameters
Name | Required | Default | Description |
---|---|---|---|
leaderboardIdentifier | Yes | undefined |
Your apps default leaderboard Identifier. You can can several of these but at least one is required. |
achievementIdentifier | No | undefined |
Your apps default achievement Identifier. Not required. Set this to avoid having to keep passing it in. |
Usage
Basic
const leaderboardIdentifier="high_scores" GameCenter
Advanced
const leaderboardIdentifier="high_scores"const achievementIdentifier="novice_award" //init appGameCenter
Player Methods
getPlayer <Promise?>
Details
Gets logged in user.
Parameters
No Parameters
Basic Usage
GameCenter
Response
getPlayerImage <Promise?>
Details
Gets logged player image if available. Most players don't have one.
Parameters
No Parameters
Usage
GameCenter
Success Response
Failed Response
Error fetching player image
getPlayerFriends
Details
Gets a list of players. Most games don't have this anymore as Apple took away the game center App. Now you see lots of users connect via Facebook, SMS and by geolocation.
Parameters
No Parameters
Usage
GameCenter
Response
I don't know what this looks like, as I don't have friends 😫 and Apple said they are depreciating support for this is new versions.
Success
or
undefined
Failed
Error fetching player friends
Leaderboard Methods
openLeaderboardModal <Promise?>
Details
Opens Game Center Modal on Leaderboard Page
Parameters
No Parameters
Usage
GameCenter //is open //could not open
Success Response
opened leaderboard modal
Failed Response
opened leaderboard modal
submitLeaderboardScore <Promise?>
Details
Submit progress of users leaderboard
Parameters
Name | Required | Default | Description |
---|---|---|---|
score | Yes | n/a | some number to track for leaderboard |
leaderboarIdentifier | No* (see Response) | leaderboarIdentifier set up in Itunes Connect |
Usage
Basic
let options=score:50; //reverts to default leaderboarIdentifier set up in init()GameCenter//now update statethis
Advanced
let options= score:50 leaderboarIdentifier:"some_other_leaderboard"; GameCenter
Response
Success
"Successfully submitted score"
Failed
"Error submitting score."
Achievements Methods
openAchievementModal <Promise?>
Details
Opens Game Center Modal on Leaderboard Page
Parameters
No Parameters
Usage
GameCenter //is open //could not open
Response
Success
opened achievement modal
Failed
opened achievement modal
getAchievements <Promise?>
Details
Gets players achievements if completed more than 0%.
You must declare submitAchievementScore
at least once before calling this.
Parameters
No Parameters
Usage
GameCenter //failed
Response
or
resetAchievements <Promise?>
[]
Details
Resets the players achievements.
Parameters
Name | Required | Default | Description |
---|---|---|---|
hideAlert | No | {hideAlert:false} |
Hide reset confirmation prompt |
Usage
Basic
//Triggers confirmation prompt GameCenter // hides confirmation prompt GameCenter
Advanced
GameCenter
Response
If you pass in {hideAlert:true}
into GameCenter.resetAchievements()
Method OR the you don't pass in the hideAlert
parameter and player presses "Reset"
If you don't pass in the hideAlert
parameter and player presses "No!"
submitAchievementScore <Promise?>
Details
Submit progress of users achievements
Parameters
Name | Required | Default | Description |
---|---|---|---|
percentComplete | Yes | n/a | number, float, or string of the percent achievement is complete. Range 1-100 |
achievementIdentifier | No* (see Response) | achievementIdentifier set up in Itunes Connect |
|
hideCompletionBanner | No | false |
Hides Game center banner when complete |
Usage
let options= percentComplete:50 achievementIdentifier:"novice_award" ; GameCenter
Response
Success
Not required if achievementIdentifier
set as default in init()
. achievementIdentifier
always reverts to default unless defended. However, will reject promise if not passed in init()
or submitAchievementScore()
function
Failed
No Game Center `achievementIdentifier` passed and no default set
TODO
ADD METHODS
[ ] getLeaderboardPlayers() [ ] invite() [ ] challengeComposer() [ ] findScoresOfFriendsToChallenge()