> For the complete documentation index, see [llms.txt](https://docs.imperialcad.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.imperialcad.app/api-and-integrations/fivem-installation/offered-plugins/wraith-ars-2x.md).

# Wraith ARS 2X

The Wraith ARS 2X Radar is a realistic and immersive in-game speed radar system designed for law enforcement use within your FiveM server. This version is a direct integration/fork designed to operate

***

### ⚙️ Installation

To install the Wraith ARS 2X radar system into your FiveM server:

1. Download the latest version of the resource from the GitHub page or your provided source.
2. Extract the zip and place the `wk_wars2x` folder into your server's `resources` directory.
3. Add the following line to your `server.cfg`:

```bash
ensure wk_wars2x
```

4. Add the following required Convars if you haven’t already (used for ImperialCAD API interaction):

```bash
setr imperial_community_id "YOUR_COMMUNITY_ID"
set imperialAPI "YOUR_SECRET_KEY"
```

5. Start your server. You should see a startup message confirming the radar system is loaded and active.

***

### 🎮 Default Keybinds

These keybinds are configurable but follow these defaults unless changed:

| Action             | Key       | Description                                                           |
| ------------------ | --------- | --------------------------------------------------------------------- |
| Open Remote        | F5        | Opens the remote (driver only, must be in an emergency-class vehicle) |
| Close Remote       | ESC / RMB | Closes the UI/remote                                                  |
| Lock Front Antenna | Numpad 8  | Locks speed from front radar (fast or strong depending on target)     |
| Lock Rear Antenna  | Numpad 5  | Locks speed from rear radar (same logic as front)                     |
| Lock Front Plate   | Numpad 9  | Locks plate currently caught by front reader                          |
| Lock Rear Plate    | Numpad 6  | Locks rear plate from rear reader                                     |
| Toggle Keylock     | L         | Disables/enables all radar keybinds                                   |

> ℹ️ These are viewable in-game through the built-in operator manual as well.

***

### 🔧 Script Configuration

Configuration is done inside `config.lua`. Below are some notable options:

#### General Behavior

```lua
config.allow_fast_limit = true       -- Allows speed auto-locking
config.only_lock_players = false     -- Only auto-lock speeds of player vehicles
config.allow_quick_start_video = true
config.allow_passenger_view = true
config.allow_passenger_control = true
```

#### Default Keybinds

```lua
config.keyDefaults = {
  remote_control = "f5",
  key_lock = "l",
  front_lock = "numpad8",
  rear_lock = "numpad5",
  plate_front_lock = "numpad9",
  plate_rear_lock = "numpad6"
}
```

#### Menu Defaults

```lua
config.menuDefaults = {
  fastDisplay = true,
  same = 0.6,
  opp = 0.6,
  beep = 0.6,
  voice = 0.6,
  plateAudio = 0.6,
  speedType = "mph",
  fastLock = false,
  fastLimit = 60
}
```

#### UI Defaults

```lua
config.uiDefaults = {
  scale = {
    radar = 0.75,
    remote = 0.75,
    plateReader = 0.75
  },
  safezone = 20
}
```

***

### 🛡️ License

This fork of Wraith ARS 2X is maintained by Imperial Solutions, MIT license still applies for the original creator WolfKnight.