Installation Guide

Let's start with the initial installation steps you need to follow to make the script work correctly.

Radio & Radio List Script Documentation

Welcome to the documentation for the Radio & Radio List Script. Here you will find everything you need to configure and customize the script for your server.

---

Basic Installation

1. Move required files

   • Copy the file:

     /installation/client/module/radio.lua

     into:

     pma_voice/client/module/

2. Import items

   • For example, if you use ox_inventory, copy the provided items from:

     installation/items/items.lua

     into your ox_inventory items configuration.

3. Restart your server or the related resources.

---

⚙️ Configuration

All settings can be found in the config.lua. Below is a detailed description of each option.

Framework Integration

Config.frameworkType = 'ESX'

• Options: ESX, QBCore, CUSTOM

• If you use Qbox, select QBCore.

• If you choose CUSTOM, edit client_editable.lua & server_editable.lua to connect your own framework.

---

Notifications

Config.notifyType = 'OX'

• Options: ESX, QBCore, OX, CUSTOM

• Defines which notification system is used.

• For CUSTOM, edit client_editable.lua.

---

Radio Basics

Config.radio_default_volume = 50
Config.maximum_frequency = 999

• radio_default_volume – default radio volume (in %).

• maximum_frequency – highest frequency that can be set.

---

Enabling Radio

Config.radioEnableSettings = {
    enableViaItem = true,
    itemName = 'radio',
    enableViaCommand = true,
    commandName = 'radio',
}

• enableViaItem – enable radio usage through an inventory item.

• itemName – item name for the radio.

• enableViaCommand – enable via command.

• commandName – command to open radio (default: /radio).

---

Restricted Frequencies

Config.restricted_frequencies = true
Config.restricted_channels = 10

• restricted_frequencies – enable/disable job-locked frequencies.

• restricted_channels – number of restricted channels available (1 to N).

Config.restricted_channels_jobs_allowed = {
    ['police'] = {1,2,3,4,5,6,7,8,9,10},
    ['sheriff'] = {1,2,3,4,5,6,7,8,9,10},
    ['ambulance'] = {1,2,3,4,5,6,7,8,9,10},
    ['taxi'] = {1},
}

• Configure which jobs can use specific restricted channels.

---

Damage in Water

Config.damagePlayerInWater = true

• If true, players take damage when using the radio underwater (with sound effects).

---

Inventory

Config.useOxInventory = true

• Set to true if you use ox_inventory.

---

Battery System

Config.batterySystem = {
    ['enable'] = true,
    ['drainRate'] = 1,
    ['chargeItem'] = 'battery',
    ['chargeAmount'] = 50,
    ['updateTime'] = 60,
}

• enable – enable/disable battery system.

• drainRate – % battery drain per update cycle.

• chargeItem – item used to recharge radio.

• chargeAmount – % restored per recharge item.

• updateTime – frequency (in seconds) of battery drain.

---

Jammer System

Config.jammerSettings = {
    ['enable'] = true,
    ['itemName'] = 'jammer',
    ['radius'] = 20,
    ['removeJammerOnPlace'] = true,
    ['giveBackJammerOnPickup'] = true,
    ['soundDistance'] = 10.0,
    ['pickupDistance'] = 3.0,
    ['controlPickupKey'] = 38,
}

• enable – enable/disable jammer system.

• itemName – item name for jammer.

• radius – range in which the jammer blocks signals.

• removeJammerOnPlace – removes item when jammer is placed.

• giveBackJammerOnPickup – returns item when jammer is picked up.

• soundDistance – how far jammer sound effects can be heard.

• pickupDistance – distance for picking up jammer.

• controlPickupKey – key to pick up jammer (default: E).

---

UI Refresh

Config.timeRefreshList = 1

• Refresh time (in seconds) for updating radio list UI.

---

Locale & Translations

Config.locale = 'en'

• Set default language for the script.

Supported:

• en – English

• pl – Polish

Config.translation = {
    ['en'] = {
        ['editAnimation'] = 'Edit animation',
        ['editPosition'] = 'Edit position',
        ...
    },
    ['pl'] = {
        ['editAnimation'] = 'Edytuj animację',
        ['editPosition'] = 'Edytuj pozycję',
        ...
    }
}

---

✅ Summary

• Move the installation files to pma_voice and import items to your inventory.

• Configure your framework, notifications, and radio system in config.lua.

• Fine-tune battery, jammer, and restrictions to fit your RP server.

This ensures your Radio & Radio List Script runs seamlessly with ESX, QBCore, Qbox, or a custom framework.