From 4baf5a5a35b17af77e4bc0b0b0e32e50cd85d75c Mon Sep 17 00:00:00 2001 From: Kevin Nguyen Date: Tue, 6 Feb 2024 20:25:07 -0700 Subject: [PATCH] Clarify Profiles verbiage and add direct links to settings page --- docs/hotkeys.mdx | 8 +++++++- docs/usage.mdx | 6 ++++-- docs/web-configurator/menu-pages/01-settings.mdx | 9 +++------ docs/web-configurator/menu-pages/02-pin-mapping.mdx | 7 ++++++- 4 files changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/hotkeys.mdx b/docs/hotkeys.mdx index 9aa5ac2..e741f84 100644 --- a/docs/hotkeys.mdx +++ b/docs/hotkeys.mdx @@ -139,10 +139,16 @@ This hotkey will prevent non-cardinal directions from registering. When a second This hotkey will alter the behavior of the directional buttons mapped with the [Dual Direction Input](./add-ons/dual-direction-input.mdx) add-on to prevent non-cardinal directions from registering. When a second cardinal direction input is received, the gamepad direction will change to the newest cardinal direction, similar to [SOCD Last Win](#socd-last-win). -## Load Profile # 1-4 +## Load Profile #1-4 This hotkey will load various input to pin mapping profiles set in [Profile Settings](./web-configurator/menu-pages/02-pin-mapping.mdx#profile-settings) in the Web Configurator. +:::caution Multiple Load Profile Hotkeys + +It is recommended that multiple `Load Profile` hotkeys be configured so as to prevent you from changing profiles without any way to change the profiles back. + +::: + ## L3 Button This hotkey emulates a press of the button as not all controllers may have this button natively on the controller. diff --git a/docs/usage.mdx b/docs/usage.mdx index f1e9445..ac6935a 100644 --- a/docs/usage.mdx +++ b/docs/usage.mdx @@ -85,7 +85,7 @@ You can boot into WebConfig Mode by holding the butto ## Input Modes -GP2040-CE is compatible with a number of systems and input modes. The specific input modes assigned to 8 buttons when held is configurable in the [Web Configurator](./web-configurator/menu-pages/01-settings.mdx#boot-input-modes). +GP2040-CE is compatible with a number of systems and input modes. The specific input modes assigned to 8 buttons when held is configurable in the Web Configurator under [Settings](./web-configurator/menu-pages/01-settings.mdx#boot-input-modes). However, there are default input modes assigned in precompiled firmware. To change input modes, **hold one of the following buttons as the controller is plugged in:** @@ -116,7 +116,9 @@ Input mode is saved across power cycles. ## Hotkeys -A number of useful hotkeys exist that change the functionality of GP2040 without needing to access the Web Configurator. Commonly used hotkeys include changing the directions to emulate a digital DPad, Left analog joystick, Right analog joystick or to change [Simultaneous Opposite Cardinal Direction (SOCD)](https://glossary.infil.net/?t=SOCD) cleaning modes. Different SOCD cleaning modes will ensure the controller obeys certain directional input rules when sending inputs to the computer or game console. +A number of useful hotkeys exist that change the functionality of GP2040 without needing to access the Web Configurator. All of the hotkeys and hotkey bindings can be changed or assigned to different button combinations in [Hotkeys Settings](./web-configurator/menu-pages/01-settings.mdx#hotkey-settings) section of the Web Configurator. + +Commonly used hotkeys include changing the directions to emulate a digital DPad, Left analog joystick, Right analog joystick or to change [Simultaneous Opposite Cardinal Direction (SOCD)](https://glossary.infil.net/?t=SOCD) cleaning modes. Different SOCD cleaning modes will ensure the controller obeys certain directional input rules when sending inputs to the computer or game console. A number of hotkeys are enabled by default and if you are encountering issues with unexpected behavior on your controller, verify that you did not accidentally trigger a hotkey. diff --git a/docs/web-configurator/menu-pages/01-settings.mdx b/docs/web-configurator/menu-pages/01-settings.mdx index aa3e3d4..a8c07f4 100644 --- a/docs/web-configurator/menu-pages/01-settings.mdx +++ b/docs/web-configurator/menu-pages/01-settings.mdx @@ -18,7 +18,7 @@ Here you can select the basic settings which are normally available via hotkeys. - `SOCD Cleaning Mode` - Choose the default SOCD Cleaning Mode (Neutral, Last Win, First Win, OFF). Please note that PS4, PS3 and Nintendo Switch modes do not support setting SOCD to off and will default to Neutral SOCD. - `Forced Setup Mode` - Allows you to lock out Input Mode, the ability to enter Web-Config or both. Enabling a web-config lockout will require you to nuke and reload the firmware if you wish to make further changes. - `4-Way Joystick Mode` - Enables 4-Way Joystick mode which will prevent non-cardinal directions from registering. When a second cardinal direction input is received, the gamepad direction will change to the newest cardinal direction, similar to [SOCD Last Win](../../hotkeys.mdx#socd-last-win). -- `Profile Number` - Enables different GPIO pin mappings per profile. Changeable through the Web-Config or hotkeys. +- `Profile Number` - Enables different GPIO pin mappings per profile. Changeable through the Web-Config or [hotkeys](../../hotkeys.mdx#load-profile--1-4). - `Debounce Delay in milliseconds` - Timeframe where the firmware will ignore additional inputs to prevent switch noise from accidentally triggering unintended inputs. ## Additional PS4 Settings @@ -49,9 +49,6 @@ For the list of input modes to select from, see [Input Modes](../../usage.mdx#in ![GP2040-CE Configurator - Hotkey Settings](../../assets/images/gpc-hotkey-settings.png) -An arbitrary number of buttons and directions, plus the optional Function (Fn) button, can be used to define -desired hotkey actions. Select `Fn` if desired, plus one or more buttons/directions, and associate them with a -hotkey action. The default hotkeys can be modified or removed, and new ones added, up to 12 in total. +An arbitrary number of buttons and directions, plus the optional Function (Fn) button, can be used to define desired hotkey actions. Select `Fn` if desired, plus one or more buttons/directions, and associate them with a hotkey action. The default hotkeys can be modified or removed, and new ones added, up to 12 in total. -The available hotkey actions will expand over time. We may also expand the number of hotkeys available to -configure in the future. For a list of the available hotkey actions, see [Hotkeys](../../hotkeys.mdx). +The available hotkey actions will expand over time. We may also expand the number of hotkeys available to configure in the future. For a list of the available hotkey actions, see [Hotkeys](../../hotkeys.mdx). diff --git a/docs/web-configurator/menu-pages/02-pin-mapping.mdx b/docs/web-configurator/menu-pages/02-pin-mapping.mdx index 7ba8e70..f434632 100644 --- a/docs/web-configurator/menu-pages/02-pin-mapping.mdx +++ b/docs/web-configurator/menu-pages/02-pin-mapping.mdx @@ -49,15 +49,20 @@ If you do not know what pins are mapped to which button on your device, there is You can configure profiles that will change the GPIO to GP2040-CE button mappings based on what profile number you have set. This means that you can have button layouts for different use cases and change between them without the need to enter the Web Configurator and remap GPIO pins. -The profile number either using the Web Configurator or using a [hotkey shortcut](../../hotkeys.mdx#load-profile--1-4). +The profile number either using the Web Configurator on the [Settings page](../../web-configurator/menu-pages/01-settings.mdx) or using a [hotkey shortcut](../../hotkeys.mdx#load-profile--1-4). There is not a default input combination associated with these `Load Profile #1-4` hotkey shortcuts so you will likely need to set them up in the Settings page under [Hotkey Settings](../../web-configurator/menu-pages/01-settings.mdx#hotkey-settings). :::info At this time, profiles are limited to changing GPIO pin assignment can cannot be used to change other settings and add-ons that are not directly related to GPIO pin assignment and available to set. This includes, but is not limited to, settings and add-ons such as +- Boot Input Modes +- Hotkeys +- Peripheral Mapping - Keyboard Mapping Assignments - Tilt Input - Wii Extension - SNES Extension - Focus Mode - Keyboard Host Button-to-Key mapping + +:::