Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

debug.keystore warning added in readme + release assets info + jar resolver info #93

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

debug.keystore warning added in readme + release assets info + jar resolver info #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
871280f
debug.keystore warning added in readme
May 13, 2019
02823f7
Added where to download assets + jar resolver
May 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 46 additions & 30 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Google Sign-In Unity Plugin
_Copyright (c) 2017 Google Inc. All rights reserved._

_Copyright (c) 2017 Google Inc. All rights reserved._

## Overview

Google Sign-In API plugin for Unity game engine. Works with Android and iOS.
This plugin exposes the Google Sign-In API within Unity. This is specifically
Google Sign-In API plugin for Unity game engine. Works with Android and iOS.
This plugin exposes the Google Sign-In API within Unity. This is specifically
intended to be used by Unity projects that require OAuth ID tokens or server
auth codes.

@@ -14,7 +14,7 @@ It is cross-platform, supporting both Android and iOS.
See [Google Sign-In for Android](https://developers.google.com/identity/sign-in/android/start)
for more information.

## Configuring the application on the API Console
## Configuring the application on the API Console

To authenticate you need to create credentials on the API console for your
application. The steps to do this are available on
@@ -25,13 +25,14 @@ a web client ID.

## How to build the sample


### Get a Google Sign-In configuration file

This file contains the client-side information needed to use Google Sign-in.
The details on how to do this are documented on the [Developer website](https://developers.google.com/identity/sign-in/android/start-integrating#get-config).

Once you have the configuration file, open it in a text editor. In the middle
of the file you should see the __oauth_client__ section:
Once you have the configuration file, open it in a text editor. In the middle
of the file you should see the **oauth_client** section:

```
"oauth_client": [
{
@@ -50,70 +51,85 @@ of the file you should see the __oauth_client__ section:
```

There are 3 values you need for configuring your Unity project:
1. The __Web client ID__. This is needed for generating a server auth code for
your backend server, or for generating an ID token. This is the `client_id`
value for the oauth client with client_type == 3.
2. The __package_name__. The client entry with client_type == 1 is the
Android client. The package_name must be entered in the Unity player settings.
3. The keystore used to sign your application. This is configured in the publishing settings of the Android Player properties in
the Unity editor. This must be the same keystore used to generate
the SHA1 fingerprint when creating the application on the console. __NOTE:__
The configutation file does not reference the keystore, you need to keep track of
this yourself.

1. The **Web client ID**. This is needed for generating a server auth code for
your backend server, or for generating an ID token. This is the `client_id`
value for the oauth client with client_type == 3.
2. The **package_name**. The client entry with client_type == 1 is the
Android client. The package_name must be entered in the Unity player settings.
3. The keystore used to sign your application. This is configured in the publishing settings of the Android Player properties in
the Unity editor. This must be the same keystore used to generate
the SHA1 fingerprint when creating the application on the console. **NOTE:**
The configutation file does not reference the keystore, you need to keep track of
this yourself.

WARN: When building in development mode, unity will use your default android debug.keystore generally located in the .android folder
generally located in the root folder of your user profile. If you can't find it, use "everything" search tool (freeware -- search for it on google)
to look for debug.keystore. You will need to use the SHA1 from that keystore rather than the release keystore in order to be able to login.

### Create a new project and import the plugin

Create a new Unity project and import the `GoogleSignIn-1.0.0.unitypackage` (or the latest version).
This contains native code, C# Unity code needed to call the Google Sign-In API for both Android and iOS.

### Import the sample scene

Import the `GoogleSignIn-sample.unitypackage` which contains the sample scene and
scripts. This package is not needed if you are integrating Google Sign-in into
scripts. This package is not needed if you are integrating Google Sign-in into
your own application.

Make sure you download the actual assets from: https://github.com/googlesamples/google-signin-unity/releases and DO NOT just clone
the source files into your project. You will also need Unity Jar Resolver to download android dependencies, you can find it here:
https://github.com/googlesamples/unity-jar-resolver/releases

### Configure the web client id

1. Open the sample scene in `Assets/SignInSample/MainScene`.
2. Select the Canvas object in the hierarchy and enter the web client id
in the __SignInSampleScript__ component.
in the **SignInSampleScript** component.

## Building for Android

1. Under Build Settings, select Android as the target platform.
2. Set the package name in the player settings to the package_name you found in
the configuration file.
the configuration file.
3. Select the keystore file, the key alias, and passwords.
4. Resolve the Google Play Services SDK dependencies by selecting from the menu:
__Assets/Play Services Resolver/Android Resolver/Resolve__. This will add
the required .aar files to your project in `Assets/Plugins/Android`.
**Assets/Play Services Resolver/Android Resolver/Resolve**. This will add
the required .aar files to your project in `Assets/Plugins/Android`.

## Building for iOS

For iOS, follow the instructions for creating a GoogleService-Info.plist file on
https://developers.google.com/identity/sign-in/ios/start-integrating.

In Unity, after switching to the iOS player, make sure to run the Play Services
Resolver. This will add the required frameworks and libraries to the XCode
Resolver. This will add the required frameworks and libraries to the XCode
project via CocoPods.

After generating the XCode project from Unity, download the GoogleService-Info.plist file
from the Google Developers website and add it to your XCode project.

## Using the Games Profile to sign in on Android

To use the Play Games Services Gamer profile when signing in, you need to edit the
dependencies in `Assets/GoogleSignIn/Editor/GoogleSignInDependencies.xml`.

Uncomment the play-services-games dependency and re-run the resolution.


## Using this plugin with Firebase Auth
Follow the instructions to use Firebase Auth with Credentials on the [Firebase developer website]( https://firebase.google.com/docs/unity/setup).

Follow the instructions to use Firebase Auth with Credentials on the [Firebase developer website](https://firebase.google.com/docs/unity/setup).

Make sure to copy the google-services.json and/or GoogleService-Info.plist to your Unity project.

Then to use Google SignIn with Firebase Auth, you need to request an ID token when authenticating.
The steps are:

1. Configure Google SignIn to request an id token and set the web client id as described above.
2. Call __SignIn()__ (or __SignInSilently()__).
2. Call **SignIn()** (or **SignInSilently()**).
3. When handling the response, use the ID token to create a Firebase Credential.
4. Call Firebase Auth method __SignInWithCredential()__.
4. Call Firebase Auth method **SignInWithCredential()**.

```
GoogleSignIn.Configuration = new GoogleSignInConfiguration {
@@ -147,14 +163,14 @@ The steps are:
});
```


## Building the Plugin

To build the plugin run `./gradlew -PlintAbortOnError build_all`. This builds the support aar
library with lint warnings as errors and packages the plugin into a .unitypackage file. It
library with lint warnings as errors and packages the plugin into a .unitypackage file. It
also packages the sample scene and script in a separate package.

There's also a shortcut for linux/mac: `./build_all`.


## Questions? Problems?

Post questions to this [Github project](https://github.com/googlesamples/google-signin-unity).