Installation

Start tc-ui and import it into a script.

#Server installation

1. Copy the tc-ui folder into resources.
2. In server.cfg, start it before every resource that depends on it:

ensure tc-ui

There is no database and no item to create. tc-ui has no config.lua file: it is tuned through the options you pass to its functions.

#Using tc-ui in your own script

In your resource's fxmanifest.lua:

dependency 'tc-ui'
shared_script '@tc-ui/init.lua'   -- exposes the `tc` global

You can then call tc.notify, tc.progress, etc. directly:

tc.notify({ title = 'Welcome', description = 'The script is ready.', type = 'success' })

#Without the import

Every function is also available as an export, without touching the manifest:

exports['tc-ui']:notify({ title = 'Info', description = 'Through an export', type = 'info' })
local ok = exports['tc-ui']:progress('Repairing', 5000, { canCancel = true })

#Check it works

From the F8 console (or a small client script):

tc.notify({ title = 'Test', description = 'tc-ui is working.', type = 'success' })

A notification should appear. If not, see troubleshooting.