Sleepless Interact

A 3D DUI interaction library for interacting with various entities and points in the world.

ox_target

interact v2 fully provides support for ox_target and will handle all of the exports for ox_target if you want it to.

Installation

Download a release (opens in a new tab) or build the source code.

git clone https://github.com/Sleepless-Development/sleepless_interact.git
cd sleepless_interact/web
pnpm i
pnpm build

Configure

To changed the config settings, look inside imports/config.lua

-- this is the maximum distance that interacts will render the indicator sprite (little cirlce)
-- recommend keeping this pretty low for optimization
config.maxInteractDistance = 5.0
 
-- {0-255, 0-255, 0-255, 0-255}
config.themeColor = { 28, 100, 184, 200 } --- r, g, b, a
 
--- texture dictionary and texture name for the sprite used to show non active interactions.
config.IndicatorSprite = { dict = 'shared', txt = 'emptydot_32' }
 
-- boolean true/false use a keybind to show and hide the interactions
config.useShowKeyBind = true
 
-- string default key mapping for the show interactions keybind
config.defaultShowKeyBind = 'LMENU'
 
-- "hold" | "toggle" sets the behavior of the show interactions key bind
config.showKeyBindBehavior = 'toggle'

Usage

To enable the library inside of your resource just add @sleepless_interact/init.lua as a client_script in your fxmanifest.lua file.

client_scripts {
    '@sleepless_interact/init.lua',
}

When sleepless_interact has been imported into your script, it will make a new global:

interact for calling sleepless_interact functions into your script.

all of the functions can also be called via exports. example: exports.sleepless_interact:addEntity(netId, options)

You can now use the interact functions inside of your resource.

removeGlobalVehicle Interact Options