From 71f751c2fffdbfa52548ef34a00a3c270d9a6dbf Mon Sep 17 00:00:00 2001 From: Linden <65407488+thelindat@users.noreply.github.com> Date: Thu, 18 May 2023 18:44:23 +1000 Subject: [PATCH] chore: readme --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e37bb8e..02479fc 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@

Documentation


-## 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 + LGPL-3.0-or-later + +## 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"