Examples and troubleshooting
server.cfg examples
Section titled “server.cfg examples”In each example the framework starts before the bridge, and the bridge starts before ox_inventory.
setr inventory:framework "esx"
ensure oxmysqlensure ox_libensure es_extended
ensure kivo-inv-bridgeensure ox_inventorysetr inventory:framework "qbx"
ensure oxmysqlensure ox_libensure qbx_core
ensure kivo-inv-bridgeensure ox_inventoryOX Core
Section titled “OX Core”setr inventory:framework "ox"
ensure oxmysqlensure ox_libensure ox_core
ensure kivo-inv-bridgeensure ox_inventoryQB-Core
Section titled “QB-Core”The bridge detects qb-core and reads cash, bank, name and ID from it. Use the same layout as above with ensure qb-core as the framework line. The inventory:framework values that ship with this version of ox_inventory are esx, ox, nd and qbx, so follow the guidance from Kivo support for the value to use on QB-Core.
ensure oxmysqlensure ox_libensure qb-core
ensure kivo-inv-bridgeensure ox_inventoryWith ox_target
Section titled “With ox_target”setr inventory:framework "esx"setr inventory:target 1
ensure oxmysqlensure ox_libensure es_extendedensure ox_target
ensure kivo-inv-bridgeensure ox_inventoryAvatar setups
Section titled “Avatar setups”Discord avatars only
Section titled “Discord avatars only”Put your bot token in the config file and leave Steam empty. In kivo-inv-bridge/shared/config.lua:
Config.Avatar = { DiscordBotToken = "your-discord-bot-token", SteamApiKey = "", Priority = "discord", CacheDuration = 0,}Players who have no linked Discord account get the default profile picture.
Steam avatars only
Section titled “Steam avatars only”Empty the Discord token so the bridge skips Discord, and set the Steam key in server.cfg:
Config.Avatar = { DiscordBotToken = "", SteamApiKey = "", Priority = "steam", CacheDuration = 0,}set steam_webApiKey "your-steam-api-key"Discord first, Steam as backup
Section titled “Discord first, Steam as backup”Set both. Discord is tried first. If Discord gives no result for a player, Steam is tried.
Config.Avatar = { DiscordBotToken = "your-discord-bot-token", SteamApiKey = "your-steam-api-key", Priority = "discord", CacheDuration = 0,}Keep the keys out of the config file
Section titled “Keep the keys out of the config file”Leave both values empty in the config file and put them in server.cfg. The bridge uses the convars when the config values are empty.
Config.Avatar = { DiscordBotToken = "", SteamApiKey = "", Priority = "discord", CacheDuration = 0,}set discord_bot_token "your-discord-bot-token"set steam_webApiKey "your-steam-api-key"No avatars at all
Section titled “No avatars at all”Leave both values empty and set neither convar. Players see the default profile picture. Everything else keeps working.
Good to know
Section titled “Good to know”- Refresh timing. Cash, bank, name and ID are requested again every time the inventory opens. The avatar is looked up once per connection.
- Multiple characters. The panel shows the data of the character the player is currently playing, as reported by your framework.
- Restarting the bridge on a live server. Run
restart kivo-inv-bridgeand thenrestart ox_inventoryin the server console. Avatars of everyone online are looked up again after the restart, so the pictures can take a few seconds to come back. - Players already online when the bridge starts. Their avatars are looked up right after the start, so you do not need to make them reconnect.
- A player changed their Discord or Steam picture. The old one stays until they disconnect and join again.
- Other scripts and ox_inventory exports. Scripts that use
exports.ox_inventorykeep working as with stock ox_inventory 2.44.1. - Currency symbol. The interface shows amounts with a
$prefix. Changing it means editing the interface source and rebuilding. See Rebuilding the interface. - Backups inside
resources. Do not leave a backup copy of an oldox_inventoryfolder insideresources. FiveM scans every folder there and can load the wrong one. Keep backups outsideresources.
Troubleshooting
Section titled “Troubleshooting”| Problem | Likely cause | What to do |
|---|---|---|
| The inventory does not open, or the interface looks broken | kivo-inv-bridge is not installed, is not started, or starts after ox_inventory |
Put ensure kivo-inv-bridge directly above ensure ox_inventory. Check that the folder is named exactly kivo-inv-bridge. Then restart the bridge and ox_inventory. |
F8 console shows [kivo-inv] kivo-inv-bridge is NOT started, skipping ... |
The bridge is not running on the server | Run ensure kivo-inv-bridge in the server console and check for errors. Fix the server.cfg order so it starts at boot. |
ox_inventory stops at start and says the UI has not been built |
ox_inventory/web/build/index.html is missing |
Extract ox_inventory/web/build.zip inside ox_inventory/web/. See Installation. |
An error about a required version of ox_lib or oxmysql |
A dependency is too old | Update ox_lib to 3.27.0 or newer and oxmysql to 2.7.3 or newer. |
Console shows WARNING: No supported framework detected! |
Your framework was not started yet when the bridge started, or it is not one of ESX, QB-Core, QBX, OX Core | Move your framework ensure line above ensure kivo-inv-bridge, then restart the bridge. For other frameworks, see Feed the interface from another framework or script. |
Cash and bank always show 0 |
The framework was not detected, or your money accounts do not use the usual names | Check the detection line in the console. On ESX the accounts must be named money and bank. On QB-Core and QBX they must be cash and bank. For a custom economy, see the exports page. |
| The panel shows the FiveM name and the server ID | The framework was not detected, or the character is not loaded yet | Check the detection line in the console. Make sure the player has finished choosing a character. |
| The avatar is always the default picture | See the avatar checklist below | Work through the checklist below. |
Changing Priority, CacheDuration, Debug.Enabled or Debug.LogAvatar changes nothing |
These options are not used by the bridge in this release | Nothing to fix. See Configuration. |
Another script reports No such export ... in resource kivo-inv-bridge |
That script started before the bridge, or the bridge is stopped | Start the bridge earlier, guard the call, or add dependency 'kivo-inv-bridge' to that script’s manifest. See Guard your calls. |
| Item pictures are missing | The image is not in ox_inventory/web/images/, or its name does not match the item name |
Add a .png file named exactly like the item, in lowercase, for example water.png for the item water. |
| Players still see the old interface after an update | The client still has the old files | Ask the player to restart FiveM. If it persists, clear the server cache folder and restart the server. |
| After a stock ox_inventory update, the interface stopped working | The update replaced client.lua or web/build/ |
Follow Using the Kivo interface with your own ox_inventory. |
Avatar checklist
Section titled “Avatar checklist”Work through these in order:
- Is a source configured? You need a Discord bot token, a Steam Web API key, or both, in the config file or as convars. Check that the value was copied in full and is inside the quotes.
- Does the player have the identifier? Discord avatars need the Discord desktop app running on the player’s PC. Steam avatars need Steam running and the
steam_webApiKeyconvar set inserver.cfg. - Is the bot token valid? If Discord does not return a picture and the player has no Steam fallback, the default picture is shown. Create a new token in the Discord Developer Portal if needed.
- Can your server reach the services? Some hosts block outgoing connections. The server must be able to reach
discord.comandapi.steampowered.com. - Was the lookup done before you fixed the setup? A failed lookup is not repeated while the player stays online. After you change the settings, restart
kivo-inv-bridge(avatars of everyone online are looked up again), or ask the player to reconnect.
