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

# Install the menu

> Install Element 3D Pause Menu and element_sdk, add its integration, and check it in game.

At the end of this page the menu opens in game on `ESCAPE` and shows the markers your other resources
create. It takes about ten minutes.

> [!TIP]
>
> The download carries the same steps for that exact release in `INSTALL.md`, beside its two
> folders, including the `element_sdk` version it needs. When this
> page and that file disagree, the file is right for the release you have.

## Before you start

* **Element 3D Pause Menu** and **element\_sdk** under Granted Assets on the
  [Cfx.re portal](https://portal.cfx.re/assets/granted-assets), on the account that bought the menu.
* A server license key from that same account. See [Licensing](https://docs.elementlabs.net/policies/licensing.md).
* A backup of your `resources` folder. Step 5 adds a line to your other resources.

No framework and no database are needed. With `es_extended`, `qb-core` or `qbx_core` running, the
player card shows the character's name; without one it shows the FiveM name.

## Steps

**1. Extract element\_sdk and the menu**

The menu's download holds two folders: `element_3d_pausemenu` and `element_3d_pausemenu_assets`,
the files the game streams. Put them beside `element_sdk`, each with its `fxmanifest.lua`
directly inside:

```text theme={null}
resources/[element]/element_sdk/fxmanifest.lua
resources/[element]/element_3d_pausemenu/fxmanifest.lua
resources/[element]/element_3d_pausemenu_assets/fxmanifest.lua
```

If you find `element_3d_pausemenu/element_3d_pausemenu/`, move the inner folder up
one level.

**2. Check the element\_sdk version**

Open `INSTALL.md`, at the top of the menu's download. It names the `element_sdk` versions this
release accepts, such as `^0.1.0`. Your version is the `version` line in
`element_sdk/fxmanifest.lua`. If it is older, download `element_sdk` again. What the range means
is in [Versions and releases](https://docs.elementlabs.net/compatibility/versions.md).

**3. Add them to server.cfg**

```cfg theme={null}
ensure element_sdk
ensure element_3d_pausemenu_assets
ensure element_3d_pausemenu
```

After your framework, if you run one. See [Start order](https://docs.elementlabs.net/configure/start-order.md).

**4. Restart the server and check the console**

The console shows both resources starting, with no `[ERROR]` or `[WARN ]` line naming either. If
not, see [A product does not start](https://docs.elementlabs.net/troubleshooting/product-does-not-start.md).

**5. Install the integration**

The menu shows the markers your other resources create, and to see them it needs one line added
to each of those resources. From `element_3d_pausemenu/install`:

> [tab] Windows
>
> Double-click `windows-install-hooks-element_3d_pausemenu.bat`.

> [tab] Linux
>
> ```bash theme={null}
> cd resources/\[element\]/element_3d_pausemenu/install
> ./linux-install-hooks-element_3d_pausemenu.sh
> ```

Then restart the server again. What it changes, when to run it again and how to remove it are in
[Install an integration](https://docs.elementlabs.net/get-started/integrations.md).

The menu works without this step, but markers created by your other resources stay invisible on
the map.

## Check that it worked

**1. Open the menu**

Press `ESCAPE` in game. The camera rises above your character and the map appears. If nothing
happens, see [The map does not open](https://docs.elementlabs.net/products/3d-pause-menu/troubleshooting/map-will-not-open.md).

**2. Look for your markers**

Markers from your other resources, such as shops or garages, are on the map and in the legend.
If they are not, see [Markers do not appear](https://docs.elementlabs.net/products/3d-pause-menu/troubleshooting/blips-missing.md).

## Next steps

* [How players use the menu](https://docs.elementlabs.net/products/3d-pause-menu/using-the-map.md): every control, worth sharing
  with your players.
* [Change the key that opens the menu](https://docs.elementlabs.net/products/3d-pause-menu/guides/change-the-open-key.md)
* [Configuration](https://docs.elementlabs.net/products/3d-pause-menu/configuration/index.md): everything you can change.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.