Skip to main content

Installation

HookUI is distributed through the Unity Asset Store. It installs like any other Asset Store package, straight into your project through the Package Manager.

Prerequisites​

  • Unity Version: 2021.3 LTS or higher (Recommended: 2022.3 LTS).
  • Dependencies:
    • TextMeshPro (Usually included in Unity projects).
    • (Optional) DOTween (If you plan to implement advanced tween-based animations, though HookUI has internal simple tweens).

Installation via the Asset Store​

  1. Get Hook UI from the Unity Asset Store.
  2. In the Unity Editor, open Window > Package Manager.
  3. Switch the source dropdown (top-left) to My Assets.
  4. Find Hook UI in the list, click Download, then Import.
  5. In the Import dialog, keep everything checked (or at least Runtime + Editor) and click Import.

That's it — no extra setup step, no external CLI, no dependencies to resolve by hand.

:::tip Prefer installing from source? If you're contributing to HookUI itself, or want to track the repository directly instead of a versioned Asset Store release, see Installing from Git below. :::

Post-Installation Setup​

Once installed, there is zero mandatory configuration to start. However, you can verify everything is working:

  1. Open the Dashboard: Tools > HookUI > Dashboard.
  2. Go to the Settings tab.
  3. You should see the "Global Database" loaded.
  4. Check the Debug Channels to configure your initial logging preference (Recommended: Core + Navigation).
  5. (Optional) Import the Demo Lab sample from the Package Manager's package details page to see every feature wired up in one scene.

Troubleshooting​

"Error: Assembly not found"​

Ensure your project has TextMeshPro installed. If you are using the Sample Scenes, ensure you have imported the Samples from the Package Manager window.

"Database not found"​

HookUI automatically creates a default database at Assets/Resources/HookUI/HookUI_Database.asset. If you moved your Resources folder, ensure this path remains valid or create a new database manually via right-click: Create > HookUI > Database.

Alternative: Installing from Git​

Not using the Asset Store version? HookUI also installs as a regular UPM git package:

  1. Open your Unity Project.
  2. Go to Window > Package Manager.
  3. Click the + (Plus) icon in the top-left corner.
  4. Select "Add package from git URL...".
  5. Enter the repository URL: 
    https://gitlab.jsonproductions.com/Json55/hookui.git?path=/Assets/hookuipackage
  6. Click Add.

Manual installation​

If you prefer to include the source code directly in your project (e.g., for extensive modification):

  1. Download the repository as a .zip.
  2. Extract the contents.
  3. Copy the Assets/hookuipackage folder into your project's Assets folder (or Packages folder).
  4. Unity will automatically compile the assembly definitions.