Skip to content

Installation

Installation

BUPA Chat replaces FiveM's default chat. Installation is mostly about making sure the old chat resource is gone and the dependencies start before BUPA Chat.

1. Dependencies first

Make sure these are installed and started before BUPA Chat:

  • ox_lib
  • qb-core
  • assetpacks — BUPA Chat declares dependency '/assetpacks'; the UI will not load its assets without it.

2. Remove the default chat

BUPA Chat declares provide 'chat', so it registers itself as the chat resource. If the stock chat resource is still running you will get two chat boxes.

Do not ensure chat (the default resource) anywhere in your server config. Either delete/rename the default [system]/chat resource or make sure it is never started.

3. Drop in the resource

Place the bupa-chat folder in your resources directory (for example inside [qbx]/[BUPA]) and ensure it after its dependencies.

server.cfg
ensure ox_lib
ensure qb-core
ensure assetpacks

# make sure the default chat is NOT ensured
ensure bupa-chat

4. Set the language

BUPA Chat reads its language from the standard ox_lib locale convar, with an optional per-resource override.

server.cfg
# global ox_lib locale — used by BUPA Chat and every other ox_lib resource
setr ox:locale "tr"

# optional: override the language for BUPA Chat only (leave out to follow ox:locale)
setr bupa-chat:locale "en"

If neither convar is set, BUPA Chat falls back to English (en). See Localization for the full list of shipped languages.

The escrow build keeps the config open for editing. Files under shared/config/*.lua, all locales/*.json, client/editable.lua, server/editable.lua, server/playerIdDisplay.lua, server/webhook.lua and shared/type.lua are listed in escrow_ignore, so you can edit them directly after purchase.

5. Verify

Start the server and press T (the default open key). You should see the BUPA Chat input with a Commands tab. If you see the old chat as well, the default chat resource is still running — go back to step 2.