> ## Documentation Index
> Fetch the complete documentation index at: https://docs.awokenlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Replace the stock GTA pause menu with the Awoken one, keeping the real map and settings screens.

## Asset download

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

## What you need

<CardGroup cols={2}>
  <Card title="Required" icon="circle-check">
    **ox\_lib** and **awoken\_bridge**. The bridge answers every framework question, so the menu never has to.
  </Card>

  <Card title="Only for playtime" icon="database">
    **oxmysql**. No table is created and no query runs unless `Config.Footer.showTotalPlaytime` is on.
  </Card>
</CardGroup>

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

<Steps>
  <Step title="Drop the folder in place">
    Put the **`awoken_pausemenu`** folder (the one from `releases/`) into your server's `resources/`.

    <Warning>
      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.
    </Warning>
  </Step>

  <Step title="Set the ensure order">
    ```cfg server.cfg theme={"dark"}
    ensure oxmysql
    ensure ox_lib
    ensure awoken_bridge
    ensure awoken_pausemenu
    ```

    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.
  </Step>

  <Step title="Pick your accent colour (optional)">
    ```cfg server.cfg theme={"dark"}
    setr awoken:primaryColor "#00E5FF"
    ```

    Every Awoken panel reads the same convar, which is how they end up matching. `Config.Theme.accent` overrides it for this resource alone.
  </Step>

  <Step title="Start the server">
    Press <kbd>Esc</kbd>. The Awoken menu opens instead of the stock one.
  </Step>
</Steps>

## 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.

<Warning>
  Replacing the folder overwrites `config.lua`, `locales/`, `client/hooks.lua` and `server/adapters.lua`. Back up anything you have changed in those first.
</Warning>

## 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.

<CardGroup cols={2}>
  <Card title="Configuration" icon="sliders" href="/resources/awoken-pausemenu/configuration">
    Every switch: what is shown, the theme, sounds and input.
  </Card>

  <Card title="Exports and events" icon="code" href="/resources/awoken-pausemenu/exports">
    Telling your own HUD when the menu is open.
  </Card>
</CardGroup>