Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 3.07 KB

README.md

File metadata and controls

69 lines (41 loc) · 3.07 KB
Raw

HIDrogen

openupm

An add-on for the Unity InputSystem package that provides additional input backends, including proper HID support on Linux, and raw Xbox One controller support via GameInput on Windows.

Refer to the inner package README for more details.

(pronounced "hydrogen" or "hid-rogen")

Installing

Below are instructions for installing the package itself. Note that some backends have their own dependencies which must be installed separately alongside your application; refer to the inner package README for more details.

From OpenUPM

Refer to the OpenUPM documentation:

The OpenUPM package page is located here.

From the Releases Page

See the Unity documentation for full details.

  1. Download the .tgz file from the latest release.
  2. Open the Unity Package Manager and hit the + button, then pick Add package from tarball.
  3. Select the downloaded .tgz file in the file prompt.

To update, repeat with the new .tgz.

From Git

See the Unity documentation for full details.

Via URL

  1. Open the Unity Package Manager and hit the + button, then select Add package from git URL.
  2. Paste in https://github.com/TheNathannator/HIDrogen.git?path=/Packages/com.thenathannator.hidrogen#v0.4.3 and hit Add.

To update, increment the version number at the end of the URL to the new version number and repeat these steps with the new URL. Alternatively, you can edit the URL listed in your manifest.json file as described in the Via Manifest section.

Via Manifest

In your Packages > manifest.json file, add the following line to your dependencies:

{
  "dependencies": {
+   "com.thenathannator.hidrogen": "https://github.com/TheNathannator/HIDrogen.git?path=/Packages/com.thenathannator.hidrogen#v0.4.3"
  }
}

To update, increment the version number at the end of the URL to the new version number. The package manager will automatically pull the new changes upon regaining focus.

Via Cloning

  1. Clone this repository to somewhere on your system.
  2. Go to the Unity Package Manager and hit the + button, then pick Add package from disk.
  3. Navigate to the Packages > com.thenathannator.hidrogen folder inside the clone and select the package.json file.

To update, pull the latest commits. Unity will detect the changes automatically.

License

This project is licensed under the MIT license. See LICENSE.md for details.