RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

AI Module ReferenceBackwards Compatibility Module ReferenceBdebug Module ReferenceBdebugImpl Module ReferenceBeamstate Module ReferenceBullettime Module ReferenceController Module ReferenceDamageTracker Module ReferenceDrivetrain Module ReferenceElectrics Module ReferenceElectrics Custom Value ParserEnergyStorage Module ReferenceExtensions Module ReferenceFire Module ReferenceVehicle Engine True GlobalsGuihooks Module ReferenceGUI Streams Module ReferenceHTML Texture Module ReferenceHydros Module ReferenceInput Module ReferenceJBeam-Lua Integration GuideMapmgr Module ReferenceMaterial Module ReferenceBeamNG Math & Unit Conversions Referenceobj (Vehicle C++ Object)PartCondition Module ReferenceParticlefilter Module ReferenceParticles Module ReferencePowertrain Module ReferenceVehicle Property & Module TreeProps Module ReferenceProtocols Module ReferenceRecovery Module ReferenceScriptAI Module ReferenceSensors Module ReferenceSounds Module ReferenceStreams Module ReferenceThrusters Module Reference`v` (Vehicle Data & JBeam)Wheels Module Reference
Protocols DirectoryMotionSim ProtocolOutGauge Protocol

UI

Resources

BeamNG Game Engine Lua Cheat SheetGE Developer RecipesMCP Server Setup

// RLS.STUDIOS=true

Premium Mods for BeamNG.drive. Career systems, custom vehicles, and immersive gameplay experiences.

Index

HomeProjectsPatreon

Socials

DiscordPatreon (RLS)Patreon (Vehicles)

© 2026 RLS Studios. All rights reserved.

Modding since 2024

API Referenceveprotocols

OutGauge Protocol

Module defined in `lua/vehicle/protocols/outgauge.lua`. Implements the industry-standard OutGauge protocol (originally from LiveForSpeed) for external dashboards and hardware gauges.

Module defined in lua/vehicle/protocols/outgauge.lua. Implements the industry-standard OutGauge protocol (originally from LiveForSpeed) for external dashboards and hardware gauges.

Exports

Functions

getStructDefinition() (callable)

  • Description: Returns the C-style struct definition.
  • Packet Fields:
    • rpm, speed, turbo, engTemp, fuel: Basic engine metrics.
    • gear: Current gear index.
    • throttle, brake, clutch: User inputs.
    • dashLights: Bitmask of available dashboard indicators.
    • showLights: Bitmask of currently active indicators (signals, highbeam, ABS, etc.).

fillStruct(o, dtSim) (callable)

  • Description: Populates the packet primarily using values from electrics.values.

isPhysicsStepUsed() (callable)

  • Description: Returns false. This protocol runs on the graphics step for better performance.

Related

  • electrics: Source of most telemetry data.

module.reset()

  • Description: Resets the module state.
  • @context: any | @performance: low

module.getAddress()

  • Description: Returns the address.
  • @context: any | @performance: low

module.getPort()

  • Description: Returns the port.
  • @context: any | @performance: low

module.getMaxUpdateRate()

  • Description: Returns the max update rate.
  • @context: any | @performance: low

MotionSim Protocol

Module defined in `lua/vehicle/protocols/motionSim.lua`. Provides high-frequency telemetry data specifically designed for motion simulator platforms.

Tech Utilities Overview

The `tech/` directory (at the top-level of `lua/vehicle/`) provides specialized utility functions for advanced vehicle analysis, often used by external research tools or the Tech sensor suite.

On this page

ExportsFunctionsgetStructDefinition() (callable)fillStruct(o, dtSim) (callable)isPhysicsStepUsed() (callable)Relatedmodule.reset()module.getAddress()module.getPort()module.getMaxUpdateRate()