# FiveM Installation

***

### Features

* Built-In Tablet to use ImperialCAD
* 25+ Developer API Endpoints & Exports
* ERS Integration
* QBCore, QBox, and NAT2K15 Framework Integration
* LiveMap Integration
* Emergency Services Features
* Civilian Features
* Duty Features
* Customizable Location Data
* And more...

***

### Installation

{% stepper %}
{% step %}

#### [Download](https://github.com/Zippy01/ImperialCAD)

> **Required Dependency:** \
> [OXLib](https://github.com/overextended/ox_lib/releases/latest)
> {% endstep %}

{% step %}

#### Place Into `Resources` Directory

* Place the `ImperialCAD` resource into your FiveM resources folder.
  {% endstep %}

{% step %}

#### Configure `config.lua`

* Our configuration file includes a wide range of options. Be sure to review each setting carefully, as certain features such as [ERS integration](https://docs.imperialcad.app/api-and-integrations/fivem-installation/offered-plugins/ers-integration) may require additional setup steps.
  {% endstep %}

{% step %}

#### Ensure Resource

* Place `ensure ImperialCAD` in your `server.cfg`
  {% endstep %}

{% step %}

#### Configure Convars

* Find the community ID and API key in `Admin Panel > Settings > API`.
* Add to `server.cfg`.

```lua
setr imperial_community_id "COMMUNITY_ID_HERE" 
set imperialAPI "API_KEY_HERE"
```

{% hint style="info" %}
If you receive an error regarding missing convars, make sure the convars are set the top of your `server.cfg`
{% endhint %}
{% endstep %}

{% step %}

#### Restart Server

* **Finished**! Your in-game integration is now complete. Enjoy the experience!
  {% endstep %}
  {% endstepper %}

***

### Additional Resources

* These resources are free and optional that have yet to make it to our main resource.

{% content-ref url="fivem-installation/additional-resources" %}
[additional-resources](https://docs.imperialcad.app/api-and-integrations/fivem-installation/additional-resources)
{% endcontent-ref %}

#### Paid Resources

* These resources are paid assets that are compatible with ImperialCAD.

{% content-ref url="fivem-installation/paid-resources" %}
[paid-resources](https://docs.imperialcad.app/api-and-integrations/fivem-installation/paid-resources)
{% endcontent-ref %}

### Offered Plugins

* A list of all plugins we use in the ImperialCAD resource.

{% content-ref url="fivem-installation/offered-plugins" %}
[offered-plugins](https://docs.imperialcad.app/api-and-integrations/fivem-installation/offered-plugins)
{% endcontent-ref %}

***

### Commands

| Command               | Description                                                                                | Example                        |
| --------------------- | ------------------------------------------------------------------------------------------ | ------------------------------ |
| `/setciv (ssn)`       | Sets the civilian                                                                          | /setciv 43294343               |
| `/getciv`             | Gets the civilian information                                                              | /getciv                        |
| `/clearciv`           | Clears the set civilian                                                                    | /clearciv                      |
| `/regveh`             | Registers the vehicle the user is in                                                       | /regveh                        |
| `/tablet`             | Shows the tablet                                                                           | /tablet                        |
| `/911 (description)`  | <p>Sends a 911 call <br>- If civilian is set, it will send the civilian's information.</p> | /911 There's a man with a gun  |
| `/a911 (description)` | Sends an anonymous 911 call                                                                | /a911 There's a man with a gun |
| `/panic`              | Sends a panic notification in the CAD                                                      | /panic                         |
| `/rplate (plate)`     | Runs the plate                                                                             | /rplate 3PA7AW                 |
| `/ts (details)`       | Starts a traffic stop call and attaches the unit                                           | /ts Plate: 39ALP23             |
| `/attach (callnum)`   | Attaches a unit to a call                                                                  | /attach 43                     |

***

### Contributing

> Fork, modify, and submit pull requests to contribute.

***

### License

> Imperial Software Solutions, LLC. Unauthorized copying, distribution, or use without explicit permission is prohibited and may result in legal action.

***