🧩 Zion XRay

Quick Start

This guide creates a basic working Zion XRay setup with scanner input, an active objective, XRay highlighting, HUD, world markers and a GPS trail.

1. Open the Setup Wizard

In Unity, open the setup tool:

Tools → Zion Games → Zion XRay → Setup Wizard

The Setup Wizard is the recommended first-run experience. It keeps the main references in one place and can create the scanner, controller, HUD, GPS trail, marker system and optional demo components.

2. Assign your player

Assign the player object that should control scanner mode. The player normally receives:

• ZionXRayController
• ZionXRayScanner
• ZionXRayGpsTrail

3. Assign an Input Action

Create or select a Unity Input System action for scanner mode, then assign it to the XRay Input Action field in the wizard or ZionXRayController.

Setting	Suggested Value
Action Map	Player or Gameplay
Action Name	XRay
Action Type	Button
Keyboard Binding	Q, Left Alt or Mouse Button 4
Gamepad Binding	Left Shoulder, Right Bumper, Right Stick Press or D-Pad

4. Assign or create an active objective

Zion XRay needs one current objective for the active marker, HUD, highlight and GPS trail. While learning the system, you can use the included demo provider.

For production, connect your own quest, mission, interaction or objective system to an objective provider and supply the active objective transform.

5. Add targets

Objects that should appear as XRay targets usually need:

• ZionXRayTarget
• ZionXRayTargetHighlighter when the object should use XRay highlight material swapping
• A supported renderer, such as MeshRenderer or SkinnedMeshRenderer

Choose a target type such as Objective, Enemy, Pickup, Interactable or Custom/Object.

6. Bake a NavMesh

GPS floor arrows require a baked NavMesh. The player and active objective both need to be near reachable NavMesh positions.

7. Run diagnostics

Open the Diagnostics tab in the Setup Wizard or use the standalone window:

Tools → Zion Games → Zion XRay → Diagnostics

Run full validation and check for missing references, invalid input, missing HUD setup, missing GPS prefab, missing objective provider, missing NavMesh route or missing highlight materials.

8. Test in Play Mode

1. Enter Play Mode.
2. Activate the assigned XRay input.
3. Confirm the scanner HUD appears.
4. Confirm the active objective marker appears stronger than other markers.
5. Confirm the GPS trail leads toward the active target.
6. Turn away from targets to confirm screen-edge indicators behave as expected.
7. Confirm the active target receives a stable filled XRay highlight if highlighting is configured.