Configuration
All configuration is done in config.lua inside the f5_boost resource folder.
Config = {}
Config.Locale = 'en'
Config.OpenKey = 'F7'
Config.Command = 'fpsmenu'
Config.MaxProfiles = 5
Config.ShowFPSCounter = true
Config.DisableDispatch = true
Options
| Option | Type | Default | Description |
|---|---|---|---|
Locale | string | 'en' | Language file to load from locales/. See Localization below |
OpenKey | string | 'F7' | Default keybind to open/close the menu. Players can rebind this in FiveM settings |
Command | string | 'fpsmenu' | Chat command to open/close the menu (used as /fpsmenu) |
MaxProfiles | number | 5 | Maximum number of saved profiles per player. Stored in the database |
ShowFPSCounter | boolean | true | Show a live FPS counter in the menu header |
DisableDispatch | boolean | true | Disable GTA's built-in dispatch services (police/ambulance AI). Big CPU savings on RP servers |
Keybind
The keybind set in Config.OpenKey is only the default. FiveM's key mapping system lets each player rebind it through Settings > Key Bindings > FiveM. The command name shown there is "Open FPS Menu".
If you change Config.OpenKey, existing players who already have a saved binding won't be affected. FiveM stores key mappings per-player. The new default only applies to players who haven't rebound it yet.
Dispatch Services
When Config.DisableDispatch is true, the script disables all 15 GTA dispatch service types on startup. This prevents the game from spawning response units (police cars, ambulances, firetrucks) when crimes happen nearby.
This is a significant CPU saver on RP servers where dispatch is handled by scripts like qb-dispatch or cd_dispatch. If your server relies on GTA's built-in wanted system, set this to false.
FPS Counter
The FPS counter runs a per-frame loop to count actual rendered frames. It only sends data to the NUI when the menu is open, once per second. When the menu is closed, it still counts frames (needed for accuracy) but doesn't send any NUI messages.
Setting Config.ShowFPSCounter to false disables the counter entirely, removing the per-frame loop.
Localization
F5 Boost ships with 13 languages:
| Code | Language |
|---|---|
en | English |
pl | Polish |
de | German |
es | Spanish |
fr | French |
it | Italian |
pt | Portuguese |
nl | Dutch |
cs | Czech |
tr | Turkish |
ar | Arabic |
th | Thai |
zh | Chinese |
Set Config.Locale to any of these codes. The locale system has a fallback chain: configured language, then English, then the raw key name.
To add a new language, copy locales/en.lua, rename it (e.g. locales/ru.lua), translate the values, and set Config.Locale = 'ru'. All 79 locale keys must be present.
The locale covers both the NUI interface and server-side notification messages. If a key is missing, it will show the raw key name (e.g. notify_profile_saved) instead of the translated text.