Subtitles for FiveM
A guide to install Subtitles for FiveM
📋 Table of Contents
- 🎯 Overview
- 🛒 Purchase Information
- 📺 Video Showcase
- ⚠️ Important Pre-Installation Notes
- 🔧 System Requirements & Compatibility
- 📦 Installation Process
- ⚙️ Configuration Setup
- 🎮 How It Works
- 🔗 Integration & Compatibility
- 📊 Exports
- 🛠️ Troubleshooting
- 💡 Best Practices
- 🆘 Support
🎯 Overview
Simply use client-side exports to invoke subtitles on your game screen and grant your players a cinematic experience. This resource provides easy-to-use subtitle functionality with full customization options.
Key Features
- ✅ Client-Side Exports - Easy integration with any script
- ✅ Cinematic Experience - Grant players immersive subtitle displays
- ✅ Configurable Styling - Customize the appearance of subtitles
- ✅ Universal Compatibility - Works with any FiveM server
- ✅ Duration Control - Set custom display duration in milliseconds
- ✅ Escrow Protection - Secure resource protection
- ✅ Lightweight - Minimal performance impact
🛒 Purchase Information
Get Subtitles for FiveM:
Purchase on Nights Software Store
📺 Video Showcase
Watch the video showcase:
⚠️ Important Pre-Installation Notes
Critical Installation Order: Always follow this exact sequence to avoid parsing errors in the F8 console:
- Download ZIP Package from CFX Portal
- Unpack in a folder on your local machine
- Set your File Transfer Protocol (FTP) type to binary
- Drag files from local machine to server resources folder
- Add to server.cfg (ensure script)
- Boot up the server
Support Policy: Follow this guide step by step. If you’re stuck, ask for support in our Discord and provide the specific step name. Do not skip steps.
🔧 System Requirements & Compatibility
Framework Compatibility
- ✅ Standalone: Works independently without any framework
- ✅ Any FiveM Server: Universal compatibility
OneSync Compatibility
- ✅ OneSync Legacy: Fully tested and compatible
- ✅ OneSync Infinity: Fully tested and compatible
Note: Subtitles is designed to work with any FiveM server configuration and provides cinematic subtitle functionality.
📦 Installation Process
Step 1: Download Resource
Download this resource via CFX Portal Assets after purchasing.
Step 2: Install Resource
- Extract the ZIP package to your local machine
- Transfer files using binary FTP mode to your server’s resources folder
- Ensure the folder is named
night_subtitles(do not rename)
Step 3: Server Configuration
Add the resource to your server.cfg:
ensure night_subtitles
Step 4: Configure Settings
- Open
/config/config.luain your preferred editor - Configure all settings to your liking
- Test the resource functionality
⚙️ Configuration Setup
Required Tools
Visual Studio Code: We recommend downloading VS Code for editing Lua files.
Configuration Files
| File | Purpose |
|---|---|
night_subtitles/config/config.lua | Main configuration and styling settings |
night_subtitles/client/c_functions.lua | Client-side functions |
night_subtitles/server/s_functions.lua | Server-side functions |
Configuration Process
- Open VS Code and navigate to the config files
- Read thoroughly - each line has explanatory comments
- Configure styling - customize subtitle appearance
- Test frequently - use F8 console for error checking
Styling Options: The config file contains all styling options for customizing the appearance of subtitles.
🎮 How It Works
Subtitle Display
- Client-Side Exports - Easy integration with any script
- Cinematic Experience - Grant players immersive subtitle displays
- Duration Control - Set custom display duration in milliseconds
- Real-Time Display - Subtitles appear instantly on game screen
Configuration Options
- Styling Configuration - Customize subtitle appearance and behavior
- Duration Settings - Configure how long subtitles are displayed
- Visual Customization - Adjust fonts, colors, positioning, and effects
- Integration Options - Easy integration with other scripts
User Experience
- Cinematic Feel - Professional subtitle display for immersive gameplay
- Easy Integration - Simple export function for any script
- Customizable - Full control over subtitle appearance
- Performance Optimized - Lightweight and efficient
🔗 Integration & Compatibility
Framework Support
- Standalone - Works independently without framework dependencies
Script Integration
- Universal Integration - Works with any FiveM script
- Export Function - Simple client-side export for easy integration
- Custom Scripts - Perfect for custom missions, cutscenes, and events
- Cinematic Content - Enhance storytelling and immersion
Server Integration
- Universal Compatibility - Works with any FiveM server setup
- Performance Optimized - Lightweight and efficient
- Easy Integration - Simple setup and configuration
Cinematic Enhancement: Subtitles enhance the cinematic experience of your FiveM server with professional subtitle displays.
📊 Exports
Client-Side Exports
-- Display a subtitle
exports.night_subtitles:DisplaySubtitle(text, duration_in_milliseconds)
Parameter Details
| Parameter | Type | Description |
|---|---|---|
text | string | The subtitle text to display |
duration_in_milliseconds | number | How long to display the subtitle in milliseconds |
Usage Examples
-- Basic subtitle display
exports.night_subtitles:DisplaySubtitle("Welcome to Nights Software🙂. It's time for some real subtitles!", 5000)
-- Short subtitle
exports.night_subtitles:DisplaySubtitle("Hello World", 3000)
-- Long subtitle
exports.night_subtitles:DisplaySubtitle("This is a longer subtitle message that will be displayed for a longer duration", 8000)
Export Usage: Use this export function to display subtitles from any client-side script for cinematic experiences.
🛠️ Troubleshooting
Common Issues
Export Not Found
- Ensure the resource is properly started in server.cfg
- Check that the resource name is
night_subtitles- Verify the resource started without errors in console
Subtitles Not Displaying
- Check F8 console for any error messages
- Verify the export parameters are correct
- Ensure the text parameter is a string and duration is a number
Styling Issues
- Check the config.lua file for styling settings
- Verify CSS/styling configurations are correct
- Test with default settings first
Debugging Tips
- Check F8 Console - Look for any error messages
- Test with Simple Export - Start with basic parameters
- Verify Resource Loading - Ensure resource starts without errors
- Check File Permissions - Ensure all files are accessible
💡 Best Practices
Subtitle Design
- Clear Text - Use concise, readable subtitle text
- Appropriate Duration - Set duration based on text length and reading speed
- Consistent Styling - Use consistent subtitle formatting across your server
- Cinematic Timing - Coordinate subtitles with other cinematic elements
Integration Tips
- Mission Integration - Use subtitles for mission instructions and dialogue
- Event Enhancement - Add subtitles to server events and announcements
- Storytelling - Enhance narrative elements with subtitle displays
- Error Handling - Implement proper error handling for export calls
User Experience
- Readable Text - Ensure subtitles are easy to read
- Appropriate Timing - Don’t overwhelm players with too many subtitles
- Contextual Usage - Use subtitles when they enhance the experience
- Accessibility - Consider players who may need subtitle support
🆘 Support
Read through the instructions again if you have not managed to install the resource. Can’t get it to work still? Create a ticket through our dedicated support system in Discord: