ORYNTDOCS
StoreSupport
Docs/Start here

Getting started

Everything you need to get any Orynt script running: downloading it, installing Orynt Bridge, the right order in server.cfg, staff access and updating without losing your settings.

Before you start

Every Orynt script runs on a normal FiveM server. You need:

A recent FiveM server build Paid scripts are protected by Cfx.re asset escrow, which needs an up-to-date server artifact. Update your artifacts if a script won't start.
ox_lib Used by most Orynt scripts: download
oxmysql Needed by the scripts that save to your database: download
orynt_bridge Free. Connects every Orynt script to your framework, inventory and third eye. Install it once, see below.

ESX, QBCore, Qbox (and for some scripts, no framework at all) are found automatically. So are ox_inventory, qs-inventory, qb-inventory and many others: see Orynt Bridge for the full list.

1. Download your scripts

  1. Buy the script on our store with your Cfx.re account.
  2. Open portal.cfx.re, go to Assets > Granted Assets and download it.
  3. Unzip it. Keep the folder name exactly as it is (e.g. orynt_shops): the scripts and their saved settings are tied to it.

The server's license key has to belong to the same Cfx.re account that bought the script. If it doesn't, the server console shows "You lack the required entitlement" and the script won't start.

2. Install Orynt Bridge (once)

Download orynt_bridge (free) and put it in your resources folder. Every Orynt script uses it, so it only ever needs installing once, no matter how many Orynt scripts you run.

3. Add everything to server.cfg

Put the scripts in your resources folder (a folder named [orynt] keeps them together) and start them after your framework, database, inventory and target, with orynt_bridge first:

ensure oxmysql
ensure ox_lib
ensure es_extended          # or qb-core / qbx_core
ensure ox_inventory         # or your inventory
ensure ox_target            # optional: or qb-target

ensure orynt_bridge
ensure orynt_shops
ensure orynt_licenses
# ...the rest of your Orynt scripts

Orynt Chat replaces the default chat, so it goes where ensure chat was (early in the file), with ensure orynt_bridge just above it.

4. Start the server and check the console

Every script prints what it found when it starts:

[Orynt Shops] framework: qbcore, inventory: qs-inventory, third eye: qb-target
[Orynt Shops] Loaded 9 shop(s)

Wrong framework or inventory? Set it in that script's config.lua (Config.Framework, Config.Inventory, Config.Target), or once for every Orynt script in orynt_bridge/config.lua. 'auto' finds it by itself.

5. Give your staff access

Admins in your framework's admin / superadmin / god groups can already use the in-game editors. You can also allow people with an ace in server.cfg (each script's page lists its ace):

add_ace group.admin orynt_shops.admin allow
add_principal identifier.fivem:1234567 group.admin

6. Set things up in game

Most Orynt scripts are set up in game, with no coordinates to copy and no SQL to import: shops with /shopadmin, money washes with /washadmin, rentals with /rentaladmin, stashes with /stashes, licenses with /licenses... Each script's page walks you through it.

Updating a script

  1. Download the new version from portal.cfx.re.
  2. Replace the script's folder with the new one.
  3. Restart the server, or type refresh and then ensure <script> in the console.

Your settings come back by themselves. Every Orynt script keeps a copy of your config.lua (and its other settings files) on the server. When an update starts with the files from the download, yours are put back and the script restarts once to load them. New options use their defaults, and the console lists them once. Everything you made in game (shops, locations, licenses...) is saved on the server and stays.

To let the script restart itself after putting your settings back, add this once per script:

add_ace resource.orynt_shops command.ensure allow

Common problems

Problem Fix
"You lack the required entitlement" The server key isn't from the Cfx.re account that bought the script. Use that account's key, or have the script transferred.
"orynt_bridge is not running" Install orynt_bridge and put ensure orynt_bridge above your Orynt scripts.
"needs orynt_bridge x.x.x or newer" Download the latest orynt_bridge (free) and replace the folder.
The script finds the wrong framework / inventory Set Config.Framework / Config.Inventory in its config.lua (or in orynt_bridge's config).
Item pictures are missing Copy the pictures from the script's install/ folder to your inventory's image folder and clear the FiveM cache.
A script won't start after an update Read the console: it says which settings were put back and if it needs one restart.
Nobody can open the editor Give staff the script's ace (see its page), or check their framework group.

Getting help

Stuck, found a bug or have an idea? Join our Discord and open a ticket. Send the server console output from when the script starts (and the error, if there is one), your framework and inventory, and the script's version: we'll get you going.

New scripts and updates are on our store.

Orynt Development© Orynt Development. Docs for every Orynt FiveM script.