Skip to content

Radiocastdotnet/fivem-integration

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎙️ Radiocast FiveM Integration [BETA]

The official FiveM integration script for Radiocast. Access 20+ user-created radio stations with exceptional reliability (99.9%+ uptime) directly in your FiveM server.

License Discord

⚠️ Important: You must comply with Radiocast's API Usage Policy.


📋 Table of Contents


✨ Features

  • Access to Station Library: Access 20+ Radiocast stations
  • High Reliability: 99.9%+ historical uptime
  • Auto-Updater: Automatic resource updates with optional restart capability
  • In-Game UI: Intuitive radio station selector panel
  • Car Overlay: Non-intrusive metadata display
  • Easy Integration: Simple installation and configuration process
  • In-Car Synchronization: Current station and volume settings are synchronized in realtime for everyone inside of the vehicle

⚠️ Prerequisites

Required

  • FiveM Server
  • Radiocast API Key (Free)

Obtaining Your API Key

You can obtain a free API key from our billing panel in the profile settings menu.

⚠️ Important: API key abuse will result in immediate termination. Do not share your API key with anyone.


📥 Installation

Step 1: Download

  1. Navigate to the releases page
  2. Download the latest radiocast4fivem-download release

Step 2: Extract & Install

  1. Unzip the downloaded folder
  2. Drag and drop the radiocast4fivem-download folder into your server's resources directory
  3. Rename the folder to radiocast4fivem (optional but recommended)

Step 3: Configure Server

Open your server.cfg file and add the following line:

ensure radiocast4fivem

This ensures Radiocast4FiveM starts automatically when your server launches.

Step 4: Enable Auto-Updates (Optional)

To allow the auto-updater to restart the resource for updates, add this line to your server.cfg:

add_ace resource.radiocast4fivem command allow

⚙️ Configuration

API Key Setup

  1. Locate the configuration file in the resource folder
  2. Add your Radiocast API key:
-- In the configuration file
RADIOCAST_API_KEY = "your_api_key_here"

Customization

You can customize various aspects:

  • UI theme and colors (CSS)
  • Command names and permissions
  • Overlay positioning

This must be done by altering the code at this time.


🎮 Usage

In-Game Commands

/radiocast - Opens the Radiocast stations panel

📸 Screenshots

Command Interface

Command usage example

Command used to access the Radiocast stations panel

In-Game Radio Panel

Radio stations panel

In-game Radiocast stations panel with station listing and controls

Car Radio Overlay

Car radio overlay

In-game Radiocast car overlay displaying current station information


🔌 API Integration

Architecture

This integration is built with:

  • JavaScript - API communication and core logic
  • Lua - FiveM scripting framework
  • CSS - UI styling and design
  • HTML - Interface markup

API Communication

The resource communicates with Radiocast servers via REST API to:

  • Fetch available stations
  • Stream station data

Rate Limiting

Be mindful of API rate limits. Excessive requests may result in API key termination.


🐛 Troubleshooting

Resource Won't Start

  • Verify ensure radiocast4fivem is in your server.cfg
  • Check server logs for error messages
  • Ensure the resource folder name is correct

API Key Issues

  • Confirm your API key is valid and active
  • Check for typos in your configuration
  • Verify the API key hasn't been revoked due to abuse

UI Not Appearing

  • Clear your FiveM cache
  • Restart your server
  • Check browser console for JavaScript errors
  • Verify all UI files are present

Audio Not Playing

  • Check volume settings in-game
  • Verify internet connection stability
  • Try switching stations to test functionality

Auto-Updater Not Working

  • Ensure add_ace resource.radiocast4fivem command allow is in server.cfg
  • Verify the resource has proper permissions
  • Check server logs for update messages

🆘 Support

Getting Help


📝 License

This project is licensed under the MIT License - see the LICENSE file for details.


🤝 Contributing

We welcome contributions! Please feel free to submit pull requests or open issues for bugs and feature requests.


⚡ Performance Notes

  • Minimal server resource usage
  • Efficient API caching
  • Optimized UI rendering
  • Low bandwidth consumption

Made with ❤️ for the FiveM community

For more information, visit Radiocast or join our Discord.

About

The official FiveM integration for Radiocast. Uses the Radiocast.net API.

Topics

Resources

License

Stars

Watchers

Forks

Contributors