Installation

Requirements, the folder name and the start order in server.cfg.

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
  • A framework: ESX Legacy, QBCore or QBX (or your own, see Custom framework)

Install

  1. Download

    Get the latest release from GitHub releases. Release zips already contain the built UI.
  2. Name the folder obsi-lib

    Put it in your resources as obsi-lib.
  3. Add it to server.cfg

    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
  4. 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.