Installation

Guide for using SP Core and its Bridge with ox_lib.

1) Requirements

• Lua 5.4 in your resource

• [ox_lib] loaded before anything that uses SP Core Add the ox_lib init to shared so both sides get it.

-- fxmanifest.lua
lua54 'yes'

shared_scripts {
    '@ox_lib/init.lua',      -- required
}

If ox_lib isn’t started, you will see load errors. Start order must be ox_lib → sp_core → Any other SP Studio Scripts or your own scripts.

---

2) Loading SP Core Utility Library

-- fxmanifest.lua
lua54 'yes'

shared_scripts {
    '@ox_lib/init.lua',      -- required
    '@sp_core/init.lua' -- this is for utility functions/interface
}

3) Loading SP Core Bridge

(1) through fxmanifest.lua (Recommended)

This would load the entirety of the bridge ( Framework, Inventory, Target, UI Modules)

-- fxmanifest.lua
lua54 'yes'

shared_scripts {
    '@ox_lib/init.lua',      -- required
    '@sp_core/init.lua' -- this is for utility functions/interface
    '@sp_core/bridge/init.lua' -- this is required for bridge
} 

You can also load just the client or just the server script in as well.

-- fxmanifest.lua
lua54 'yes'
shared_scripts {
    '@ox_lib/init.lua',      -- required
    '@sp_core/init.lua' -- this is for utility functions/interface
}

client_scripts {
    '@sp_core/bridge/init.lua' 
} 
-- or
server_scripts {
    '@sp_core/bridge/init.lua'
}

(2) using require and load function to use only specific modules

local Notify = require('@sp_core.bridge.shared').load('ui.notify')

Notify({ message = 'sp is awesome'})

You can also load multiple modules in as well

local Bridge = require('@sp_core.bridge.shared').load('ui', 'fw')

Bridge.fw.hasGroup('police')

Bridge.ui.notify({ message = 'sp is awesome'})

(3) using require function

FW = require('@sp_core.bridge.framework.init')

FW.hasGroup('police')