Skip to content

Commit

Permalink
Merge pull request #64 from r3claimer/main
Browse files Browse the repository at this point in the history
Wiki updates
  • Loading branch information
r3claimer authored Jan 17, 2025
2 parents 5369fd6 + 2d34b22 commit 0f23478
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/configure/overlays.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Overlays should be possible to add when using RetroArch cores. Broadly speaking

Instructions on how to use overlays can be found here: [https://docs.libretro.com/guides/libretro-overlays/](https://docs.libretro.com/guides/libretro-overlays/). Suggested sample configurations for different systems can be found in [https://retrogamecorps.com/2024/09/01/guide-shaders-and-overlays-on-retro-handhelds/#Overlays](Retrogamecorps Overlay and Shaders guide).

The default selection of overlays in Retroarch is limited, additional overlays can be found on Github, see e.g [https://github.com/Duimon/Retroarch-Overlays](Duimn Retroarch-Overlays) for 16:9 systems or [https://github.com/ourigen/perfect_overlays/](Ourigen Perfect Overlays) for 4:3 screens.
The default selection of overlays in Retroarch is limited, additional overlays can be found on Github, see e.g [https://github.com/Duimon/Retroarch-Overlays](Duimn Retroarch-Overlays) for 16:9 systems or [https://github.com/ourigen/perfect_overlays/](https://github.com/ourigen/perfect_overlays/) for 4:3 screens.

## Stand-Alone Emulators

Overlays are not supported for standalone emulators. That said, if you are interested in developing the support to add them please check out how to start contributing [here](../../contribute/).
Overlays are not supported for standalone emulators. That said, if you are interested in developing the support to add them please check out how to start contributing [here](../../contribute/).
1 change: 1 addition & 0 deletions docs/devices/retroid/retroid-pocket-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ search:
{%include 'controls/retroarch.md' %}
{%include 'controls/mupen64plus.md' %}
{%include 'controls/ppsspp.md' %}
{%include 'controls/dolphinqt.md' %}
{%include 'controls/dolphin.md' %}
{%include 'controls/aethersx2.md' %}
{%include 'controls/xemu.md' %}
Expand Down
1 change: 1 addition & 0 deletions docs/devices/retroid/retroid-pocket-mini.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ search:
{%include 'controls/retroarch.md' %}
{%include 'controls/mupen64plus.md' %}
{%include 'controls/ppsspp.md' %}
{%include 'controls/dolphinqt.md' %}
{%include 'controls/dolphin.md' %}
{%include 'controls/aethersx2.md' %}
{%include 'controls/xemu.md' %}
Expand Down
15 changes: 13 additions & 2 deletions docs/systems/gamecube.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,16 @@

| Name | Documentation |
| --- | --- |
| Dolphin (SA)   `default` | [dolphin-emu.org/docs/guides](https://dolphin-emu.org/docs/guides/) |
| Dolphin | [docs.libretro.com/library/dolphin](https://docs.libretro.com/library/dolphin/) |
| Dolphin (SA) | [dolphin-emu.org/docs/guides](https://dolphin-emu.org/docs/guides/) |
| Dolphin (QT) | [dolphin-emu.org/docs/guides](https://dolphin-emu.org/docs/guides/) |
| Dolphin Libretro | [docs.libretro.com/library/dolphin](https://docs.libretro.com/library/dolphin/) |

## Bios

> You may need the following files to correctly load fonts on some Gamecube games
| Emulator | Optional Files | Path |
| --- | --- | --- |
| Dolphin | IPL.bin | `roms/bios/GC/EUR` |
| Dolphin | IPL.bin | `roms/bios/GC/JAP` |
| Dolphin | IPL.bin | `roms/bios/GC/USA` |
2 changes: 1 addition & 1 deletion docs/systems/ps2.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

| Name | Platform | Documentation |
| --- | --- | --- |
| AetherSX2 | RK3588, S922X, RK3399 | [www.aethersx2.com/archive](https://www.aethersx2.com/archive/) |
| AetherSX2 | RK3588, S922X, RK3399, SD865 | [www.aethersx2.com/archive](https://www.aethersx2.com/archive/) |

## Bios

Expand Down
5 changes: 3 additions & 2 deletions docs/systems/wii.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@

| Name | Documentation |
| --- | --- |
| Dolphin (SA)   `default` | [dolphin-emu.org/docs/guides](https://dolphin-emu.org/docs/guides/) |
| Dolphin | [docs.libretro.com/library/dolphin](https://docs.libretro.com/library/dolphin/) |
| Dolphin (SA) | [dolphin-emu.org/docs/guides](https://dolphin-emu.org/docs/guides/) |
| Dolphin (QT) | [dolphin-emu.org/docs/guides](https://dolphin-emu.org/docs/guides/) |
| Dolphin Libretro | [docs.libretro.com/library/dolphin](https://docs.libretro.com/library/dolphin/) |
6 changes: 3 additions & 3 deletions includes/controls/dolphin.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
| Button Combo | Action |
| -- | -- |
| ++"{{ btn_hotkey_a }}"+"START"++ | Quit Game |
| ++"{{ btn_hotkey_a }}"+"R1"++ | Save State |
| ++"{{ btn_hotkey_a }}"+"L1"++ | Load State |
| ++"{{ btn_hotkey_a }}"+"R2"++ | Save State |
| ++"{{ btn_hotkey_a }}"+"L2"++ | Load State |
| ++"{{ btn_hotkey_a }}"+"{{ btn_south }}"++ | Screenshot |
| ++"{{ btn_hotkey_a }}"+"{{ btn_west }}"++ | Change Internal Resolution |
| ++"{{ btn_hotkey_a }}"+"{{ btn_east }}"++ | Change Aspect Ratio |
| ++"{{ btn_hotkey_a }}"+"{{ btn_north }}"++ | Show FPS |
| ++"{{ btn_hotkey_a }}"+"D-Pad Up"++ | Increase current state slot |
| ++"{{ btn_hotkey_a }}"+"D-Pad Down"++ | Decrease current state slot |
| ++"{{ btn_hotkey_a }}"+"R2"++ | Fast-Forward |
| ++"{{ btn_hotkey_a }}"+"R1"++ | Fast-Forward |
16 changes: 16 additions & 0 deletions includes/controls/dolphinqt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{% if not btn_hotkey_a %}
{% set btn_hotkey_a = 'SELECT' %}
{% endif %}
### Dolphin-SA ([Gamecube](../../../systems/gamecube))

| Button Combo | Action |
| -- | -- |
| ++"{{ btn_hotkey_a }}"+"START"++ | Quit Game |
| ++"{{ btn_hotkey_a }}"+"R1"++ | Save State |
| ++"{{ btn_hotkey_a }}"+"L1"++ | Load State |
| ++"{{ btn_hotkey_a }}"+"{{ btn_south }}"++ | Screenshot |
| ++"{{ btn_hotkey_a }}"+"{{ btn_east }}"++ | Change Aspect Ratio |
| ++"{{ btn_hotkey_a }}"+"D-Pad Up"++ | Increase current state slot |
| ++"{{ btn_hotkey_a }}"+"D-Pad Down"++ | Decrease current state slot |
| ++"{{ btn_hotkey_a }}"+"R2"++ | Increase Emulator Speed |
| ++"{{ btn_hotkey_a }}"+"L2"++ | Decrease Emulator Speed |

0 comments on commit 0f23478

Please sign in to comment.