Resource Configuration

This page provides comprehensive information about our configuration files, assisting in the setup of the resource.

---

cfg.language

This feature enables users to personalize the language that the resource will utilize. These languages can be configured and set within the cfg.languages section of the configuration file. Here.

Example: config.lua

cfg.language = 'en'

---

cfg.commands

This section of the configuration file allows for the customization of the resources commands. There are 2 commands within the table that can be edited according to your needs. Each section will contain specific values such as command, description, and more. These details are outlined and explained below.

Command:

This refers to the input command used in the user chat. It is a string value.

Description:

This provides a brief description of the command that is displayed when a user inputs it. This helps the user understand the purpose and function of the command. It is also a string value.

Cooldown:

This refers to the cooldown period between inputting the command. The value is measured in milliseconds, with every 1000 milliseconds being equivalent to one second. If you prefer not to have a cooldown period, please leave this value at 0.

Example: config.lua

    ['spawnFan'] = {
        command = 'spawnFan',
        description = 'Spawn a PPV Fan.',
        cooldown = 3000 --@comment: In Miliseconds
    },

---

cfg.framework

In this section, you have the capability to whitelist resource commands. You can utilize both QBCore and ESX to whitelist the commands. Additionally, you have the option to create an item for both QBCore and ESX.

---

cfg.particles

This section offers the ability to customize, enable, and disable the particles used by the resource.

• Allow: This value is a boolean indicating whether particles will loop on any fan entity that is powered on and belongs to the associated script.

• Data: Within this table, you have the ability to customize the particles that the resource will utilize. You can explore new particles to incorporate into this section. Additionally, you can adjust the scale of the particles, with higher values resulting in larger particles and lower values resulting in smaller particles.

Particle List

---

cfg.model

In this section, you have the ability to modify the model used by the resource.

cfg.models = {
    ['ppv_fan'] = `zea_ppvfan`
}

---

cfg.indicators

This section offers the ability to customize interaction indicators that are displayed on entities associated with the script. If the setting is enabled (set to true), the indicators will be visible when in proximity to fans; if disabled (set to false), they will not be displayed.

cfg.indicators = {
    ['indicator'] = {
        allow = true,
        img = 'indicator.png'
    }
} 

---

cfg.keybinds

This section provides the opportunity to customize the key bindings used by the resource. The key bindings have been converted to string format to simplify configuration and can be accessed here.

cfg.keybinds = {
    toggle_power = 'E',
}

---

cfg.languages

This section provides the capability to add, remove, and customize languages used by the resource. The language can be configured at the beginning of the file. Here.

---