API Referenceveextensions
Vehicle Extensions Overview
This directory contains modular extensions that provide specialized functionality for vehicles. These range from UI helpers to low-level Tech sensor integrations.
This directory contains modular extensions that provide specialized functionality for vehicles. These range from UI helpers to low-level Tech sensor integrations.
High-Level Extensions
- Advanced Wheel Debug: Real-time alignment, caster, toe, and tire pressure visualization.
- Aero Debug: Calculation and visualization of aerodynamic forces and center of pressure.
- Vehicle API: Web-based JSON server for inspecting vehicle nodes, beams, and geometry.
- Chassis Data: Reporting of vehicle dimensions, track width, and wheelbase.
- Couplings: Management of trailers, fifth-wheels, and auto-coupling logic.
- Cruise Control: Advanced speed maintenance system with PID and target ramping.
- Drag AI: Automated drag racing launch and lane-keeping assistance.
- Dynamic Vehicle Data: Automated performance testing suite (acceleration, braking, off-road).
- Dyno Client: Real-time engine and gearbox data streaming to dyno UI objects.
- ESC Calibration: Automated tuning tools for Electronic Stability Control parameters.
- ESC Measurement: Detailed driving dynamics analysis for advanced integrations.
- Gameplay Interface: Unified bridge for external system requests and notifications.
- Gameplay Statistic: Centralized reporting hub for vehicle metrics and achievements.
- Input Analyzer: Detection of specific user input sequences (cheats or combos).
- MQTT Grafana Demo: Telemetry streaming to MQTT brokers for real-time visualization.
- Odometer: Persistent distance tracking and statistical reporting.
- Perfect Launch: Assistance for achieving optimal standing starts.
- Performance Logger: Profiling utility for measuring execution time of Lua functions.
- Simple Trip App: Backend support for the 'Simple Trip' UI app.
- Skeleton: Debug visualization of the vehicle's node and beam structure.
- Straight Line: Heading maintenance assistance for testing and automation.
- Telemetry Logger: Comprehensive logging of vehicle state to JSON/CSV files.
- UT Recorder: Integration for recording vehicle state within the Game Engine.
- Vehicle Performance Data: Real-time capture of power, torque, and acceleration metrics.
- Vehicle Stats Logger: Configurable CSV logging for research and data analysis.
Sub-Module Directories
- Core: Fundamental vehicle helper extensions (boosters, menu proxies).
- Debug: Tools for external visualization and deep system debugging.
- Gameplay Interface Modules: Specialized modules for the
gameplayInterfacebridge (AI, Electrics, Parts). - Gameplay Statistic Modules: Trackers for specific gameplay events (airtime, burnouts).
- Profiling: Deep performance analysis tools for the LuaJIT VM.
- Scenario: Logic helpers tailored for scenario-specific requirements (annotations, freezing).
- Tech: BeamNG.tech-specific integrations, sensors, and protocols (CAN, LIN, ADAS).
- Test: Metrics and calibration utilities for validation testing.
- UI: Controllers for managing vehicle-specific UI elements and button states.
- Vehicle Editor: Support functions for the in-game JBeam and node editors.
ESC Measurement
Detailed driving dynamics analysis for measuring yaw rate, lateral acceleration, and slip angles. Provides data for ESC tuning and advanced vehicle dynamics research.
Gameplay Interface
Unified bridge between external game systems and the vehicle Lua environment. Routes requests and notifications from the Game Engine to specialized handler modules.