Skip to content

Commit a4ca199

Browse files
committed
Update tutorials for GBA/PS1 BIOS and GB/GBC palette after the new OS update
Minor naming convention changes
1 parent b2b7688 commit a4ca199

File tree

7 files changed

+14
-12
lines changed

7 files changed

+14
-12
lines changed

docs/assets/images/PS1_BIOS.png

3.71 KB
Loading

docs/developer_guide/hardware_reference/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ But this solution also brings a lot of challenges, as the required
1616
hinge make connections between the 2 halfs of the shell more
1717
difficult.
1818

19-
However, this has been done before in the classic GameBoy Advanced SP,
19+
However, this has been done before in the classic Game Boy Advance SP,
2020
or in many clamshell cellphones from some years ago, so why can't we?
2121

2222
## Design Goals

docs/user_manual/tutorials/software/add_opk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ files as simply as you would do it with a simple USB memory stick:
1818
| **Display** | **Action** |
1919
|:---------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------|
2020
| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
21-
| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with gmenu2x), press the <i class="funkey-menu"></i> key |
21+
| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with GMenu2X), press the <i class="funkey-menu"></i> key |
2222
| ![Mount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
2323
| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
2424
| ![Eject USB](/assets/images/Eject_USB_gmenu2x.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |

docs/user_manual/tutorials/software/gb_palette.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
**This tutorial applies to the previous OS update with the default emulators. For PicoArch GB/GBC emulator, palettes can now be set through the core options.**
2+
13
## Palette Description
24

35
The default **FunKey S** Game Boy emulator: _[gnuboy][1]_ allows to
46
set the palette used for grayscale when running DMG (original mono
5-
Gameboy) ROMs.
7+
Game Boy) ROMs.
68

79
There are four variables for this purpose, allowing the background,
810
window, and both sprite palettes to be colored differently. Each one
@@ -131,7 +133,7 @@ set dmg_obp1 0xc0ffff 0x408080 0x204040 0x000000`
131133
| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer |
132134
| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
133135
| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |
134-
| ![palette results](/assets/images/results_palette.png){.lightbox} | Launch any Gameboy game to see the results of your new palette settings. |
136+
| ![palette results](/assets/images/results_palette.png){.lightbox} | Launch any Game Boy game to see the results of your new palette settings. |
135137

136138
[1]: https://github.com/rofl0r/gnuboy
137139

docs/user_manual/tutorials/software/gba_bios.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
**This tutorial applies to the previous OS update with the default emulators. For PicoArch emulators, BIOS files now go into _FunKey/.picoarch/system/_ folder.**
2+
13
Most retro-gaming console software emulators are able to run game ROMs
24
directly.
35

@@ -44,8 +46,6 @@ file with the right name and size before you can actually play.
4446

4547
BIOS file name: SCPH1001.BIN
4648

47-
**Note: The BIOS location was recently moved to FunKey/.pcsx/bios, please read below.**
48-
4949
### Installation procedure
5050

5151
| **Display** | **Action** |
@@ -56,7 +56,7 @@ BIOS file name: SCPH1001.BIN
5656
| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
5757
| ![Eject USB](/assets/images/Eject_USB.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |
5858
| ![USB Drive](/assets/images/USB_Drive.png){.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) |
59-
| ![Copy ROM](/assets/images/Copy_PS1_BIOS.png){.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**FunKey/.pcsx/bios**_ folder in this USB drive on your computer |
59+
| ![Copy ROM](/assets/images/Copy_PS1_BIOS.png){.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**FunKey/.pcsx/bios/**_ folder in this USB drive on your computer |
6060
| ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer |
6161
| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
6262
| ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |

docs/user_manual/tutorials/software/gmenu2x_wallpaper.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Changing the Gmenu2x wallpaper is easy: the chosen picture must be a
1+
Changing the GMenu2X wallpaper is easy: the chosen picture must be a
22
PNG file with a 240x240 pixel resolution.
33

44
Connect your **FunKey S** console to your computer and add wallpaper
@@ -7,7 +7,7 @@ files as simply as you would do it with a simple USB memory stick:
77
| **Display** | **Action** |
88
|:---------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
99
| ![Connection PC](/assets/images/Connection_PC.png){.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
10-
| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with gmenu2x), press the <i class="funkey-menu"></i> key |
10+
| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with GMenu2X), press the <i class="funkey-menu"></i> key |
1111
| ![Mount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
1212
| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
1313
| ![Eject USB](/assets/images/Eject_USB_gmenu2x.png){.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |
@@ -20,7 +20,7 @@ files as simply as you would do it with a simple USB memory stick:
2020
| ![Unmount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |
2121
| ![Wallpaper Settings](/assets/images/Wallpaper_Settings.png){.lightbox} | Navigate to the **Settings** tab using the <i class="funkey-L"></i> or <i class="funkey-R"></i> keys, select the **Wallpaper** icon using the <i class="funkey-up"></i>, <i class="funkey-down"></i>, <i class="funkey-left"></i> or <i class="funkey-right"></i> keys, then press the <i class="funkey-A"></i> key |
2222
| ![Choose Wallpaper](/assets/images/Choose_Wallpaper.png){.lightbox} | Choose the wallpaper using the <i class="funkey-L"></i>, <i class="funkey-R"></i>, <i class="funkey-up"></i>, <i class="funkey-down"></i>, <i class="funkey-left"></i> or <i class="funkey-right"></i> keys, then press the <i class="funkey-A"></i> key |
23-
| ![New Wallpaper](/assets/images/New_Wallpaper.png){.lightbox} | The selected wallpaper becomes the new gmenu2x wallpaper |
23+
| ![New Wallpaper](/assets/images/New_Wallpaper.png){.lightbox} | The selected wallpaper becomes the new GMenu2X wallpaper |
2424

2525
Of course, you can remove wallpaper files from the **FunKey S**
2626
console as you would do with a USB memory stick, too!

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ nav:
149149
- 'Change Aspect Ratio': 'user_manual/tutorials/software/aspect_ratio.md'
150150
- 'Take a Snapshot': 'user_manual/tutorials/software/snapshot.md'
151151
- 'Firmware Upgrade': 'user_manual/tutorials/software/firmware_update.md'
152-
- 'Change Gameboy Palette': 'user_manual/tutorials/software/gb_palette.md'
153-
- 'Change Gmenu2x Wallpaper': 'user_manual/tutorials/software/gmenu2x_wallpaper.md'
152+
- 'Change Game Boy Palette': 'user_manual/tutorials/software/gb_palette.md'
153+
- 'Change GMenu2X Wallpaper': 'user_manual/tutorials/software/gmenu2x_wallpaper.md'
154154
# - 'Create Themes': 'user_manual/tutorials/software/create_themes.md'
155155
#- 'Restore Default Games & Emulators': 'user_manual/tutorials/software/restore_games.md'
156156
- Hardware:

0 commit comments

Comments
 (0)