refactor(client/main): fix structure and move config out of client lua

README.md

@@ -13,3 +13,7 @@ Population management for qbox.
 ```
 ensure qbx_density
 ```
+
+## Configuration
+- Adjust variables in `config/client.lua` for permanent changes
+- Utilize `exports.qbx_density:SetDensity(type, value)` to adjust at runtime

main.lua → client/main.lua

@@ -1,50 +1,46 @@
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_HILLBILLY`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_BALLAS`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_MEXICAN`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_FAMILY`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_MARABUNTE`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_SALVA`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `AMBIENT_GANG_LOST`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `GANG_1`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `GANG_2`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `GANG_9`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `GANG_10`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `FIREMAN`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `MEDIC`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `COP`, `PLAYER`)
-SetRelationshipBetweenGroups(1, `PRISONER`, `PLAYER`)
-
-local density = {
-    parked = 0.8,
-    vehicle = 0.8,
-    multiplier = 0.8,
-    peds = 0.8,
-    scenario = 0.8,
-}
-
-local function decorSet(type, value)
-    if type == 'parked' then
-        density.parked = value
-    elseif type == 'vehicle' then
-        density.vehicle = value
-    elseif type == 'multiplier' then
-        density.multiplier = value
-    elseif type == 'peds' then
-        density.peds = value
-    elseif type == 'scenario' then
-        density.scenario = value
-    end
-end
-
-exports('DecorSet', decorSet)
-
-CreateThread(function()
-    while true do
-        SetParkedVehicleDensityMultiplierThisFrame(density.parked)
-        SetVehicleDensityMultiplierThisFrame(density.vehicle)
-        SetRandomVehicleDensityMultiplierThisFrame(density.multiplier)
-        SetPedDensityMultiplierThisFrame(density.peds)
-        SetScenarioPedDensityMultiplierThisFrame(density.scenario, density.scenario) -- Walking NPC Density
-        Wait(0)
-    end
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_HILLBILLY`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_BALLAS`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_MEXICAN`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_FAMILY`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_MARABUNTE`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_SALVA`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `AMBIENT_GANG_LOST`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `GANG_1`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `GANG_2`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `GANG_9`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `GANG_10`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `FIREMAN`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `MEDIC`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `COP`, `PLAYER`)
+SetRelationshipBetweenGroups(1, `PRISONER`, `PLAYER`)
+
+local density = lib.load('qbx_density.config')
+
+local function setDensity(type, value)
+    if type == 'parked' then
+        density.parked = value
+    elseif type == 'vehicle' then
+        density.vehicle = value
+    elseif type == 'multiplier' then
+        density.multiplier = value
+    elseif type == 'peds' then
+        density.peds = value
+    elseif type == 'scenario' then
+        density.scenario = value
+    end
+end
+
+---@deprecated use SetDensity instead
+exports('DecorSet', setDensity)
+exports('SetDensity', setDensity)
+
+CreateThread(function()
+    while true do
+        SetParkedVehicleDensityMultiplierThisFrame(density.parked)
+        SetVehicleDensityMultiplierThisFrame(density.vehicle)
+        SetRandomVehicleDensityMultiplierThisFrame(density.multiplier)
+        SetPedDensityMultiplierThisFrame(density.peds)
+        SetScenarioPedDensityMultiplierThisFrame(density.scenario, density.scenario) -- Walking NPC Density
+        Wait(0)
+    end
 end)

config/client.lua

@@ -0,0 +1,11 @@
+return {
+    -- Density of various things in the world
+    -- Minimum value is 0.0, maximum value is 1.0
+    -- Value of 1.0 represents GTA Online populate rates
+    -- Value of 0.0 removes all of that type
+    parked = 0.8, -- Density of parked vehicles
+    vehicle = 0.8, -- Density of vehicles
+    randomvehicles = 0.8, -- Density of random vehicles
+    peds = 0.8, -- Density of random peds (civilians, etc.)
+    scenario = 0.8, -- Density of scenario peds (bikers, gangsters, etc.)
+}

fxmanifest.lua

@@ -6,7 +6,14 @@ description 'Population management'
 repository 'https://github.com/Qbox-project/qbx_density'
 version '1.0.0'
 
-client_script 'main.lua'
+client_scripts {
+    '@ox_lib/init.lua',
+    'client/main.lua'
+}
+
+files {
+    'config/client.lua'
+}
 
 lua54 'yes'
 use_experimental_fxv2_oal 'yes'