funkey/FunKey-Project.github.io
1
0
Fork 0
mirror of https://github.com/FunKey-Project/FunKey-Project.github.io.git synced 2025-12-12 18:28:51 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add ROM and OPK drag and drop tutorial

Browse Source 
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK 2021-01-21 09:21:22 +01:00
parent 4f07ef4e25
commit f0ada68cc5
17 changed files with 79 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/assets/images/Copy_GBA_BIOS.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 71 KiB

BIN
docs/assets/images/Copy_OPK.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 65 KiB

BIN
docs/assets/images/Copy_PS1_BIOS.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 59 KiB

BIN
docs/assets/images/Copy_ROM.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

BIN
docs/assets/images/Eject_Drive.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 120 KiB

BIN
docs/assets/images/Eject_USB_are_you_sure_gmenu2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/assets/images/Eject_USB_gmenu2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/assets/images/Mount_USB_are_you_sure_gmenu2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/assets/images/Mount_USB_gmenu2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/assets/images/USB_Drag_Drop.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 49 KiB

BIN
docs/assets/images/USB_Drive.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 53 KiB

BIN
docs/assets/images/gmenu2x.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 51 KiB

22
docs/tutorials/software/add_roms.md
View File

@ -1,3 +1,25 @@
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<-- --8<--
includes/glossary.md includes/glossary.md

40
docs/tutorials/software/copy_opk.md
View File

@ -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<--

20
docs/tutorials/software/update.md
View File

@ -10,17 +10,17 @@ https://github.com/FunKey-Project/FunKey-OS/releases/latest
![Github Release](/assets/images/Github_Release.png) ![Github Release](/assets/images/Github_Release.png)
| **Display** | **Action** | | **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 | | ![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 | | ![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**" | | ![Mount USB](/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 | | ![Mount USB Are you sure](/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 | | ![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 |
| ![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) | | ![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) |
| ![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 | | ![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 |
| ![RetroFE](/assets/images/Eject_Drive.png) | Eject cleanly the USB drive from your computer | | ![Eject Drive](/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 | | ![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 |
| ![RetroFE](/assets/images/Updating.png) | The **FunKey S** will then reboot and perform the upgrade | | ![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 [1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.0.0/FunKey-rootfs-2.0.0.fwu

1
includes/glossary.md
View File

@ -23,6 +23,7 @@
*[LiPo]: Lithium Polymer *[LiPo]: Lithium Polymer
*[MIPI]: Mobile Industry Processor Interface *[MIPI]: Mobile Industry Processor Interface
*[NTC]: Negative Temperature Coefficient *[NTC]: Negative Temperature Coefficient
*[OPK]: Open Package
*[OTG]: On-The-Go *[OTG]: On-The-Go
*[PCBA]: Printed Circuit Board Assembly *[PCBA]: Printed Circuit Board Assembly
*[PCB]: Printed Circuit Board *[PCB]: Printed Circuit Board

6
mkdocs.yml
View File

@ -106,7 +106,7 @@ nav:
- 'Overview': 'index.md' - 'Overview': 'index.md'
- User's manual: - User's manual:
- 'Quickstart': 'quickstart.md' - 'Quickstart': 'quickstart.md'
- Product's description: - Product description:
- 'Key mapping': 'features/key_mapping.md' - 'Key mapping': 'features/key_mapping.md'
- 'Launchers': 'features/launchers.md' - 'Launchers': 'features/launchers.md'
- 'Emulators': 'features/emulators.md' - 'Emulators': 'features/emulators.md'
@ -117,8 +117,8 @@ nav:
- 'Instant action': 'features/instant_action.md' - 'Instant action': 'features/instant_action.md'
- Tutorials: - Tutorials:
- Software: - Software:
- 'Add new roms': 'tutorials/software/add_roms.md' - 'Add new ROMs': 'tutorials/software/add_roms.md'
- 'Add opk files': 'tutorials/software/copy_opk.md' - 'Add OPK files': 'tutorials/software/copy_opk.md'
- 'Install the GBA/PS1 BIOS': 'tutorials/software/gba_bios.md' - 'Install the GBA/PS1 BIOS': 'tutorials/software/gba_bios.md'
- 'Change aspect ratio': 'tutorials/software/aspect_ratio.md' - 'Change aspect ratio': 'tutorials/software/aspect_ratio.md'
- 'Take a snapshot': 'tutorials/software/snapshot.md' - 'Take a snapshot': 'tutorials/software/snapshot.md'