FumeNodes/ox_lib
1
0
Fork 0
mirror of https://github.com/CommunityOx/ox_lib.git synced 2026-08-17 06:56:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
Linden
2023-07-29 07:52:49 +10:00
committed by GitHub
parent 99519d3d8e
commit 497bee836f
1 changed files with 14 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -1,31 +1,27 @@
<div align='center'><h1><a href='https://overextended.github.io/docs/'>Documentation</a></h3></div> # ox_lib
<br>
## ox_lib A FiveM library and resource implementing reusable modules, methods, and UI elements.
Cfx provides functionality for loading external files in a resource through fxmanifest. ![](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)
```lua ## 📚 Documentation
lua54 'yes'
shared_script '@ox_lib/init.lua'
```
### server.cfg https://overextended.dev/ox_lib
``` ## 💾 Download
add_ace resource.ox_lib command.add_ace allow
add_ace resource.ox_lib command.remove_ace allow
add_ace resource.ox_lib command.add_principal allow
add_ace resource.ox_lib command.remove_principal allow
```
## License https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip
<a href='https://www.gnu.org/licenses/lgpl-3.0.en.html'>LGPL-3.0-or-later</a> ## npm Package
https://www.npmjs.com/package/@overextended/ox_lib
## Lua Language Server ## 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 [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. - 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. - 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" - e.g. "c:/fxserver/resources/ox_lib"