Main/resources/[standalone]/ox_lib/README.md
2025-06-07 08:51:21 +02:00

32 lines
1.4 KiB
Markdown

# ox_lib
A FiveM library and resource implementing reusable modules, methods, and UI elements.
![](https://img.shields.io/github/downloads/overextended/ox_lib/total?logo=github)
![](https://img.shields.io/github/downloads/overextended/ox_lib/latest/total?logo=github)
![](https://img.shields.io/github/contributors/overextended/ox_lib?logo=github)
![](https://img.shields.io/github/v/release/overextended/ox_lib?logo=github)
For guidelines to contributing to the project, and to see our Contributor License Agreement, see [CONTRIBUTING.md](./CONTRIBUTING.md)
For additional legal notices, refer to [NOTICE.md](./NOTICE.md).
## 📚 Documentation
https://overextended.dev/ox_lib
## 💾 Download
https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip
## 📦 npm package
https://www.npmjs.com/package/@overextended/ox_lib
## 🖥️ Lua Language Server
- Install [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) to ease development with annotations, type checking, diagnostics, and more.
- Install [cfxlua-vscode](https://marketplace.visualstudio.com/items?itemName=overextended.cfxlua-vscode) to add natives and cfxlua runtime declarations to LLS.
- You can load ox_lib into your global development environment by modifying workspace/user settings "Lua.workspace.library" with the resource path.
- e.g. "c:/fxserver/resources/ox_lib"