Summary

This is a developer resource and connector. It should be used in conjunction with other scripts.

crToolkit is a set of utilities, functions, events and systems that can be leveraged by LUA scripts in FiveM and RedM. It attempts to provide an abstraction similar to that seen in C# developments and simplifies script development by easily re-using common functions.

Using the toolkit

We have two different versions of our toolkit, our community edition is free to download from our tebex site. The source code isn't readable, but we publish all the usable exports in the link below.

For our developer edition which is our paid version, this has a host of functions that can be directly called via the short code keys provided in our reference documentation. This can be used on your own resources or other third party code you use.

Community Edition

With the community edition, you can use any of the provided exports found in this list.

Exports

All our first party scripts come packaged with our community edition.

Developer Edition

Do not use this code with the community edition or your resources will fail to start.

You can add the toolkit to existing resources in order to leverage the functions. You can do this by adding the following record to your shared scripts in the fxmanifest.

We recommend adding crToolkit as a dependency if you do add it to your scripts, this ensures it won't try and execute toolkit functions while the resource is unavailable.

fxmanifest.lua

dependencies {
	'crToolkit'
}

shared_scripts {
	'@crToolkit/import.lua'
}