diff --git a/docs/assets/images/Copy_GBA_BIOS.png b/docs/assets/images/Copy_GBA_BIOS.png new file mode 100644 index 0000000..14629a2 Binary files /dev/null and b/docs/assets/images/Copy_GBA_BIOS.png differ diff --git a/docs/assets/images/Copy_OPK.png b/docs/assets/images/Copy_OPK.png new file mode 100644 index 0000000..dc285f1 Binary files /dev/null and b/docs/assets/images/Copy_OPK.png differ diff --git a/docs/assets/images/Copy_PS1_BIOS.png b/docs/assets/images/Copy_PS1_BIOS.png new file mode 100644 index 0000000..26be7c8 Binary files /dev/null and b/docs/assets/images/Copy_PS1_BIOS.png differ diff --git a/docs/assets/images/Copy_ROM.png b/docs/assets/images/Copy_ROM.png new file mode 100644 index 0000000..af7d99f Binary files /dev/null and b/docs/assets/images/Copy_ROM.png differ diff --git a/docs/assets/images/Eject_Drive.png b/docs/assets/images/Eject_Drive.png index ab9b745..551298f 100644 Binary files a/docs/assets/images/Eject_Drive.png and b/docs/assets/images/Eject_Drive.png differ diff --git a/docs/assets/images/Eject_USB_are_you_sure_gmenu2x.png b/docs/assets/images/Eject_USB_are_you_sure_gmenu2x.png new file mode 100644 index 0000000..e854c60 Binary files /dev/null and b/docs/assets/images/Eject_USB_are_you_sure_gmenu2x.png differ diff --git a/docs/assets/images/Eject_USB_gmenu2x.png b/docs/assets/images/Eject_USB_gmenu2x.png new file mode 100644 index 0000000..d57bc0c Binary files /dev/null and b/docs/assets/images/Eject_USB_gmenu2x.png differ diff --git a/docs/assets/images/Mount_USB_are_you_sure_gmenu2x.png b/docs/assets/images/Mount_USB_are_you_sure_gmenu2x.png new file mode 100644 index 0000000..8a02271 Binary files /dev/null and b/docs/assets/images/Mount_USB_are_you_sure_gmenu2x.png differ diff --git a/docs/assets/images/Mount_USB_gmenu2x.png b/docs/assets/images/Mount_USB_gmenu2x.png new file mode 100644 index 0000000..103932e Binary files /dev/null and b/docs/assets/images/Mount_USB_gmenu2x.png differ diff --git a/docs/assets/images/USB_Drag_Drop.png b/docs/assets/images/USB_Drag_Drop.png index 8167000..e0c0dfa 100644 Binary files a/docs/assets/images/USB_Drag_Drop.png and b/docs/assets/images/USB_Drag_Drop.png differ diff --git a/docs/assets/images/USB_Drive.png b/docs/assets/images/USB_Drive.png index da1d47d..01a8eff 100644 Binary files a/docs/assets/images/USB_Drive.png and b/docs/assets/images/USB_Drive.png differ diff --git a/docs/assets/images/gmenu2x.png b/docs/assets/images/gmenu2x.png new file mode 100644 index 0000000..bee111f Binary files /dev/null and b/docs/assets/images/gmenu2x.png differ diff --git a/docs/tutorials/software/add_roms.md b/docs/tutorials/software/add_roms.md index a0aea94..cf41aed 100644 --- a/docs/tutorials/software/add_roms.md +++ b/docs/tutorials/software/add_roms.md @@ -1,4 +1,26 @@ +Connect your **FunKey S** console to your computer and add new games +as simply as you would do it with a simple USB memory stick: + +| **Display** | **Action** | +|:--------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png) | 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) | At the launcher's main screen (example here with RetroFE), press the **MENU** key | +| ![Mount USB](/assets/images/Mount_USB.png) | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png) | Press the **A** key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png) | "**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) | 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) | Drag & drop the ROM file and optional artwork file[^1] into the folder corresponding to the emulated console in this USB drive on your computer | +| ![Eject Drive](/assets/images/Eject_Drive.png) | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png) | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the "**A**" key twice to confirm | +| ![Unmout USB](/assets/images/Mount_USB.png) | Press the **MENU** 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! + +[^1]: The artwork file must have the same base name as the ROM file, +with a _.png_ or _.jpg_ extension, preferably with a 240 x 240 +resolution. --8<-- includes/glossary.md ---8<-- \ No newline at end of file +--8<-- diff --git a/docs/tutorials/software/copy_opk.md b/docs/tutorials/software/copy_opk.md index e69de29..2ed57c9 100644 --- a/docs/tutorials/software/copy_opk.md +++ b/docs/tutorials/software/copy_opk.md @@ -0,0 +1,40 @@ +**OPK** (Open PacKage) files are archive files that contains +emulators, standalone games, applications or utilities along with all +their associated resources like icons packed into a single file that +does not require installation to be able to run them. + +!!! Note + + In the current (2.0.0) release of the FunKey-OS, the **OPK** files are only available for the gmenu2x launcher, and not in RetroFE. + +[7-Zip][1] can be used to extract **OPK** files, and [Open Package +Creator (v1.1.2)][2] is a useful tool if you want to re-package an +**OPK** or customize icons, add additional games and much more. + +Connect your **FunKey S** console to your computer and add **OPK** +files as simply as you would do it with a simple USB memory stick: + +| **Display** | **Action** | +|:----------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png) | 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) | At the launcher's main screen (example here with gmenu2x), press the **MENU** key | +| ![Mount USB](/assets/images/Mount_USB_gmenu2x.png) | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png) | Press the **A** key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB_gmenu2x.png) | "**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) | 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) | 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) | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure_gmenu2x.png) | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the "**A**" key twice to confirm | +| ![Unmout USB](/assets/images/Mount_USB_gmenu2x.png) | Press the **MENU** 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! + +[1]: https://www.7-zip.org/download.html +[2]: https://github.com/Harteex/OpenPackageCreator/releases + +[^1]: You can create additional 1st-level folders in order to organize your **OPK** files just like you want. + +--8<-- +includes/glossary.md +--8<-- diff --git a/docs/tutorials/software/update.md b/docs/tutorials/software/update.md index 9996eec..24706ca 100644 --- a/docs/tutorials/software/update.md +++ b/docs/tutorials/software/update.md @@ -9,18 +9,18 @@ https://github.com/FunKey-Project/FunKey-OS/releases/latest ![Github Release](/assets/images/Github_Release.png) -| **Display** | **Action** | -|:-----------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------| -| ![RetroFE](/assets/images/Connection_PC.png) | 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) | At the launcher's main screen (example here with RetroFE), press the **MENU** key | -| ![RetroFE](/assets/images/Mount_USB.png) | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" | -| ![RetroFE](/assets/images/Mount_USB_are_you_sure.png) | Press the **A** key twice to confirm | -| ![RetroFE](/assets/images/Eject_USB.png) | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window | -| ![RetroFE](/assets/images/USB_Drive.png) | You should see the FunKey S appear as an USB drive on your computer in the File Explorer (example here with Windows 10) | -| ![RetroFE](/assets/images/USB_Drag_Drop.png) | Drag & drop the _FunKey-roots-2.0.0.fwu_ file you just downloaded at the root of this USB drive on your computer | -| ![RetroFE](/assets/images/Eject_Drive.png) | Eject cleanly the USB drive from your computer | -| ![RetroFE](/assets/images/Eject_USB_are_you_sure.png) | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the "**A**" key twice to confirm | -| ![RetroFE](/assets/images/Updating.png) | The **FunKey S** will then reboot and perform the upgrade | +| **Display** | **Action** | +|:--------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------| +| ![Connection PC](/assets/images/Connection_PC.png) | 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) | At the launcher's main screen (example here with RetroFE), press the **MENU** key | +| ![Mount USB](/assets/images/Mount_USB.png) | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" | +| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png) | Press the **A** key twice to confirm | +| ![Eject USB](/assets/images/Eject_USB.png) | "**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) | 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) | 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) | Eject cleanly the USB drive from your computer | +| ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png) | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the "**A**" key twice to confirm | +| ![Updating](/assets/images/Updating.png) | 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 diff --git a/includes/glossary.md b/includes/glossary.md index 0269eff..58b39a9 100644 --- a/includes/glossary.md +++ b/includes/glossary.md @@ -23,6 +23,7 @@ *[LiPo]: Lithium Polymer *[MIPI]: Mobile Industry Processor Interface *[NTC]: Negative Temperature Coefficient +*[OPK]: Open Package *[OTG]: On-The-Go *[PCBA]: Printed Circuit Board Assembly *[PCB]: Printed Circuit Board diff --git a/mkdocs.yml b/mkdocs.yml index a66bd14..88e4e82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -106,7 +106,7 @@ nav: - 'Overview': 'index.md' - User's manual: - 'Quickstart': 'quickstart.md' - - Product's description: + - Product description: - 'Key mapping': 'features/key_mapping.md' - 'Launchers': 'features/launchers.md' - 'Emulators': 'features/emulators.md' @@ -117,8 +117,8 @@ nav: - 'Instant action': 'features/instant_action.md' - Tutorials: - Software: - - 'Add new roms': 'tutorials/software/add_roms.md' - - 'Add opk files': 'tutorials/software/copy_opk.md' + - 'Add new ROMs': 'tutorials/software/add_roms.md' + - 'Add OPK files': 'tutorials/software/copy_opk.md' - 'Install the GBA/PS1 BIOS': 'tutorials/software/gba_bios.md' - 'Change aspect ratio': 'tutorials/software/aspect_ratio.md' - 'Take a snapshot': 'tutorials/software/snapshot.md'