> 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/garages/installation.md).

# Installation

## Download

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

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

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

* oxmysql
* mysql\_async
* ghmattimysql

***

## Ensuring

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

```json
ensure aty_garage
```

***

## Setting Up The Config

* UseSharedGarages, if you set this to true then players will be able to see their vehicles in any garage.
* VehicleDataName: this should be `owned_vehicles` for esx and `player_vehicles` for qb-core,
* VehicleIdentifier: this should be `owner` for esx and `citizenid` for qb-core,
* VehicleGarageName: this should be `parking` for esx and `garage` for qb-core,
* Warp, if you set this to true then players will get teleported to the vehicle when they take it out from the garage.
* VisuallyDamageCars, if you set this to true then the vehicles visual damage will stay the same even after they take it out from the garage.
* MileAgeFunction: This is a custom feature that you can add you hud's or a different scripts mile age system's export.

***

## Adding New Garage

The key has to be unique.

* label, can be anything
* garage, has to be unique
* pedCoords is where the garage ped will appear
* vehicleCoords is where the marker will appear
* job, it can be `all` or you can specify it.
