New updated Unity SDK documentation #580

PythonHackerr · 2024-12-09T16:10:09Z

Unity SDK documentation

vercel · 2024-12-09T16:10:14Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
documentation	❌ Failed (Inspect)			Dec 9, 2024 4:11pm

vercel · 2024-12-09T16:10:15Z

@PythonHackerr is attempting to deploy a commit to the Radar Team on Vercel.

A member of the Team first needs to authorize it.

KennyHuRadar · 2024-12-16T19:33:13Z

docs/sdk/unity.mdx

+
+# Unity wrapper SDK
+
+This is the documentation for the Unity wrapper/plugin, which provides a thin proxy layer for integrating existing native SDKs offering location tracking and geofencing services. Before integrating, review the native SDK documentation for iOS and Android to understand platform-specific requirements and features.


We normally also include a link like such

Before integrating, read the [native SDK documentation](/sdk) to familiarize yourself with the platform.

We should also add the unity icon to the sdk page

KennyHuRadar · 2024-12-16T19:37:08Z

docs/sdk/unity.mdx

+
+Scripts documentation and Demo scene overview can be found in project READMEs.
+
+## Install


Is there a reason why we are not able to simply provide a .unitypackage file so that developers can simply add the required assets by double clicking the .unitypackage from inside unity?

We can and we should, I will create it and publish to the repo

KennyHuRadar · 2024-12-16T19:38:46Z

docs/sdk/unity.mdx

+
+To integrate the Unity SDK, download or clone the package and include it in your Unity project:
+
+1. Copy the `Plugins` folder (containing both Android and iOS native implementations) into the `Assets` directory of your Unity project. Ensure it contains all the required files.


nit: Ensure it contains all the required files. feels extraneous

KennyHuRadar · 2024-12-16T19:39:31Z

docs/sdk/unity.mdx

+To integrate the Unity SDK, download or clone the package and include it in your Unity project:
+
+1. Copy the `Plugins` folder (containing both Android and iOS native implementations) into the `Assets` directory of your Unity project. Ensure it contains all the required files.
+2. Import the ExternalDependencyManager for Unity (EDM4U). It is included in the project but you can get it from `Package Manager` or from [repo](https://github.com/googlesamples/unity-jar-resolver): It is required if you want to add and use iOS/Android dependencies directly in your project like: `Android specific libraries (e.g AARs)` or `iOS CocoaPods`


Should we say ExternalDependencyManager instead of ExternalDependencyManager?

KennyHuRadar · 2024-12-16T19:41:16Z

docs/sdk/unity.mdx

+
+1. Copy the `Plugins` folder (containing both Android and iOS native implementations) into the `Assets` directory of your Unity project. Ensure it contains all the required files.
+2. Import the ExternalDependencyManager for Unity (EDM4U). It is included in the project but you can get it from `Package Manager` or from [repo](https://github.com/googlesamples/unity-jar-resolver): It is required if you want to add and use iOS/Android dependencies directly in your project like: `Android specific libraries (e.g AARs)` or `iOS CocoaPods`
+3. Ensure that any required permissions or settings specific to location tracking and geofencing are configured on both iOS and Android, as outlined in the native SDK documentation. 


Lets link to the corresponding sections within native SDK documentation here.

KennyHuRadar · 2024-12-16T20:02:28Z

docs/sdk/unity.mdx

+
+### Calls to APIs
+
+The Unity SDK exposes following APIs calls: 


I don't believe having a comma separated list is the best way to index our api calls, maybe a codebox with pseudo code in a class format looks better? Like the C# version of

RadarSDK { initialize ... }

And also since we already describe the calls below, do we even need to list them out here?

Agree, no need to list them out

KennyHuRadar · 2024-12-16T20:04:47Z

docs/sdk/unity.mdx

+
+#### GetVerifiedLocationToken
+
+Once the native SDK retrieves the location, it sends the data back to Unity. On Android, this is done via RadarJavaProxy, and on iOS, it’s done via a delegate or callback defined in RadarUnityBridge.m


we should either have a descriptions for all api calls or for none of them for consistency.

I will add some short descriptions that make sense to all functions

KennyHuRadar · 2024-12-16T20:05:37Z

docs/sdk/unity.mdx

+```csharp
+try
+{
+   Radar.SomeFunctionality();


let's use a real call here

KennyHuRadar · 2024-12-16T20:06:34Z

package.json

@@ -49,6 +49,7 @@
    "@types/react": "^17.0.11",
    "@types/react-helmet": "^6.1.1",
    "@types/react-router-dom": "^5.1.7",
+    "cross-env": "^7.0.3",


why are we using cross env? is this just a local dev dependency you need?

I think we do not need this. Perhaps I added this when I tried to fix some issues. I will delete it and test everything.

Without it, I cannot preview. I get this error:

$ npm run start > [email protected] start > NODE_OPTIONS=--openssl-legacy-provider docusaurus start 'NODE_OPTIONS' is not recognized as an internal or external command, operable program or batch file.

I see, are you working on a windows PC?

KennyHuRadar · 2024-12-16T20:07:06Z

Description

why do we need this? is this also related to the cross-env?

What exactly?

I'm curious on why do we need to add this new file into the repository, this wasn't previously here.

KennyHuRadar · 2025-01-23T12:09:19Z

The preview is not building, I suspect that there may be an issue with the new files you created. I am guessing that you need these files to build the file for you but they are breaking the actual deployment build process. Can you remove those file diffs from this PR, you can obviously keep those on your local copy of the repo but I think we don't want to merge them in.

PythonHackerr and others added 9 commits October 14, 2024 10:39

Added unity sdk documentation page

f1c8978

added cross-platform compatibility to fix issues on Windows

d2306dc

Initial Unity SDK documentation

65004f1

Initial Unity SDK documentation

0a4fdf2

Updated documentation

1be3339

updated documentation

2757573

updated documentation

80ae82d

Revised documentation

f892cd2

Revised documentation

b2bcdd5

vercel bot had a problem deploying to Preview December 9, 2024 16:10 Failure

KennyHuRadar reviewed Dec 16, 2024

View reviewed changes

Updated Documentation

5fdb6f4


		# Unity wrapper SDK

		This is the documentation for the Unity wrapper/plugin, which provides a thin proxy layer for integrating existing native SDKs offering location tracking and geofencing services. Before integrating, review the native SDK documentation for iOS and Android to understand platform-specific requirements and features.


		Scripts documentation and Demo scene overview can be found in project READMEs.

		## Install


		To integrate the Unity SDK, download or clone the package and include it in your Unity project:

		1. Copy the `Plugins` folder (containing both Android and iOS native implementations) into the `Assets` directory of your Unity project. Ensure it contains all the required files.


		### Calls to APIs

		The Unity SDK exposes following APIs calls:


		#### GetVerifiedLocationToken

		Once the native SDK retrieves the location, it sends the data back to Unity. On Android, this is done via RadarJavaProxy, and on iOS, it’s done via a delegate or callback defined in RadarUnityBridge.m

New updated Unity SDK documentation #580

Are you sure you want to change the base?

New updated Unity SDK documentation #580

Uh oh!

Conversation

PythonHackerr commented Dec 9, 2024

Uh oh!

vercel bot commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Dec 9, 2024

Uh oh!

KennyHuRadar Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KennyHuRadar commented Jan 23, 2025

Uh oh!

Uh oh!

vercel bot commented Dec 9, 2024 •

edited

Loading

KennyHuRadar Dec 16, 2024 •

edited

Loading