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

MotionSim Protocol

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

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

Exports

Functions

getAddress(), getPort(), getMaxUpdateRate() (callable)

  • Description: Retrieves UDP configuration from game settings.

  • Returns: M

getStructDefinition() (callable)

  • Description: Returns a C-style struct definition for the data packet.
  • Packet Fields:
    • posX, posY, posZ: World position.
    • velX, velY, velZ: Smoothed velocity.
    • accX, accY, accZ: Smoothed acceleration (excluding gravity).
    • upX, upY, upZ: Local Up vector.
    • rollPos, pitchPos, yawPos: Orientation angles.
    • rollVel, pitchVel, yawVel: Angular velocities.

fillStruct(o, dtSim) (callable)

  • Arguments: o (ffi-struct): The struct to fill. dtSim (number): Time step.
  • Description: Populates the packet using data from the protocols global.

isPhysicsStepUsed() (callable)

  • Description: Returns true. This protocol runs on the physics step (up to 2000Hz) for maximum fidelity.

Related

  • Protocols Master: Dispatches data to this module.

module.reset()

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

Protocols Directory

This directory contains implementations of specific communication standards for external hardware and software.

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.

On this page

ExportsFunctionsgetAddress(), getPort(), getMaxUpdateRate() (callable)getStructDefinition() (callable)fillStruct(o, dtSim) (callable)isPhysicsStepUsed() (callable)Relatedmodule.reset()