chore: readme

This commit is contained in:
Linden
2023-05-18 18:44:23 +10:00
parent 16875ca7e3
commit 71f751c2ff

View File

@@ -1,11 +1,12 @@
<div align='center'><h1><a href='https://overextended.github.io/docs/'>Documentation</a></h3></div> <div align='center'><h1><a href='https://overextended.github.io/docs/'>Documentation</a></h3></div>
<br> <br>
## Lua Library for FiveM ## ox_lib
FXServer provides its own system for including files, which we use to load this resource in the fxmanifest via Cfx provides functionality for loading external files in a resource through fxmanifest.
```lua ```lua
lua54 'yes'
shared_script '@ox_lib/init.lua' shared_script '@ox_lib/init.lua'
``` ```
@@ -19,4 +20,12 @@ add_ace resource.ox_lib command.remove_principal allow
``` ```
## License ## License
<a href='https://www.gnu.org/licenses/lgpl-3.0.en.html'>LGPL-3.0-or-later</a> <a href='https://www.gnu.org/licenses/lgpl-3.0.en.html'>LGPL-3.0-or-later</a>
## 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"