mirror of
https://github.com/CommunityOx/ox_lib.git
synced 2026-08-16 22:46:03 +01:00
chore: readme
This commit is contained in:
13
README.md
13
README.md
@@ -1,11 +1,12 @@
|
||||
<div align='center'><h1><a href='https://overextended.github.io/docs/'>Documentation</a></h3></div>
|
||||
<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
|
||||
lua54 'yes'
|
||||
shared_script '@ox_lib/init.lua'
|
||||
```
|
||||
|
||||
@@ -19,4 +20,12 @@ add_ace resource.ox_lib command.remove_principal allow
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
<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"
|
||||
|
||||
Reference in New Issue
Block a user