Installation

Requirements

Resource	Notes
A framework: qb-core, qbx_core or es_extended	Optional. Needed for job and gang conditions and for the creator’s money and items. Without one it runs standalone
An inventory: ox_inventory, qs-inventory, qb-inventory or the ESX one	Optional. Needed for item conditions, item pictures and the creator’s items

No database, SQL file or additional items are required.

Step by step

1. Download the resource

Open portal.cfx.re, go to Assets > Granted Assets and download SL-Interact. It has two folders: sl_interact (the script) and sl_interact_demo (an optional example).

The open-source edition is downloaded the same way, with every file open. It also includes the source code of the interface in sl_interact/web.

Asset Escrow

The escrow version only runs on a server whose licence key (sv_licenseKey) belongs to the Cfx account that bought it. Keep the .fxap file that comes with the download.

2. Add it to your resources

Place the sl_interact folder in your resources directory, for example resources/[scripts]/sl_interact.

Do not rename the folder

Other scripts call it as exports.sl_interact. With another folder name, none of them would find it.

3. Remove your old target script

If your server uses ox_target, qb-target or qtarget, remove it from server.cfg (or move its folder to a [disabled] folder). SL-Interact takes its place: the scripts that use it keep working without changes. See target scripts.

Note

If the original is still running, SL-Interact prints a warning in the server console when it starts: scripts would talk to the original and not to SL-Interact.

4. Start it in server.cfg

Start SL-Interact after your framework and inventory, and before any script that uses it or used your old target script:

ensure qb-core          # or qbx_core / es_extended
ensure ox_inventory     # your inventory, if any
ensure sl_interact      # before [qb], [standalone]... and every script that uses it
ensure [qb]

On a default QBCore server, qb-target lives inside [qb]: move it out of that folder, and put ensure sl_interact above ensure [qb].

5. Give admins permission

The style editor (/slinteract_style) and the interactions panel (/slinteract_admin) need the sl_interact.style ACE permission:

add_ace group.admin sl_interact.style allow

You can also list identifiers (license:, discord:, fivem:) in Config.StyleEditor.admins in config.lua.

6. Check the configuration

Open config.lua and set at least:

• Config.Locale: 'en' or 'es'.
• Config.Debug: false on a live server.

Everything else works with its defaults. See configuration.

7. Restart the server

Restart the whole server, not only the resource. Scripts that use your old target script need to start after SL-Interact to reach it.

Try it

The download includes an example resource, sl_interact_demo, next to sl_interact and with open code:

1. Put sl_interact_demo in your resources folder and add ensure sl_interact_demo after ensure sl_interact.
2. In game, type /slidemo: an ATM, a door, a crate, a vending machine, a car and an NPC appear in front of you.
3. Hold Alt and aim at any vehicle to open its menu.
4. /slidemo clear removes them.

Remove it from server.cfg when you are done.

Updating

1. Download the new version from portal.cfx.re.
2. Keep your config.lua and the data folder: data/style.json (your style), data/interactions.json (panel rules) and data/creations.json (what you built in the creator).
3. Replace the rest of the folder and restart the server.
4. Check the changelog for new options in config.lua.