Start here
Use this edition as the shared ox_lib foundation for resources that rely on OX callbacks, zones, menus, notifications, progress tools, and other client/server helpers. The compiled custom interface is already included.
On this page
ox_lib
The familiar OX foundation with a refreshed interface.
StandaloneFiveMRedMLuaReact UI
What you need
PlatformsFiveM or RedM
Server artifact7290 or newer
RequiredOneSync
Resource nameox_lib
Install and start
- 01
Download or clone the repository into your server resources as ox_lib.
- 02
Confirm the server artifact requirement and enable OneSync.
- 03
Ensure ox_lib before every resource that imports or depends on it.
- 04
Use the README test commands to review the customized UI in-game.
Recommended start orderplain text
ensure ox_libConfiguration checkpoints
Keep the resource name unchanged
The folder must be named ox_lib. Dependent resources reference that exact name when importing the shared initializer.
Meet the server baseline
Use FXServer artifact 7290 or newer with OneSync enabled. The resource uses Lua 5.4 and should start before every resource that consumes it.
Set shared preferences
Use the ox:locale and ox:userLocales convars for server-wide locale behavior. Players can open /ox_lib to adjust their notification position, audio, and locale preferences.
Import the library
Add the shared initializer to the fxmanifest of a resource that consumes ox_lib.
Exampleplain text
shared_script '@ox_lib/init.lua'Validate the resource
Validate the customized interface
Run the included preview commands in-game to check each UI surface after installation.
Commandsplain text
/oxtestui
/oxnotify
/oxctx
/oxmenu
/oxradial
/oxskill
/oxprog
/oxcircle
/oxtext
/oxhidetextUse the upstream API reference
Use the public OX API reference for callbacks, zones, points, keybinds, menus, dialogs, and progress tools, while checking that each page still applies to this 3.39.0-based fork.
Common checks
A dependent resource cannot find ox_lib
Confirm the folder is named ox_lib, the resource is ensured first, and the consumer imports @ox_lib/init.lua.
A preview command does not display
Check the client console for NUI errors, confirm the bundled web build is still present, and test the complete /oxtestui suite.
The server rejects the resource
Verify the FXServer artifact is new enough and OneSync is enabled before changing the resource itself.
Source and release notes
- This is a UI-focused edition based on Overextended ox_lib 3.39.0.
- Keep upstream author credit and the LGPL-3.0-or-later license with redistributed copies.