> For the complete documentation index, see [llms.txt](https://atiysus-organization.gitbook.io/aty-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atiysus-organization.gitbook.io/aty-scripts/pause-menu-remake/installation.md).

# Installation

## Download <a href="#download" id="download"></a>

To find and use the assets, you must have made the purchase from your own keymaster which you have your server key in. Otherwise you will not be able to use the asset.Once you make the purchase, you'll be able to access it from your [keymaster](https://keymaster.fivem.net/asset-grants). If you have more issues regarding [FiveM Escrow](https://forum.cfx.re/t/introducing-asset-escrow-for-your-resources/4777151), accounts or asset startup errors you can go here and see if any of them match your case, since Escrow requires some basics. Such as your keymaster account, your license key, etc.

***

## Dependencies <a href="#dependencies" id="dependencies"></a>

This assets has depencies such as frameworks like QBCore and ESX also MySQL connections. You can only use this script with qb-core or es\_extended based servers.

#### MySQL <a href="#mysql" id="mysql"></a>

This asset needs MySQL connections so you need to have one of these resuources:

* oxmysql
* mysql\_async
* ghmattimysql

***

## Ensuring <a href="#ensuring" id="ensuring"></a>

To ensure and use this script in your server, simply add this code in your `server.cfg` file, under your MySQL and framework scripts.

```
ensure aty_pausemenuv2
```

***

## Setting Up The Config

### Adding Staffs

* name, is the name of the staff.
* rank, is the rank of the staff.
* avatar, is the image of the staff, you can add the avatars in the \`ui\` folder.
* license, is their license. This is used to check if the player is online.

### Adding Menu Buttons

We do no recommend changing anything in this section unless you know what you are doing.

* title, is the label of the button
* color, you can either use `primary` or `secondary` as color.
* icon, is a png where you put in the \`ui\` folder.
* bg, is a png where you put in the \`ui\` folder.
* action, is written in the client/open.lua and client/nui.lua files.

### Adding Idle Animations

The key and the id has to be the same.

***

## Adding Custom Data

You can add custom data from the server/server\_config.lua file. We do no recommend changing anything in this section unless you know what you are doing

* title, is the label of the data.
* value, is the data that will show up.
* name, has to be unique.
* icon, is a png where you put in the \`ui\` folder.