Speedometer
A modern, customizable vehicle speedometer for FiveM with advanced features and sleek design.
Overview
Section titled “Overview”Experience the ultimate driving interface with Night Speedometer - a modern, feature-rich speedometer that transforms your FiveM vehicle experience. With real-time data display, customizable positioning, and intuitive controls, this speedometer delivers both functionality and style.
Key Features
Section titled “Key Features”- Real-Time Speed Display - Accurate speed monitoring in km/h or mph
- Dynamic RPM Gauge - Visual RPM bar with customizable scaling
- Gear Indicator - Shows current gear (P/R/N/1-6) with parking detection
- Turn Signals - Left, right, and hazard indicator controls
- Engine Status - Engine health monitoring with visual warnings
- Fuel System - Fuel level display with low fuel warnings
- Compass Navigation - Rotating compass with directional indicators
- Vehicle Status Icons - Door, lights, handbrake, and engine indicators
- Drag & Drop Positioning - Customizable UI placement
- Theme Customization - Scale, opacity, and position settings
- Framework Compatibility - Standalone compatible
- Modern UI Design - Glass-morphism design with smooth animations
- Configurable Controls - Customizable keybindings and commands
- Performance Optimized - Efficient rendering with configurable update intervals
Important Pre-Installation Notes
Section titled “Important Pre-Installation Notes”System Requirements & Compatibility
Section titled “System Requirements & Compatibility”Framework Compatibility
Section titled “Framework Compatibility”- Standalone: Works independently without any framework
- ESX: Works alongside ESX framework, no integrations.
- QBCore: Works alongside QBCore framework, no integrations.
OneSync Compatibility
Section titled “OneSync Compatibility”- OneSync Legacy: Fully tested and compatible
- OneSync Infinity: Fully tested and compatible
Dependencies
Section titled “Dependencies”- No External Dependencies - Works out of the box
- FiveM Server - Requires FiveM server environment
Installation Process
Section titled “Installation Process”Step 1: Download Night Speedometer
Section titled “Step 1: Download Night Speedometer”- Download from CFX Portal Assets after purchasing
- Extract the package to your local machine
- Verify files - Ensure all folders (client, config, html, server) are present
Step 2: Transfer to Server
Section titled “Step 2: Transfer to Server”- Set FTP to binary mode - Critical for proper file transfer
- Upload ‘night_speedometer’ folder to your server’s resources directory
- Verify upload - Check that all files transferred correctly
Step 3: Configure Server
Section titled “Step 3: Configure Server”- Add to server.cfg:
ensure night_speedometer- Start your server and verify the resource loads without errors
- Check console for successful startup messages
Configuration Setup
Section titled “Configuration Setup”Required Tools
Section titled “Required Tools”Configuration Files
Section titled “Configuration Files”| File | Purpose |
|---|---|
night_speedometer/config/config.lua |
Main configuration settings |
night_speedometer/client/client.lua |
Client-side functionality |
night_speedometer/html/style.css |
UI styling and themes |
Configuration Process
Section titled “Configuration Process”- Open VS Code and navigate to
config/config.lua - Read thoroughly - each setting has explanatory comments
- Configure settings - customize speed units, keybindings, UI positioning, and display options
- Test frequently - use F8 console for error checking
Key Configuration Options
Section titled “Key Configuration Options”Speed Units
Section titled “Speed Units”-- Options: 'kmh', 'mph'Config.SpeedUnit = 'kmh'UI Positioning
Section titled “UI Positioning”Config.Theme = { position = 'bottom-center', -- 'bottom-right' | 'bottom-left' | 'bottom-center' offsetX = 40, -- pixels from chosen edge offsetY = 40, -- pixels from chosen edge scale = 1.0, -- UI scale multiplier opacity = 1.0, -- 0.0 - 1.0}Keybindings
Section titled “Keybindings”Config.IndicatorLeft = {command = "indicator_left", keyMapping = 'LEFT', input = 'keyboard'}Config.IndicatorRight = {command = "indicator_right", keyMapping = 'RIGHT', input = 'keyboard'}Config.IndicatorHazard = {command = "indicator_hazard", keyMapping = 'UP', input = 'keyboard'}Config.EngineToggle = {command = "engine_toggle", keyMapping = 'DOWN', input = 'keyboard'}How It Works
Section titled “How It Works”Speedometer System
Section titled “Speedometer System”- Real-Time Speed - Displays current vehicle speed in selected units
- Dynamic Updates - Configurable update intervals for performance optimization
- Unit Conversion - Automatic conversion between km/h and mph
- Speed Thresholds - Parking detection based on speed limits
RPM and Engine Monitoring
Section titled “RPM and Engine Monitoring”- RPM Display - Visual RPM bar with customizable maximum RPM
- Engine Health - Monitors engine condition with warning states
- Gear Detection - Shows current gear with parking/reverse detection
- Performance Scaling - Configurable RPM scaling for different vehicle types
Vehicle Status Indicators
Section titled “Vehicle Status Indicators”- Turn Signals - Left, right, and hazard indicator controls
- Engine Status - Engine on/off with health warnings
- Door Status - Vehicle door open/closed indicators
- Light Status - Headlight and high beam indicators
- Handbrake - Handbrake engaged/disengaged status
Fuel System
Section titled “Fuel System”- Fuel Level - Visual fuel gauge with percentage display
- Low Fuel Warnings - Configurable warning thresholds
- Electric Vehicles - Special handling for electric vehicle fuel display
- Fuel Icons - Visual fuel pump icon with status indicators
Navigation Features
Section titled “Navigation Features”- Compass Display - Rotating compass with directional indicators
- Heading Detection - Real-time heading calculation
- Smooth Animation - Fluid compass rotation animations
- Directional Text - N, NE, E, SE, S, SW, W, NW indicators
UI Customization
Section titled “UI Customization”- Drag & Drop - Reposition speedometer with drag command
- Theme Settings - Scale, opacity, and position customization
- Visual Themes - Glass-morphism design with customizable colors
- Responsive Design - Adapts to different screen resolutions
Customization Options
Section titled “Customization Options”UI Positioning
Section titled “UI Positioning”- Position Options - bottom-center, bottom-right, bottom-left
- Offset Settings - Customizable X and Y pixel offsets
- Scale Multiplier - Adjust UI size (0.5 - 2.0 recommended)
- Opacity Control - Transparency settings (0.0 - 1.0)
Display Settings
Section titled “Display Settings”- Speed Units - Switch between km/h and mph
- Compass Display - Enable/disable compass feature
- Fuel Display - Show/hide fuel gauge
- First Person Hide - Hide speedometer in first-person view
Performance Tuning
Section titled “Performance Tuning”- Update Intervals - Adjust refresh rate (default: 100ms)
- RPM Scaling - Configure maximum RPM for display
- Parking Thresholds - Set speed limits for parking detection
Commands & Keybindings
Section titled “Commands & Keybindings”Default Commands
Section titled “Default Commands”| Command | Default Key | Description |
|---|---|---|
/indicator_left |
LEFT Arrow | Toggle left turn signal |
/indicator_right |
RIGHT Arrow | Toggle right turn signal |
/indicator_hazard |
UP Arrow | Toggle hazard lights |
/engine_toggle |
DOWN Arrow | Toggle engine on/off |
/dsm |
None | Enter drag mode for repositioning |
Customizing Keybindings
Section titled “Customizing Keybindings”Edit config/config.lua to change keybindings:
Config.IndicatorLeft = { command = "indicator_left", chatSuggestion = 'Toggle the indicator left.', keyMapping = 'LEFT', input = 'keyboard'}Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”Debugging Tips
Section titled “Debugging Tips”- Check F8 Console - Look for any error messages
- Verify Configuration - Ensure all config settings are correct
- Test in Vehicle - Speedometer only shows when in a vehicle
- Check Keybindings - Verify key mappings are working
Best Practices
Section titled “Best Practices”Performance Optimization
Section titled “Performance Optimization”- Update Intervals - Use appropriate update intervals (100ms recommended)
- UI Scaling - Keep scale between 0.5 - 2.0 for optimal performance
- Resource Priority - Ensure speedometer loads after vehicle resources
- Memory Management - Monitor resource memory usage
User Experience
Section titled “User Experience”- Positioning - Place speedometer where it doesn’t obstruct gameplay
- Opacity Settings - Use appropriate opacity for visibility
- Keybindings - Choose intuitive key mappings for players
- Documentation - Provide server-specific usage instructions
Customization Guidelines
Section titled “Customization Guidelines”- Theme Consistency - Match speedometer theme with server style
- Performance Balance - Balance visual features with performance
- User Preferences - Allow players to customize their experience
- Regular Updates - Keep resource updated for latest features
Support
Section titled “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: