diff --git a/docs/tutorials/software/add_roms.md b/docs/tutorials/software/add_roms.md index b9906e4..a9d4924 100644 --- a/docs/tutorials/software/add_roms.md +++ b/docs/tutorials/software/add_roms.md @@ -36,15 +36,15 @@ as simply as you would do it with a simple USB memory stick: | **Display** | **Action** | | :-------------------------------------------------------------------------------: | :----------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ![PC Connection](/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/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | +| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![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_ROM.png){: .lightbox} | Drag & drop the ROM file and optional artwork file into the folder corresponding to the emulated console in this USB drive on your computer

The artwork file must have the **same base name** as the ROM file with a _.png_ or _.jpg_ extension. It is recommended to resize the artwork to a maximum dimension of 240px (big files will make scrolling less fluid on the launcher)
An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster here.
An otherwise complete list of artwork can be found here. | | ![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 | +| ![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 | Of course, you can remove games from the **FunKey S** console as you would do with a USB memory stick, too! diff --git a/docs/tutorials/software/aspect_ratio.md b/docs/tutorials/software/aspect_ratio.md index ba68add..1a8df63 100644 --- a/docs/tutorials/software/aspect_ratio.md +++ b/docs/tutorials/software/aspect_ratio.md @@ -7,7 +7,8 @@ display aspect ratio: ## Quick shortcuts - - + : Change Aspect Ratio (AR), cycle between: + - + : Change + Aspect Ratio (AR), cycle between: - Stretched (default) @@ -17,17 +18,21 @@ display aspect ratio: - Manual Zoom - - + : Decrease zoom level by 10% + - + : Decrease + zoom level by 10% - - + : Increase Zoom level by 10% + - + : Increase + Zoom level by 10% ## FunKey menu - - Press the key to enter the FunKey menu + - Press the key to enter the FunKey menu - - Press the or key to select the "**ASPECT RATIO**" setting + - Press the or + key to select the "**ASPECT RATIO**" setting - - Use the and keys to change the aspect ratio + - Use the and keys to change the aspect ratio | **Display** | **Aspect Ratio** | |:---------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| @@ -36,7 +41,8 @@ display aspect ratio: | ![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 | - - Press the key again to exit from the FunKey menu + - Press the key again to exit from the + FunKey menu ## Aspect ratio preview diff --git a/docs/tutorials/software/copy_opk.md b/docs/tutorials/software/copy_opk.md index afd48a1..083bcf9 100644 --- a/docs/tutorials/software/copy_opk.md +++ b/docs/tutorials/software/copy_opk.md @@ -18,15 +18,15 @@ 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 | -| ![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 | +| ![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 | | ![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 OPK](/assets/images/Copy_OPK.png){: .lightbox} | Drag & drop the **OPK** file into any 1st-level folder[^1] in this USB drive on your computer and they will be automatically available on the **FunKey S** | | ![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_gmenu2x.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_gmenu2x.png){: .lightbox} | Press the key to return to the launcher screen | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure_gmenu2x.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_gmenu2x.png){: .lightbox} | Press the key to return to the launcher screen | Of course, you can remove **OPK** files from the **FunKey S** console as you would do with a USB memory stick, too! diff --git a/docs/tutorials/software/gb_palette.md b/docs/tutorials/software/gb_palette.md index 0c3c2cd..97064a7 100644 --- a/docs/tutorials/software/gb_palette.md +++ b/docs/tutorials/software/gb_palette.md @@ -120,17 +120,17 @@ set dmg_obp1 0xc0ffff 0x408080 0x204040 0x000000` | **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/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | +| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![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. | | ![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 | +| ![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. | [1]: https://github.com/rofl0r/gnuboy diff --git a/docs/tutorials/software/gba_bios.md b/docs/tutorials/software/gba_bios.md index 3fbb62c..4de13bf 100644 --- a/docs/tutorials/software/gba_bios.md +++ b/docs/tutorials/software/gba_bios.md @@ -22,15 +22,15 @@ actually play. | **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/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | +| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![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 | | ![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 | +| ![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 | ## PS1 @@ -49,15 +49,15 @@ BIOS file name: SCPH1001.BIN | **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/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | +| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the | +| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![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 _**PS1/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 | +| ![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 | --8<-- includes/glossary.md diff --git a/docs/tutorials/software/snapshot.md b/docs/tutorials/software/snapshot.md index 997d623..5765560 100644 --- a/docs/tutorials/software/snapshot.md +++ b/docs/tutorials/software/snapshot.md @@ -11,15 +11,15 @@ In order to access the snapshots, follow these simple steps: | **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/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | +| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![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/Snapshots.png){: .lightbox} | Drag & drop / Copy / Move / Delete the snapshots files from the _FunKey/snapshots/_ folder in this USB drive on your computer as required | | ![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 | +| ![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 | --8<-- includes/glossary.md diff --git a/docs/tutorials/software/update.md b/docs/tutorials/software/update.md index 2ed7bec..d376458 100644 --- a/docs/tutorials/software/update.md +++ b/docs/tutorials/software/update.md @@ -12,14 +12,14 @@ https://github.com/FunKey-Project/FunKey-OS/releases/latest | **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/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | -| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | -| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the key twice to confirm | +| ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the key | +| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the or keys until you see "**MOUNT USB**" | +| ![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) | | ![USB Drag and Drop](/assets/images/USB_Drag_Drop.png){: .lightbox} | Drag & drop the _FunKey-roots-2.0.0.fwu_ file you just downloaded at the root of 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 | +| ![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 | | ![Updating](/assets/images/Updating.png){: .lightbox} | The **FunKey S** will then reboot and perform the upgrade | [1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.0.0/FunKey-rootfs-2.0.0.fwu