> For the complete documentation index, see [llms.txt](https://brunx-mods.gitbook.io/brunx-mods-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brunx-mods.gitbook.io/brunx-mods-docs/products/scripts/brunx-bridge/installation.md).

# Installation

{% stepper %}
{% step %}

### Install ox\_lib

Download the latest [ox\_lib release](https://github.com/overextended/ox_lib/releases) and place it in your resources. The bridge will not start without it.
{% endstep %}

{% step %}

### Add the bridge

Download Brunx Bridge from the Cfx portal or [GitHub](https://github.com/brunxscripts/brunx_bridge) and place the folder in your `resources` directory.

{% hint style="success" %}
The folder name does not matter. `brnx_bridge`, `brunx_bridge` or `brunx_bridge-main`: every export is also registered as `exports['brnx_bridge']`.
{% endhint %}
{% endstep %}

{% step %}

### Set the ensure order

Start the bridge after your framework, inventory and target, and before every resource that uses it.

{% code title="server.cfg" %}

```cfg
ensure ox_lib
ensure qbx_core        # or qb-core / es_extended
ensure ox_inventory    # optional
ensure ox_target       # optional
ensure brnx_bridge     # your folder name

ensure my_script       # scripts that use the bridge
```

{% endcode %}

{% hint style="info" %}
When a framework starts after the bridge anyway, the bridge detects it the moment it starts. Restarting the bridge is not needed.
{% endhint %}
{% endstep %}

{% step %}

### Give admins access to /compchecker

The CompChecker command is restricted. Servers that grant `command` to admins (the Qbox and QBCore default) already have access. Otherwise add:

{% code title="server.cfg" %}

```cfg
add_ace group.admin command.compchecker allow
```

{% endcode %}
{% endstep %}

{% step %}

### Start the server

The console shows which framework the bridge picked:

```
[brnx_bridge] Framework: qbox (qbx_core)
```

Set your language in `shared/config.lua` with `Config.Locale` (see [Locales](/brunx-mods-docs/products/scripts/brunx-bridge/localization.md)).
{% endstep %}
{% endstepper %}

## Updating

Replace the whole folder and keep your own `shared/config.lua` and `shared/cayo.lua`. Both files are excluded from escrow, so they always stay editable.

With `Config.VersionCheck = true` the server console reports on start whether a newer version is available.

{% hint style="warning" %}
Coming from 1.0.x? A few config options were renamed or removed. Read the [changelog](/brunx-mods-docs/products/scripts/brunx-bridge/version-changelog.md) before copying your old config over.
{% endhint %}