# General FAQ
Source: https://docs.markz3d.com/other/general-faq

Here you can find FAQ related to all our products

# How to install items?

If the items are provided in the purchased product, there will be a `[items]` folder, this folder contains predefined items in different formats.\
**To install them:**

## ox\_inventory.lua

1. Open `ox_inventory.lua`
2. **CTRL + A**
3. **CTRL + C**
4. Open `@ox_inventory/data/items.lua`
5. Go to the end of the file
6. Delete the `}`
7. **CTRL + V**
8. Re-insert the `}`

## qb-inventory.lua

1. Open `qb-inventory.lua`
2. **CTRL + A**
3. **CTRL + C**
4. Open `@qb-core/shared/items.lua`
5. Go to the end of the file
6. Delete the `}`
7. **CTRL + V**
8. Re-insert the `}`

***

# How to install item images?

If the purchased product includes item images, you'll find them in `[items]/[images]`
You need to copy those images into the correct inventory `images` folder for your framework.

## ox\_inventory

1. Open your product's `[items]/[images]` folder
2. Copy **all** image files
3. Paste them into: `ox_inventory/web/images/`
4. Overwrite if asked
5. Restart your server and verify in-game

***

## qb-inventory / QBCore

1. Open your product's `[items]/[images]` folder
2. Copy **all** image files
3. Paste them into: `qb-inventory/html/images/`
4. Overwrite if asked
5. Restart your server and verify in-game

> Tip: Image filenames must match the **item name**, this as already be done for you

***

### Common troubleshooting

* **Image not showing:** filename doesn't match the item name exactly.
* **Still old image:** clear your client cache or ensure you overwrote the correct file.


# Installation for qb-inventory
Source: https://docs.markz3d.com/other/installation-for-qb-inventory

Steps to integrate our resources utilizing specific inventory features (e.g., utility_kitchen)

### Modify the resource

Replace or update your `qb-inventory` by following this commit or using the provided modified version.

<Card title="GitHub" icon="github" href="https://github.com/qbcore-framework/qb-inventory/compare/main...MXC-PR:main">
  Comparing qbcore-framework:main...MXC-PR:main · qbcore-framework/qb-inventory
</Card>

### Run this SQL query using HeidiSQL or any other database viewer

```sql theme={null}
ALTER TABLE inventories CHANGE COLUMN identifier identifier VARCHAR(100) NOT NULL
```


# Utility:BankRobbery:BombPlanted
Source: https://docs.markz3d.com/utility-bank/events/utility-bankrobbery-bombplanted



Called when a bomb is planted on a prevault door,, called exactly after the item removal. (Called for server and all clients)

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`source`</td>
        <td>number</td>
        <td>The source of the hacker</td>
      </tr>

      <tr>
        <td>`bankId`</td>
        <td>number</td>
        <td>The index in the Config.Banks table</td>
      </tr>

      <tr>
        <td>`item`</td>
        <td>string</td>

        <td>
          The bomb item, currently its just Config.BombItem
        </td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  RegisterNetEvent("Utility:BankRobbery:BombPlanted", function(source, bankId, item)
      print("Bomb planted by", source, "in bank", bankId)
  end)
  ```
</Accordion>


# Utility:BankRobbery:EnteredBank
Source: https://docs.markz3d.com/utility-bank/events/utility-bankrobbery-enteredbank



Called when a player enters a bank (Called for server and the caller client)

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`bankId`</td>
        <td>number</td>
        <td>The index in the Config.Banks table</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  RegisterNetEvent("Utility:BankRobbery:EnteredBank", function(bankId)
      print("Entered bank", bankId)
  end)
  ```
</Accordion>


# Utility:BankRobbery:ExitedBank
Source: https://docs.markz3d.com/utility-bank/events/utility-bankrobbery-exitedbank



Called when a player exits a bank (Called for server and the caller client)

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`bankId`</td>
        <td>number</td>
        <td>The index in the Config.Banks table</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  RegisterNetEvent("Utility:BankRobbery:ExitedBank", function(bankId)
      print("Exited bank", bankId)
  end)
  ```
</Accordion>


# Utility:BankRobbery:VaultHacked
Source: https://docs.markz3d.com/utility-bank/events/utility-bankrobbery-vaulthacked



Called when a bank vault is hacked. (Called for server and all clients)

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`source`</td>
        <td>number</td>
        <td>The source of the hacker</td>
      </tr>

      <tr>
        <td>`bankId`</td>
        <td>number</td>
        <td>The index in the Config.Banks table</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  RegisterNetEvent("Utility:BankRobbery:VaultHacked", function(source, bankId)
      print("Vault hacked by", source, "in bank", bankId)
  end)
  ```
</Accordion>


# GetAllDoorsStatus
Source: https://docs.markz3d.com/utility-bank/exports/client/getalldoorsstatus



Return the status of all the doors of a bank.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`bankId`</th>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The index in the Config.Banks table</td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Returns">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>table</td>

          <td>
            The status of all the doors in a key value pair.
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local doors = exports["utility_bank"]:GetAllDoorsStatus(1)

  for door_id, status in pairs(doors) do
      print("The status of the door", door_id, "is", status)
  end
  ```
</Accordion>


# GetCurrentBank
Source: https://docs.markz3d.com/utility-bank/exports/client/getcurrentbank



Get the id of the current bank. (Works only if the player is inside a bank)

<Accordion title="Returns">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>
          <td>The id of the current bank.</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local id = exports["utility_bank"]:GetCurrentBank()

  print("The player is inside the bank: "..id)
  ```
</Accordion>


# GetDoorObject
Source: https://docs.markz3d.com/utility-bank/exports/client/getdoorobject



Get the object (entity) of a door or 0 if not found.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`bankId`</th>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The index in the Config.Banks table</td>
      </tr>

      <tr>
        <td>`doorId`</td>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>

        <td>
          Internal id to refer the door, generally can be one of the following
          values: vault, prevault, shutters
        </td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Returns">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>
          <td>The object (entity) of the door.</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local obj = exports["utility_bank"]:GetDoorObject(1, "shutters")

  print(GetEntityCoords(obj))
  ```
</Accordion>


# IsCurrentBankDoorOpen
Source: https://docs.markz3d.com/utility-bank/exports/client/iscurrentbankdooropen



Check if the current bank door is open. (Works only if the player is inside a bank)

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`doorId`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>

        <td>
          Internal id to refer the door, generally can be one of the following
          values: vault, prevault, shutters
        </td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Returns">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>
          <td>true if the door is open, false otherwise</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  if exports["utility_bank"]:IsInsideBank() then
      local open = exports["utility_bank"]:IsCurrentBankDoorOpen("vault")

      print("The vault door is: "..(open and "open" or "closed"))
  end
  ```
</Accordion>


# IsInsideBank
Source: https://docs.markz3d.com/utility-bank/exports/client/isinsidebank



Check if the player is inside a bank.

<Accordion title="Returns">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>

          <td>
            true if the player is inside a bank, false otherwise
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  if exports["utility_bank"]:IsInsideBank() then
      local open = exports["utility_bank"]:IsCurrentBankDoorOpen("vault")

      print("The vault door is: "..(open and "open" or "closed"))
  end
  ```
</Accordion>


# GetAllDoorsStatus
Source: https://docs.markz3d.com/utility-bank/exports/server/getalldoorsstatus



Return the status of all the doors of a bank.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`bankId`</th>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The index in the Config.Banks table</td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Returns">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>table</td>

          <td>
            The status of all the doors in a key value pair.
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local doors = exports["utility_bank"]:GetAllDoorsStatus(1)

  for door_id, status in pairs(doors) do
      print("The status of the door", door_id, "is", status)
  end
  ```
</Accordion>


# SetBankDoorStatus
Source: https://docs.markz3d.com/utility-bank/exports/server/setbankdoorstatus



Sets the status of a bank door.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`bankId`</th>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The index in the Config.Banks table</td>
      </tr>

      <tr>
        <th>`doorId`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>

        <td>
          Internal id to refer the door, generally can be one of the following
          values: vault, prevault, shutters
        </td>
      </tr>

      <tr>
        <th>`status`</th>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>

        <td>
          True to open the door, false to close it (for shutters its inverted,
          so true = closed)
        </td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_bank"]:SetBankDoorStatus(1, "shutters", true)
  ```
</Accordion>


# How to create a new bank type
Source: https://docs.markz3d.com/utility-bank/how-to-create-a-new-bank-type



Open the config and scroll to `Config.BankTypes` \
To create a new bank type, add a table entry with your chosen name.

<img alt="Image" />

Every bank type require:

* **coords**: Used to spawn robbery blip and calculate distance to handle *In/Out/Near* states <a href="how-to-create-a-new-bank-type#how-to-get-offset-from-interior%3F">offset</a>
* **hostagesRoom**: hostages room center, used to draw intimidation bar <a href="how-to-create-a-new-bank-type#how-to-get-offset-from-interior%3F">offset</a>
* **hostagesDistance**: distance from **hostagesRoom** from which onward the player results in the hostagesRoom <span>(optional, default: 4.5)</span>
* **insideDistance**: distance from **coords** from which onward the player results *inside* the bank
* **nearDistance**: distance from **coords** from which onward the player results *near* the bank
* **In**: function called when the player enters the bank (please copy the In function of another);
* **Out**: function called when the player exits the bank
* **trollies**: table with all trollies (last coordinate is the heading) <a href="how-to-create-a-new-bank-type#how-to-get-offset-from-interior%3F">offset</a>\
  &#x20; types: cash, gold, diamond
* **doors**: all doors data
* **peds**: all peds data

<Note>
  The vault hacking panel is automatically detected within a 30 meter radius of
  the vault door and currently only recognizes the model
  `hei_prop_hei_securitypanel`
</Note>

After you have finished creating your bank type you can create a new bank in the `Config.Banks` that uses your newly created bank type

***

## How to get interior informations?

To retrieve interior information, use the `getInteriorInfo` command (client console).

<img alt="Image" />

## How to get offset from interior?

To determine the offset from the interior, use the `getInteriorOffset` command (client console). \
This command provides you the offset from your current position within the interior.

<img alt="Image" />


# Installation
Source: https://docs.markz3d.com/utility-bank/installation



# 📦 Required Dependencies

* Install [Utility Lib](https://github.com/utility-library/utility_lib)


# Known issues
Source: https://docs.markz3d.com/utility-bank/known-issues



## Interior not loading correctly with FM FLEECA V2

If you are using **FM FLEECA V2** please remove `v_int_10.ytyp` and `mxc_fleeca_bank6_milo_ymap.ymap` from the `stream` folder of `utility_bank`


# AddShelfAllowedItem
Source: https://docs.markz3d.com/utility-delivery/exports/server/addshelfalloweditem



Adds an item to the list of allowed items for a specific shelf.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`shelfName`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The name (key) of the shelf defined in Config.Shelfs</td>
      </tr>

      <tr>
        <th>`item`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The name of the item to add to the allowed list</td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_delivery"]:AddShelfAllowedItem("pizza_this_vinewood", "water_bottle")
  ```
</Accordion>


# RemoveShelfAllowedItem
Source: https://docs.markz3d.com/utility-delivery/exports/server/removeshelfalloweditem



Removes an item from the list of allowed items for a specific shelf.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`shelfName`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The name (key) of the shelf defined in Config.Shelfs</td>
      </tr>

      <tr>
        <th>`item`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The name of the item to remove from the allowed list</td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_delivery"]:RemoveShelfAllowedItem("pizza_this_vinewood", "water_bottle")
  ```
</Accordion>


# SetShelfOrderGeneration
Source: https://docs.markz3d.com/utility-delivery/exports/server/setshelfordergeneration



Sets whether a shelf should generate orders.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`shelfName`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The name (key) of the shelf defined in Config.Shelfs</td>
      </tr>

      <tr>
        <th>`value`</th>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>
        <td>True to enable order generation, false to disable it</td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_delivery"]:SetShelfOrderGeneration("pizza_this_vinewood", false)
  ```
</Accordion>


# SetStandaloneModeOnShelf
Source: https://docs.markz3d.com/utility-delivery/exports/server/setstandalonemodeonshelf



Sets the standalone mode for a specific shelf.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Needed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <th>`shelfName`</th>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The name (key) of the shelf defined in Config.Shelfs</td>
      </tr>

      <tr>
        <th>`value`</th>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>
        <td>True to enable standalone mode, false to disable it</td>
      </tr>
    </tbody>
  </table>
</div>

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_delivery"]:SetStandaloneModeOnShelf("pizza_this_vinewood", true)
  ```
</Accordion>


# Installation
Source: https://docs.markz3d.com/utility-delivery/installation



<Steps>
  <Step title="📦 Install the required dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
    * Install the items if you plan to use an inventory<br />
      <a href="../other/general-faq#how-to-install-items%3F">
        how to install items?
      </a>
  </Step>
</Steps>


# Installation
Source: https://docs.markz3d.com/utility-drugs/installation



<Steps>
  <Step title="📦 Install the required dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
    * Install the items <br />
      <a href="../other/general-faq#how-to-install-items%3F">
        how to install items?
      </a>
  </Step>
</Steps>


# How to create a new hotel website
Source: https://docs.markz3d.com/utility-hotel/how-to-setup-new-website

This guide explains, step by step, how to create and activate a new hotel website.

## Overview

Creating a new website requires you to:

1. [Create a new website folder](#step-1-create-the-website-folder)
2. [Add the required images](#step-2-add-required-images)
3. [(Optional) Copy an existing website as a starting template](#step-3-optional-copy-an-existing-website-as-a-template)
4. [Connect the website to the hotel screen ui](#step-4-connect-the-website-to-the-hotel-screen-ui)
5. [Changing the website colors](#step-5-changing-the-website-colors)

***

## Step 1: Create the Website Folder

You need to create a new folder for your website.

### Folder Location

The folder must be created inside:

```
nui/websites/
```

### Folder Naming Format

The folder name must follow this format:

```
www.<website-name>.com
```

### Example

If your hotel is called **Opium Nights Hotel**, the folder name should be:

```
www.opium-nights-hotel.com
```

So the final path will look like:

```
nui/websites/www.opium-nights-hotel.com
```

<img alt="Image" />

***

## Step 2: Add Required Images

Inside your new website folder, you must add all required image files.

These usually include:

* Background image
* Hotel logo
* Pattern image
* Room image

Make sure:

* Image names match what the website expects
* Images are placed directly inside the website folder

<img alt="Image" />

***

## Step 3: (Optional) Copy an Existing Website as a Template

To make things easier, you can copy an existing hotel website folder and use it as a starting point.

### How to do it:

1. Go to `nui/websites/`
2. Copy an existing folder
3. Rename it to your new website name (example: `www.opium-nights-hotel.com`)
4. Replace the images with your own

This method is **recommended** because:

* The structure is already correct
* You only need to change the images

***

## Step 4: Connect the Website to the Hotel Screen UI

After creating the website folder, you must configure the hotel screen UI to use it.

### What to do:

1. Open the `config.lua` file
2. Navigate to the hotel that you want to use the new website
3. Locate the `screens` section
4. Be sure that the `action` field is set to `ui`
5. Inside the `ui` section, locate the **url** field and set it to your website folder name

Example:

If your folder is:

```
www.opium-nights-hotel.com
```

Set the URL to:

```
www.opium-nights-hotel.com
```

Save the configuration file.

<br />

<img alt="Image" />

<img alt="Image" />

***

## Step 5: Changing the Website Colors

You can customize the website colors directly from the **screen UI configuration**.

This allows you to adapt the look of the website to match your hotel branding while keeping the original layout and structure.

### Available Color Settings

Inside the screen UI configuration, you will find these color properties:

**`backgroundColor`**
This controls the main background color of the website.

**`accentColor`**
This is the primary accent color. It is mainly used for:

* Buttons
* Highlights
* Important UI elements
* Decorative details

**`accentColor2`**
This is the secondary accent color. It is used for:

* Button shadows
* Depth effects
* Secondary decorative elements

To keep the **GTA-style visual design intact**, we strongly recommend setting:

👉 `accentColor2` to a **darker variant of `accentColor`**

This preserves proper contrast and maintains the intended visual depth of the interface.

***

### Using FiveM NUI DevTools to Test Colors in Real Time (Recommended)

To speed up the setup process, you can modify colors **live at runtime** using the FiveM **NUI DevTools**.

This allows you to experiment with different color combinations instantly, without restarting the resource or editing files repeatedly.

#### 1. Preparation

To be able to use the FiveM NUI DevTools, the `Beta` channel must be selected in the FiveM client settings under Game.

<img alt="Image of FiveM client settings" />

#### 2. Open your selected screen UI

<img alt="Image of selected screen UI" />

#### 3. Open the FiveM Console

Press **F8** while in game to open the FiveM console.

<img alt="Open FiveM console" />

***

#### 4. Enable NUI DevTools

Now navigate to **Tools > NUI > Open DevTools** in the FiveM console.\
This will open the Chromium Developer Tools for the current UI.

<img alt="Open NUI DevTools by clicking Tools > NUI > Open DevTools" />

***

#### 5. Find the element to change the colors

Inside DevTools:

1. Open the **Elements** tab
2. Scroll down until you find the `<iframe>` element named `utility_hotel`

<img alt="Locate Iframe element named utility_hotel" />

3. Now right click on the `<iframe>` element and select **Expand Recursively**

<img alt="Expand UI container div" />

4. Scroll down until you find and click the first `<div>` element inside the `<div id="root">` element

<img alt="Locate UI container div" />

***

#### 6. Modify the Colors

Once you locate the correct element:

1. On your right you will find the **Styles** tab, there you can see the current color values

<img alt="On the right you will find the Styles tab with the current color values" />

2. To change the color values, click on the small rectangle next to the color you want to modify and see the color change in real time

<img alt="On the right you will find the Styles tab with the current color values" />

***

#### 7. Apply Final Values to Config

After finding the colors you like:

1. Copy the final color values
2. Paste them into your screen UI configuration
3. Save the config file

<img alt="On the right you will find the Styles tab with the current color values" />

Your website will now use the selected colors permanently.

***

### Why This Method Is Recommended

Using NUI DevTools lets you:

* Preview changes instantly
* Avoid repeated restarts
* Fine-tune GTA-style color balance
* Find the perfect accent contrast

This significantly reduces setup time when designing a new hotel website.

***

## Final Checklist

Before testing the website, make sure:

* The folder is inside `nui/websites/`
* The folder name follows the format `www.<name>.com`
* All required images are added
* The screen UI configuration URL matches the folder name exactly

If everything is correct, your new hotel website should now be available on the hotel screen.


# Installation
Source: https://docs.markz3d.com/utility-hotel/installation



<Steps>
  <Step title="📦 Install the required dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
    * Install the items if you plan to use an inventory<br />
      <a href="../other/general-faq#how-to-install-items%3F">
        how to install items?
      </a>
  </Step>

  <Step title="🗃️ Database Setup">
    You will find a `mxc_hotels.sql` file that creates the necessary tables.\
    Before running the server, import this file into your database using HeidiSQL, phpMyAdmin, or any other MariaDB/MySQL-compatible manager.\
    Simply open your database tool, select your target database, and execute (import) the `mxc_hotels.sql` file to generate the required structure.
  </Step>

  <Step title="🌍 Maps Compatibility">
    Some maps require additional work to be compatible with the hotel system.

    1. Check the `[compatibility]` folder in the resource for further installation steps
  </Step>
</Steps>


# GetPlayersInRobbery
Source: https://docs.markz3d.com/utility-jewelry/exports/getplayersinrobbery



Returns a table with all the players inside the robbery, this doesnt 100% means that they are robbers but only that they are near/in the robbery location (physically)

<Tabs>
  <Tab title="Parameters">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>id</td>
            <td>number</td>

            <td />

            <td>The store id (only 1 for now)</td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>

  <Tab title="Returns">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>players</td>
            <td>table</td>

            <td />

            <td>A table of all players inside the robbery (server id)</td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>
</Tabs>

# Example

```lua theme={null}
local players = exports["utility_jewelry"]:GetPlayersInRobbery(1)

for k,v in pairs(players) do
    print("The player "..GetPlayerName(v).." ("..v..") is inside the robbery")
end
```


# GetShuttersStatus
Source: https://docs.markz3d.com/utility-jewelry/exports/getshuttersstatus



Allow to get the shutters status (closed/open)

<Tabs>
  <Tab title="Parameters">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>id</td>
            <td>number</td>

            <td />

            <td>The store id (only 1 for now)</td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>

  <Tab title="Returns">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>status</td>
            <td>boolean</td>

            <td />

            <td>The store shutters status (true = open, false = closed)</td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>
</Tabs>

# Example

```lua theme={null}
local status = exports["utility_jewelry"]:GetShuttersStatus(1)

if status then
    print("Open!")
else
    print("Closed!")
end
```


# IsJewelryBeingRobbed
Source: https://docs.markz3d.com/utility-jewelry/exports/isjewelrybeingrobbed



Returns true if the jewelry is being robbed

<Tabs>
  <Tab title="Parameters">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>id</td>
            <td>number</td>

            <td />

            <td>The store id (only 1 for now)</td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>

  <Tab title="Returns">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>beingRobbed</td>
            <td>boolean</td>

            <td />

            <td>If the jewelry is being robbed</td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>
</Tabs>

# Example

```lua theme={null}
local status = exports["utility_jewelry"]:IsJewelryBeingRobbed(1)

if status then
    print("Open!")
else
    print("Closed!")
end
```


# SetShuttersStatus
Source: https://docs.markz3d.com/utility-jewelry/exports/setshuttersstatus



Allow to set the shutters status (closed/open)

<Tabs>
  <Tab title="Parameters">
    <div>
      <table>
        <thead>
          <tr>
            <th>
              Name
            </th>

            <th>
              Type
            </th>

            <th>
              Default
            </th>

            <th>
              Description
            </th>
          </tr>
        </thead>

        <tbody>
          <tr>
            <td>id</td>
            <td>number</td>

            <td />

            <td>The store id (only 1 for now)</td>
          </tr>

          <tr>
            <td>status</td>
            <td>boolean</td>
            <td>false</td>

            <td>
              The new shutters status, true = open, false = closed
            </td>
          </tr>
        </tbody>
      </table>
    </div>
  </Tab>

  <Tab title="Returns">Nothing.</Tab>
</Tabs>

# Example

```lua theme={null}
exports["utility_jewelry"]:SetShuttersStatus(1, true) -- opens shutters
exports["utility_jewelry"]:SetShuttersStatus(1, false) -- closes shutters
```


# FAQ
Source: https://docs.markz3d.com/utility-jewelry/faq



# How to integrate your dispatch system

To integrate your dispatch system you can modify the `StartAlarm` function in `config_functions.lua`.

<Info>
  In the
  [compatibilities](https://discord.com/channels/722977719864000534/1334090058315333662)
  channel on our discord you can discover already integrated dispatch systems by
  us or our community. We would be grateful if you could share your integration
  in the channel!
</Info>


# Installation
Source: https://docs.markz3d.com/utility-jewelry/installation



# 📦 Required Dependencies

* Install [Utility Lib](https://github.com/utility-library/utility_lib)
* Install [Vangelico Jewelry (MXC)](https://www.markz3d.com/products/maps/base?product=6533130)
* Install the items if you plan to use an inventory<br />
  <a href="../other/general-faq#how-to-install-items%3F">
    how to install items?
  </a>

# Community Video

A step-by-step installation guide created by one of our community members. This video walks you through the full setup process, making it easier to get started quickly and without confusion.

<Info>
  this is an external community-made video and not an official MXC resource. it
  should be treated as a reference or supplement to the default documentation
</Info>

<iframe title="YouTube video player" />


# Installation
Source: https://docs.markz3d.com/utility-keyhanger/installation



<Steps>
  <Step title="📦Required Dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
  </Step>

  <Step title="🚗 Car Key Integration">
    To integrate car keys out of the box, ensure the item metadata includes the <code>plate</code> field.<br />
    You can fully edit the code in <code>Config.KeyHangers\["mxc\_keyhanger\_prop\_cargarage\_1"]</code> to integrate your custom system.<br /><br />
    This type of integration currently requires coding experience.
  </Step>
</Steps>


# FAQ
Source: https://docs.markz3d.com/utility-kitchen/faq



# How do I install the required items?

<a href="../other/general-faq#how-to-install-items%3F">
  How to install items?
</a>

# I have installed utility\_kitchen / merged the expansions into utility\_kitchen, but all of the containers are empty?

By default is `Config.RequireItems` set to `true`, while set to true the containers require to have their contents added manually by the players. If you'd like to have unlimited ingredients, set `Config.RequireItems` to `false`.

# How can I setup a new kitchen?

Follow the format of `Config.Kitchens`

# How do I install an expansion?

<iframe title="YouTube video player" />

# What should I do if I see duplicate props or props that I cannot interact with?

Make sure you have followed the readme in the `[compatibility]` folder of the affected map


# Durability formulas
Source: https://docs.markz3d.com/utility-kitchen/guides/durability-formulas



This documentation explains how durability is calculated for ingredients/foods.

***

# Ingredient/Food Durability

Each ingredient (or food item that can be cooked) has a **durability value** depending on how well it is cooked.

The <span>perfect cooking point</span> is at <span>73% (0.73)</span> of its cooking progress.

Durability scales as follows:

1. **From 0** → **0.73 cooking progress**
   * Durability rises from **0%** → **100%**
   * Example: <span>halfway cooked</span> (0.365) gives \~50% durability.
2. **From 0.73 → 1.00 cooking progress**
   * Durability decreases from **100% → 0%**
   * Example: <span>burned</span> (1.0) gives 0% durability.

The progressbar is completed at <span>73%</span> after that it will start turning <span>red</span> and so <span>burning</span>

***

# Examples

**Cooking progress =** <span>0.50</span><br />
**Durability formula:**<br /><span>= (0.50 / 0.73) \* 100</span><br />
&#x20; ≈ <span>69%</span>

<div>
  <img alt="Main dashboard interface" />
</div>

**Cooking progress =** <span>0.90</span><br />
**Durability formula:**<br /><span>= ((1 - 0.90) / (0.27)) \* 100</span><br /><span>= (0.10 / 0.27) \* 100</span><br />
&#x20; ≈ <span>37%</span>

<div>
  <img alt="Main dashboard interface" />
</div>

**Cooking progress =** <span>0.73</span><br />
**Durability formula:**<br /><span>= (0.73 / 0.73) \* 100</span><br /><span>= 1 \* 100</span><br />
&#x20; ≈ <span>100%</span>

<div>
  <img alt="Main dashboard interface" />
</div>

***

# Hamburger Durability

A hamburger’s durability depends on **two factors**:

1. <span>How well its ingredients are cooked.</span>
2. <span>How many ingredients are used.</span>

***

### 1. <span>Ingredient Durability (80% of total)</span>

Each ingredient contributes durability based on how close it is to the **perfect cooking point** (73%).\
We take the **average durability** of all ingredients in the burger.

👉 Example:

* 4 ingredients with durabilities **60%, 80%, 90%, 70%**
* Average durability = (60 + 80 + 90 + 70) / 4 = **75%**

### 2. <span>Ingredient Count Score (20% of total)</span>

The hamburger also gets a bonus depending on how many ingredients it has.\
Max bonus at <span>8 ingredients = 100%.</span><br />
Fewer ingredients give a smaller bonus.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Ingredients
        </th>

        <th>
          Score
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>8</td>
        <td>100%</td>
      </tr>

      <tr>
        <td>6</td>
        <td>75%</td>
      </tr>

      <tr>
        <td>4</td>
        <td>50%</td>
      </tr>

      <tr>
        <td>2</td>
        <td>25%</td>
      </tr>

      <tr>
        <td>0</td>
        <td>0%</td>
      </tr>
    </tbody>
  </table>
</div>

👉 Example:

* 4 ingredients = <span>50% score</span>

***

# Combine Them (Final Durability)

The final durability of the hamburger is calculated as:

<span>Hamburger Durability</span> = (<span>
Average Ingredients Durability
</span> \* 0.8) + (
<span>Ingredient Count Score</span> \* 0.2)

## Example

**Average ingredients durability =** <span>75% (0.75)</span><br />
**Ingredient count score =** <span>50% (0.50)</span>

**Durability:**<br />= (<span>0.75</span>\*0.8) + (<span>0.50</span>\*0.2) \* 100 <br />= <span>0.60</span> + <span>0.10</span> \* 100<br />= <span>70%</span>

***

# Examples

### 2 ingredients (cooked at 0.5, 0.6) and 6 filling ingredients

**Ingredient durabilities:**<br />
0.5 → 68%<br />
0.6 → 82%<br />
**Average =** <span>75%</span>

**Ingredient count score:** <br /> <span>(8 / 8) \* 100</span> = <span>100%</span>

**Final durability:** <br /> (<span>75</span> \* 0.8) + (<span>100</span> \* 0.2) = <span>60</span> + <span>20</span> = <span>62%</span>

***

### 5 filling ingredients, no cooking ingredient

**Ingredient durabilities:**<br />
(none, so all = <span>0%</span>)<br />
**Average =** <span>0%</span>

**Ingredient count score:** <br /> (5 / 8) \* 100 = <span>62%</span>

**Final durability:** <br /> (<span>0</span> \* 0.8) + (<span>62</span> \* 0.2) = <span>0</span> + <span>12</span> = <span>12%</span>

***

### 1 cooking ingredient burned (1.0) and 2 filling ingredients

**Ingredient durabilities:**<br />
1.0 → 0%<br />
**Average =** <span>0%</span>

**Ingredient count score:** <br /> (3 / 8) \* 100 = <span>37%</span>

**Final durability:** <br /> (<span>0</span> \* 0.8) + (<span>37</span> \* 0.2) = <span>0</span> + <span>7</span> = <span>7%</span>


# Installation
Source: https://docs.markz3d.com/utility-kitchen/installation

This resource relies on specific inventory features and requires a compatible inventory or custom integration. Check the product description on our store for a list of supported inventories!

<Steps>
  <Step title="📦 Install the required dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
    * Install the items if you plan to use an inventory<br />
      <a href="../other/general-faq#how-to-install-items%3F">
        how to install items?
      </a>
  </Step>

  <Step title="🧩 Inventory Integration (qb-inventory)">
    [installation for qb-inventory](../other/installation-for-qb-inventory "mention")
  </Step>

  <Step title="🌍 Maps Compatibility">
    If you're using a **supported map**, do the following:

    1. Check the `[compatibility]` folder in the resource for further installation steps
    2. If you see:
       * Duplicate props
       * Props you can't interact with <br />
       <a href="faq#what-should-i-do-if-i-see-duplicate-props-or-props-that-i-cannot-interact-with%3F">
         What should I do if I see duplicate props or props that I cannot interact with?
       </a>
  </Step>

  <Step title="🧱 Install an expansion (Optional)">
    If you have purchased either the pizza or kebab expansion, follow this installation video.

    <iframe title="YouTube video player" />

    <Warning>Expansion resources **should not** be started as standalone resources.</Warning>
  </Step>
</Steps>


# Known Crashes
Source: https://docs.markz3d.com/utility-kitchen/known-crashes



# ScaleformStore Pool Full, Size == 852

When the Scaleform pool becomes full, it can lead to crashes because the system is unable to allocate additional resources beyond its capacity. \
To increase the pool size add the following line to your `server.cfg` configuration file:

```lua theme={null}
increase_pool_size "ScaleformStore" 200
```


# Installation
Source: https://docs.markz3d.com/utility-moneywash/installation



<Steps>
  <Step title="📦 Install the required dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
  </Step>

  <Step title="🗃️ Database Setup">
    You will find a `mxc_moneywash.sql` file that creates the necessary tables.\
    Before running the server, import this file into your database using HeidiSQL, phpMyAdmin, or any other MariaDB/MySQL-compatible manager.\
    Simply open your database tool, select your target database, and execute (import) the `mxc_moneywash.sql` file to generate the required structure.
  </Step>

  <Step title="🌍 Maps Compatibility">
    Some maps require additional work to be compatible with the moneywash system.

    1. Check the `[compatibility]` folder in the resource for further installation steps
  </Step>
</Steps>


# DisableMenus
Source: https://docs.markz3d.com/utility-pausemenu/exports/disablemenus



If is true the menus (pause, map, settings) will be disabled.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`disable`</td>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>

        <td />
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_pausemenu"]:DisableMenus(true)
  ```
</Accordion>


# GetCurrentPauseMenu
Source: https://docs.markz3d.com/utility-pausemenu/exports/getcurrentpausemenu



Return the current pause menu that is being displayed.

<Accordion title="Example">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>string</td>
          <td>"map", "settings", "pause"</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local menu = exports["utility_pausemenu"]:GetCurrentPauseMenu()
  ```
</Accordion>


# IsInPause
Source: https://docs.markz3d.com/utility-pausemenu/exports/isinpause



Return true if the pause menu its showing

<Accordion title="Example">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>

          <td />
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local inpause = exports["utility_pausemenu"]:IsInPause()
  ```
</Accordion>


# IsMenuDisabled
Source: https://docs.markz3d.com/utility-pausemenu/exports/ismenudisabled



Return the current disable state of the menus (pause, map, settings)

<Accordion title="Example">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>

          <td>
            If true the menus (pause, map, settings) are disabled, if false they
            are enabled.
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local menuState = exports["utility_pausemenu"]:IsMenuDisabled()
  ```
</Accordion>


# OpenBrowserPage
Source: https://docs.markz3d.com/utility-pausemenu/exports/openbrowserpage



Open a browser page, with the given URL.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`url`</td>
        <td>string</td>
        <td>✅</td>
        <td>`-`</td>

        <td />
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_pausemenu"]:OpenBrowserPage("https://google.com")
  ```
</Accordion>


# SetMapMenu
Source: https://docs.markz3d.com/utility-pausemenu/exports/setmapmenu



Set the map menu to be displayed, this is the menu that is displayed when you click the "MAP" button.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`active`</td>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>

        <td />
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_pausemenu"]:SetMapMenu(true) -- Open the map
  ```
</Accordion>


# SetPauseMenu
Source: https://docs.markz3d.com/utility-pausemenu/exports/setpausemenu



Set the pause menu to be displayed, this is the menu that is displayed when you click ESC.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`active`</td>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>

        <td />
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_pausemenu"]:SetPauseMenu(true) -- Open the pause menu
  ```
</Accordion>


# SetSettingsMenu
Source: https://docs.markz3d.com/utility-pausemenu/exports/setsettingsmenu



Set the settings menu to be displayed, this is the menu that is displayed when you click the "SETTINGS" button.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`active`</td>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>

        <td />
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_pausemenu"]:SetSettingsMenu(true) -- Open the settings menu
  ```
</Accordion>


# TogglePauseMenu
Source: https://docs.markz3d.com/utility-pausemenu/exports/togglepausemenu



Toggle the pause menu.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`active`</td>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>

        <td />
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  exports["utility_pausemenu"]:TogglePauseMenu() -- Open or close the pause menu
  ```
</Accordion>


# Installation
Source: https://docs.markz3d.com/utility-pausemenu/installation



# 📦 Required Dependencies

* Install [Utility Lib](https://github.com/utility-library/utility_lib)


# Installation
Source: https://docs.markz3d.com/utility-respray/installation



<Steps>
  <Step title="📦Required Dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
  </Step>

  <Step title="🐂 Add the spraygun to the ignored weapon list (ox_inventory)">
    Add the following
    [convar](https://docs.fivem.net/docs/scripting-reference/convars/) to your
    `server.cfg` to prevent `ox_inventory` from removing the spraygun weapon

    ```
    setr inventory:ignoreweapons ["WEAPON_SPRAYGUN"]
    ```

    Save the changes and restart your server to apply the configuration

    <Note>If you already have the `inventory:ignoreweapons` [convar](https://docs.fivem.net/docs/scripting-reference/convars/) set elsewhere in your `server.cfg`, simply add `WEAPON_SPRAYGUN` to the existing array.<br />For example, if your current array is `["WEAPON_KNIFE", "WEAPON_BAT"]`, update it to `["WEAPON_KNIFE", "WEAPON_BAT", "WEAPON_SPRAYGUN"]`.<br /><br />Make sure each weapon is separated by a comma and enclosed in double quotes.</Note>
  </Step>
</Steps>


# Installation
Source: https://docs.markz3d.com/utility-safe/installation



<Steps>
  <Step title="📦Required Dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
  </Step>

  <Step title="🗃️ Database Setup">
    You will find a `mxc_safe.sql` file that creates the necessary tables.\
    Before running the server, import this file into your database using HeidiSQL, phpMyAdmin, or any other MariaDB/MySQL-compatible manager.\
    Simply open your database tool, select your target database, and execute (import) the `mxc_safe.sql` file to generate the required structure.
  </Step>
</Steps>


# Creating a new liquid
Source: https://docs.markz3d.com/utility-vape/creating-a-new-liquid



<Steps>
  <Step title="Open the `config.lua`" />

  <Step title="Scroll down to the section labeled `Config.Liquids`." />

  <Step title="Now, you can create a new liquid.">
    Following this format:

    ```lua theme={null}
    ["item-name"] = {
        puffs  = 10 -- The number of puffs that the liquid will last
    }
    ```

    `item-name` *refers to the name of the item that will function as a liquid.*\
    `puffs` *represents the number of puffs the liquid.*

    <Note>You need to register the item in your inventory for it to work.</Note>
  </Step>
</Steps>


# Installation
Source: https://docs.markz3d.com/utility-vape/installation



<Steps>
  <Step title="📦Required Dependencies">
    * Install [Utility Lib](https://github.com/utility-library/utility_lib)
    * Install the items if you plan to use an inventory<br /><a href="../other/general-faq#how-to-install-items%3F">how to install items?</a>
  </Step>

  <Step title="🌍 MXC Smoking Compatibility">
    If you're using a **mxc-smoking**, do the following in the mxc-smoking folder:

    * Delete the `stream/[props]` folder (from the map folder)
    * Open `smoking_entityset_mods.lua`
    * Set all `desk-workmats` to `false`

    <div>
      <img alt="Image" />
    </div>

    ###### Final smoking\_entityset\_mods.lua
  </Step>
</Steps>


# Installation
Source: https://docs.markz3d.com/utility-vending/installation



# 📦 Required Dependencies

* Install [Utility Lib](https://github.com/utility-library/utility_lib)

***

## Community Video

A step-by-step installation guide created by one of our community members. This video walks you through the full setup process, making it easier to get started quickly and without confusion.

<Info>
  this is an external community-made video and not an official MXC resource. it
  should be treated as a reference or supplement to the default documentation
</Info>

<iframe title="YouTube video player" />


# utility_weapons:BreathOver
Source: https://docs.markz3d.com/utility-weapons/events/breathover



Triggered when the player hold breath until he runs out

<Accordion title="Example">
  ```lua theme={null}
  AddEventHandler("utility_weapons:BreathOver", function()
      print("Player ran out of breath!")
  end)
  ```
</Accordion>


# CanHoldBreath
Source: https://docs.markz3d.com/utility-weapons/exports/breath-system/canholdbreath



Return true if the player can hold breath or not

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>
          <td>If the player can hold breath</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local isHolding = exports["utility_weapons"]:CanHoldBreath()
  ```
</Accordion>


# GetMaxBreathTime
Source: https://docs.markz3d.com/utility-weapons/exports/breath-system/getmaxbreathtime



Return the max allowed breath time for a specific weapon, including the weapon experience a player has

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weaponHash`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>
          <td>The max breath time (in ms)</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local maxBreath = exports["utility_weapons"]:GetMaxBreathTime(`WEAPON_SNIPERRIFLE`)
  ```
</Accordion>


# GetRemainingBreath
Source: https://docs.markz3d.com/utility-weapons/exports/breath-system/getremainingbreath



Return a value from 1.0 to 0.0 that indicate the current remaining breath, when the player its not holding the breath it returns 1.0

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>
          <td>The remaining breath (1.0 to 0.0)</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local remaining = exports["utility_weapons"]:GetRemainingBreath()
  ```
</Accordion>


# IsHoldingBreath
Source: https://docs.markz3d.com/utility-weapons/exports/breath-system/isholdingbreath



Return if the player is holding breath or not

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>
          <td>If the player is holding breath or not</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local breath = exports["utility_weapons"]:IsHoldingBreath()
  ```
</Accordion>


# GetWeaponFireMode
Source: https://docs.markz3d.com/utility-weapons/exports/firemode/getweaponfiremode



Return the fire mode of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>

          <td>
            The experience that the player has with the weapon
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  local fireMode = exports["utility_weapons"]:GetWeaponFireMode(weapon)
  ```
</Accordion>


# SetWeaponFireMode
Source: https://docs.markz3d.com/utility-weapons/exports/firemode/setweaponfiremode



Set the weapon fire mode of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>

      <tr>
        <td>`mode`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>

        <td>
          The weapon firemode (1 = single, 2 = burst, 3 = auto, 4 = safety)
        </td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  exports["utility_weapons"]:SetWeaponFireMode(weapon, 1)
  ```
</Accordion>


# IsWeaponJammed
Source: https://docs.markz3d.com/utility-weapons/exports/jamming-system/isweaponjammed



Return the jammed state of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>
          <td>The jammed state of the weapon</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  local jammed = exports["utility_weapons"]:IsWeaponJammed(weapon)
  ```
</Accordion>


# SetWeaponJamState
Source: https://docs.markz3d.com/utility-weapons/exports/jamming-system/setweaponjamstate



Set the weapon jam state of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>

      <tr>
        <td>`state`</td>
        <td>boolean</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The jam state</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  exports["utility_weapons"]:SetWeaponJamState(weapon, true)
  ```
</Accordion>


# GetRecoilStep
Source: https://docs.markz3d.com/utility-weapons/exports/other/getrecoilstep



Return the current recoil step of the specified weapon (every time the weapon is fired, the recoil step is increased), the recoil step can be setted in Config.Patterns

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>
          <td>The recoil step of the weapon</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  local recoilStep = exports["utility_weapons"]:GetRecoilStep(weapon)
  ```
</Accordion>


# HaveGunpowderTraces
Source: https://docs.markz3d.com/utility-weapons/exports/other/havegunpowdertraces



Return true if the player has a gunpowder trace.

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`source`</td>
        <td>number</td>

        <td>
          <input type="checkbox" />
        </td>

        <td>`-`</td>
        <td>Only in the server side</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>boolean</td>
          <td>If the player is holding breath or not</td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  The following example shows how to use the export in the client-side, for the server side you need to use the `source` argument.

  ```lua theme={null}
  exports["utility_weapons"]:HaveGunpowderTraces()
  ```
</Accordion>


# AddWeaponExperience
Source: https://docs.markz3d.com/utility-weapons/exports/weapon-experience/addweaponexperience



Set the weapon experience of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>

      <tr>
        <td>`experience`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The experience</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  exports["utility_weapons"]:SetWeaponExperience(weapon, 100)
  ```
</Accordion>


# GetWeaponExperience
Source: https://docs.markz3d.com/utility-weapons/exports/weapon-experience/getweaponexperience



Return the experience of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Returns ">
  <div>
    <table>
      <thead>
        <tr>
          <th>
            Type
          </th>

          <th>
            Description
          </th>
        </tr>
      </thead>

      <tbody>
        <tr>
          <td>number</td>

          <td>
            The experience that the player has with the weapon
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</Accordion>

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())
  local experience = exports["utility_weapons"]:GetWeaponExperience(weapon)

  print(experience)
  ```
</Accordion>


# RemoveWeaponExperience
Source: https://docs.markz3d.com/utility-weapons/exports/weapon-experience/removeweaponexperience



Remove experience from a weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>

      <tr>
        <td>`experience`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The experience</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  exports["utility_weapons"]:RemoveWeaponExperience(weapon, 100)
  ```
</Accordion>


# SetWeaponExperience
Source: https://docs.markz3d.com/utility-weapons/exports/weapon-experience/setweaponexperience



Set the weapon experience of the specified weapon

<div>
  <table>
    <thead>
      <tr>
        <th>
          Argument
        </th>

        <th>
          Data Type
        </th>

        <th>
          Nedeed
        </th>

        <th>
          Default
        </th>

        <th>
          Description
        </th>
      </tr>
    </thead>

    <tbody>
      <tr>
        <td>`weapon`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The weapon hash</td>
      </tr>

      <tr>
        <td>`experience`</td>
        <td>number</td>
        <td>✅</td>
        <td>`-`</td>
        <td>The experience</td>
      </tr>
    </tbody>
  </table>
</div>

<br />

<Accordion title="Example">
  ```lua theme={null}
  local retval, weapon = GetCurrentPedWeapon(PlayerPedId())

  exports["utility_weapons"]:SetWeaponExperience(weapon, 100)
  ```
</Accordion>


# Installation
Source: https://docs.markz3d.com/utility-weapons/installation



# 📦 Required Dependencies

* Install [Utility Lib](https://github.com/utility-library/utility_lib)