Merge branch 'master' of https://github.com/TROPHiT/UnityDeeplinks

pulling the readme

Author: sagi

README.md

@@ -1,2 +1,103 @@
 # UnityDeeplinks
 A set of tools for Unity to allow handling deeplink activation from within Unity scripts
+
+# Usage
+From within your Unity script, whenever the app gets activated by a deeplink, the following method will be called:
+
+```
+public void onDeeplink(string deeplink) {
+    Debug.Log("onDeeplink " + deeplink);
+}
+```
+
+# Integration Instructions
+1. Clone/download the repository
+2. Copy the entire UnityDeeplinks folder into your Unity project Assets folder
+
+## Android
+There are two alternatives to handle a deeplink by a Unity app, depending on how your Unity project is currently built. It's up to you to decide which way to go.
+
+### Alternative 1: Subclassing UnityPlayerActivity
+In this approach, you use a subclass of the default *UnityPlayerActivity*, which contains deeplink-handling code that marshals deeplinks into your Unity script. This is more recommended approach, as it is the least complex. If you have no previous plans to subsclass UnityPlayerActivity, it's a good approach because then the subclassed code would not conflict with anything. If you do have plans to subclass UnityPlayerActivity, however, it would usually also be a good approach as the code changes you need to make are minimal. You will have to use the provided *MyUnityPlayerActivity* subclass as follows:
+
+* Replace the default UnityPlayerActivity in your Assets/Plugins/Android/AndroidManifest.xml with com.trophit.MyUnityPlayerActivity:
+
+```
+<!--
+<activity android:name="com.unity3d.player.UnityPlayerActivity" ...
+-->
+<activity android:name="com.trophit.MyUnityPlayerActivity" ...
+```
+
+* Add the following inside the <activity> tag, assuming your deeplink URL scheme is myapp://
+```
+  	<intent-filter>
+   		<action android:name="android.intent.action.VIEW" />
+   		<category android:name="android.intent.category.DEFAULT" />
+   		<category android:name="android.intent.category.BROWSABLE" />
+   		<data android:scheme="myapp" />
+ 	</intent-filter>
+```
+
+* Optional: by default, *MyUnityPlayerActivity* calls a Unity script method `onDeeplink` on a game object called *UnityDeeplinks*. If you wish to change the name of the object or method, you should edit *Assets/UnityDeeplinks/Android/MyUnityPlayerActivity.java*, change the values of the `gameObject` and/or `deeplinkMethod` static properties and rebuild the *UnityDeeplinks.jar* file as instructed below
+
+### Alternative 2: Adding a Deeplink Activity
+In this approach, a second activity with deeplink-handling code is added to the Unity project, without subclassing the default activity. Use this is case where option #1 is not acceptable (code is too complex, not under your control, cannot be subclassed, etc)
+
+* Add the following activity to your Assets/Plugins/Android/AndroidManifest.xml, assuming your deeplink URL scheme is myapp://
+```
+<activity android:name="com.trophit.DeeplinkActivity" android:exported="true">
+	<intent-filter>
+		<action android:name="android.intent.action.VIEW" />
+		<category android:name="android.intent.category.DEFAULT" />
+		<category android:name="android.intent.category.BROWSABLE" />
+		<data android:scheme="myapp" />
+ 	</intent-filter>
+</activity>
+```
+
+* Optional: by default, *DeeplinkActivity* calls a Unity script method `onDeeplink` on a game object called *UnityDeeplinks*. If you wish to change the name of the object or method, you should edit *Assets/UnityDeeplinks/Android/DeeplinkActivity.java*, change the values of the `gameObject` and/or `deeplinkMethod` static properties and rebuild the *UnityDeeplinks.jar* file as instructed below
+
+### Building the UnityDeeplinks.jar file
+Only perform this step if you made changes to *Assets/UnityDeeplinks/Android/MyUnityPlayerActivity.java* or would like to rebuild it using an updated version of Unity classes, Android SDK, JDK and so on.
+
+#### Prerequisites
+* Go to your Unity => Preferences => External tools menu and find your Android SDK and JDK home folders
+* Edit *UnityDeeplinks/Android/bulid_jar.sh*
+* Ensure ANDROID_SDK_ROOT points to your Android SDK root folder
+* Ensure the BOOTCLASSPATH points to your JDK/jre/lib folder
+* Ensure UNITY_LIBS points to the Unity classes.jar file in your development environment
+
+#### Build instructions
+* Run the build script:
+```
+cd MY_UNITY_PROJECT_ROOT/Assets/UnityDeeplinks/Android
+./build_jar.sh
+```
+Example output:
+```
+Compiling ...
+/Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home/jre/lib
+/Applications/Unity/PlaybackEngines/AndroidPlayer/Variations/mono/Release/Classes/classes.jar:/kankado/dev/tools/android-sdk-macosx/platforms/android-23/android.jar
+Creating jar file...
+adding: com/(in = 0) (out= 0)(stored 0%)
+adding: com/trophit/(in = 0) (out= 0)(stored 0%)
+adding: com/trophit/MyUnityPlayerActivity.class(in = 1504) (out= 789)(deflated 47%)
+```
+This creates/updates a *UnityDeeplinks.jar* file under your Unity project's Assets/UnityDeeplinks folder
+
+* Continue to build and test your Unity project as usual in order for any jar changes to take effect
+
+## iOS
+
+## Testing
+
+* Prepare a dummy html page that is accessible by your mobile device:
+```
+<body>
+<a href="myapp://?a=b">deeplink test</a>
+</body>
+```
+
+* Open the web page on the device browser and click the deeplink
+* The Unity app should open and the onDeeplink Unity script method should be invoked, performing whatever it is you designed it to perform