> For the complete documentation index, see [llms.txt](https://docs.mosotoscripts.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mosotoscripts.com/scripts/mst_fpscanner/installation.md).

# Installation

***

{% stepper %}
{% step %}

### Download

Download **mst\_fpscanner** from [**Portal**](https://portal.cfx.re/assets/granted-assets).
{% endstep %}

{% step %}

### Dependencies

**Required:**

* [es\_extended](https://github.com/esx-framework/esx_core/tree/main/%5Bcore%5D/es_extended) or [qb-core](https://github.com/qbcore-framework/qb-core) or [qbx\_core](https://github.com/Qbox-project/qbx_core)
* [mst\_bridge](https://portal.cfx.re/assets/granted-assets)
* [ox\_lib](https://github.com/communityox/ox_lib/releases)
* [qb-target](https://github.com/qbcore-framework/qb-target) or [ox\_target](https://github.com/communityox/ox_target/releases)

**Optional:**

* [screencapture](https://github.com/itschip/screencapture)
* [MugShotBase64](https://github.com/BaziForYou/MugShotBase64)
  {% endstep %}

{% step %}

### Resources Order

{% hint style="warning" %}
mst\_fpscanner must be at the bottom of mst\_bridge
{% endhint %}

<pre class="language-markdown" data-title="SERVER.CFG"><code class="lang-markdown">ensure es_extended/qb-core/qbx_core
ensure oxmysql
ensure ox_lib

ensure inventory
ensure phone
ensure clothing
ensure banking
ensure fuel
ensure target

<strong>ensure mst_bridge
</strong><strong>ensure mst_fpscanner
</strong></code></pre>

{% endstep %}

{% step %}

## Database

* Add the images from the `inventory_images` folder inside `mst_fpscanner` to your inventory system’s image directory.

{% tabs %}
{% tab title="MySQL" %}

```sql
DELETE FROM items WHERE name = 'mobilescanner';
DELETE FROM items WHERE name = 'staticscanner';

INSERT INTO `items` (`name`, `label`, `weight`) VALUES
	('mobilescanner', 'Mobile Fingerprint Scanner', 1),
	('staticscanner', 'Static Fingerprint Scanner', 1)
;
```

{% endtab %}

{% tab title="QB" %}

```lua
mobilescanner = { name = 'mobilescanner', label = 'Mobile Fingerprint Scanner', weight = 1, type = 'item', image = 'mobilescanner.png', unique = true, useable = true, shouldClose = true, description = 'A portable device used to scan fingerprints on the go' },
staticscanner = { name = 'staticscanner', label = 'Static Fingerprint Scanner', weight = 1, type = 'item', image = 'staticscanner.png', unique = true, useable = true, shouldClose = true, description = 'A stationary fingerprint scanner that can be placed in a location' },
```

{% endtab %}

{% tab title="OX" %}

```lua
['mobilescanner'] = {
    label = 'Mobile Fingerprint Scanner',
    weight = 1000,
    stack = false,
    close = true,
    description = 'A portable device used to scan fingerprints on the go',
    client = {
        image = 'mobilescanner.png'
    }
},

['staticscanner'] = {
    label = 'Static Fingerprint Scanner',
    weight = 2000,
    stack = false,
    close = true,
    description = 'A stationary fingerprint scanner that can be placed in a location',
    client = {
        image = 'staticscanner.png'
    }
}
```

{% endtab %}

{% tab title="TGIANN" %}
{% code fullWidth="false" %}

```lua
mobilescanner = { label = "Mobile Fingerprint Scanner", weight = 1, type = "item", image = "mobilescanner.png", unique = true, useable = true, shouldClose = true, description = "A portable device used to scan fingerprints on the go" },
staticscanner = { label = "Static Fingerprint Scanner", weight = 1, type = "item", image = "staticscanner.png", unique = true, useable = true, shouldClose = true, description = "A stationary fingerprint scanner that can be placed in a location" },
```

{% endcode %}
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

### Storage Setup

{% hint style="info" %}
There are 2 storage options where to store your images.
{% endhint %}

{% tabs %}
{% tab title="Fivemanage" %}

1. Open [Fivemanage](https://refer.fivemanage.com/simeon)
2. Create an account
3. Go to "Tokens" in the sidebar and then "Create Token"
4. Choose a name and "Images only" type from the dropdown
5. Finish with "Create Token"
6. Add <kbd>setr FIVEMANAGE\_MEDIA\_API\_KEY yourToken</kbd> in server.cfg below `mysql_connection_string` for example
7. Copy the token you made and put it in place of `yourToken`
8. Go to `mst_fpscanner/config` and set `storage = "fivemanage"`.
9. Save & Restart the server
   {% endtab %}

{% tab title="Imgbb " %}

1. Open [Imgbb](https://api.imgbb.com/)
2. Sign Up
3. Generate an API Key
4. Add `set IMGBB_API_KEY "your_key"` in server.cfg below `mysql_connection_string` for example
5. Copy the generated key and paste it between ""
6. Go to `mst_fpscanner/config` and set `storage = "imgbb"`.
7. Save & Restart the server
   {% endtab %}
   {% endtabs %}
   {% endstep %}

{% step %}

### Any other configurations?

{% hint style="success" %}
At Mosoto Scripts, we are constantly improving our resources, and for this reason you do not need to run the SQL manually, this happens automatically when you run the script for the first time.
{% endhint %}

{% hint style="info" %}
You will also no longer have to change the framework manually, for each script, as well as the language, notifications, etc. Everything happens through the `config.lua` file of **mst\_bridge**.
{% endhint %}
{% endstep %}

{% step %}

### Not working?

We hope you won’t need this step, but if you do, feel free to join our [**Discord**](https://discord.mosotoscripts.com) and open a support ticket. :)
{% endstep %}
{% endstepper %}