https://github.com/asus4/ARKitStreamer

AR Foundation Remote Debugging Tool for Unity
https://github.com/asus4/ARKitStreamer

arkit3 unity

Last synced: 3 months ago
JSON representation

AR Foundation Remote Debugging Tool for Unity

• Host: GitHub
• URL: https://github.com/asus4/ARKitStreamer
• Owner: asus4
• License: other
• Created: 2019-10-14T13:13:27.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-30T12:21:58.000Z (about 1 year ago)
• Last Synced: 2024-08-04T02:09:13.138Z (6 months ago)
• Topics: arkit3, unity
• Language: C#
• Homepage:
• Size: 2.04 MB
• Stars: 187
• Watchers: 9
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-unity-packages - ARKit Streamer - See Unity forum for more information. (Augmented and Virtual Reality)

README

        

## Check out the next project **[ARFoundationReplay](https://github.com/asus4/ARFoundationReplay)**, which supports URP, Record/Replay and Google Geospatial.

---

# ARKit Streamer

[![OpenUPM](https://img.shields.io/npm/v/com.koki-ibukuro.arkitstream?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.koki-ibukuro.arkitstream/)

A remote debugging tool for AR Foundation with ARKit4 features. This is temporary solution until the Unity team has completed the AR remote functionality - See [Unity forum](https://forum.unity.com/threads/ar-remoting-simulation.720575/) for more information.

![img1](https://i.imgur.com/vZoYIs1.gif)  

Human segmentation  

![img2](https://user-images.githubusercontent.com/357497/89782917-66e0e680-db16-11ea-856b-fb6782ec0b23.gif)  

Sample with VFX Graph  

## Environments

- Tested on Unity 2020.3.36f1

- ARFoundation 4.2.3

- iPhone X or more

## Supporting ARKit features

- Basic camera position tracking

- Send camera image via NDI

- Human Segmentation / Depth

- Face

- Plane tracking

- 3D body tracking

## How to Install

### Install NDI SDK

Depends on NDI (Network Device Interface), download the NDI SDK for iOS from [https://ndi.tv/sdk/](https://ndi.tv/sdk/)

### Install dependencies

Open the file `Packages/manifest.json` and add following lines into `scopedRegistries` and `dependencies` section.

```json

{

  "scopedRegistries": [

    {

      "name": "Unity NuGet",

      "url": "https://unitynuget-registry.azurewebsites.net",

      "scopes": [ "org.nuget" ]

    },

    {

      "name": "npm",

      "url": "https://registry.npmjs.com",

      "scopes": [

        "jp.keijiro",

        "com.koki-ibukuro"

      ]

    }

  ],

  "dependencies": {

    "com.koki-ibukuro.arkitstream": "0.5.2",

    ...// other dependencies

  }

}

```

## How to Use

### Set up Sender iPhone

Download this repository and build/install on iPhone. Then run the app on iPhone.

Or you can simply add `ARKitSender` to your custom ARKit scene.  

![Imgur](https://imgur.com/tevPT1n.png)

Open the project settings and enable "ARKit Stream" as an XR plug-in for Unity Editor.

![fig](https://imgur.com/pVxnPm4.png)

Recommend using USB connected network instead of Wi-Fi to reduce network delay.  

![Imgur](https://imgur.com/4YVbIUP.png)

### Simulate on Editor

Add `ARKitReceiver` to the scene which you want to simulate on Editor. Make sure that there are ARKitSender and ARKitReceiver in the scene.

See the `Assets/Sample` for more information.

### Setting for LWRP / URP

If you use LWRP / URP, you need also add the ARBackgroundRemoteRendererFeature to the list of render features. See [AR Foundation Document](https://docs.unity3d.com/Packages/[email protected]/api/UnityEngine.XR.ARFoundation.ARCameraBackground.html) for more information.

![Imgur](https://imgur.com/CRC99iQ.png)

## Dependent Libraries

- [KlakNDI](https://github.com/keijiro/KlakNDI/)