Skip to main content

Quick Start

NAMESPACEMyDreamGameStudio.InteractAnything
MENU PATHQuick Start Guide
COMPATIBILITYUnity 6.0+
DOC VERSION

This guide covers the absolute minimum requirements to get a functional interaction running in your scene without writing a single line of code. We will set up the global input router, equip your player camera with a sensor, and make a standard 3D cube interactive.

Step 1: The Global Input Manager​

The framework uses a centralized hardware router so individual sensors don't have to poll for input independently.

  1. Create a new Empty GameObject in your scene and name it Interaction Manager.
  2. Add the Interaction Input component (Interaction System > Core > Interaction Input).
  3. Leave the settings at their defaults. It will automatically listen for the E key (or left mouse click) and route it to whatever interactor is currently active.

Step 2: The Player Sensor (Interactor)​

Your player needs a way to detect interactive objects in the world. For a standard First-Person or Third-Person setup, we use a Raycast.

  1. Select your player's Main Camera in the hierarchy.
  2. Add the Raycast Interactor component (Interaction System > Interactors > Raycast Interactor).
  3. By default, it will automatically use the camera it is attached to and cast a ray forward into the center of the screen. You can adjust the Ray Distance if you want a longer or shorter reach.

(Note: If you are building a top-down or point-and-click game, use the Cursor Interactor instead, which projects a ray from the mouse position.)

Step 3: The Target Object (Interactable)​

Now we need something to actually interact with. The Interactable component acts as the brain for the object, handling states like Instant, Hold, and Toggle.

  1. Go to GameObject > 3D Object > Cube to create a basic cube in front of your camera.
  2. Add the Interactable component (Interaction System > Core > Interactable).
  3. In the Inspector, locate the Prompt Text field and change it from "Interact" to "Destroy Cube".
  4. Scroll down to the Core Events section.
  5. Click the + button under On Interaction Complete.
  6. Drag the Cube GameObject itself into the object slot, click the dropdown, and select GameObject.SetActive. Ensure the checkbox is unchecked (false).

To see the "Destroy Cube" text pop up when you look at the object, we need to add the UI renderer.

  1. Go to GameObject > UI > Canvas to create a new UI Canvas.
  2. Inside the Canvas, create an Empty GameObject named Prompt Panel.
  3. Inside the Prompt Panel, create a UI > Text - TextMeshPro object.
  4. Select the Canvas and add the Interaction Prompt UI component (Interaction System > UI > Interaction Prompt UI).
  5. Assign your Main Camera to the UI Camera slot.
  6. Assign the Prompt Panel to the Panel slot, and your TextMeshPro object to the Prompt Text slot.

Play!​

Press Play in the Unity Editor. When you look at the Cube, the Raycast Interactor will detect it and the UI will snap to the cube's position displaying "Destroy Cube". Press the E key, and the cube will instantly deactivate.