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.

Post-Installation Setup​

Once installed, there is zero mandatory configuration to start. The fastest way to get a scene running:

  1. Open Tools > HookUI > Dashboard.
  2. On the Overview tab, find the Quick Setup section.
  3. Click Setup Scene for HookUI. One click creates whatever the active scene is missing — EventSystem, Canvas, the HookUI_System (HookUIManager, with a new empty Flow Graph asset auto-assigned), and a HookAudioManager — and skips anything already present. It's safe to click repeatedly and fully undoable with Ctrl+Z. A summary dialog lists what was created vs. already there.
  4. (Optional) Click Setup In-App Notifications to drop the HookInAppNotifications prefab (used for modal popups/confirmations) into the scene.

That's a working scene. For the full tour of the Dashboard and its Quick Setup buttons, see Dashboard & Editor Tools.

Building the setup manually​

If you'd rather assemble the scene yourself (custom Canvas settings, a non-default EventSystem, etc.), you don't need the Quick Setup buttons at all:

  1. Add an EventSystem to the scene (GameObject > UI > Event System) if one doesn't already exist.
  2. Add a Canvas with a CanvasScaler and GraphicRaycaster.
  3. Create an empty GameObject, add the HookUIManager component, and assign it a HookUIFlowGraph asset (create one via right-click Create > HookUI > Flow Graph if you don't have one yet).
  4. (Optional) Add a GameObject with HookAudioManager + AudioSource if you plan to use HookUI's audio hooks.
  5. Open the Dashboard's Settings tab to confirm the "Global Database" loaded, and set your Debug Channels (Recommended: Core + Navigation).
  6. (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.