Skip to main content

​
Asset download

Once you buy from our official website, the asset lands in your Cfx.re portal. Download it from there. The asset must sit on the keymaster account that made the purchase, or transfer it across first.

​
What you need

Required

ox_lib and awoken_bridge. The bridge answers every framework question, so the menu never has to.

Only for playtime

oxmysql. No table is created and no query runs unless Config.Footer.showTotalPlaytime is on.
Works on QBox, QBCore, and ESX, detected automatically by the bridge, and standalone with no framework at all. Without one you lose the job and money lines, and nothing else.

​
Install

1

Drop the folder in place

Put the awoken_pausemenu folder (the one from releases/) into your server’s resources/.
Keep the folder name exactly awoken_pausemenu. Renamed, the resource starts and then does nothing at all. That is how we stop resellers passing it off as their own.
2

Set the ensure order

server.cfg
The bridge has to start first. It works out which framework you run at load time, so anything starting after it is invisible to it.
3

Pick your accent colour (optional)

server.cfg
Every Awoken panel reads the same convar, which is how they end up matching. Config.Theme.accent overrides it for this resource alone.
4

Start the server

Press Esc. The Awoken menu opens instead of the stock one.

​
Updating

Re-download the asset from your Cfx.re portal, replace the folder, and restart. Playtime lives in the database, not in the folder, so updating never touches it.
Replacing the folder overwrites config.lua, locales/, client/hooks.lua and server/adapters.lua. Back up anything you have changed in those first.

​
First check

Open the menu and look at the bottom left. The street and the in-game clock appear straight away. Session and total playtime follow a moment later, once the server has answered.

Configuration

Every switch: what is shown, the theme, sounds and input.

Exports and events

Telling your own HUD when the menu is open.