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
Preview Video: Preview by MJ Team on Youtube
Todo
- Introduce more features
- Fix existing bugs
Dependencie
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
Suspension System
- Suspension wear tracking and replacement service
- Configurable wear rates and maximum wear values
- Progress bar and animation for suspension service
- Cancelable maintenance procedures
Mechanic Interactions
- Approach a vehicle
- Use the target system (ox_target or qb-target)
- Available maintenance options:
- Change Oil
- Replace Oil Filter
- Replace Air Filter
- Change Tires
- Service Brakes
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
Inventory System
- Integrated inventory support for:
- Spark Plugs
- Engine Oil
- Oil Filter
- Air Filter
- Tires
- Brake Parts
- Suspension Parts
- Clutch Parts
- Supports multiple inventory systems:
- ox_inventory
- qb-inventory
- Quasar inventory
- CodeM inventory
- ESX inventory
- Configurable item weights and descriptions
- Items can be used directly from inventory
- Automatic item removal after use
Multiple Menu Support
- Supports multiple menu systems:
- ox_lib
- QBCore/QBox menu
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
Disabled Vehicle Classes
- Option to disable mileage tracking and maintenance for specific vehicle classes such as:
- Cycles
- Boats
- Helicopters
- Planes
- Trains
- Military vehicles
- Commercial vehicles
Vehicle Mileage Database UI
- Interactive vehicle mileage database panel accessible in-game
- Displays a list of vehicles with plate numbers and current mileage
- Allows editing of vehicle data including:
- Mileage
- Last oil change
- Last oil filter change
- Last air filter change
- Last tire change
- Last brakes change and brake wear
- Last clutch change and clutch wear
- Last suspension change
- Last spark plug change
- Validation to ensure data consistency (e.g., last change values not exceeding mileage)
- Supports deleting vehicles with user confirmation
- Real-time updates and notifications for successful or failed operations
- Custom confirmation modal for user actions
Mileage UI Customizer
- Allows players to toggle visibility of mileage and wear displays
- Provides sliders to adjust size of mileage meter and wear bars
- Allows precise positioning of UI elements via X and Y coordinates inputs
- Supports dragging UI elements to reposition them interactively
- Saves player customization settings persistently
- Enhances user experience with customizable and flexible UI layout
Getting Started
This guide will help you set up the script easily!
Installing
Moved to GitBook
Preview Video: