# Configuration

Lightweight 3D world-space interaction system for FiveM. Drop hint icons in the world, swap them for a hold-to-confirm panel when the player gets close, trigger callbacks (single key or multi-choice), and optionally open a NPC dialogue tree — all from a single config table.

Built on `ox_lib` (DUI + points) with a Vite/React NUI bundle

### **Features**

* **Hint → Hold panel** with a smooth scale transition and a configurable border-accent color per interaction.
* **Multi-choice menus** (`E` / `G` / `F` …) with per-choice conditions.
* **NPC dialogue trees** with camera focus, ped animations and an auto injected "Back" entry.
* **Five registration entrypoints** for every common use case: `pedRegister`, `positionRegister`, `entityRegister`, `entityRegisterByHash`, `interactCreate` / `interactRemove`.
* **One central config** (`config/config.lua`) for defaults, palette, keybinds, dialogue camera/HUD wiring and UI styling.
* **Auto cleanup** — every registration is tagged with the calling resource and removed when that resource stops.

### **Requirements**

* `ox_lib` installed and started before this resource.
* Keep the resource name Var-Interact (exports reference this exact name).

### Step 1

Connect via this site : [Portal](https://portal.cfx.re/) with your CFX account to which your purchase was made on the store <https://www.var-fivem.com/>

### Step 2

<figure><img src="/files/fMwG6jwxMscfoBLtcjZs" alt=""><figcaption></figcaption></figure>

<figure><img src="https://cdn.discordapp.com/attachments/1034270065681510474/1402682407257247907/image.png?ex=6894cd4a&#x26;is=68937bca&#x26;hm=8214c573107c2788bff96137fe6ad473544fe16a4816a7f25beb8f1c6c4df1ae&#x26;" alt=""><figcaption><p>Go to the Granted Assets category and download the most recent version of the Var-Interact</p></figcaption></figure>

### Step 4

Place the resource in `resources/` and add it to `server.cfg`.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.var-fivem.com/interaction/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.