From 64b5bc609b59bf5c3a0638765514d07fa9f30694 Mon Sep 17 00:00:00 2001 From: Eduardo Silva Date: Tue, 14 Oct 2025 18:20:16 +0100 Subject: [PATCH] Updated the README --- README.md | 64 ++++++++++++++++--- .../core/input/actions/ESBtnBoxBindings.json | 4 +- 2 files changed, 58 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 498669f..5a62e54 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,65 @@ # ESBtnBoxBindings This mod creates new binds to handle: -- Lights -- Diff locks +- Headlights +- Lightbar +- Differentials - Range box - Ignition - Starter -Becasue in BeamNG.drive currently the user can only assign a single key to toggle across the -multiple positions for each one of those settings, which doesn't really work well with toggle -switches. +# Why this exists +In BeamNG.drive most binds are expecting a single key press to either toggle +across multiple states of a given device or just toggle from `on` and `off`. + +For example, on the rangebox it goes: +`H2 -> Press -> H4 -> Press -> L4 -> Press -> H2` + +We cannot manually set the range box to `L4` or `H2`. We have to toggle across +its available modes. + +This mod extends the default BeamNG.drive keybinds to allow selecting what mode +we want to be in. -With this mod you can have a `On - Off - On` toggle switch with 2 distinct states that can stay in -each of its positions to turn something on and when returning to the Off position it will turn it -off. \ No newline at end of file +### New Controls +- `ESBtnBox Bindings: Toggle Ignition to ON Position` +Turns the key to the ON position + +- `ESBtnBox Bindings: Toggle Ignition to Acc Position` +Turns the key to the Acc position + +- `ESBtnBox Bindings: Turn starter` +Turns the starter + +- `ESBtnBox Bindings: Toggle High Beams On` +Turns high beams on and off with the flick of the toggle switch + +- `ESBtnBox Bindings: Toggle Low Beams On` +Turns the low beams on and off with the flick of the toggle switch + +- `ESBtnBox Bindings: Toggle Lightbar Light On` +Turns the lights on the lightbar + +- `ESBtnBox Bindings: Toggle Lightbar Sound On` +Turns the sound and lights on the lightbar + +- `ESBtnBox Bindings: Toggle High 4` +Set the range box to high four + +- `ESBtnBox Bindings: Toggle Low 4` +Set the range box to low four + +- `ESBtnBox Bindings: Toggle Front Diff Lock` +Lock the front diff + +- `ESBtnBox Bindings: Toggle Rear Diff Lock` +Lock the rear diff + +- `ESBtnBox Bindings: Toggle Both Diff Locks` +Lock front and rear diffs + + +### Versioning +Will follow BeamNG.drive version and set the patch version number for my +updates. diff --git a/lua/ge/extensions/core/input/actions/ESBtnBoxBindings.json b/lua/ge/extensions/core/input/actions/ESBtnBoxBindings.json index 8a6817e..19cd1bb 100644 --- a/lua/ge/extensions/core/input/actions/ESBtnBoxBindings.json +++ b/lua/ge/extensions/core/input/actions/ESBtnBoxBindings.json @@ -54,7 +54,7 @@ "ctx": "vlua", "onDown": "extensions.use('ESBtnBoxHeadlights').toggleLigthbarSound()", "title": "ESBtnBox Bindings: Toggle Lightbar Sound On", - "desc": "Turns the sound on the lightbar" + "desc": "Turns the sound and lights on the lightbar" }, "bb_turn_high_four": { "cat": "vehicle", @@ -104,4 +104,4 @@ "title": "ESBtnBox Bindings: Toggle Brake Lights", "desc": "Toggles the brake lights for those proper police runs" } -} \ No newline at end of file +}