Installation

Four steps to a player on a working channel. tRadio ships a starter configuration, so there is nothing to set up first — no SQL import, no database, no port for the radio, no account.

Requirements

Version compatibility

Always pair a tRadio release with the newest tLib. Starting with a tLib below the minimum fails loudly.

Every version needs artifact 4752 or newer. A framework not on the list runs through the hooks in config/sv_functions.lua — see Framework integration.

Install

ensure tLib
ensure tRadio

[Radio-Server] Radio ready over FiveM net events; web exposure disabled (no HTTP listener or tLib registration)

What ships preconfigured

On first start tRadio writes a data.json holding a working starter configuration:

All of it is editable live in the admin panel — /tradio → Quick opens both panels in game. Only config/config.lua and the two function-hook files need a restart tRadio.

The admin panel opens on Overview, which tracks what a new server still needs. Two items you tick by hand: job mappings and the dispatch login.

data.json is written only when none exists, so an update never overwrites it.

Optional browser access

The panels already work without this. /tradio → Quick opens both in game.

The shipped defaults in config/config.lua:

exposeWeb = true,
useLegacySocketTransport = false,

With exposeWeb = true the dispatch panel is mounted at /dispatch on tLib's port (tlib_http_port, default 7777), so it answers at http://<your server>:7777/dispatch and the admin panel at /dispatch/admin. Open and forward that port — tLib's guide has the step, at opening tLib's port. Set tlib_http_public_url if tLib's auto-detected address is wrong. Both exposeWeb and useLegacySocketTransport need a resource restart, and useLegacySocketTransport stays false.

Never open tRadio's own loopback port.

showDispatchInHub and showAdminInHub control listing on tLib's hub, not access: hiding an entry does not make it private, and the mount still answers. To stop serving the panels at all, set exposeWeb = false.

A federation host must expose an endpoint its satellites can reach. Satellites connect outbound and need no inbound port of their own.

Secrets

Set strong authToken, adminPassword and dispatchNacId values before exposing web access or using federation. A blank admin password disables password login; configure Discord admin authentication instead if you want that.

Updating tRadio

Six items hold your configuration. Five still ship in the release zip, so delete them from the new copy before anything is copied anywhere.

1. stop tRadio
2. Extract the new release zip somewhere temporary
3. In the extracted folder, delete config/config.lua, config/cl_functions.lua, config/sv_functions.lua and layouts/
4. In your tRadio folder, delete everything except those four and data.json. This clears out files an older version left behind
5. Copy everything remaining in the extracted folder into your tRadio folder
6. start tRadio

Step 3 is the one that matters: after it, nothing in the extracted folder can replace your configuration.

config/locales.json is the one config file an update replaces

It is not in step 3, so the new copy lands and replaces yours. If you have translated or reworded it, keep a copy before updating and re-apply your changes.

Factory reset: stop the resource, delete data.json, start it again. You lose everything you changed. The Load Defaults buttons on the Zones, Alerts and Codeplugs pages restore the same starter content one page at a time.

Next steps

• Rename the starter zones and channels, then split the leo codeplug: Zones and channels
• Give your players radios: Framework integration
• Learn the radio and the panel: Usage
• Something not working: Troubleshooting