RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

server/commands - Camera & Input Commandsge_utils - Game Engine Utility Functionsmain.lua - GE Lua Entry Point & Game Loopmap.lua - Navigation Graph (AI Road Map)screenshot.lua - Screenshot Systemserver/server - Level Loading & Game ServerserverConnection - Client-Server Connection Manager`setSpawnpoint` - Default Spawn Point Persistence`simTimeAuthority` - Simulation Time & Bullet Time Control`spawn` - Vehicle Spawning & Safe Placement`suspensionFrequencyTester` - Suspension Natural Frequency Analysis
Auto AnnotationBoosterCalibrate ESCCompile ImpostersCompile MeshesConfig List GeneratorDecal Roads EditorDependency TreeDoc CreatorExport (glTF)Follow The White RabbitForest GeneratorGround Model DebugInput System UtilsInstanced Line Render DemoJBeam StatsLog StreamsMap TilesNode Beam ExportNode StreamPhotomodePrecompile ShadersPrecompile VehiclesProcedural Track (Gymkhana Generator)Rectangle GeneratorRender Components APIResave MaterialsRich PresenceSave Dynamic DataScreenshot Creator (Vehicle Thumbnails)ShowroomSort LinesStep HandlerTerrain GeneratorTest Extension ProxiesTest JSON Files Syntaxutil/vehicleRopeDebug - Rope Physics Debug UIutil/worker - Batch Job Workerutil/wsTest - WebSocket Test Server

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 Extensionsutil

Follow The White Rabbit

A minimal text-adventure easter egg that runs in a custom console context.

A minimal text-adventure easter egg that runs in a custom console context.


Overview

util_followTheWhiteRabbit registers a custom console context called 'neo' and presents a simple text-adventure prompt. It's a playful easter egg referencing The Matrix.

Extension path: lua/ge/extensions/util/followTheWhiteRabbit.lua


Exports (M)

FunctionSignatureDescription
onExtensionLoaded()Sets up the neo console context and prints the intro.
onConsoleExecuteCommand(context, cmd)Handles commands typed in the neo context.

Internals

Console Context

On load:

  1. Disables log timestamps via consoleSetPrintLogTimeAndOrigin(false).
  2. Adds and switches to the 'neo' context.
  3. Prints the intro text describing a GRIDMAP scene.

Commands

CommandResult
throttle"You crash. Game over."
Anything elseNo response (placeholder for future content).

How It Works

  1. Load the extension: extensions.load('util_followTheWhiteRabbit').
  2. The console switches to the neo context.
  3. Type commands to interact with the text adventure.

Lua Examples

-- Start the adventure
extensions.load('util_followTheWhiteRabbit')

-- In the console, type:
-- throttle
-- (Result: "You crash. Game over.")

Additional Exports

  • M.onConsoleExecuteCommand - (undocumented)
  • M.onExtensionLoaded - (undocumented)

Export (glTF)

Exports the current player vehicle as a glTF/GLB 3D file, including meshes, materials, textures, part hierarchy, and optionally node/beam data.

Forest Generator

Procedural forest generation utility for creating, querying, updating, and deleting forest items programmatically.

On this page

OverviewExports (M)InternalsConsole ContextCommandsHow It WorksLua ExamplesAdditional Exports