Configuring this resource

We've made it as simple as possible to configure oELS

Our config.lua file contains all customisable options to make your initial configuration of oELS as simple as possible. Many of the values are accompanied by comment lines where needed but you can find the options below with details.

Debugging & Version Checking

These settings are useful to server owners and developers as they allow you to ensure your resource is the most up-to-date version of the script as well as toggle the debugging prints which will be useful to locate an error or where something is not going right.

If you are opening a ticket, the team will ask for your debugging logs.

Default Keybinds

This section is where you will set the default keybinds for the ELS system, users will be able to customise these via their FiveM keybinds menu. The accepted input for each value is a string representing which control is pressed.

Keyboard Keybinds: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/

Controller Keybinds: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/pad_analogbutton/

Config.DefaultKeybinds.Keyboard = {
    PrimaryLights = "Q",
    SecondaryLights = "K",
    WarningLights = "L",
    SirensToggle = "G",
    SirensSwitch = "R",
    Bullhorn = "X",
}

Config.DefaultKeybinds.Controller = {
    PrimaryLights = "LLEFT_INDEX",
    SirensToggle = "LDOWN_INDEX",
    SirensSwitch = "RRIGHT_INDEX",
    Bullhorn = "RDOWN_INDEX",
}

Soundpacks

Soundpacks are used by Server-Sided Siren resources, you are required to define them in this section so the script is able to load the sounds for use. We do NOT provide support for any server-sided sirens and advise that users contact the developers of those resources.

We recommend the use of the LG Mod Sirens

UI Options

oELS comes with an optional and configurable UI for players who are in ELS-enabled vehicles. The options in this section allow you to enable that UI for your server, set the command to toggle it and indicate if it is on by default.

Optilink

Optilink are the beeps which occur when your ELS completes any changes, these can be activated by switching the value of Enabled to either true/false. As well as the basic optilink we allow for the use of 999 Mode when the lights are initially turned on.

If you are adding a vehicle to the 999 Mode list, please ensure that the vehicle spawn code is surrounded by ` and the line is followed by a comma otherwise the table will not form causing errors on script startup.

Non-ELS Vehicles

The support for Non-ELS vehicles is a new addition to oELS, the majority of configuration for lighting patterns is done via this configuration file. Simply copy the code extract from below populating it with the correct data for your vehicle.

[`NONELS`] = {
    PrimaryLights = {1},
    SecondaryLights = {3},
    WarningLights = {4},
    OnSceneLights = {2}
}

This only works for Extra controlled Non-ELS vehicles

WigWags

This feature is a new addition to oELS which is still being worked on, simply set the value to true/false and the script will handle the rest.

Custom Patterns

The four tables at the bottom of the configuration file allow you to customise the order that the lights flash in and how long, for each stage of the lighting. We advise having the vehicle creator let you know which extra is which or using vMenu to correctly identify them.

One of the simplest tasks within our ELS is creating custom patterns for your vehicles to use, at first this seems daunting due to the large number of numbers involved but once you understand it you are good to go at creating any pattern that you want for your vehicles.

When adding a pattern you should follow the format provided below.

["Pattern Name"] = {
    {
        {Extras Controlled}, Time in Miliseconds
    }
},

To demonstrate we will be using extras 1,2,3 and 4 and would like them to flash with extra 1 and 2 together then stop and flash extra 3 and 4 together with a really small delay of 75 milliseconds. To give you an idea, 1 second in milliseconds is 1000.

["NewPattern"] = {{{1,2}, 75}, {{}, 75}, {{3,4}, 75}},

That is for our primary lights, we would then repeat the same process to make our Secondary and Warning patterns before setting the JSON file’s light pattern to the name of our new pattern.