# HYPER Core

This package helps you to get started quickly with your Unity XR projects.

Dependencies:
- Meta XR Audio SDK v77
- Meta XR Interaction SDK v77
- OpenXR Plugin v1.14.3

## How to install

This package is available in the `HYPER` scoped registry.

- Name: `HYPER`
- URL: `https://registry.npmjs.com`
- Scope: `de.tu-dresden.hyper`

Please follow [this snippet] to add the registry to your project.

[this snippet]: https://git-st.inf.tu-dresden.de/hyper/core/-/snippets/14

## How to use

### Quick start guide

1. Create a new Unity project with **Universal 3D** as the template.
1. Switch the build target platform to **Android**.
1. [Install this package].
1. Wait for the packages to install, then for each pop-up window:
    - On the **Enable Meta XR Feature Set**, select **Yes**.
    - On the **Restart Unity**, select **Restart Editor**.
    - On the **Interaction SDK OpenXR Upgrade**, select **Use OpenXR Hand (New Projects)**.
1. Click **HYPER** > **Core** > **Init Project**.
1. Right click on the **Hierarchy** panel, then click **HYPER** > **Core** > **XR**.
1. Open **Meta** > **Tools** > **Project Setup Tool**, then click **Fix All** in all tabs.

### Enable debug messages

Add `HYPER_CORE_DEBUG_LOG` to **Project Settings** > **Player** > **Script Compilation** > **Scripting Define Symbols**.

## Attribution

- Error.wav by Autistic Lucario -- https://freesound.org/s/142608/ -- License: Attribution 4.0
- Ping! by unfa -- https://freesound.org/s/215415/ -- License: Creative Commons 0

[Install this package]: https://git-st.inf.tu-dresden.de/hyper/core/-/snippets/14