Skip to content

Installation

Follow these steps in order. No database changes or items are needed.

The source repository for this script has a README.md at the top level and the resource itself inside a subfolder named pausemenu. Only the inner pausemenu folder is the resource. It is the folder that contains fxmanifest.lua directly.

kivo-pausemenu/ <- repository or download folder, do NOT put this in resources
README.md
pausemenu/ <- this is the resource, copy this folder
fxmanifest.lua
config.lua
framework/
open.lua
locales/
en.lua
fr.lua
(other folders, leave as shipped)

After copying, your server must look like this:

resources/
[kivo]/ <- optional category folder, any name in square brackets
pausemenu/
fxmanifest.lua
config.lua
...

Copy the inner pausemenu folder into your server’s resources folder (or into a category folder inside it). Keep the folder name pausemenu. The commands and server.cfg lines on this page use that name.

Start the resource after your framework. Place it anywhere below the framework line.

ensure es_extended # or qb-core / qbx_core, whichever you run
ensure pausemenu

If you run a standalone server with no framework, only the second line is needed.

The menu shows each player’s Discord profile picture. Skip this step if you do not want that. Players then see a default image, or the image you set in Config.DefaultAvatar.

  1. Create a Discord application and a bot in the Discord developer portal.
  2. Invite the bot to your Discord server. It only needs to be a member of the server. No privileged intents are required.
  3. Copy the bot token.
  4. Add this line to server.cfg, before the ensure pausemenu line:
set pausemenu_discord_token "YOUR_BOT_TOKEN"

Use the raw token. Do not add the word Bot in front of it.

The server.cfg value takes priority over Config.Discord.token in config.lua. Keeping the token in server.cfg means it is not stored inside the resource folder. Do not post the token in screenshots or support requests.

Players only get an avatar if their FiveM account has a linked Discord identifier. Players who run FiveM without Discord open will see the default image.

Open pausemenu/config.lua and change at least:

  • Config.ServerName
  • Config.Links (Discord, donate and Tebex URLs)
  • Config.Events (replace the two sample events or remove them)
  • Config.Locale if you want another language

All options are explained in Configuration.

6. Connect the buttons to your scripts (optional)

Section titled “6. Connect the buttons to your scripts (optional)”

The Report, Battle Pass, Map and Settings buttons run the functions in pausemenu/framework/open.lua. By default, Report and Battle Pass only show a notification that says to hook them up, and Map and Settings open the native GTA menus. Replace them with calls to your own scripts. See Hooks and integration.

If you do not use a card, set active = false for it in Config.Buttons so it shows darker and cannot be clicked.

  1. Restart the server, or run refresh and then ensure pausemenu in the server console.
  2. Check the server console. It prints one line with the detected framework, for example [pausemenu] framework detected: qbx. If it says standalone and you run a framework, see the start order note above.
  3. Join the server and press ESC. The camera should swing around to your character and the menu should open.
  4. Press ESC again to close it.

Config and locale changes are read when the resource starts. After editing config.lua, a locale file or framework/open.lua, run this in the server console:

restart pausemenu

If you added a new file (for example a new language file), run refresh first, then restart pausemenu.