Wizard Mileage System

A comprehensive vehicle maintenance and mileage tracking system for FiveM servers that simulates realistic vehicle wear and tear, including oil life, filters, tires, and brake conditions. The system tracks vehicle mileage and component wear, requiring regular maintenance to maintain optimal vehicle performance.

📝 Table of Contents

• ShowCase
• Todo
• Dependencies
• Features Scope
• Setting up
• Authors

🖼️ ShowCase

💡 Todo

• Introduce more features
• Fix existing bugs

⛓️ Dependencie

• oxmysql
• ox_lib
• ox_target or qb-target

🚀 Features Scope

Vehicle Mileage Tracking

• Real-time mileage tracking for owned vehicles
• Configurable distance units (kilometers or miles)
• Customizable mileage display position on screen
• Automatic mileage saving to database
• Command to reset vehicle mileage

Oil System

• Oil life monitoring based on distance traveled
• Configurable oil change intervals
• Engine damage simulation when oil maintenance is neglected
• Visual warnings for low oil life
• Oil change service interaction for mechanics

Oil Filter System

• Separate tracking for oil filter life
• Independent oil filter change intervals
• Engine performance impact when filter is worn
• Service option for filter replacement
• Warning system for filter maintenance

Air Filter System

• Air filter condition monitoring
• Performance impact on vehicle when filter is dirty:
  • Reduced top speed
  • Decreased acceleration
• Air filter replacement service
• Warning notifications for filter maintenance

Tire System

• Tire wear tracking based on distance
• Impact on vehicle handling and grip
• Configurable tire wear rates
• Tire replacement service
• Visual wear indicators and warnings

Brake System

• Progressive brake wear simulation
• Impact on braking efficiency
• Brake maintenance service
• Warning system for brake condition
• Configurable wear rates and efficiency loss

Clutch System

• Clutch wear tracking based on gear changes
• Impact on vehicle performance
• Engine Stalls when clutch is worn out
• Clutch replacement service
• Warning system for clutch condition
• Configurable wear rates and performance loss

Mechanic Interactions

1. Approach a vehicle
2. Use the target system (ox_target or qb-target)
3. Available maintenance options:
   • Change Oil
   • Replace Oil Filter
   • Replace Air Filter
   • Change Tires
   • Service Brakes
   • Replace Clutch
4. Each interaction requires appropriate inventory items
5. Progress bars and animations for maintenance actions

Job Requirements

• Mechanic job required for maintenance (configurable)
• Minimum job grade requirement (configurable)
• Job name configurable in config.lua
• Supports both ox_target and qb-target systems

Inventory System

• Integrated inventory support for:
  • Engine Oil
  • Oil Filter
  • Air Filter
  • Tires
  • Brake Parts
  • Clutch Parts
• Supports multiple inventory systems:
  • ox_inventory
  • qb-inventory
  • ESX inventory
• Configurable item weights and descriptions
• Items can be used directly from inventory
• Automatic item removal after use

HUD Features

• Real-time mileage display
• Configurable position (top-left, top-right, bottom-left, bottom-right)
• Component wear display when using /checkwear
• Warning notifications for maintenance needs

Job Requirements

• If enabled, only players with the mechanic job can perform maintenance
• Job name configurable in config.lua
• Supports both ox_target and qb-target systems

Maintenance Interface

• Target-based interaction system
• Progress bars for maintenance actions
• Cancelable maintenance procedures
• Animation support for maintenance actions
• Job-based restrictions for mechanics

Notification System

• Multiple notification system support:
  • QBox
  • QBCore
  • ESX
  • Wizard Notify
  • OkOk Notify
  • ox_lib notify
• Configurable warning intervals
• Multi-language support

Database Integration

• Automatic mileage saving
• Persistent maintenance history
• Vehicle ownership verification
• Supports multiple vehicle database structures

🏁 Getting Started

This guide will help you set up the script easily!

Setting up

1. Download the folder and remove the -main suffix from it. The folder name should be wizard-mileage

Installing

GUIDE

Configuration

1. Open the config.lua file in the wizard-mileage folder.
2. Choose your favorite notification system from the list and set it as the default.
3. Choose the preffered distance unit (km or mile).
4. Choose the preffered location for mileage HUD.
5. Change the Config.VehDB to your vehicle database table name.
   • 'player_vehicles' for QBCore & QBox
   • 'owned_vehicles' for ESX
   • you can change it to your custom table name.
6. Customize other settings as per your preference.
7. Save the config.lua file.

✍️ Authors

• @The_Hs5

Support

For support, join our Discord server: CodeWizards Discord

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.