Installation
Follow these steps in order. Steps 4 and 5 are optional.
1. Check what you already have
Section titled “1. Check what you already have”- Make sure
pma-voiceis installed and that normal voice chat works. Kivo Radio only adds the radio interface and extra features on top of it. - Remove or stop any other radio resource, including radio scripts bundled with your framework. Two radio resources would clash on the same commands and the same radio item.
- Decide whether you want the radio earpiece. If you do not, you can skip step 4 and set
Config.Items.enabled = falseinconfig/items.lua. Every radio will then be audible to people standing nearby. See Radio earpiece.
2. Copy the resource
Section titled “2. Copy the resource”Copy the resource folder into your server’s resources folder. The file fxmanifest.lua must sit directly inside the folder you start.
resources/ [kivo]/ <- optional category folder kivo-radio/ fxmanifest.lua config/ channels.lua jobChannels.lua items.lua proximity.lua (other folders, leave as shipped)3. Add the resource to server.cfg
Section titled “3. Add the resource to server.cfg”Start pma-voice first, then your framework and inventory, then Kivo Radio.
ensure pma-voiceensure qb-core # or qbx_core / es_extendedensure ox_inventory # if you use itensure kivo-radioAutomatic detection uses ox_inventory when it is running. Start it before Kivo Radio. If you cannot change the order, set Config.Inventory = "ox" in config/items.lua.
4. Add the two items
Section titled “4. Add the two items”The earpiece needs two items in your inventory: the radio and the earpiece. The names must match Config.Items.radio and Config.Items.earpiece in config/items.lua. The defaults are radio and radio_earpiece.
Kivo Radio does not ship item images. Add your own radio.png and radio_earpiece.png (or the file names your inventory expects) to your inventory’s image folder.
ox_inventory (recommended)
Section titled “ox_inventory (recommended)”This also applies to Kivo Inventory, which is built on ox_inventory. Add both entries to ox_inventory/data/items.lua:
['radio'] = { label = 'Radio', weight = 500, stack = false, close = true, description = 'A handheld two-way radio.', buttons = { { label = 'Remove Earpiece', action = function(slot) TriggerServerEvent('radio:earpiece:requestDetach') end }, },},
['radio_earpiece'] = { label = 'Radio Earpiece', weight = 50, stack = false, close = true, description = 'An acoustic tube earpiece. Fit it to a radio so only you can hear it.', buttons = { { label = 'Attach to Radio', action = function(slot) TriggerServerEvent('radio:earpiece:requestAttach') end }, },},Copy the two TriggerServerEvent lines exactly. The buttons are a convenience. Using the earpiece item attaches it, and the radio’s Settings tab can remove it, so the earpiece works even if your inventory interface does not show item buttons.
With ox_inventory the earpiece is stored in the metadata of the radio item. Keep stack = false on the radio so every radio is its own slot.
qb-core and qbx_core
Section titled “qb-core and qbx_core”If you use qb-inventory (or another inventory that reads the framework’s item list), add both entries to qb-core/shared/items.lua or qbx_core/shared/items.lua:
radio = { name = 'radio', label = 'Radio', weight = 500, type = 'item', image = 'radio.png', unique = true, useable = true, shouldClose = true, description = 'A handheld two-way radio.'},radio_earpiece = { name = 'radio_earpiece', label = 'Radio Earpiece', weight = 50, type = 'item', image = 'radio_earpiece.png', unique = true, useable = true, shouldClose = true, description = 'An acoustic tube earpiece. Fit it to a radio so only you can hear it.'},If you run ox_inventory on QBCore or QBX, use the ox_inventory entries above instead.
ESX with the default inventory
Section titled “ESX with the default inventory”Run this SQL on your database. If a radio row already exists, remove that line from the statement.
INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES ('radio', 'Radio', 1, 0, 1), ('radio_earpiece', 'Radio Earpiece', 1, 0, 1);Some ESX versions use a limit column instead of weight. Match the columns of your own items table.
If you run ox_inventory on ESX, use the ox_inventory entries above instead and do not run the SQL.
Other inventories
Section titled “Other inventories”For qs-inventory and similar inventories, add both items the way that inventory expects. Both items must be usable (using the item must work) and should not stack. Then leave Config.Inventory = "auto". The earpiece is then stored for the player instead of for one radio item. See Frameworks and inventories.
5. Check the job channels and the lock permission
Section titled “5. Check the job channels and the lock permission”Open config/jobChannels.lua. The shipped file contains a Police channel 1.00 locked with the code 1234 and an EMS channel 2.00 that is not locked. Edit or remove these entries to match your server. Details are on Configuration.
If you want players to be able to lock channels, give the right group the radio.lock permission in server.cfg:
add_ace group.admin radio.lock allow6. Restart and test
Section titled “6. Restart and test”- Restart the server (or run
refreshandensure kivo-radio). - Join with two players. Give both a
radioitem. - Both players open the radio (use the item or type
/radio), enter the same channel, such as21.00, and press connect. They should hear each other when they use the radio push to talk key of pma-voice. - Open the Settings tab in the radio. If the earpiece is set up, there is an Earpiece row that reads
NONE. - Give one player a
radio_earpieceitem and use it. The player should see a notification, and the row should now readFITTED. - Bring a third player who is not on the channel. Keep the third player within 3 metres of the second player, but well away from the first player. When the first player talks, the third player hears the transmission coming out of the second player’s radio.
- Fit an earpiece to the second player’s radio and repeat. The third player should now hear nothing.
To try the interface with fake channel members and no other players online, see Demo mode.
If something does not work, see Examples and troubleshooting.
