METROLORE Docs
  1. Docs
  2. FPS Booster
  3. Configuration

M5Line M5 · FPS BoosterView in store →

Configuration

All options are in Config.lua.

Option Default Meaning
Config.Locale "en" Interface language: "en" or "tr". Texts are in locales/.
Config.GlobalSettings all false The available options and the state each one starts in for a player who has no saved settings.
Config.BenchmarkSeconds 8 Length of the built-in FPS test, in seconds.
Config.Key "F11" Default key that opens the menu.
Config.DisableKeybind false Set to true to remove the default key.
Config.CommandString "fpsMenu" Command that opens the menu.

#Options

The keys of Config.GlobalSettings are the option names. Do not add keys; only these are accepted by the resource:

Key Menu name What it does
peds Pedestrians Stops ambient peds from spawning and removes the local ambient ones near the player.
vehicles Traffic Stops ambient vehicles from spawning and removes the local ambient ones near the player.
objects Object detail Draws distant objects at lower detail.
particles Particle effects Removes particle effects within 25 metres.
broken Broken glass Clears glass shards. Small effect.
ped Ped decals Clears blood, dirt and wetness from the player. Small effect.
rain Weather Sets rain and wind to zero on this client. Small effect.
shadows Shadows Turns off cascade shadows.
lights Lighting Shortens street light and headlight range.
lowTexture Detail distance Lowers the level-of-detail distance of the scene.
modelBudget Model memory budget Reduces the memory budget for ped and vehicle models. Helps graphics cards with little video memory.

#Language

Texts are in locales/en.lua and locales/tr.lua. Add a language by copying en.lua, translating the values and adding the file to fxmanifest.lua, then set Config.Locale.

#Exports and events

Client side only:

lua
-- Turn an option on or off. Returns true when the option name and value are valid.
exports['mlr-fpsbooster']:setSetting('shadows', true)

-- Open the menu
TriggerEvent('fpsBooster:OpenMenu')

The option must be one of the keys above and the value must be a boolean. The change is saved for the player.