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

# Installation

> Requirements, start order and the first start.

## Requirements

* OneSync.
* `ug-core` 1.0.0 or newer, started and ready.
* `ug-lib` 1.0.0 or newer.

The `jobs`, `gangs` and `inventory` modules of ug-core are optional. Conditions that need a disabled module never pass.

## Start order

```cfg server.cfg theme={"dark"}
ensure oxmysql
ensure ug-core
ensure ug-lib
ensure ug-target
```

> [!WARNING]
>
> Remove `ox_target` from your server. ug-target provides `ox_target`, so resources that depend on it start against ug-target instead. Running both binds the same key twice.

## First start

On the first start ug-target copies `config.example.lua` to `config.lua`. Updates never overwrite it.

The server console prints one line when it is ready:

```text theme={"dark"}
[ug-target] v1.0.0 ready.
```

Each client prints one line in F8 once the key is bound:

```text theme={"dark"}
[ug-target] Ready: hold, anchored.
```

Players MAY rebind the key in **Settings > Key Bindings > FiveM**.

## When it does not start

| Console | Cause |
| - | - |
| `config.lua: ...` then `Config invalid: N error(s). ug-target stays idle.` | A value in `config.lua` is wrong. Every error is listed. |
| `ug-core did not become ready.` | ug-core failed to boot. Check its output first. |
| F8: `No config from the server.` | The server side stayed idle. Check the server console. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.