diff --git a/docs/assets/images/GBA_BIOS.png b/docs/assets/images/GBA_BIOS.png index 24fcfe7..9c93405 100644 Binary files a/docs/assets/images/GBA_BIOS.png and b/docs/assets/images/GBA_BIOS.png differ diff --git a/docs/assets/images/PS1_BIOS.png b/docs/assets/images/PS1_BIOS.png index bd3dd60..48f212a 100644 Binary files a/docs/assets/images/PS1_BIOS.png and b/docs/assets/images/PS1_BIOS.png differ diff --git a/docs/developer_guide/hardware_reference/index.md b/docs/developer_guide/hardware_reference/index.md index 2c29e17..5efc009 100644 --- a/docs/developer_guide/hardware_reference/index.md +++ b/docs/developer_guide/hardware_reference/index.md @@ -16,7 +16,7 @@ But this solution also brings a lot of challenges, as the required hinge make connections between the 2 halfs of the shell more difficult. -However, this has been done before in the classic GameBoy Advanced SP, +However, this has been done before in the classic Game Boy Advance SP, or in many clamshell cellphones from some years ago, so why can't we? ## Design Goals diff --git a/docs/user_manual/tutorials/software/add_opk.md b/docs/user_manual/tutorials/software/add_opk.md index be0db18..1ef4ba2 100644 --- a/docs/user_manual/tutorials/software/add_opk.md +++ b/docs/user_manual/tutorials/software/add_opk.md @@ -18,7 +18,7 @@ files as simply as you would do it with a simple USB memory stick: | **Display** | **Action** | |:---------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------| | ![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 | -| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with gmenu2x), press the key | +| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with GMenu2X), press the key | | ![Mount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){.lightbox} | Press the key twice to confirm | | ![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 | diff --git a/docs/user_manual/tutorials/software/aspect_ratio.md b/docs/user_manual/tutorials/software/aspect_ratio.md index af7b60c..6a31807 100644 --- a/docs/user_manual/tutorials/software/aspect_ratio.md +++ b/docs/user_manual/tutorials/software/aspect_ratio.md @@ -16,7 +16,7 @@ display aspect ratio: - Scaled - - Manual Zoom + - Manual Zoom (not available with PicoArch) - + : Decrease zoom level by 10% @@ -39,7 +39,7 @@ display aspect ratio: | ![Menu Stretched](/assets/images/Menu_Stretched.png){.lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | | ![Menu Cropped](/assets/images/Menu_Cropped.png){.lightbox} | Cropped (Zoom 100%), The display fills the screen vertically, and is clipped vertically to the left and right of the screen | | ![Menu Scaled](/assets/images/Menu_Scaled.png){.lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically | -| ![Menu Manual Zoom](/assets/images/Menu_Manual_Zoom.png){.lightbox} | Manual zoom: The display is zoomed in/out manually | +| ![Menu Manual Zoom](/assets/images/Menu_Manual_Zoom.png){.lightbox} | Manual zoom: The display is zoomed in/out manually (not available with PicoArch) | - Press the key again to exit from the FunKey menu diff --git a/docs/user_manual/tutorials/software/gb_palette.md b/docs/user_manual/tutorials/software/gb_palette.md index 700b757..3f12207 100644 --- a/docs/user_manual/tutorials/software/gb_palette.md +++ b/docs/user_manual/tutorials/software/gb_palette.md @@ -1,8 +1,10 @@ +**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.** + ## Palette Description The default **FunKey S** Game Boy emulator: _[gnuboy][1]_ allows to set the palette used for grayscale when running DMG (original mono -Gameboy) ROMs. +Game Boy) ROMs. There are four variables for this purpose, allowing the background, window, and both sprite palettes to be colored differently. Each one @@ -125,13 +127,13 @@ set dmg_obp1 0xc0ffff 0x408080 0x204040 0x000000` | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | | ![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 | | ![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) | -| ![create _gnuboy](/assets/images/create_gnuboy_folder.png){.lightbox} | In the FunKey folder, create a new folder .gnuboy if it does not already exist. | -| ![create gnuboy_rc](/assets/images/create_gnuboy_rc_file.png){.lightbox} | In the FunKey/.gnuboy folder create a file gnuboy.rc if it does not already exist. | -| ![modify gnuboy_rc](/assets/images/set_palette.png){.lightbox} | Open the gnuboy.rc file with a text editor and add the palette you want. | +| ![create _gnuboy](/assets/images/create_gnuboy_folder.png){.lightbox} | In the FunKey folder, create a new folder _**.gnuboy**_ if it does not already exist. | +| ![create gnuboy_rc](/assets/images/create_gnuboy_rc_file.png){.lightbox} | In the _**FunKey/.gnuboy/**_ folder create a file _**gnuboy.rc**_ if it does not already exist. | +| ![modify gnuboy_rc](/assets/images/set_palette.png){.lightbox} | Open the _**gnuboy.rc**_ file with a text editor and add the palette you want. | | ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | | ![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 key twice to confirm | | ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | -| ![palette results](/assets/images/results_palette.png){.lightbox} | Launch any Gameboy game to see the results of your new palette settings. | +| ![palette results](/assets/images/results_palette.png){.lightbox} | Launch any Game Boy game to see the results of your new palette settings. | [1]: https://github.com/rofl0r/gnuboy diff --git a/docs/user_manual/tutorials/software/gba_bios.md b/docs/user_manual/tutorials/software/gba_bios.md index 132d825..ff65b06 100644 --- a/docs/user_manual/tutorials/software/gba_bios.md +++ b/docs/user_manual/tutorials/software/gba_bios.md @@ -1,3 +1,5 @@ +**This tutorial applies to the previous OS update with the default emulators. For PicoArch emulators, BIOS files now go into _FunKey/.picoarch/system/_ folder.** + Most retro-gaming console software emulators are able to run game ROMs directly. @@ -27,7 +29,7 @@ actually play. | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | | ![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 | | ![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) | -| ![Copy ROM](/assets/images/Copy_GBA_BIOS.png){.lightbox} | Drag & drop the _**gba_bios.bin**_ BIOS file into the _**Game Boy Advance**_ folder in this USB drive on your computer | +| ![Copy ROM](/assets/images/Copy_GBA_BIOS.png){.lightbox} | Drag & drop the _**gba_bios.bin**_ BIOS file into the _**Game Boy Advance/bios/**_ folder in this USB drive on your computer | | ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | | ![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 key twice to confirm | | ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | @@ -44,8 +46,6 @@ file with the right name and size before you can actually play. BIOS file name: SCPH1001.BIN -**Note: The BIOS location was recently moved to FunKey/.pcsx/bios, please read below.** - ### Installation procedure | **Display** | **Action** | @@ -56,7 +56,7 @@ BIOS file name: SCPH1001.BIN | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){.lightbox} | Press the key twice to confirm | | ![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 | | ![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) | -| ![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 | +| ![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 | | ![Eject Drive](/assets/images/Eject_Drive.png){.lightbox} | Eject cleanly the USB drive from your computer | | ![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 key twice to confirm | | ![Unmount USB](/assets/images/Mount_USB.png){.lightbox} | Press the key to return to the launcher screen | diff --git a/docs/user_manual/tutorials/software/gmenu2x_wallpaper.md b/docs/user_manual/tutorials/software/gmenu2x_wallpaper.md index 351ecc1..3292c9a 100644 --- a/docs/user_manual/tutorials/software/gmenu2x_wallpaper.md +++ b/docs/user_manual/tutorials/software/gmenu2x_wallpaper.md @@ -1,4 +1,4 @@ -Changing the Gmenu2x wallpaper is easy: the chosen picture must be a +Changing the GMenu2X wallpaper is easy: the chosen picture must be a PNG file with a 240x240 pixel resolution. 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: | **Display** | **Action** | |:---------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ![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 | -| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with gmenu2x), press the key | +| ![RetroFE](/assets/images/gmenu2x.png){.lightbox} | At the launcher's main screen (example here with GMenu2X), press the key | | ![Mount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the or keys until you see "**MOUNT USB**" | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){.lightbox} | Press the key twice to confirm | | ![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: | ![Unmount USB](/assets/images/Mount_USB_gmenu2x.png){.lightbox} | Press the key to return to the launcher screen | | ![Wallpaper Settings](/assets/images/Wallpaper_Settings.png){.lightbox} | Navigate to the **Settings** tab using the or keys, select the **Wallpaper** icon using the , , or keys, then press the key | | ![Choose Wallpaper](/assets/images/Choose_Wallpaper.png){.lightbox} | Choose the wallpaper using the , , , , or keys, then press the key | -| ![New Wallpaper](/assets/images/New_Wallpaper.png){.lightbox} | The selected wallpaper becomes the new gmenu2x wallpaper | +| ![New Wallpaper](/assets/images/New_Wallpaper.png){.lightbox} | The selected wallpaper becomes the new GMenu2X wallpaper | Of course, you can remove wallpaper files from the **FunKey S** console as you would do with a USB memory stick, too! diff --git a/mkdocs.yml b/mkdocs.yml index 0fa0878..23837c6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,8 +13,8 @@ site_description: >- # Copyright copyright: > - © 2020-2023 FunKey Project
- Last updated on 2023-05-27
+ © 2020-2024 FunKey Project
+ Last updated on 2024-05-04 by DrUm78
Creative Commons License
This work is licensed under a @@ -149,8 +149,8 @@ nav: - 'Change Aspect Ratio': 'user_manual/tutorials/software/aspect_ratio.md' - 'Take a Snapshot': 'user_manual/tutorials/software/snapshot.md' - 'Firmware Upgrade': 'user_manual/tutorials/software/firmware_update.md' - - 'Change Gameboy Palette': 'user_manual/tutorials/software/gb_palette.md' - - 'Change Gmenu2x Wallpaper': 'user_manual/tutorials/software/gmenu2x_wallpaper.md' + - 'Change Game Boy Palette': 'user_manual/tutorials/software/gb_palette.md' + - 'Change GMenu2X Wallpaper': 'user_manual/tutorials/software/gmenu2x_wallpaper.md' # - 'Create Themes': 'user_manual/tutorials/software/create_themes.md' #- 'Restore Default Games & Emulators': 'user_manual/tutorials/software/restore_games.md' - Hardware: