RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

Server CommandsGE UtilitiesGame Engine MainNavigation GraphScreenshot CaptureServerServer ConnectionSpawnpoint ManagerSimulation TimeVehicle SpawningSuspension Frequency Tester
Gameplay AchievementGameplay CityDiscoverForce FieldGarage ModeMarker InteractionParking SystemGameplay Playmode MarkersGameplay PoliceGameplay RallyGameplay Rally LoopGameplay Raw POIsGameplay Skidpad TestSpeed Trap LeaderboardsSpeed Traps and CamerasGameplay StatisticsTaxi Ride SystemTraffic SystemVehicle PerformanceWalking
Rally Audio ManagerRally Camera Path PlayerRally ClientRally Cut CaptureRally EnumsRally Extension HelperRally GeometryRally ManagerRecce ManagerRecce AppRecce SettingsRally Settings ManagerSnap-to-RoadTraffic Exclusion ZonesRally UtilityRally Vehicle CaptureRally Vehicle Tracker
Rally English Compositor

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 ReferenceGE Extensionsgameplayrallycompositorsenglish

Rally English Compositor

Defines the English-language configuration for rally pacenote composition. Contains corner severity scales, direction labels, modifier definitions, visual styling (colors/icons), distance rounding, tr

Defines the English-language configuration for rally pacenote composition. Contains corner severity scales, direction labels, modifier definitions, visual styling (colors/icons), distance rounding, transition rules, and system phrases (countdown, finish, damage, etc.).


Public API

FieldTypeDescription
M.configtableComplete compositor configuration
M.breathConfigtableBreath timing between phrases

Key Configuration Sections

Corner Severity (config.cornerSeverity)

Nine levels from tightest to most open:

NameValueDiameterIcon
tight hairpin10010mturnHp
hairpin8917mturnHp
open hairpin7825mturnHp
one6835mturn1
two5755mturn2
three4788mturn3
four36139mturn4
five26221mturn5
six15350mturn6

Corner Length (config.cornerLength)

NameAngle RangeValue
short0°–50°40
(default)50°–110°50
long110°–150°60
extra long150°–360°70

Modifiers (config.modifiers)

Ordered by priority: don't cut, narrows, watersplash, over jump, over crest, bumpy, over bump

Each modifier has: text, optional textWhenFirst, visual.icon, visual.colorIcon

Transitions (config.transitions)

LevelThresholdText
level15m<none>
level215minto
level325mand

System Phrases (config.system)

Includes weighted variants for: damage, countdown (1-5, go), firstnoteintro, firstnoteoutro, finish, commsCheck, beltsCheck, rescheduled, falseStart, and time warnings (10s, 20s, 30s, 60s).

How It Works

  1. The compositor config is consumed by the pacenote composition system to generate co-driver call text and visual UI data
  2. Corner severity maps measured turn diameter to a named severity level with associated icon and color
  3. Transitions determine phrasing between consecutive notes based on distance apart
  4. Modifiers add contextual warnings (cut, crest, bump, etc.) as suffixes to corner calls
  5. Visual properties (colors, icons) drive the in-game pacenote HUD display
  6. System phrases provide pre-race and post-race co-driver dialogue with weighted random selection

Notes

  • WARNING: Changing text strings requires regenerating all audio files
  • Colors use CSS variable references (e.g., var(--bng-add-red-550)) for the UI
  • breathConfig.default = 0.05–0.075s; lastSubphrase = 0.10–0.20s
  • Distance rounding: small=10m, medium=50m (>100m), large=250m (>1000m)
  • Units default to metric with m / km labels
  • Corner radius change: opens (value 40), tightens (value 60)
  • separateDigits in transitions controls whether distance numbers are read digit-by-digit

See Also

  • Gameplay Systems Guide - Guide

Rally Vehicle Tracker

Class that tracks the player vehicle's position, velocity, speed, and damage during rally gameplay. Provides damage detection with configurable threshold.

Rally Driveline Measurement

Stub class for driveline measurement functionality. Currently a placeholder with only an `init` method.

On this page

Public APIKey Configuration SectionsCorner Severity (config.cornerSeverity)Corner Length (config.cornerLength)Modifiers (config.modifiers)Transitions (config.transitions)System Phrases (config.system)How It WorksNotesSee Also