> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nexdevelopment.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> How positioning mode works in-game — the command, the camera modes, the controls, and the panel.

## The command

Run `/animpos` to enter positioning mode. The same command does different things depending on where you are in the flow:

| State                     | `/animpos` does                                                     |
| ------------------------- | ------------------------------------------------------------------- |
| Not positioning           | Starts a session at your current spot.                              |
| Positioning (editor open) | Cancels — same as pressing `X`, returns you to the start.           |
| Position confirmed        | Re-opens the editor at your current spot so you can keep adjusting. |
| In a vehicle              | Nothing. You can't position from a vehicle.                         |

The command name is configurable via `Config.Command` — see [Configuration](/nex_animpos/configuration#command).

While positioning you're invincible, and your character is attached to an invisible, collision-less anchor — so nothing snaps, clips, or falls.

## Default controls

| Action                                               | Default                    |
| ---------------------------------------------------- | -------------------------- |
| Move (character or camera)                           | `W` `A` `S` `D`            |
| Up / down                                            | `Q` / `Z`                  |
| Rotate character (orbit) / move character (free-fly) | `←` / `→`                  |
| Move character forward / back (free-fly)             | `↑` / `↓`                  |
| Look around                                          | Hold **Right Mouse**       |
| Zoom / fly-speed                                     | Mouse **wheel**            |
| Free-fly fast / slow                                 | `Left Shift` / `Left Ctrl` |
| Toggle Orbit / Free-Fly                              | `V`                        |
| Recenter camera                                      | `F`                        |
| Confirm position                                     | `G`                        |
| Cancel                                               | `X`                        |

`V` and `F` are rebindable per player in **Settings → Key Bindings** (FiveM category). Everything else maps to `Config.Controls`.

## Camera modes

Toggle between the two with `V`. The camera blends from one mode to the other without a cut.

### Orbit

The camera circles your character. `WASD` moves the **character** relative to the view, `Q`/`Z` move it up and down, and the arrow keys rotate it. The mouse wheel zooms in and out.

### Free-fly

The camera flies through the world with `WASD` (plus `Q`/`Z` for up/down); your character stays put. The arrow keys nudge the **character** relative to the camera while you fly. Hold `Left Shift` to fly fast, `Left Ctrl` for slow, fine movement, and use the wheel to change the base fly speed.

Press `F` at any time to recenter — the camera snaps back to orbit behind your character at the default distance.

<Info>
  Hold **Right Mouse** to grab the view and look around in either mode. While it's held the cursor is captured by the game; release it to get the cursor back for the panel.
</Info>

## The panel

The screen has two parts: a plain-text controls list in the top-left, and the control card (position set by `Config.UIPosition`). The card is mouse-interactive and stays in live sync with the game:

* **Camera mode** — segmented Orbit / Free-Fly toggle, mirroring `V`.
* **Position** — live X / Y / Z offsets from your starting point, heading, and a distance bar showing how much of the allowed range you've used.
* **Adjust** — sliders for the move step (snaps to the `Config.Steps` stops), field of view, and look sensitivity.
* **Confirm** / **Cancel** buttons, mirroring `G` and `X`.

## Distance limit

You can move at most `Config.MaxDistance` metres (default `5.0`) from where you started. At the edge, movement clamps and the UI warns "Reached the maximum distance". The free-fly camera has its own, larger tether (`Config.Camera.free.maxDistance`, default `30.0` metres).

## Confirm and cancel

* **Confirm (`G`)** — locks the position in place. The scripted camera drops back to gameplay, the panel hides, and the anchor is networked so other players see you where you placed yourself. You stay locked until you press `X`, enter a vehicle, or die. Run `/animpos` again to unlock and keep editing from that spot.
* **Cancel (`X`)** — ends the session and teleports you back to your starting point.

<Warning>
  Cancel always returns you to the start on purpose: the placed spot was chosen without collision, so releasing you there could drop you through the map. If you want to stay where you placed yourself, use **Confirm**.
</Warning>
