From 827ce1a223db68be7c536e6d00ec5d3228d5ffcd Mon Sep 17 00:00:00 2001 From: Linden <65407488+thelindat@users.noreply.github.com> Date: Thu, 11 Nov 2021 08:07:33 +1100 Subject: [PATCH] chore: readme --- README.md | 13 ++++++++++++- imports/callbacks/server.lua | 1 - 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0e4afff..f8fd6d8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ ## WIP Lua Library -### How to utilise in another resource +The idea of this resource is to create a set of reusable functions for importing into other resources. Though FiveM has its own system for importing files (which is used to load init), this simplifies declarations and allows you to keep everything as `locals` rather than polluting the global namespace. + +Everyone is free to utilise either the library or code from it so long as [the license is respected and adhered to](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)). + +- [x] Server Callbacks +- [ ] Table utilities +- [ ] OxMySQL library +- [ ] Native wrappers (animations, spawning, etc.) +- [ ] Iterators +- todo: think of more features + +### How to utilise ServerCallbacks - fxmanifest.lua ```lua diff --git a/imports/callbacks/server.lua b/imports/callbacks/server.lua index 59944e1..f0b92b1 100644 --- a/imports/callbacks/server.lua +++ b/imports/callbacks/server.lua @@ -13,6 +13,5 @@ local ServerCallback = {} end, ...) end) end -} return ServerCallback \ No newline at end of file