Skip to content

Commit 51dc254

Browse files
authored
Update controller-autoconfiguration.md (#1071)
* Improved the "Add hotkey(s)" section * For clarity and consistency in labeling analog stick directions, use the format with initial capitals for all directions, such as: "Left Analog X+ (Right)", "Left Analog X- (Left)", "Left Analog Y+ (Down)", "Left Analog Y- (Up)", "Right Analog X+ (Right)", "Right Analog X- (Left)", "Right Analog Y+ (Down)", and "Right Analog Y- (Up)." This ensures all direction terms in parentheses are capitalized uniformly, aligning with common UI and input labeling practices for precision and professionalism. Small letters should not be used for the directions in parentheses, as lowercase can appear inconsistent, less formal, and potentially reduce clarity in UI labels. Maintaining capitalization throughout avoids confusion and presents a polished, consistent interface.
1 parent 57041e4 commit 51dc254

File tree

1 file changed

+54
-57
lines changed

1 file changed

+54
-57
lines changed

docs/guides/controller-autoconfiguration.md

Lines changed: 54 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -282,37 +282,34 @@ If your joypad is not recognized by RetroArch even after updating the profiles,
282282
#### Add hotkey(s)
283283
When using RetroArch, not all controller buttons are automatically mapped through the "Set All Controls" option. Some buttons—such as menu toggles, screenshot triggers, or other special functions—must be configured separately. Here’s a step-by-step guide to ensure all your controller buttons work as desired.
284284

285-
##### Step 1: Identify the Button Functions
286-
Take a look at your physical controller to spot any special buttons that might not be auto-mapped by RetroArch. These could include:
287-
288-
- Buttons marked for menus, home, or guides (e.g., *Menu Toggle*).
289-
- Extra buttons for screenshots or system functions (e.g., *Screenshot* on some Nintendo Switch Pro Controllers).
290-
291-
Knowing which buttons are physically present helps you decide what needs manual mapping or hotkey assignment.
292-
293-
##### Step 2: Configure Hotkeys in RetroArch
294-
1. Open RetroArch and navigate to:
295-
- `Settings``Input``Hotkeys`
296-
2. Assign your desired button to the special function (e.g., menu toggle, screenshot).
297-
3. Close RetroArch properly to save your hotkey assignments to the main retroarch.cfg file. On most platforms, simply exiting RetroArch saves the configuration. However, on Android, you must explicitly quit RetroArch via the menu by selecting `Main Menu``Quit` for your changes to be saved correctly.
298-
299-
##### Step 3: Transfer Hotkey Assignments to the Autoconfig File
300-
To persist your custom mappings automatically for your controller:
301-
302-
1. Open your main `retroarch.cfg` and locate the relevant variable(s), e.g.:
285+
1. Identify special buttons on your controller
286+
- Look for buttons on your physical controller not automatically mapped by Retroarch.
287+
- Examples include
288+
- *Menu Toggle* (virtually all controllers has them)
289+
- Additional special buttons may be found on some controllers. For example, the *Capture* (screenshot) button and the *HOME* button on the Nintendo Switch Pro Controller are examples of such special buttons.
290+
2. Assign hotkeys in Retroarch
291+
- Launch Retroarch.
292+
- Navigate to: `Settings``Input``Hotkeys`.
293+
- Select the special function you want to assign (e.g., *Menu Toggle*, *Screenshot*).
294+
- Press the desired button on your controller to bind it.
295+
- Exit Retroarch properly to save the settings:
296+
- On most platforms, just closing Retroarch saves the config.
297+
- On Android, explicitly quit via `Main Menu``Quit` to ensure save.
298+
299+
3. Transfer hotkey assignments to your controller autoconfig file
300+
- Open your main `retroarch.cfg` file.
301+
- Locate the hotkey assignment lines, for example:
303302
```
304303
input_menu_toggle_btn = "[x]"
305304
input_screenshot_btn = "[y]"
306305
```
307-
The values shown are only examples and won’t work if directly copied into your autoconfig.
308-
309-
2. Open your controller’s autoconfig file, usually located at:
310-
306+
(The values `[x]`, `[y]` are placeholders from your config.)
307+
- Open your controller’s autoconfig file, typically found at:
311308
```
312-
RetroArch/autoconfig/[platform]/[controller-name].cfg
309+
retroarch/autoconfig/[platform]/[controller-name].cfg
313310
```
314-
3. Append the copied hotkey lines at the very bottom of the autoconfig file.
315-
4. Save changes.
311+
- Append the copied hotkey lines to the bottom of this autoconfig file.
312+
- Save the autoconfig file.
316313
317314
### Analog L2/R2 remapping
318315
RetroArch has a bug([ref1](https://github.com/libretro/RetroArch/issues/6920), [ref2](https://github.com/libretro/RetroArch/issues/16767)) that causes analog L2/R2 triggers to be incorrectly mapped as digital buttons instead of analog axes when configuring controls through the UI. This affects pressure-sensitive triggers on controllers like PlayStation 2 and later, making some games unplayable due to the lack of analog input.
@@ -752,14 +749,14 @@ The term "Analog" is included in the variable values for the analog inputs to cl
752749
753750
Labels for analog thumb sticks:
754751
```
755-
input_l_x_plus_axis_label = "Left Analog X+ (right)"
756-
input_l_x_minus_axis_label = "Left Analog X- (left)"
757-
input_l_y_plus_axis_label = "Left Analog Y+ (down)"
758-
input_l_y_minus_axis_label = "Left Analog Y- (up)"
759-
input_r_x_plus_axis_label = "Right Analog X+ (right)"
760-
input_r_x_minus_axis_label = "Right Analog X- (left)"
761-
input_r_y_plus_axis_label = "Right Analog Y+ (down)"
762-
input_r_y_minus_axis_label = "Right Analog Y- (up)"
752+
input_l_x_plus_axis_label = "Left Analog X+ (Right)"
753+
input_l_x_minus_axis_label = "Left Analog X- (Left)"
754+
input_l_y_plus_axis_label = "Left Analog Y+ (Down)"
755+
input_l_y_minus_axis_label = "Left Analog Y- (Up)"
756+
input_r_x_plus_axis_label = "Right Analog X+ (Right)"
757+
input_r_x_minus_axis_label = "Right Analog X- (Left)"
758+
input_r_y_plus_axis_label = "Right Analog Y+ (Down)"
759+
input_r_y_minus_axis_label = "Right Analog Y- (Up)"
763760
```
764761
765762
#### Input descriptors
@@ -784,14 +781,14 @@ input_l2_axis_label = "LT"
784781
input_r2_axis_label = "RT"
785782
input_l3_btn_label = "Left Thumb"
786783
input_r3_btn_label = "Right Thumb"
787-
input_l_x_plus_axis_label = "Left Analog X+ (right)"
788-
input_l_x_minus_axis_label = "Left Analog X- (left)"
789-
input_l_y_plus_axis_label = "Left Analog Y+ (down)"
790-
input_l_y_minus_axis_label = "Left Analog Y- (up)"
791-
input_r_x_plus_axis_label = "Right Analog X+ (right)"
792-
input_r_x_minus_axis_label = "Right Analog X- (left)"
793-
input_r_y_plus_axis_label = "Right Analog Y+ (down)"
794-
input_r_y_minus_axis_label = "Right Analog Y- (up)"
784+
input_l_x_plus_axis_label = "Left Analog X+ (Right)"
785+
input_l_x_minus_axis_label = "Left Analog X- (Left)"
786+
input_l_y_plus_axis_label = "Left Analog Y+ (Down)"
787+
input_l_y_minus_axis_label = "Left Analog Y- (Up)"
788+
input_r_x_plus_axis_label = "Right Analog X+ (Right)"
789+
input_r_x_minus_axis_label = "Right Analog X- (Left)"
790+
input_r_y_plus_axis_label = "Right Analog Y+ (Down)"
791+
input_r_y_minus_axis_label = "Right Analog Y- (Up)"
795792
input_menu_toggle_btn_label = "Guide"
796793
```
797794
@@ -815,14 +812,14 @@ input_l2_axis_label = "L2 Trigger"
815812
input_r2_axis_label = "R2 Trigger"
816813
input_l3_btn_label = "L3"
817814
input_r3_btn_label = "R3"
818-
input_l_x_plus_axis_label = "Left Analog X+ (right)"
819-
input_l_x_minus_axis_label = "Left Analog X- (left)"
820-
input_l_y_plus_axis_label = "Left Analog Y+ (down)"
821-
input_l_y_minus_axis_label = "Left Analog Y- (up)"
822-
input_r_x_plus_axis_label = "Right Analog X+ (right)"
823-
input_r_x_minus_axis_label = "Right Analog X- (left)"
824-
input_r_y_plus_axis_label = "Right Analog Y+ (down)"
825-
input_r_y_minus_axis_label = "Right Analog Y- (up)"
815+
input_l_x_plus_axis_label = "Left Analog X+ (Right)"
816+
input_l_x_minus_axis_label = "Left Analog X- (Left)"
817+
input_l_y_plus_axis_label = "Left Analog Y+ (Down)"
818+
input_l_y_minus_axis_label = "Left Analog Y- (Up)"
819+
input_r_x_plus_axis_label = "Right Analog X+ (Right)"
820+
input_r_x_minus_axis_label = "Right Analog X- (Left)"
821+
input_r_y_plus_axis_label = "Right Analog Y+ (Down)"
822+
input_r_y_minus_axis_label = "Right Analog Y- (Up)"
826823
input_menu_toggle_btn_label = "PS"
827824
```
828825
@@ -878,14 +875,14 @@ input_l2_axis_label = "L2 Trigger"
878875
input_r2_axis_label = "R2 Trigger"
879876
input_l3_btn_label = "L3"
880877
input_r3_btn_label = "R3"
881-
input_l_x_plus_axis_label = "Left Analog X+ (right)"
882-
input_l_x_minus_axis_label = "Left Analog X- (left)"
883-
input_l_y_plus_axis_label = "Left Analog Y+ (down)"
884-
input_l_y_minus_axis_label = "Left Analog Y- (up)"
885-
input_r_x_plus_axis_label = "Right Analog X+ (right)"
886-
input_r_x_minus_axis_label = "Right Analog X- (left)"
887-
input_r_y_plus_axis_label = "Right Analog Y+ (down)"
888-
input_r_y_minus_axis_label = "Right Analog Y- (up)"
878+
input_l_x_plus_axis_label = "Left Analog X+ (Right)"
879+
input_l_x_minus_axis_label = "Left Analog X- (Left)"
880+
input_l_y_plus_axis_label = "Left Analog Y+ (Down)"
881+
input_l_y_minus_axis_label = "Left Analog Y- (Up)"
882+
input_r_x_plus_axis_label = "Right Analog X+ (Right)"
883+
input_r_x_minus_axis_label = "Right Analog X- (Left)"
884+
input_r_y_plus_axis_label = "Right Analog Y+ (Down)"
885+
input_r_y_minus_axis_label = "Right Analog Y- (Up)"
889886
input_menu_toggle_btn_label = "PS"
890887
```
891888

0 commit comments

Comments
 (0)