From a8792a57b9f8ea3c45349b931b3f71f5eb1dc83c Mon Sep 17 00:00:00 2001 From: Starbit04 <115287545+Starbit04@users.noreply.github.com> Date: Sun, 1 Jun 2025 22:45:32 +0100 Subject: [PATCH] Update README.md Updated readme to reflect new hotkey settings --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a5f3465..5e08224 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,12 @@ General settings. `bool useSavesFolder` - Use `/3ds/open_agb_firm/saves` for save files instead of the ROM directory. * Default: `true` +`bool enableBacklightHotkeys` - Enables/disables the backlight adjustment hotkeys. +* Default: `true` + +`bool enableScreenshotHotkey` - Enables/disables the hardware frame dump hotkey. +* Default: `true` + ### Video Video-related settings. @@ -157,6 +163,38 @@ UP=UP,CP_UP DOWN=DOWN,CP_DOWN ``` +### Hotkeys +Hotkey input settings. These use the same formatting as regular inputs. Entries with multiple buttons are treated as button combos (all buttons must be pressed), unlike regular inputs. + +`takeScreenshot` - Button map for dumping hardware frame output. +* Default: `SELECT,Y` + +`backlightUp` - Button map for increasing screen brightness. +* Default: `X,UP` + +`backlightDown` - Button map for decreasing screen brightness. +* Default: `X,DOWN` + +`backlightOff` - Button map for turning off LCD backlight. +* Default: `X,LEFT` + +`backlightOn` - Button map for turning on LCD backlight. +* Default: `X,RIGHT` + +`skipPatching` - Button map for skipping patching upon game launch. +* Default: `X` + +Notes: The general setting `enableBacklightHotkeys` must be set to `true` to use the backlight hotkeys. `enableScreenshotHotkey` must be `true` to dump hardware frames. + +Example which maps Y + D-Pad to backlight controls: +``` +[hotkeys] +backlightUp=Y,UP +backlightDown=Y,DOWN +backlightOff=Y,LEFT +backlightOn=Y,RIGHT +``` + ### Game Game-specific settings. Only intended to be used in the per-game settings (romName.ini in `/3ds/open_agb_firm/saves`). @@ -292,4 +330,4 @@ You may use this under the terms of the GNU General Public License GPL v3 or the * **[hunterk and Pokefan531 for their amazing libretro shaders](https://forums.libretro.com/t/real-gba-and-ds-phat-colors/1540/220)** * ...everyone who contributed to **3dbrew.org** -Copyright (C) 2024 derrek, profi200, d0k3 \ No newline at end of file +Copyright (C) 2024 derrek, profi200, d0k3