Obsi Lib is a normal resource that starts after your framework and inventory and before any script that uses it.

## Requirements

- A FiveM server artifact with Lua 5.4 support
- [oxmysql](https://github.com/overextended/oxmysql)
- A framework: ESX Legacy, QBCore or QBX (or your own, see [Custom framework](/lib/reference/custom-framework))

## Install

:::::steps
### Download

Get the latest release from [GitHub releases](https://github.com/Obsi-Scripts/obsi-lib/releases).
Release zips already contain the built UI.

### Name the folder obsi-lib

Put it in your resources as **`obsi-lib`**.

::::hint{type="warning" title="The name matters"}
Other scripts find the library by its resource name, so do not rename the folder.
Under any other name it prints a red warning in the console on start.
::::

### Add it to server.cfg

```cfg title="server.cfg"
ensure oxmysql
ensure es_extended      # or qb-core / qbx_core
ensure ox_inventory     # or your inventory
ensure obsi-lib
ensure obsi-whatever    # scripts that use obsi-lib
```

### Start the server

Obsi Lib detects your framework, inventory and integrations on start.
Set `ObsiConfig.Debug = true` to see how each bridge was resolved in the console.
:::::

## Cloned from GitHub?

If you cloned the repository instead of downloading a release, build the UI first; see [Building the UI](/lib/reference/building-the-ui).