README

nss_gta_libs is a collection of helpers for FIVM scripts. This library is designed for

• ease of use

• high performance

• reusability (Instead of writing duplicate code each script!)

It offers a wide range of so-called LUA modules and UI components.

The current state of the library is alpha. This means that the library is not yet feature complete and there may be bugs. Use the library on our own risk.

Visit our Discord / Homepage / Store / Docs!

---

Support

• Visit Discord to open a ticket.

---

Changelog

See CHANGELOG.md for more information.

---

Setup script for customers

1. Ensure that the nss_gta_libs folder is in your resources folder.

2. Copy [config.demo.lua] to config.lua and fill in the values.

   • If you use a not supported framework like QB-Core then you may need to create your own adapter. See Custom adapter for more information.

3. Ignore internal_cfg.lua and other config files in nss_gta_libs because they are only for developers, see Additional setup script for developers for more information.

4. Add ensure nss_gta_libs to your server.cfg. Note: Place it on top of all resources that uses nss_gta_libs but after any framework like qb-core.

5. Restart your server.

---

Additional setup script for developers

If you are a developer and create scripts using nss_gta_libs then you can optionally do the following:

• Rename [config.demo.lua] to config.lua and fill in the values (currently there are no values).

• Modules can have their own config files, check the modules for config.lua or config.demo.lua files. Note: This is not necessary for all modules and depends on your use cases (e.g. as developer to enable debug modes).

---

TODOs

• Countless ;)

• Die Exports sollen zu einem Export zusammengefasst werden, die dann weitere Apis bereitstellen, dann kann sich jede Resource auch gleich registrieren und muss das nicht mehr einzeln machen.

• Für die Config in der libs sollte auch der Config-Checker eingebaut werden.

---

Dev hints

• PHPStorm LUA Annotations