forked from overextended/ox_lib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,27 @@ | ||
<div align='center'><h1><a href='https://overextended.github.io/docs/'>Documentation</a></h3></div> | ||
<br> | ||
# ox_lib | ||
|
||
## 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 | ||
lua54 'yes' | ||
shared_script '@ox_lib/init.lua' | ||
``` | ||
## 📚 Documentation | ||
|
||
### server.cfg | ||
https://overextended.dev/ox_lib | ||
|
||
``` | ||
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 | ||
``` | ||
## 💾 Download | ||
|
||
## 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 | ||
|
||
- 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" | ||
- e.g. "c:/fxserver/resources/ox_lib" |