# Welcome to Luxart Engineering
Free law enforcement resources for FiveM.
## Luxart Vehicle Control: Fleet
The new an improved latest resource from Luxart Engineering, **coming soon**!
LVC:F Logo
{% content-ref url="/pages/EvDrceYhByCu6uIo2r8i" %}
[What is LVC:Fleet?](/fleet/readme-1)
{% endcontent-ref %}
{% content-ref url="/pages/9LSvyoXaSS02ud7vdm3g" %}
[Resource Installation](/fleet/resource-installation)
{% endcontent-ref %}
{% embed url="" %}
## Luxart Vehicle Control v3
The O.G. modified emergency light and siren controller for FiveM.
{% content-ref url="/pages/CNtaCAVKYbIAv75R6ova" %}
[Resource Installation](/pro-laser-4/resource-installation)
{% endcontent-ref %}
{% embed url="" %}
# Product Roadmaps
Luxart Engineering Product Roadmaps
{% embed url="" %}
Luxart Engineering Trello
{% endembed %}
### Fleet
* [x] ~~**Storage Management:** save & load configurations~~
* [x] ~~**Expand Rumbler / Howler Control:** client menu control, VCF settings.~~
* [x] ~~**Guaranteed Plugin Compatibility:** test and verify plug-ins work without issue.~~
* [ ] **VCF Examples & Packs:** premade LVC:F ready packs.
* [ ] **Copy Profile**[**:**](https://docs.luxartengineering.com/fleet/what-is-lvc-fleet) ability to copy configuration from one profile to another.
* [ ] **VCF XML Generator GUI:** create VCFs quickly through the help of a user interface.
* [ ] **Dynamic HUD Elements:** additional HUD buttons for plugin integration.
* [ ] **Passenger Control:** allow passengers of vehicle to use siren controller.
### v3
* [ ] **Dynamic HUD Elements:** additional HUD buttons for plugin integration.
* [ ] **Passenger Control:** allow passengers of vehicle to use siren controller.
### Shared Plugins
TBA.
### Pro Laser 4
* [x] ~~**Controller Support:** use correct controls depending on if the player is in a vehicle or on foot.~~
* [x] ~~**Resize & Move OSD:** ability to modify on screen display parameters.~~
* [x] ~~**Discord Hook:** allow users to upload records to discord instead of Imgur.~~
* [x] ~~**Improve Cosine Error:** improve accuracy of cosine error, including vertical separation.~~
* [x] ~~**Improve Redundancy:** add crash detection and recovery command.~~
* [ ] **Record Tablet Delay:** reduce upload delay experiment with more frequent uploads.
* [ ] **Bypass Self-Test:** player option to bypass self-test, legal challenge opportunity.
* [ ] **Display Self-Test Timestamp:** ability to view timestamp for ticketing purposes without tablet.
* [ ] **Passenger FPS Angle Support:** dynamic angle limitations in FPS based on seat / vehicle.
* [ ] **Tablet Improvements:** designated area exports and tablet prop.
# Frameworks & Exports
Supported frameworks and exports.
### Frameworks
The below frameworks are supported, please report any conflicts by creating an issue on the respective product or on [my discord](https://discord.link/lvc).
{% hint style="success" %}
QBCore: so long as you do not have have [qb-extras](https://github.com/MrEvilGamer/qb-extras/) installed.
{% endhint %}
{% hint style="success" %}
ESX
{% endhint %}
### Exports
**Vehicle State Change Event** (*Coming v3.2.10)*\
Broadcasts event when LVC vehicle state changes. Returns a table/array of data below:
Table Index/Key
Description
Options
state_indic
Indicator/turn-signal state.
0: off
1: left on
2: right on,
3: hazard/4-ways on
actv_manu
Is manual siren on?
true, false
actv_horn
Is the horn on?
true, false
state_lxsiren
Main siren tone ID.
0: off,
>0: tone ID of main siren
state_pwrcall
Powercall/auxiliary siren tone ID.
0: off
>0: tone ID of aux/powercall
state_airmanu
Airhorn/manual siren tone ID.
0: off
>0: tone ID of AirManu
{% code title="Example Event Handler" %}
```lua
RegisterNetEvent('lvc:UpdateThirdParty')
AddEventHandler('lvc:UpdateThirdParty', function(update_data)
local siren_tone = update_data['state_lxsiren']
if siren_tone > 0 then
--Sirens on, do something...
end
end)
```
{% endcode %}
# What is LVC:Fleet?
### Introduction
Luxart Vehicle Control: Fleet is a new separate resource based off of the innovations of [Luxart Vehicle Control v3](https://github.com/TrevorBarns/luxart-vehicle-control/). It introduces more finite control of vehicle profiles by the use of Vehicle Configuration Files, abbreviated VCFs. A vehicle configuration's settings are called **profiles** for LVC and describe all the settings encompassed in the VCF. Vehicles, by use of it's game name, are then assigned approved **profiles.**
#### **LVC:Fleet specific features over LVCv3:**
* additional profile specific settings (siren defaults, audio settings, menu permissions, etc.)
* on the fly profile selection through LVC menu
* server sided siren integration with **local override** and **peer override**
* rumbler / howler support *(requires installation of compatible siren)*
{% hint style="info" %}
**Local Override**: When active, LVC uses resident.rpf client side sirens instead of any server sided sirens.
**Peer Override:** When active, LVC uses the clients local siren selection for peers of the same *faction. See more in VCF configuration.*
{% endhint %}
#### Basics behind LVC:Fleet:
LVC:F Relationship Diagram
In the above diagram, you can see that LSPD, BCSO, SASP all have approved profiles 1, 2, 3. **This allows the player to select from these three profiles in the LVC:Fleet menu**. Meanwhile, the firetruck and ambulance are assigned individual profiles and will not be able to change profiles.
### Features
* Custom server/client side siren assignments
* Ability to change which siren is used through in game menu
* Rumbler / Howler support
* Choice to override other players sirens
* Choice to use client side sirens
* [Menu permissions](/fleet/resource-installation/customize-vcfs#menu-element-permissions)
* In-game siren controller HUD
* Additional functionality through [plugins](/shared-plugins/introduction-to-plugins)
* On-demand siren tone selection through registered keys
* Save / Load user preferences
# Resource Installation
Instructions on how to install LVC:Fleet into your server
#### Download the latest stable release `Luxart.Vehicle.Control.Fleet.vX.X.X.zip` (not source code) from [releases](https://github.com/TrevorBarns/luxart-vehicle-control-fleet/releases).
1. **Copy `RageUI` folder from 'dependencies' folder in resources folder.**
LVC utilizes a modified release of RageUI, please install it even if you already have another version installed.
2. **Copy `lvc_fleet` folder to resources folder.**
Make sure your resource is named lvc_fleet it is required.
3. **Add `ensure lvc_fleet` to server.cfg.**
4. **(*****Optional*****) Install any desired plugins from plugins folder to `lvc_fleet/PLUGINS/` (*****see*** [***shared plugins***](/shared-plugins/introduction-to-plugins)**)**
{% hint style="info" %}
This resource utilizes [globbing](https://docs.fivem.net/docs/scripting-reference/resource-manifest/resource-manifest/#globbing) which may not be supported in some linux environments. Most releases include `fxmanifest.for.Linux.Servers.no.globbing.zip` which contain a compatible fxmainfest.lua without globbing.
{% endhint %}
# Customize VCFs
VCFs contain LVC:Fleet setting for each profile. Customize them to your desire.
{% hint style="info" %}
VCF files use XML file format and must be valid for LVC:Fleet to load them. Parsing errors will be printed to server console on resource start. You can use [xmlvalidation](https://www.xmlvalidation.com/) to check your VCF file for errors.
{% endhint %}
VCF files should be placed in `/VCF/` folder see [Assign Profiles](/fleet/resource-installation/configure-base-settings#assign-profiles) on how to assign them to specific vehicles.
#### VCFROOT Attributes
```xml
```
{% tabs %}
{% tab title="Faction" %}
Determines if two clients profiles are compatible for peer override.
*Example*: setting all profiles used for police departments to "LEO" would allow one agency to use peer override another agencies sirens. This is what prevents fire sirens from being overridden.
{% endtab %}
{% tab title="Author" %}
*Reserved for future implementation.*
{% endtab %}
{% endtabs %}
#### :loud\_sound:HORNS/SIRENS Elements
`` and `` are containers that can contain multiple HORN and SIREN elements respectively.
{% code title="\
Item Name
Use
ResidentString
GTA V tone string that references RESIDENT.rpf file.
String
Tone string that references server sided sirens. (optional)
Ref
Tone audio bank reference for server sided sirens. (optional)
Bank
Tone audio bank name that loaded server sided sirens bank. (optional)
RumblerString
Tone string that references resident or server sided sirens. (optional)
RumblerRef
Tone string that references resident or server sided sirens. (optional)
RumblerBank
Tone audio bank name that loaded server sided sirens bank. (optional)
Option
Determines when this tone can be played: 1-Cycle & Button, 2-Cycle Only, 3-Button Only, 4-Disabled. (optional)
Fallback
Determines what siren should be played when using peer override and the other player is using a siren index that is greater than the local players siren count. e.g. playing 4th siren and the local player only has 3 sirens assigned.(Recommended)
#### :gear: SIREN\_CONFIG Element
```xml
```
Item Name
Use
*ToneID
Which index for respective tones (HORN, PRI. MANU., SEC. MANU.)
Airhorn_Intrp
Airhorn interrupt siren on activation, default behavior.
Reset_Standby
Siren resets to first index on toggle, default behavior.
Park_Kill
Turn siren turn off on vehicle exit, default behavior.
Local_Override
Override any server side sirens with client side sirens. (Must be enabled if no server sided sirens are used.)
Peer_Override
Override other players siren choice with select profile. (Recommend disabled if no server sided sirens are used.)
Rumbler
Enables rumbler/howler functionality (Requires RumblerString, RumblerRef, RumblerBank to be set.)
#### :traffic\_light: HUD Element
```xml
```
{% tabs %}
{% tab title="Enabled" %}
Default siren controller HUD display state.
{% endtab %}
{% tab title="Backlight Mode" %}
1 = Auto: toggle HUD backlight with headlight state
2 = Always off
3 = Always on
{% endtab %}
{% endtabs %}
#### :sound:Audio Element
```xml
```
#### :closed\_lock\_with\_key: Menu Element - Permissions
Each element controls the access to a menu element.
```xml
```
# Configure Base Settings
## Set a Community
This unique set of characters for your community will be used for profile saving.
* The ID should be 4-6 alphanumerical characters.
* Spaces are not allowed and will not work, dashes can be used instead.
* Some examples may be your servers abbreviation, name, etc.
* **Examples:**\
`'LCPS'`, `'LCPSR'`, `'SARP'`, `'LSDOJ'`, `'JakesRP'`, etc.
{% hint style="info" %}
The purpose of this string is to differentiate the client side saves between servers. Since it is possible (and likely) that servers may use the same profile names, but different profile siren assignments.
{% endhint %}
{% hint style="warning" %}
This string should be set once, and never changed as it will result in loss of LVC saves for all players. It is not public facing so even if the server name changes it does not need to change.
{% endhint %}
## Configure Controls
#### Register Key Maps
Users may change these in their GTA V > Settings > Hotkeys > FiveM settings. \
More info: [CFX Cookbook - How RegisterKeyMappings Work]()\
List of Keys**:** [RegisterKeyMap Supported Keys](https://pastebin.com/u9ewvWWZ)
`open_menu_key`: sets default key for opening LVC:Fleet Menu.\
`lockout_default_key`: sets default key for toggling LVC:Fleet control lock, which disabled all controls.
**Indicator Controls**
These static keys cannot be changed by the end user and support controller keys as well.\
List of Keys**:** [CFX Game Reference - Controls](https://docs.fivem.net/docs/game-references/controls/)
`hazard_key`*:* when held for `hazard_hold_duration` toggle 4-way flashers.\
`left_signal_key`: toggle left turn signal.\
`right_signal_key`: toggle right turn signal.
## Assign Profiles
{% code title="SETTINGS.lua" %}
```lua
---------------------VCF FILES---------------------
VCF_Files = {
'DEFAULT.xml', --1
'WHELEN-295.xml', --2
'WHELEN-CENCOM-G.xml', --3
'MASTERCOM-B.xml', --4
'FS2000.xml', --5
'TMD.xml', --6
}
VCF_Assignments = {
['DEFAULT'] = { 1 },
['LAPD'] = { 1, 3 }
[''] = { 1, 2, 3, 4, 5 }
}
```
{% endcode %}
### VCF\_Files
Table of VCF file names to be loaded on resource start. These should be locate in `/VCF/` directory. VCF Files represent profiles and contain all of LVC:Fleet's settings for that profile.
{% hint style="info" %}
To load newly installed VCF files, run `refresh` then `restart lvc_fleet`.
{% endhint %}
### VCF\_Assignements
In this table you can add additional vehicles for assignment using the vehicles `` exactly as found in `vehicles.meta`. **It is case sensitive**.
vehicles.meta example:
```xml
...
so2so2so2null
...
```
On the right side of the key, `{ 1, 2, 3 }`, for example, are the index's of the profiles you would like assigned to this vehicle. In the above example, that would equate to DEFAULT, WHELEN-295, WHELEN-CENCOM-G. Moreover, changing the order of the VCF\_Files, you would change which profiles are assigned.
Both R\* and LVC truncate down to 11 characters. **It is important that the first 11 characters of the vehicle game name are unique.**
* **Example**:\
If my addon vehicles `` is "*2008 Ford CVPI CHP*" and I have another vehicle "*2008 Ford CVPI LSPD*" both of these after truncate equate to "*2008 Ford C*" therefor LVC:Fleet will not be able to differentiate these.
{% hint style="danger" %}
**The default or fallback key `['DEFAULT']` in the VCF\_Assignements table should always be present and never removed. Doing so will result in issues.**
{% endhint %}
#### **Wildcards**
Supported Wildcards:
* `#` represents 1 or more digits.
**How it works:**
1. LVC checks for vehicle profile matching game name. *e.g.* `['2008fpiu1']`
2. If not found, attempts wildcard search, meaning wildcards will be used *secondary* to custom profiles. *e.g.* `['2008fpiu#']`
3. If not found, attempts a less specific wildcard search, leading and trailing numbers. *e.g.* `['#fpiu#']`
4. If not found, use default profile. *e.g.* `['DEFAULT']`
*Example*:\
\* `['veh#'] = { ... }` will be used for vehicles with game names `veh1`, `veh2`, ..., `veh9999`, etc. where exact profile not found.
# Advanced Configuration
Debugging and advanced configuration functionality.
### Debug Mode
To temporarily toggle *debug mode* use chat command `/lvcdebug` this resets on resource restart. For persistent debug mode use convar below.
### **Resource Convars (fxmanifest.lua)**
* `beta_checking` enables beta version notifications to server console.
* `experimental` will mute experimental messages for server console.
* `debug_mode` increases console logging for client, prints \ of vehicle if no profile was found.
{% hint style="info" %}
Toggling these require the `refresh` command to be ran first, then restart the resource for changes to take effect.
{% endhint %}
### Custom HUD
#### Custom Graphics
The in game siren controller display or heads-up-display UI can be modified to your liking, you will need an understanding of HTML, Javascript, and NUI.
{% hint style="info" %}
Support is limited in this area.
{% endhint %}
#### Move Default HUD location
All HUD related functions/code is located in the UI folder. The default position of the HUD is set in `UI/html/style.css`.
```css
#sirenbox {
display: none;
position: absolute;
overflow: hidden;
width: 602px;
height: 161px;
left: 0%;
top: 68%;
transform-origin: left top;
transform: scale(0.6);
background-image: url("../textures/background.png");
}
```
**The relevant attributes are: *****left*****, *****top*****, and *****transform-origin*****.**
* *left* determines how far in percentage of the screen resolution should the HUD be placed from the left edge. If you wanted to right align the HUD you could change this to `right: XX%`, 0% being against the right edge of the display.
* *top* determines how far down from the top the HUD should be placed.
* *transform-origin* attribute determines which way the HUD should expand on size adjustment. For a bottom right aligned HUD you would want the transform-origin to be `right bottom`. This ensures that the HUD does not expand outside of the screen space.
### Custom Audio Schemes
Custom front end sound effects can be added. Create a new folder in `/UI/sounds` with the desired name of your scheme.
{% hint style="warning" %}
Sound scheme names cannot have any spaces in them.
{% endhint %}
Add scheme name to `` object in VCF.
### Ace Menu Permissions
{% hint style="info" %}
:date: Future Feature: estimated release 1.0.0-BETA
{% endhint %}
#### Set up VCF for Permission
To do this add an attribute to the associated menu item you would like to limit a profile's VCF.
```xml
```
In the example above, we've added `Permissions="true"` after the enable attribute. It is important to note that the `Enabled` attribute must be true, it acts as an end-all-be-all switch. Permissions can be added to any of the `