Skip to content

Kivo Pausemenu

Kivo Pausemenu replaces the native ESC pause menu with an animated menu. When a player presses ESC, the camera swings around to face their character, the character plays an idle emote, and a menu opens with their personal data, server events and shortcut buttons.

This documentation covers version 1.0.4.

  • Pause menu replacement. ESC opens this menu instead of the Rockstar pause map. The native menu stays suppressed.
  • Camera swing. The camera moves from the gameplay view to a front view of the character, framed on the right side of the screen. In a vehicle, the camera films the car from the front instead and no emote plays.
  • Personal data panel. Name, cash, bank, job, gang, server ID, Discord profile picture and playtime.
  • Events carousel. A list of events with a “Starts in” countdown, an image per event and an optional link.
  • Action cards. Report, Donate, Discord, Battle Pass and Map cards. Each card can open a link or run your own client code.
  • Tabs. Home, Map, Settings, Tebex, Discord and Exit. Exit closes the menu. It does not disconnect the player.
  • Player count bubble. Shows online players and the server slot count. It can count every connected client or only players your framework has loaded.
  • Coexistence with other UIs. The menu does not pop open behind an inventory or another UI that the player has just closed.
  • Locales. English and French are included. You can add more languages by copying a locale file.
  • Open hook file. framework/open.lua is where you connect the buttons to your own report, battle pass, event and map scripts.
Item Details
Game build GTA V (game 'gta5'), fx_version 'cerulean', Lua 5.4
Framework Optional. ESX, QBCore and QBX are detected automatically. Other setups run in standalone mode.
Other resources None required. The resource does not need ox_lib or oxmysql.
Database No SQL import or database table is needed.
Discord avatars Optional. Needs a Discord bot that is a member of your Discord server.

Start pausemenu after your framework resource (es_extended, qb-core or qbx_core). The framework is detected once when the resource starts. If the framework is not running yet at that moment, the menu runs in standalone mode and shows default player data.

ensure es_extended # or qb-core / qbx_core
ensure pausemenu
File Purpose
config.lua Every setting: server name, colours, links, buttons, camera, emotes, Discord, playtime, events, ESC behaviour.
locales/*.lua Text shown in the menu. One file per language.
framework/open.lua Client code that runs when a player clicks Report, Battle Pass, Map, Settings or an event without a link.

All other files in the resource are part of the script and are not meant to be edited.

  1. Installation: folder layout, server.cfg lines and the Discord bot setup.
  2. Configuration: every option in config.lua and every key in the locale files, including how to add a language.
  3. Hooks and integration: the open hook file, with examples for connecting your own scripts.
  4. Examples and troubleshooting: ready-made configs, ESC and other UIs, edge cases and fixes.

Back to the scripts index.