Add Controls

Loki Max
Loki Zero

docs/devices/ayn/loki-max.md

@@ -20,11 +20,31 @@
 | :material-vibrate: Rumble | Enables the device rumble motor in emulators that support it. |
 | :material-lightbulb-on: RGB | Supports selecting from a set of colors and brightness levels or turning the RGB off (choice persists through reboots) <br> Does not support other effects. |
 
-## Notes
+## Controls
 
-| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
+{%set btn_north = 'Y(NORTH)' %}
-| -- | -- |
+{%set btn_west = 'X(WEST)' %}
-| `ayn` | `Loki Max` |
+{%set btn_south = 'A(SOUTH)' %}
+{%set btn_east = 'B(EAST)' %}
+
+{%include 'controls/retroarch.md' %}
+{%include 'controls/mednafen.md' %}
+{%include 'controls/dolphin.md' %}
+{%include 'controls/mupen64plus.md' %}
+
+{%set btn_save = 'R2' %}
+{%set btn_load = 'L2' %}
+{%set btn_menu = 'R3' %}
+{%include 'controls/ppsspp.md' %}
+
+{%include 'controls/pcsx2.md' %}
+{%include 'controls/hypseus-singe.md' %}
+
+{%set btn_pre1 = 'SELECT' %}
+{%set btn_pre2 = 'START' %}
+{%include 'controls/extra.md' %}
+
+## Notes
 
 ### Installation
 
@@ -45,9 +65,15 @@ In the bios; navigate to the `Boot` menu and then change the boot order to prior
 
 In EmulationStation press the ++"Start"++ button to open the Main Menu.  Then select `System Settings` and scroll until you see `Device LEDS`.  Under that setting you can choose to turn RGB Off or select from a set of pre-defined colors.  The value you set will persist through all future reboots but note your RGB setting will only take effect after JELOS boots.
 
-## Controls
+## Development Notes
 
-### `evtest` Output
+### `DMI` Info
+
+| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
+| -- | -- |
+| `ayn` | `Loki Max` |
+
+### Output from `evtest`
 
 ??? abstract "Main Controls"
 
@@ -134,9 +160,8 @@ In EmulationStation press the ++"Start"++ button to open the Main Menu.  Then se
 	Event: time 1695144715.840035, type 4 (EV_MSC), code 4 (MSC_SCAN), value 14
 	Event: time 1695144715.840035, type 1 (EV_KEY), code 20 (KEY_T), value 1
 	```
+	
+### Quirks
 
-## Additional References
-
-- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
 - [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/ayn%20Loki%20Zero) (*shares the same quirks as the [Loki Zero](loki-zero.md)*)
-- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)
+- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)

docs/devices/ayn/loki-zero.md

@@ -20,21 +20,32 @@
 | :material-vibrate: Rumble | Enables the device rumble motor in emulators that support it. |
 | :material-lightbulb-on: RGB | Supports selecting from a set of colors and brightness levels or turning the RGB off (choice persists through reboots) <br> Does not support other effects. |
 
-## :material-controller: Controls
+## Controls
 
 {%set btn_north = 'Y(NORTH)' %}
 {%set btn_west = 'X(WEST)' %}
 {%set btn_south = 'A(SOUTH)' %}
 {%set btn_east = 'B(EAST)' %}
+
 {%include 'controls/retroarch.md' %}
 {%include 'controls/mednafen.md' %}
+{%include 'controls/dolphin.md' %}
+{%include 'controls/mupen64plus.md' %}
+
+{%set btn_save = 'R2' %}
+{%set btn_load = 'L2' %}
+{%set btn_menu = 'R3' %}
+{%include 'controls/ppsspp.md' %}
+
+{%include 'controls/pcsx2.md' %}
+{%include 'controls/hypseus-singe.md' %}
+
+{%set btn_pre1 = 'SELECT' %}
+{%set btn_pre2 = 'START' %}
+{%include 'controls/extra.md' %}
 
 ## Notes
 
-| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
-| -- | -- |
-| `ayn` | `Loki Zero` |
-
 ### Installation
 
 Download the latest `AMD64` version of JELOS from the button below and follow the instructions listed on the [Install](../../../play/install/) page.
@@ -58,9 +69,21 @@ In the bios; navigate to the `Boot` menu and then change the boot order to prior
 
 In EmulationStation press the ++"Start"++ button to open the Main Menu.  Then select `System Settings` and scroll until you see `Device LEDS`.  Under that setting you can choose to turn RGB Off or select from a set of pre-defined colors.  The value you set will persist through all future reboots but note your RGB setting will only take effect after JELOS boots.
 
-## Controls
+### Community Videos
 
-### `evtest` Output
+| <iframe width="560" height="315" src="https://www.youtube.com/embed/1PyQGY7TUEU?si=SDv9yg7Q3igRYbhx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> | <iframe width="560" height="315" src="https://www.youtube.com/embed/NOEt92WxxGE?si=emujsI09ym41sexY&amp;start=316" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |
+| -- | -- |
+| <iframe width="560" height="315" src="https://www.youtube.com/embed/5L6zLTHXdxg?si=ZxyFVgNYKRTuAsH1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |
+
+## Development Notes
+
+### `DMI` Info
+
+| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
+| -- | -- |
+| `ayn` | `Loki Zero` |
+
+### Output from `evtest`
 
 ??? abstract "Main Controls"
 
@@ -147,15 +170,8 @@ In EmulationStation press the ++"Start"++ button to open the Main Menu.  Then se
 	Event: time 1695132759.599549, type 4 (EV_MSC), code 4 (MSC_SCAN), value 14
 	Event: time 1695132759.599549, type 1 (EV_KEY), code 20 (KEY_T), value 1
 	```
+	
+### Quirks
 
-## Additional References
-
-- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
 - [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/ayn%20Loki%20Zero)
-- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)
+- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)
-
-## Community Videos
-
-| <iframe width="560" height="315" src="https://www.youtube.com/embed/1PyQGY7TUEU?si=SDv9yg7Q3igRYbhx" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> | <iframe width="560" height="315" src="https://www.youtube.com/embed/NOEt92WxxGE?si=emujsI09ym41sexY&amp;start=316" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |
-| -- | -- |
-| <iframe width="560" height="315" src="https://www.youtube.com/embed/5L6zLTHXdxg?si=ZxyFVgNYKRTuAsH1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |

docs/devices/powkiddy/rgb10-max-3-pro.md

@@ -43,6 +43,10 @@
 {%set btn_pre2 = 'F2' %}
 {%include 'controls/extra.md' %}
 
+## Emulators
+
+- [Platform Documentation (S922X)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/S922X)
+
 ## Notes
 
 ### Installation
@@ -70,11 +74,7 @@ If you find yourself doing this often, consider drilling a pinhole in the back c
 
 ![](../../_inc/images/devices/mods/powkiddy-rgb10max3pro-mod1.png){ .off-glb }
 
-## Additional References
+### Community Videos
-
-- [Platform Documentation (S922X)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/S922X)
-
-## Community Videos
 
 | <iframe width="560" height="315" src="https://www.youtube.com/embed/X9wbPY5qf6o?si=nIUFXmEcsRswl2ij&amp;start=316" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> | <iframe width="560" height="315" src="https://www.youtube.com/embed/_dXk5UjZ_Kg?si=AxdJyrBZ4JamiHqq&amp;start=316" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |
 | -- | -- |

includes/controls/citra.md

@@ -3,3 +3,4 @@
 | Button Combo | Action |
 | -- | -- |
 | ++"{{ btn_prefix }}"+"START"++ | Quit Game |
+

includes/controls/dolphin.md

@@ -1,4 +1,4 @@
-### Dolphin ([Gamecube](../../../systems/gc))
+### Dolphin-SA ([Gamecube](../../../systems/gamecube))
 
 | Button Combo | Action |
 | -- | -- |

includes/controls/extra.md

@@ -1,4 +1,11 @@
-### Per Device Global Hotkeys
+### Global Hotkeys
+
+| Button Combo | Action |
+| -- | -- |
+| ++"{{ btn_pre1 }}"+"Vol \+"++ | Brightness Up |
+| ++"{{ btn_pre1 }}"+"Vol -"++ | Brightness Down |
+| ++"{{ btn_pre2 }}"+"Vol \+"++ | Battery Status |
+| ++"{{ btn_pre2 }}"+"Vol -"++ | WIFI Toggle |
 
 #### HDMI Output
 
@@ -10,12 +17,3 @@ While this should work; it doesn't always result in the correct resolution. The
 
 "Why doesn't hot-plugging just work?"... Hot-plug HDMI switching is a fairly complex action to accomplish and not something we have implemented on any device.  If you are a developer and interested in helping to build this functionality please start here: [Contribute](../contribute)
 
-#### Additional Keys
-
-| Button Combo | Action |
-| -- | -- |
-| ++"{{ btn_pre1 }}"+"Vol \+"++ | Brightness Up |
-| ++"{{ btn_pre1 }}"+"Vol -"++ | Brightness Down |
-| ++"{{ btn_pre2 }}"+"Vol \+"++ | Battery Status |
-| ++"{{ btn_pre2 }}"+"Vol -"++ | WIFI Toggle |
-

includes/controls/hypseus-singe.md

@@ -9,16 +9,14 @@
 | ++"{{ btn_east }}"++ | Button 2 |
 | ++"{{ btn_north }}"++ | Button 3 |
 
-#### Additional Notes:
+#### Notes:
 
-To add/change mapping you can edit `/storage/.config/game/configs/hypseus/hypinput.ini` under `[KEYBOARD]` section by changing third number for a function from `0` (disabled) to a corresponding joystick value.  You can identify joystick values by running `jstest /dev/input/js0` over ssh.
+* To add/change mapping you can edit `/storage/.config/game/configs/hypseus/hypinput.ini` under `[KEYBOARD]` section by changing third number for a function from `0` (disabled) to a corresponding joystick value.  You can identify joystick values by running `jstest /dev/input/js0` over ssh.
+* For example the following would assign `quit` to ++"L1"++ and `pause` to ++"R1"++
 
-For example the following would assign `quit` to ++"L1"++ and `pause` to ++"R1"++
+    ``` bash
-
+    [KEYBOARD]
-``` bash
+    KEY_QUIT = SDLK_ESCAPE 0 5
-[KEYBOARD]
+    KEY_PAUSE = SDLK_p 0 6
-KEY_QUIT = SDLK_ESCAPE 0 5
+    ```
-KEY_PAUSE = SDLK_p 0 6
-
-```
 

includes/controls/mednafen.md

@@ -14,4 +14,6 @@
 | ++"THUMBR"+"D-Pad Right"++ | Increase save slot by 1 |
 | ++"THUMBR"+"L2"++ | Configure buttons on virtual port 1 |
 
-By default JELOS will expand the configuration file according to the first controller mednafen finds. This only happens when the config file doesn't exists, meaning the first time or if you manually delete it. After the initial expansion the user is free to customize the controls to their wishes.
+#### Notes:
+* By default JELOS will expand the configuration file according to the first controller mednafen finds. This only happens when the config file doesn't exist (meaning the first time or if you manually delete it). After the initial expansion you are free to customize the controls.
+

includes/controls/mupen64plus.md

@@ -1,4 +1,4 @@
-### Mupen64Plus ([Nintendo 64](../../../systems/n64))
+### Mupen64Plus-SA ([Nintendo 64](../../../systems/n64))
 
 | Button Combo | Action |
 | -- | -- |
@@ -9,8 +9,8 @@
 | ++"Right Analog Down"++ | C Down |
 | ++"Right Analog Left"++ | C Left |
 | ++"Right Analog Right"++ | C Right |
-| ++"L2"++ <sup>*</sup> | Z |
+| ++"L2"++ | Z |
-| ++"L1"++ <sup>*</sup> | L |
+| ++"L1"++ | L |
 | ++"R1"++ | R |
 | ++"SELECT"+"START"++ | Quit Game |
 | ++"SELECT"+"R1"++ | Save State |
@@ -18,16 +18,14 @@
 | ++"SELECT"+"{{ btn_west }}"++ | Take Screenshot |
 | ++"SELECT"+"{{ btn_south }}"++ | Reset Game |
 
+#### Notes:
 
-#### Additional Notes:
+* ++"Z"++ and ++"L"++ button assignment can be changed directly in EmulationStation
-
+    * Highlight the game and press ++"{{ btn_north }}"++
-The Z and L button assignment can be changed in EmulationStation
+    * Select `ADVANCED GAME OPTIONS`
-
+    * Set `EMULATOR` to `MUPEN64PLUSSA`
-* Highlight the game and press ++"{{ btn_north }}"++
+    * Then change `INPUT ONFIGURATION`
-* Select ADVANCED GAME OPTIONS (A to confirm)
+        * Default: L1 = L, L2 = Z
-* Set EMULATOR to MUPEN64PLUSSA
+        * Z & L SWAP: L1 = Z, L2 = L
-* Then change INPUT CONFIGURATION
+* You can also create your own custom controller configuration and add it to `/storage/.configs/game/configs/mupen64plussa`.  Then update `INPUT CONFIGURATION` to `CUSTOM` following the same steps as above.
-    * DEFAULT:       L1 = L, L2 = Z
-    * Z & L SWAP:    L1 = Z, L2 = L
-    * CUSTOM:        You can create your own custom controller layout and add it to `/storage/.configs/game/configs/mupen64plussa`
 

includes/controls/pcsx2.md

@@ -1,4 +1,4 @@
-### PCSX2 ([PS2](../../../systems/ps2))
+### PCSX2-SA ([PS2](../../../systems/ps2))
 
 | Button Combo | Action |
 | -- | -- |

includes/controls/ppsspp.md

@@ -1,4 +1,4 @@
-### PPSSPP ([PSP](../../../systems/psp))
+### PPSSPP-SA ([PSP](../../../systems/psp))
 
 | Button Combo | Action |
 | -- | -- |
@@ -6,7 +6,7 @@
 | ++"SELECT"++ | Select |
 | ++"A(SOUTH)"++ | Circle |
 | ++"B(EAST)"++ | Cross |
-| ++"X(NORTH"++ | Triangle |
+| ++"X(NORTH)"++ | Triangle |
 | ++"Y(WEST)"++ | Square |
 | ++"L1"++ | L |
 | ++"R1"++ | R |

includes/controls/retroarch.md

@@ -9,4 +9,7 @@
 | ++"SELECT"+"{{ btn_west }}"++ | Show FPS |
 | ++"SELECT"+"R2"++ | Fast-Forward |
 
-By default JELOS will detect your controller and configure RetroArch hotkeys automatically. This is controlled by the "AUTOCONFIGURE RETROARCH HOTKEYS" option in the Controller & Bluetooth Settings menu, which is enabled by default. While the option is enabled, RetroArch hotkeys will be overwritten by defaults each time an emulator is launched. If this behavior is not desired the option can be disabled and any user-defined RetroArch hotkeys will not be overwritten.
+#### Notes:
+
+* By default JELOS will detect your controller and configure RetroArch hotkeys automatically. This is controlled by the "AUTOCONFIGURE RETROARCH HOTKEYS" option in the `Settings > Controller & Bluetooth` menu. While the option is enabled, RetroArch hotkeys will be overwritten by the above defaults each time RetroArch is launched. If this behavior is not desired that option can be disabled and your user-defined RetroArch hotkeys will be used instead.
+