From d3289dba0b5a3fd90dc9ee7d72c2e884385fdf4f Mon Sep 17 00:00:00 2001 From: Sascha Wilde Date: Tue, 16 Jan 2024 11:39:41 +0100 Subject: [PATCH] Move controls documentation do devices. As the controls are highly dependent on the buttons available on a specific device hardware it makes sense to document them per device. To prevent to much redundancy we are using mkdocs-macros to define includes and variables which allows for a maximum of reuse. The new structure also makes it possible to only document emulators actually available on the device. This initial commit only implements complete documentation for Powkiddy RGB10 MAX 3, a minimal example is also added to AYN Loki Zero in order to demonstrate the use of variables. --- docs/devices/ayn/loki-zero.md | 9 + docs/devices/powkiddy/rgb10-max-3-pro.md | 29 ++- docs/play/controls.md | 286 +---------------------- includes/controls/aethersx2.md | 11 + includes/controls/citra.md | 5 + includes/controls/dolphin.md | 15 ++ includes/controls/drastic.md | 10 + includes/controls/extra.md | 21 ++ includes/controls/hypseus-singe.md | 24 ++ includes/controls/mednafen.md | 17 ++ includes/controls/mupen64plus.md | 33 +++ includes/controls/openbor.md | 13 ++ includes/controls/pcsx2.md | 11 + includes/controls/ppsspp.md | 14 ++ includes/controls/retroarch.md | 12 + includes/controls/vice.md | 34 +++ includes/controls/yabasanshiro.md | 16 ++ mkdocs.yml | 2 + 18 files changed, 277 insertions(+), 285 deletions(-) create mode 100644 includes/controls/aethersx2.md create mode 100644 includes/controls/citra.md create mode 100644 includes/controls/dolphin.md create mode 100644 includes/controls/drastic.md create mode 100644 includes/controls/extra.md create mode 100644 includes/controls/hypseus-singe.md create mode 100644 includes/controls/mednafen.md create mode 100644 includes/controls/mupen64plus.md create mode 100644 includes/controls/openbor.md create mode 100644 includes/controls/pcsx2.md create mode 100644 includes/controls/ppsspp.md create mode 100644 includes/controls/retroarch.md create mode 100644 includes/controls/vice.md create mode 100644 includes/controls/yabasanshiro.md diff --git a/docs/devices/ayn/loki-zero.md b/docs/devices/ayn/loki-zero.md index 44db4d5..c8ab5c5 100644 --- a/docs/devices/ayn/loki-zero.md +++ b/docs/devices/ayn/loki-zero.md @@ -20,6 +20,15 @@ | :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)
Does not support other effects. | +## :material-controller: 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' %} + ## Notes | DMI_SYS_VENDOR | DMI_PRODUCT_NAME | diff --git a/docs/devices/powkiddy/rgb10-max-3-pro.md b/docs/devices/powkiddy/rgb10-max-3-pro.md index 15c282c..7174424 100644 --- a/docs/devices/powkiddy/rgb10-max-3-pro.md +++ b/docs/devices/powkiddy/rgb10-max-3-pro.md @@ -16,13 +16,40 @@ | :material-wifi: Wifi | Can be turned on in Emulation Station under Main Menu > Network Settings | | :simple-bluetooth: Bluetooth | Supports bluetooth audio and controllers | +## :material-controller: Controls + +{%set btn_north = 'X(NORTH)' %} +{%set btn_west = 'Y(WEST)' %} +{%set btn_south = 'B(SOUTH)' %} +{%set btn_east = 'A(EAST)' %} +{%include 'controls/retroarch.md' %} +{%set btn_prefix = 'F1' %} +{%include 'controls/aethersx2.md' %} +{%include 'controls/citra.md' %} +{%set btn_save = 'R2' %} +{%set btn_load = 'L2' %} +{%set btn_menu = 'F1' %} +{%set btn_swap_a = 'L3' %} +{%set btn_swap_b = 'F2' %} +{%include 'controls/drastic.md' %} +{%include 'controls/dolphin.md' %} +{%include 'controls/mupen64plus.md' %} +{%include 'controls/ppsspp.md' %} +{%include 'controls/yabasanshiro.md' %} +{%include 'controls/hypseus-singe.md' %} +{%include 'controls/openbor.md' %} +{%include 'controls/vice.md' %} +{%set btn_pre1 = 'F1' %} +{%set btn_pre2 = 'F2' %} +{%include 'controls/extra.md' %} + ## Notes ### Installation Download the latest `S922X-Odroid_GOU` version of JELOS from the button below. -!!! note "JELOS must be flashed directly onto the RGB10 Max 3 Pro rather than an SD card. This is done by putting the device into recovery mode, per the manual by holding down R2, L2, and power. A video demonstation [is shown here](https://youtu.be/X9wbPY5qf6o?t=1195). +!!! note "JELOS must be flashed directly onto the RGB10 Max 3 Pro rather than an SD card. This is done by putting the device into recovery mode, per the manual by holding down R2, L2, and power. A video demonstation [is shown here](https://youtu.be/X9wbPY5qf6o?t=1195)." [![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?labelColor=111111&color=5998FF&label=Latest&style=flat#only-light)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?labelColor=dddddd&color=5998FF&label=Latest&style=flat#only-dark)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) diff --git a/docs/play/controls.md b/docs/play/controls.md index 21f851d..bc5083e 100644 --- a/docs/play/controls.md +++ b/docs/play/controls.md @@ -1,286 +1,4 @@ # :material-controller: Controls -## RetroArch Hotkeys - -| Button Combo | Action | -| -- | -- | -| ++"SELECT"+"START"++ (x2) | Quit Game | -| ++"SELECT"+"R1"++ | Save State | -| ++"SELECT"+"L1"++ | Load State | -| ++"SELECT"+"X(NORTH)"++ | Open RA Menu | -| ++"SELECT"+"Y(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. - -## Mednafen Hotkeys - -| Button Combo | Action | -| -- | -- | -| ++"SELECT"+"START"++ (hold for 2sec) | Quit Game | -| ++"SELECT"+"R1"++ | Save State | -| ++"SELECT"+"L1"++ | Load State | -| ++"SELECT"+"Y(WEST)"++ | Show FPS | -| ++"SELECT"+"R2"++ | Fast-Forward | -| ++"SELECT"+"L2"++ | Rewind | -| ++"THUMBR"+"L1"++ | Select disc | -| ++"THUMBR"+"R1"++ | Eject/Insert disc | -| ++"THUMBR"+"D-Pad Left"++ | Decrease save slot by 1 | -| ++"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. - -## Standalone (SA) Emulators - -### AetherSX2 ([PS2](../../systems/ps2)) - -| Button Combo | Action | -| -- | -- | -| ++"F1"+"B(SOUTH)"++ | Quit Game | -| ++"F1"+"R1"++ | Save State | -| ++"F1"+"L1"++ | Load State | -| ++"F1"+"X(NORTH)"++ | Open Menu | -| ++"F1"+"Y(WEST)"++ | Cycle Aspect Ratio | -| ++"F1"+"A(EAST)"++ | Screenshot | - -### Citra ([Nintendo 3DS](../../systems/3ds)) - -| Button Combo | Action | -| -- | -- | -| ++"F1"+"START"++ | Quit Game | - -### Drastic ([Nintendo DS](../../systems/nds)) - -| Button Combo | Action | -| -- | -- | -| ++"R2"++ | Save State | -| ++"L2"++ | Load State | -| ++"F1"++ | Open Menu | -| ++"F2"++ | Switch One Screen and Dual Screen Layout | -| ++"L3"++ | Change Screen Layout/Swap Screens | - -#### Additional Notes: - -These are the mappings on S922X devices, e.g. [Powkiddy RGB10 Max 3 -Pro](../../devices/powkiddy/rgb10-max-3-pro). On other devices -++"F1"++ and ++"F2"++ may not be available and mapped to other special -keys. - -### Dolphin ([Gamecube](../../systems/gc)) - -| Button Combo | Action | -| -- | -- | -| ++"SELECT"+"START"++ | Quit Game | -| ++"SELECT"+"R1"++ | Save State | -| ++"SELECT"+"L1"++ | Load State | -| ++"SELECT"+"A(SOUTH)"++ | Screenshot | -| ++"SELECT"+"B(EAST)"++ | Change Internal Resolution | -| ++"SELECT"+"X(NORTH)"++ | Change Aspect Ratio | -| ++"SELECT"+"Y(WEST)"++ | Show FPS | -| ++"SELECT"+"D-Pad Up"++ | Increase current state slot | -| ++"SELECT"+"D-Pad Down"++ | Decrease current state slot | -| ++"SELECT"+"R2"++ | Fast-Forward | - -### Mupen64Plus ([Nintendo 64](../../systems/n64)) - -| Button Combo | Action | -| -- | -- | -| ++"START"++ | Start | -| ++"B(EAST)"++ | A | -| ++"Y(WEST)"++ | B | -| ++"Right Analog Up"++ | C Up | -| ++"Right Analog Down"++ | C Down | -| ++"Right Analog Left"++ | C Left | -| ++"Right Analog Right"++ | C Right | -| ++"L2"++ * | Z | -| ++"L1"++ * | L | -| ++"R1"++ | R | -| ++"SELECT"+"START"++ | Quit Game | -| ++"SELECT"+"R1"++ | Save State | -| ++"SELECT"+"L1"++ | Load State | -| ++"SELECT"+"Y(WEST)"++ | Take Screenshot | -| ++"SELECT"+"B(SOUTH)"++ | Reset Game | - -#### Additional Notes: - -The Z and L button assignment can be changed in EmulationStation - -* Highlight the game and press ++"X(NORTH)"++ -* Select ADVANCED GAME OPTIONS (A to confirm) -* Set EMULATOR to MUPEN64PLUSSA -* Then change INPUT CONFIGURATION - * 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` - -### PPSSPP ([PSP](../../systems/psp)) - -| Button Combo | Action | -| -- | -- | -| ++"START"++ | Start | -| ++"SELECT"++ | Select | -| ++"A(SOUTH)"++ | Circle | -| ++"B(EAST)"++ | Cross | -| ++"X(NORTH"++ | Triangle | -| ++"Y(WEST)"++ | Square | -| ++"L1"++ | L | -| ++"R1"++ | R | -| ++"R3"++ | Open Menu | - -#### Additional Notes: - -On S922X devices e.g. [Powkiddy RGB10 Max 3 -Pro](../../devices/powkiddy/rgb10-max-3-pro) instead of ++"R3"++ the -++"F1"++ key is used. - -### PCSX2 ([PS2](../../systems/ps2)) - -| Button Combo | Action | -| -- | -- | -| ++"SELECT"+"START"++ | Quit Game | -| ++"SELECT"+"R1"++ | Save State | -| ++"SELECT"+"L1"++ | Load State | -| ++"SELECT"+"X(NORTH)"++ | Open Menu | -| ++"SELECT"+"B(EAST)"++ | Take Screenshot | -| ++"SELECT"+"R2"++ | Fast-Forward | - -### Yabasanshiro ([Sega Saturn](../../systems/saturn)) - -| Button Combo | Action | -| -- | -- | -| ++"START"++ | Start | -| ++"SELECT"++ | Open Menu | -| ++"Y(WEST)"++ | A | -| ++"B(EAST)"++ | B | -| ++"A(SOUTH)"++ | C | -| ++"X(NORTH"++ | X | -| ++"L1"++ | Y | -| ++"R1"++ | Z | -| ++"L2"++ | L | -| ++"R2"++ | R | -| ++"START"+"SELECT"+"R1"++ | Quit Game | - -### Hypseus-singe ([Daphne](../../systems/daphne)) - -| Button Combo | Action | -| -- | -- | -| ++"SELECT"+"START"++ | Quit Game | -| ++"SELECT"++ | Coin | -| ++"START"++ | Start | -| ++"A(SOUTH)"++ | Button 1 | -| ++"B(EAST)"++ | Button 2 | -| ++"X(NORTH"++ | Button 3 | - -#### Additional 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. - -For example the following would assign `quit` to ++"L1"++ and `pause` to ++"R1"++ - -``` bash -[KEYBOARD] -KEY_QUIT = SDLK_ESCAPE 0 5 -KEY_PAUSE = SDLK_p 0 6 - -``` - -### Open Beats of Rage ([OpenBOR](../../systems/openbor)) - -| Button Combo | Action | -| -- | -- | -| ++"START"++ | Confirm | -| ++"SELECT"++ | Cancel | -| ++"A(SOUTH)"++ | Attack 1 | -| ++"B(EAST)"++ | Jump | -| ++"X(NORTH"++ | Attack 2 | -| ++"Y(WEST)"++ | Special | - -> note: pressing A on title screen will exit - - -### Vice ([Commodore 64](../../systems/c64)) - -| Button Combo | Action | -| -- | -- | -| ++"START"++ | Open Menu | -| ++"SELECT"++ | Display Keyboard | -| ++"A(SOUTH)"++ | Back | -| ++"B(EAST)"++ | Fire / Confirm | -| ++"L1"++ | Back | -| ++"L2"++ | Assign Hotkey | -| ++"L3"++ | Fire (Joy 2) | -| ++"R1"++ | Confirm | -| ++"R2"++ | Swap Joystick Port | - -#### Additional Notes: - -Games will require keyboard key presses to progress through messages and to launch -(e.g. SPACE, RSTR [run/start], F3, F7). - -SELECT to show onscreen keyboard, left analog/d-pad to move cursor, B to confirm - -C= on keyboard resets the machine - -L2 to assign highlighted key or menu function to gamepad button (save config to retain) - -To cancel onscreen keyboard, move cursor to blank area and A/L1 to close keyboard -or click on X in top left corner of keyboard - -Joystick can be assigned to port 1 or 2. R2 to switch ports. -port 1: [left analog] + [B = fire] -port 2: [right analog] + [L3 = fire]. - -To quit emulator, START, highlight Exit Emulator, B to confirm - - - -## Per Device Global Hotkeys - -### HDMI Output - -!!! note "These instruction only work for aarm64 devices. This is not implemented for x86_64 devices." - -Press ++"L1"++ + ++"START"++ + ++"SELECT"++ while in EmulationStation to swtich between Screen and HDMI output. - -While this should work; it doesn't always result in the correct resolution. The best way to get consistent results is to turn off the device, plug in an HDMI cable and reboot. - -"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 - -|Device|Brightness Up|Brightness Down|Battery Status|WIFI Toggle| -|----|----|----|----|----| -|Anbernic RG351M|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -| -|Anbernic RG353M|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -| -|Anbernic RG353P|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -| -|Anbernic RG353V|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -| -|Anbernic RG503|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -| -|Anbernic RG552|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -| -|ATARI VCS 800 Onyx|NA|NA|NA|NA| -|AYANEO AIR|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AIR Plus|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AIR Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AYANEO 2|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AYA NEO 2021|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AYANEO 2021|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AYANEO 2021 Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AYANEO 2021 Pro Retro Power|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYA NEO AYA NEO Founder|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO AYANEO NEXT Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO GEEK|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO NEXT|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO NEXT Advance|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|AYANEO NEXT Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -| -|GPD G1619-04|TBD|TBD|TBD|TBD| -|Hardkernel ODROID-GO-Ultra|F1 & Vol +|F1 & Vol -|F2 & Vol +|F2 & Vol -| -|Indiedroid Nova|NA|NA|NA|NA| -|LENOVO 81TC|NA|NA|NA|NA| -|ODROID-GO Advance|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -| -|ODROID-GO Advance Black Edition|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -| -|ODROID-GO Super|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -| -|Orange Pi 5|NA|NA|NA|NA| -|Powkiddy RGB10 MAX 3|F1 & Vol +|F1 & Vol -|F2 & Vol +|F2 & Vol -| -|Powkiddy RK2023|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -| -|Powkiddy x55|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -| -|Valve Jupiter|Steam Button & Vol + | Steam Button & Vol - | ... Button & Vol + | ... Button & Vol -| +Controls are dependent on the buttons available on a specific device. +Therefor documentation of the controls can be found on the [device page](../../devices) diff --git a/includes/controls/aethersx2.md b/includes/controls/aethersx2.md new file mode 100644 index 0000000..eff563e --- /dev/null +++ b/includes/controls/aethersx2.md @@ -0,0 +1,11 @@ +### AetherSX2 ([PS2](../../../systems/ps2)) + +| Button Combo | Action | +| -- | -- | +| ++"{{ btn_prefix }}"+"{{ btn_south }}"++ | Quit Game | +| ++"{{ btn_prefix }}"+"R1"++ | Save State | +| ++"{{ btn_prefix }}"+"L1"++ | Load State | +| ++"{{ btn_prefix }}"+"{{ btn_north }}"++ | Open Menu | +| ++"{{ btn_prefix }}"+"{{ btn_west }}"++ | Cycle Aspect Ratio | +| ++"{{ btn_prefix }}"+"{{ btn_east }}"++ | Screenshot | + diff --git a/includes/controls/citra.md b/includes/controls/citra.md new file mode 100644 index 0000000..4e73dcc --- /dev/null +++ b/includes/controls/citra.md @@ -0,0 +1,5 @@ +### Citra ([Nintendo 3DS](../../../systems/3ds)) + +| Button Combo | Action | +| -- | -- | +| ++"{{ btn_prefix }}"+"START"++ | Quit Game | diff --git a/includes/controls/dolphin.md b/includes/controls/dolphin.md new file mode 100644 index 0000000..8a73139 --- /dev/null +++ b/includes/controls/dolphin.md @@ -0,0 +1,15 @@ +### Dolphin ([Gamecube](../../../systems/gc)) + +| Button Combo | Action | +| -- | -- | +| ++"SELECT"+"START"++ | Quit Game | +| ++"SELECT"+"R1"++ | Save State | +| ++"SELECT"+"L1"++ | Load State | +| ++"SELECT"+"{{ btn_south }}"++ | Screenshot | +| ++"SELECT"+"{{ btn_east }}"++ | Change Internal Resolution | +| ++"SELECT"+"{{ btn_north }}"++ | Change Aspect Ratio | +| ++"SELECT"+"{{ btn_west }}"++ | Show FPS | +| ++"SELECT"+"D-Pad Up"++ | Increase current state slot | +| ++"SELECT"+"D-Pad Down"++ | Decrease current state slot | +| ++"SELECT"+"R2"++ | Fast-Forward | + diff --git a/includes/controls/drastic.md b/includes/controls/drastic.md new file mode 100644 index 0000000..154cda8 --- /dev/null +++ b/includes/controls/drastic.md @@ -0,0 +1,10 @@ +### Drastic ([Nintendo DS](../../../systems/nds)) + +| Button Combo | Action | +| -- | -- | +| ++"{{ btn_save }}"++ | Save State | +| ++"{{ btn_load }}"++ | Load State | +| ++"{{ btn_menu }}"++ | Open Menu | +| ++"{{ btn_swap_b }}"++ | Switch One Screen and Dual Screen Layout | +| ++"{{ btn_swap_a }}"++ | Change Screen Layout/Swap Screens | + diff --git a/includes/controls/extra.md b/includes/controls/extra.md new file mode 100644 index 0000000..f035460 --- /dev/null +++ b/includes/controls/extra.md @@ -0,0 +1,21 @@ +### Per Device Global Hotkeys + +#### HDMI Output + +!!! note "These instruction only work for aarm64 devices. This is not implemented for x86_64 devices." + +Press ++"L1"++ + ++"START"++ + ++"SELECT"++ while in EmulationStation to swtich between Screen and HDMI output. + +While this should work; it doesn't always result in the correct resolution. The best way to get consistent results is to turn off the device, plug in an HDMI cable and reboot. + +"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 | + diff --git a/includes/controls/hypseus-singe.md b/includes/controls/hypseus-singe.md new file mode 100644 index 0000000..18d8554 --- /dev/null +++ b/includes/controls/hypseus-singe.md @@ -0,0 +1,24 @@ +### Hypseus-singe ([Daphne](../../../systems/daphne)) + +| Button Combo | Action | +| -- | -- | +| ++"SELECT"+"START"++ | Quit Game | +| ++"SELECT"++ | Coin | +| ++"START"++ | Start | +| ++"{{ btn_south }}"++ | Button 1 | +| ++"{{ btn_east }}"++ | Button 2 | +| ++"{{ btn_north }}"++ | Button 3 | + +#### Additional 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. + +For example the following would assign `quit` to ++"L1"++ and `pause` to ++"R1"++ + +``` bash +[KEYBOARD] +KEY_QUIT = SDLK_ESCAPE 0 5 +KEY_PAUSE = SDLK_p 0 6 + +``` + diff --git a/includes/controls/mednafen.md b/includes/controls/mednafen.md new file mode 100644 index 0000000..711cbf8 --- /dev/null +++ b/includes/controls/mednafen.md @@ -0,0 +1,17 @@ +### Mednafen Hotkeys + +| Button Combo | Action | +| -- | -- | +| ++"SELECT"+"START"++ (hold for 2sec) | Quit Game | +| ++"SELECT"+"R1"++ | Save State | +| ++"SELECT"+"L1"++ | Load State | +| ++"SELECT"+"{{ btn_west }}"++ | Show FPS | +| ++"SELECT"+"R2"++ | Fast-Forward | +| ++"SELECT"+"L2"++ | Rewind | +| ++"THUMBR"+"L1"++ | Select disc | +| ++"THUMBR"+"R1"++ | Eject/Insert disc | +| ++"THUMBR"+"D-Pad Left"++ | Decrease save slot by 1 | +| ++"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. diff --git a/includes/controls/mupen64plus.md b/includes/controls/mupen64plus.md new file mode 100644 index 0000000..825a42d --- /dev/null +++ b/includes/controls/mupen64plus.md @@ -0,0 +1,33 @@ +### Mupen64Plus ([Nintendo 64](../../../systems/n64)) + +| Button Combo | Action | +| -- | -- | +| ++"START"++ | Start | +| ++"{{ btn_east }}"++ | A | +| ++"{{ btn_west }}"++ | B | +| ++"Right Analog Up"++ | C Up | +| ++"Right Analog Down"++ | C Down | +| ++"Right Analog Left"++ | C Left | +| ++"Right Analog Right"++ | C Right | +| ++"L2"++ * | Z | +| ++"L1"++ * | L | +| ++"R1"++ | R | +| ++"SELECT"+"START"++ | Quit Game | +| ++"SELECT"+"R1"++ | Save State | +| ++"SELECT"+"L1"++ | Load State | +| ++"SELECT"+"{{ btn_west }}"++ | Take Screenshot | +| ++"SELECT"+"{{ btn_south }}"++ | Reset Game | + + +#### Additional Notes: + +The Z and L button assignment can be changed in EmulationStation + +* Highlight the game and press ++"{{ btn_north }}"++ +* Select ADVANCED GAME OPTIONS (A to confirm) +* Set EMULATOR to MUPEN64PLUSSA +* Then change INPUT CONFIGURATION + * 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` + diff --git a/includes/controls/openbor.md b/includes/controls/openbor.md new file mode 100644 index 0000000..31dc1f2 --- /dev/null +++ b/includes/controls/openbor.md @@ -0,0 +1,13 @@ +### Open Beats of Rage ([OpenBOR](../../../systems/openbor)) + +| Button Combo | Action | +| -- | -- | +| ++"START"++ | Confirm | +| ++"SELECT"++ | Cancel | +| ++"{{ btn_south }}"++ | Attack 1 | +| ++"{{ btn_east }}"++ | Jump | +| ++"{{ btn_north }}"++ | Attack 2 | +| ++"{{ btn_west }}"++ | Special | + +> note: pressing A on title screen will exit + diff --git a/includes/controls/pcsx2.md b/includes/controls/pcsx2.md new file mode 100644 index 0000000..3899e8d --- /dev/null +++ b/includes/controls/pcsx2.md @@ -0,0 +1,11 @@ +### PCSX2 ([PS2](../../../systems/ps2)) + +| Button Combo | Action | +| -- | -- | +| ++"SELECT"+"START"++ | Quit Game | +| ++"SELECT"+"R1"++ | Save State | +| ++"SELECT"+"L1"++ | Load State | +| ++"SELECT"+"{{ btn_north }}"++ | Open Menu | +| ++"SELECT"+"{{ btn_east }}"++ | Take Screenshot | +| ++"SELECT"+"R2"++ | Fast-Forward | + diff --git a/includes/controls/ppsspp.md b/includes/controls/ppsspp.md new file mode 100644 index 0000000..a7dfd19 --- /dev/null +++ b/includes/controls/ppsspp.md @@ -0,0 +1,14 @@ +### PPSSPP ([PSP](../../../systems/psp)) + +| Button Combo | Action | +| -- | -- | +| ++"START"++ | Start | +| ++"SELECT"++ | Select | +| ++"A(SOUTH)"++ | Circle | +| ++"B(EAST)"++ | Cross | +| ++"X(NORTH"++ | Triangle | +| ++"Y(WEST)"++ | Square | +| ++"L1"++ | L | +| ++"R1"++ | R | +| ++"{{ btn_menu }}"++ | Open Menu | + diff --git a/includes/controls/retroarch.md b/includes/controls/retroarch.md new file mode 100644 index 0000000..7a83796 --- /dev/null +++ b/includes/controls/retroarch.md @@ -0,0 +1,12 @@ +### RetroArch Hotkeys + +| Button Combo | Action | +| -- | -- | +| ++"SELECT"+"START"++ (x2) | Quit Game | +| ++"SELECT"+"R1"++ | Save State | +| ++"SELECT"+"L1"++ | Load State | +| ++"SELECT"+"{{ btn_north }}"++ | Open RA Menu | +| ++"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. diff --git a/includes/controls/vice.md b/includes/controls/vice.md new file mode 100644 index 0000000..40ac625 --- /dev/null +++ b/includes/controls/vice.md @@ -0,0 +1,34 @@ +### Vice ([Commodore 64](../../../systems/c64)) + +| Button Combo | Action | +| -- | -- | +| ++"START"++ | Open Menu | +| ++"SELECT"++ | Display Keyboard | +| ++"{{ btn_south }}"++ | Back | +| ++"{{ btn_east }}"++ | Fire / Confirm | +| ++"L1"++ | Back | +| ++"L2"++ | Assign Hotkey | +| ++"L3"++ | Fire (Joy 2) | +| ++"R1"++ | Confirm | +| ++"R2"++ | Swap Joystick Port | + +#### Additional Notes: + +Games will require keyboard key presses to progress through messages and to launch +(e.g. SPACE, RSTR [run/start], F3, F7). + +SELECT to show onscreen keyboard, left analog/d-pad to move cursor, B to confirm + +C= on keyboard resets the machine + +L2 to assign highlighted key or menu function to gamepad button (save config to retain) + +To cancel onscreen keyboard, move cursor to blank area and A/L1 to close keyboard +or click on X in top left corner of keyboard + +Joystick can be assigned to port 1 or 2. R2 to switch ports. +port 1: [left analog] + [B = fire] +port 2: [right analog] + [L3 = fire]. + +To quit emulator, START, highlight Exit Emulator, B to confirm + diff --git a/includes/controls/yabasanshiro.md b/includes/controls/yabasanshiro.md new file mode 100644 index 0000000..4c528ea --- /dev/null +++ b/includes/controls/yabasanshiro.md @@ -0,0 +1,16 @@ +### Yabasanshiro ([Sega Saturn](../../../systems/saturn)) + +| Button Combo | Action | +| -- | -- | +| ++"START"++ | Start | +| ++"SELECT"++ | Open Menu | +| ++"{{ btn_west }}"++ | A | +| ++"{{ btn_east }}"++ | B | +| ++"{{ btn_south }}"++ | C | +| ++"{{ btn_north }}"++ | X | +| ++"L1"++ | Y | +| ++"R1"++ | Z | +| ++"L2"++ | L | +| ++"R2"++ | R | +| ++"START"+"SELECT"+"R1"++ | Quit Game | + diff --git a/mkdocs.yml b/mkdocs.yml index 632b54c..c6d42bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,6 +64,8 @@ extra: plugins: - search - glightbox + - macros: + include_dir: includes nav: - Home: index.md - FAQs: faqs.md