Skip to main content

Configuration

Learn how to configure WhackerLinkFiveM for your specific server needs, including codeplugs, radio models, and server connections.

Configuration Files Overview​

WhackerLinkFiveM uses several YAML configuration files:

  • configs/config.yml - Global resource settings
  • configs/sites.yml - Site locations and configurations
  • codeplugs/*.yml - Radio configurations and talk groups

Global Configuration (config.yml)​

Theres only a couple of settings available in the main config file. Most of them are good to leave as default.

siteBlips: true # Show site blips on map
disableAnimations: false # Disable character animations when using the radio
# Beep volume reduction factor. 0.0 is full volume, 1.0 is silent
beepVolumeReduction: 0.6 # Radio beep volume setting, recommended to keep at 0.6

Site Configuration (sites.yml)​

Sites represent physical radio tower locations that provide coverage areas.

Basic Site Structure​

sites:
  - name: "Central Site" # Name of the site, must match WLS server config
    controlChannel: "772.74375" # Control channel frequency
    voiceChannels: # List of voice channel frequencies. Do not overlap with other sites
      - "771.66875"
      - "772.46875"
      - "773.74375"
      - "855.7375"
    location: # XYZ coordinates for site location within FiveM
      X: 757.89
      Y: 1274.17
      Z: 360.3
    systemID: 1 # System ID as defined in WLS server config
    siteID: 1 # Unique site ID within the system
    range: 1.5 # Coverage radius within FiveM

  - name: "Central-West Site"
    controlChannel: "852.8875"
    voiceChannels:
      - "857.2625"
      - "857.4375"
      - "851.7375"
    location:
      X: -2312.05
      Y: 336.79
      Z: 188.6
    systemID: 1
    siteID: 2
    range: 1.0

  - name: "City-FBI Site"
    controlChannel: "773.66875"
    voiceChannels:
      - "774.89375"
      - "772.11875"
      - "771.06875"
      - "770.04375"
      - "769.28125"
    location:
      X: 148.69
      Y: -770.36
      Z: 262.85
    systemID: 1
    siteID: 3
    range: 2.0

  - name: "North-East Site"
    controlChannel: "854.9625"
    voiceChannels:
      - "853.2125"
      - "852.6625"
      - "852.0375"
      - "851.7125"
      - "773.16875"
      - "769.36875"
    location:
      X: 1869.07
      Y: 3715.00
      Z: 33.06
    systemID: 1
    siteID: 4
    range: 1.5

  - name: "North-Central Site"
    controlChannel: "856.7625"
    voiceChannels:
      - "855.4625"
      - "855.2125"
      - "852.9125"
      - "852.0625"
    location:
      X: 450.82
      Y: 5567.40
      Z: 796.62
    systemID: 1
    siteID: 5
    range: 2.0

    ###
    # Uncomment the following if your FiveM server has Roxwood
    ###

#  - name: "Roxwood West Site"
#    controlChannel: "854.5125"
#    voiceChannels:
#        - "853.8625"
#        - "853.3125"
#        - "852.6125"
#    location:
#        X: -1707.05
#        Y: 6824.27
#        Z: 94.5
#    systemID: 2
#    siteID: 7
#    range: 1.0

Codeplug Configuration​

Codeplugs define the complete radio configuration including systems, zones, channels, and talk groups.

Basic Codeplug Structure​

radioWide:
  hostVersion: "R01.00.00" # Radio firmware version (visual only)
  codeplugVersion: "R01.00.00" # Codeplug version (visual only)
  radioAlias: "" # Radio alias are not implemented yet
  serialNumber: "123ABC1234" # Radio serial number (visual only)
  model: "APX6000" # Radio model for handheld version
  inCarMode: "APX4500" # Radio model for in-car(mobile) version

systems:
  - name: "System 1" # System name (visual only) -- Must match other references of the system name however.
    # This address is the Public IP of your Whackerlink Server. If hosted in a VPS, it is your Public IP of the VPS.
    # If hosted locally, this is the Public IP of your Network.
    address: "localhost" # If you're using this publically, you will need to change this to your public IP or domain name.
    authKey: "SuperSecretKey1" # Authentication key, must match the key in your WhackerLink v4 server auth_keys.yml file.
    port: 3000 # Port number, must match the port in your WhackerLink v4 server config.yml file.
    rid: null # Optional default Radio ID for this system (can be overridden in-game) -- Recommended to keep null

qcList: # QuickCall tone frequencies list
  - a: 855.5 # First frequency of the tone pair
    b: 349 # Second frequency of the tone pair
  - a: 1006.9
    b: 500.9

zones:
  - name: "Zone 1" # Display name of the zone
    channels:
      - name: "Channel 1" # Display name of the channel
        system: "System 1" # Must match a defined system name in the above systems section
        tgid: "2001" # Talkgroup ID, unique identifier for the channel. If matching in another codeplug, you can hear each other.
        scanList: List 1 # Optional scan list name, must match a defined scan list name in the scanLists section below
      - name: "Channel 2"
        system: "System 1"
        tgid: "15002"
      - name: "Channel 3"
        system: "System 1"
        tgid: "15003"

  - name: "Zone 2"
    channels:
      - name: "Channel A"
        system: "System 1"
        tgid: "16001"
      - name: "Channel B"
        system: "System 1"
        tgid: "16002"
      - name: "Channel C"
        system: "System 1"
        tgid: "16002"

scanLists:
  - name: List 1 # Scan list name, must match scanList references in channels above
    channels:
      - zone: Zone 1 # Must match a defined zone name in the zones section above
        channel: Channel 1 # Must match a defined channel name in the zones section above

Supported Radio Models​

WhackerLinkFiveM supports various realistic radio models with authentic interfaces. This list is not exhaustive and more models may be added in future updates. Please reference the GitHub repository for the complete list.

Portable Radios​

  • APX6000
  • APX6000XE
  • APX7000
  • APX7000XE
  • APX8000XE
  • APX900
  • APXN70
  • E5
  • XTS5000
  • SRX2200
  • APXNext
  • APXNext-T
  • APXNextXE

Mobile Radios​

  • APX4500
  • APX4500-G
  • XTL2500

Scanners​

  • UNIG5

Testing Your Configuration​

Validate Configuration Files​

  1. Start your FiveM server
  2. Check console for YAML parsing errors
  3. Look for successful codeplug loading messages

In-Game Testing​

  1. Use /set_codeplug <your-codeplug-name>
  2. Set your radio ID: /set_rid 1234
  3. Open the radio interface
  4. Test voice communications
  5. Verify zone/channel switching

Next Steps​