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

# Installation

> Install Revo ID Card and set it up on your FiveM server.

<Warning>
  If you are updating to v1.2 from an older version, you must update your inventory item image names to prevent missing-image issues and inventory errors.

  `id_card` -> `revo_design_1.png`\
  `driver_license` -> `revo_design_2.png`\
  `firearm_license` -> `revo_design_3.png`
</Warning>

<Info>
  After updating the image names in your inventory items file, place the new images from the `items-images` folder into your inventory image folder.
</Info>

<Steps>
  <Step title="Download Revo ID Card">
    Visit the <a href="https://keymaster.fivem.net/" target="_blank">FiveM Keymaster</a> and download the latest version of **Revo ID Card**. Save the script to your computer.
  </Step>

  <Step title="Add to Resources">
    Place the downloaded `revo_idcard` folder inside your server's `resources` directory.
  </Step>

  <Step title="Configure server.cfg">
    Add the following line to your `server.cfg` to ensure Revo ID Card starts with your server:

    ```bash theme={null}
    ensure revo_idcard
    ```
  </Step>

  <Step title="Add Items to Your Inventory System">
    Revo ID Card supports the following inventory systems. Choose the one you're using and follow the corresponding instructions:

    <Tabs>
      <Tab title="ox_inventory">
        Open your `ox_inventory/data/items.lua` file and add the following items:

        ```lua theme={null}
        ['id_card'] = {
          label = 'ID Card',
          weight = 1,
          stack = false,
          close = true,
          description = "Your personal identification card.",
          client = {
            image = 'revo_design_1.png',
          }
        },
        ['driver_license'] = {
          label = 'Driver License',
          weight = 1,
          stack = false,
          close = true,
          description = "Your driver's license.",
          client = {
            image = 'revo_design_2.png',
          }
        },
        ['firearm_license'] = {
          label = 'Firearm License',
          weight = 1,
          stack = false,
          close = true,
          description = "Your weapon's license.",
          client = {
            image = 'revo_design_3.png',
          }
        },
        ```

        Add images (from `items-images` folder of `revo_idcard`) to: `ox_inventory/web/images/`

        * revo\_design\_1.png
        * revo\_design\_2.png
        * revo\_design\_3.png
      </Tab>

      <Tab title="qb-inventory">
        Open your `qb-core/shared/items.lua` file and add the following items. If your server uses a custom QB/Quasar item file, update that file instead:

        ```lua theme={null}
        ['id_card'] = {
          ['name'] = 'id_card',
          ['label'] = 'ID Card',
          ['weight'] = 1,
          ['type'] = 'item',
          ['image'] = 'revo_design_1.png',
          ['unique'] = false,
          ['useable'] = true,
          ['shouldClose'] = true,
          ['combinable'] = nil,
          ['description'] = 'Your personal identification card.'
        },
        ['driver_license'] = {
          ['name'] = 'driver_license',
          ['label'] = 'Driver License',
          ['weight'] = 1,
          ['type'] = 'item',
          ['image'] = 'revo_design_2.png',
          ['unique'] = false,
          ['useable'] = true,
          ['shouldClose'] = true,
          ['combinable'] = nil,
          ['description'] = 'Your driver'
        },
        ['firearm_license'] = {
          ['name'] = 'firearm_license',
          ['label'] = 'Firearm License',
          ['weight'] = 1,
          ['type'] = 'item',
          ['image'] = 'revo_design_3.png',
          ['unique'] = false,
          ['useable'] = true,
          ['shouldClose'] = true,
          ['combinable'] = nil,
          ['description'] = 'Your weapon'
        },
        ```

        Add images (from `items-images` folder of `revo_idcard`) to: `qb-inventory/html/images/`

        * revo\_design\_1.png
        * revo\_design\_2.png
        * revo\_design\_3.png
      </Tab>

      <Tab title="qs-inventory / qs-advancedinventory">
        For ESX servers, add the following items to your Quasar items file such as `qs-inventory/shared/items.lua`.

        For QBCore servers, add the same items to `qb-core/shared/items.lua` or the relevant items file used by your Quasar setup.

        ```lua theme={null}
        ['id_card'] = {
          ['name'] = 'id_card',
          ['label'] = 'ID Card',
          ['weight'] = 1,
          ['type'] = 'item',
          ['image'] = 'revo_design_1.png',
          ['unique'] = false,
          ['useable'] = true,
          ['shouldClose'] = true,
          ['combinable'] = nil,
          ['description'] = 'Your personal identification card.'
        },
        ['driver_license'] = {
          ['name'] = 'driver_license',
          ['label'] = 'Driver License',
          ['weight'] = 1,
          ['type'] = 'item',
          ['image'] = 'revo_design_2.png',
          ['unique'] = false,
          ['useable'] = true,
          ['shouldClose'] = true,
          ['combinable'] = nil,
          ['description'] = 'Your driver'
        },
        ['firearm_license'] = {
          ['name'] = 'firearm_license',
          ['label'] = 'Firearm License',
          ['weight'] = 1,
          ['type'] = 'item',
          ['image'] = 'revo_design_3.png',
          ['unique'] = false,
          ['useable'] = true,
          ['shouldClose'] = true,
          ['combinable'] = nil,
          ['description'] = 'Your weapon'
        },
        ```

        Place the new images from the `items-images` folder of `revo_idcard` into the image folder used by your Quasar inventory build.

        * revo\_design\_1.png
        * revo\_design\_2.png
        * revo\_design\_3.png
      </Tab>
    </Tabs>
  </Step>

  <Step title="Start the Resource">
    After adding or updating the items and images, restart your inventory resource (ox\_inventory, qb-inventory, qs-inventory, or qs-advancedinventory) to load the new items.

    Then restart your server or run these commands in the server console:

    ```bash theme={null}
    refresh
    ensure revo_idcard
    ```
  </Step>
</Steps>

<Tip>
  Revo ID Card is fully configurable and optimized for performance. You can customize NPCs, card visuals, card designs, validation behavior, and prices in the `config.lua` file.
</Tip>