> For the complete documentation index, see [llms.txt](https://udexreal.gitbook.io/udexreal-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://udexreal.gitbook.io/udexreal-docs/plugins/handdriver-unity-upm-package-usage-guide.md).

# HandDriver Unity UPM Package Usage Guide

## 1. Updates

<table><thead><tr><th width="71.5" data-type="number">No.</th><th width="123">Date</th><th width="350">Content</th><th width="106.5">Remarks</th></tr></thead><tbody><tr><td>1</td><td>2026/08/14</td><td>Added vibration-related features for Controller version 2.0.</td><td></td></tr><tr><td>2</td><td>2026/02/06</td><td>Updated some configurations to support 2021 &#x26; 2022 versions.</td><td></td></tr><tr><td>3</td><td>2026/02/03</td><td>Updated the plugin package format to make it more lightweight and fixed some errors.</td><td></td></tr><tr><td>4</td><td>2026/01/29</td><td>Updated JSON files, upgraded related plugins, and updated notes.</td><td></td></tr><tr><td>5</td><td>2025/12/03</td><td>HandDriver Demo. You can directly import it from the Package Manager and use the Sample scenes within the package.</td><td></td></tr></tbody></table>

## 2. How to Install the Unity Udexreal Development Plugin (Example: Version 2.2.3)

### 2.1. Important Notes Before Use

* <mark style="color:red;">If your existing project uses the ".unitypackage" file, please continue to use the ".unitypackage" file for updates. When updating with ".unitypackage", please back up in advance! If you encounter any errors, please contact technical support.</mark>
* For <mark style="color:red;">new projects</mark>, it is recommended to install via UPM.

### 2.2. Installation Method 1: Install via Package Manager

* In Window -> Package Manager, click the "+" icon in the top-left corner -> "Add package from git URL..." - Enter: <mark style="background-color:blue;"><https://github.com/UDEXREAL-Org/UDXHDPluginUnity.git#release\\_2.2.3></mark> -> Click "Add"

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2F6YJM1CloULhIrzYfBfhD%2Fimage.png?alt=media&amp;token=48a7dc6a-0d41-4076-8159-b5659a649602" alt="" width="338"><figcaption></figcaption></figure>

* After successful installation, as shown in the figure below:

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2FjMZmidZQoGvS2063JnYh%2Fimage.png?alt=media&amp;token=1fa4a802-25e2-4b9b-9ba0-0ffac1402dab" alt="" width="563"><figcaption></figcaption></figure>

* Then, directly click Import in the Package Manager and use the Sample scenes within the package.

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2FKoixAS2gd1TABFbnYZT9%2Fimage.png?alt=media&amp;token=4a8f9949-2071-4f1e-833e-91df22683dcf" alt="" width="326"><figcaption></figcaption></figure>

### 2.3. Installation Method 2: Install by Modifying the Manifest File

#### 2.3.1. Open the manifest.json File

Open the manifest.json file of your Unity project. Its path is: Your Unity Project Directory\Packages\manifest.json.

#### 2.3.2. Add Code

Add the following code anywhere within the dependencies section of manifest.json and save:

```json
"com.udexreal.handdriver": "https://github.com/UDEXREAL-Org/UDXHDPluginUnity.git#release_2.2.3"
```

as shown below:

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2Ff0nJexJL4dKnBbCEHvNd%2Fimage.png?alt=media&amp;token=aaafe31b-246a-46bf-a185-ad49e28f6452" alt="" width="563"><figcaption></figcaption></figure>

<mark style="background-color:$warning;">Please note that each line of code must be separated by a comma, and no comma is required for the last line.</mark>

#### 2.3.3. Open the Unity Project

After completing the above steps, opening the Unity project will automatically download the UDEXREAL plugin package. You can view it in Window -> Package Manager and import it in Samples:

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2FbqAI7awxp3aIIi8d9xzF%2Fimage.png?alt=media&amp;token=be335e5c-052d-4532-bfd4-2bb1bd2c3325" alt="" width="563"><figcaption></figcaption></figure>

If you encounter an error about missing meta files as shown in the figure below, you can ignore it as it does not affect usage.

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2Fqw4WgSzXoZjcanndZbR7%2Fimage.png?alt=media&amp;token=81ad2ffb-ea17-4e06-b1de-b8647fbdac27" alt="" width="563"><figcaption></figcaption></figure>

### 2.4. Important Notes

#### 2.4.1. Vibration-related (IL2CPP)

* Before building the APK, check <mark style="background-color:purple;">Project Settings - Player - Other Settings - Managed Stripping Level</mark> and select "<mark style="background-color:red;">Minimal</mark>".
* If your project requirements do not allow selecting "Minimal", create a "<mark style="background-color:blue;">link.xml</mark>" file in the Asset folder with the following content:

```xml
<linker>
  <assembly fullname="Newtonsoft.Json">
    <type fullname="Newtonsoft.Json.*" preserve="all"/>
  </assembly>
</linker>
```

Relevant pre-configuration can be referred to [here](https://udexreal.gitbook.io/udexreal-docs/plugins/pages/RKsyf4tXI5o2rWPN2gUC#id-3.3.-app-options).

#### 2.4.2. Project Configuration

* <mark style="background-color:purple;">File -> Build Settings... -> Player Settings -> Project Settings -> Player -> Other Settings -> Configuration -> Set API Compatibility Level</mark>\* to <mark style="background-color:red;">.NET Framework</mark>

## 3. FAQs

### Where is the Package Manager?

Window -> Package Manager

* To <mark style="background-color:red;">install locally by downloading a ZIP package</mark>, select "<mark style="background-color:blue;">Add package from disk...</mark>"
* To <mark style="background-color:red;">install via a URL link</mark>, select "<mark style="background-color:blue;">Add package from git URL...</mark>"

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2FigIWRVIqtBkBwqw5mzs9%2Fimage.png?alt=media&amp;token=ce7ef306-91f5-48eb-b330-90d20f8f6e48" alt="" width="230"><figcaption></figcaption></figure>

<figure><img src="https://2082502898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8s1Ia6TfFovgyJ5JsDJZ%2Fuploads%2F2fn1Skafvu3Tto8PInRT%2Fimage.png?alt=media&amp;token=cdf1b61b-0c52-4af3-9775-81473fe4c318" alt="" width="199"><figcaption></figcaption></figure>

### Why can't I load the plugin package via git URL?

Please check whether Git is properly installed on your machine and whether the network environment is functioning correctly. Connecting to GitHub requires access to the external network.

### Models or scripts are missing after importing the Sample?

Please check if the Unity version is compatible. If compatible, they will be automatically indexed and populated. If incompatibility occurs, please contact the official support.

## 4. Official GitHub Link

{% embed url="<https://github.com/UDEXREAL-Org/UDXHDPluginUnity>" %}