mirror of
https://github.com/FunKey-Project/FunKey-Project.github.io.git
synced 2026-03-19 10:22:42 +01:00
- Commented several empty sections in mkdocs.yml (will reactivate them later if someone fills them)
- Enabled 'Directory Structure' section that was not present in mkdocs.yml - Removed all links to empty sections - Fixed incorrect links that led to a 404 error - Updated art covers url - Redirected former FunKey OS links to my release page - Updated a few things in some sections - Fixed a few typos
This commit is contained in:
DrUm78
@@ -13,7 +13,7 @@ Get the latest "***FunKey-rootfs-x.y.z.img***" SD card image file
|
||||
directly from [here][1] or from the bottom of the latest release page
|
||||
in the "assets" section:
|
||||
|
||||
[https://github.com/FunKey-Project/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
[https://github.com/DrUm78/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
|
||||
{.lightbox}
|
||||
|
||||
@@ -123,8 +123,8 @@ Reassemble the console by following the previous steps in reverse order.
|
||||
Be careful not to damage the switches on the circuit board when
|
||||
putting back the L/R plastic buttons.
|
||||
|
||||
[1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.3.0/FunKey-sdcard-2.3.0.img
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/latest
|
||||
[1]: https://github.com/DrUm78/FunKey-OS/releases/download/FunKey-OS-DrUm78/FunKey-sdcard-DrUm78.img
|
||||
[2]: https://github.com/DrUm78/FunKey-OS/releases/latest
|
||||
[3]: https://www.balena.io/etcher/
|
||||
[4]: #flashing-a-new-micro-sd-card
|
||||
|
||||
|
||||
@@ -5,11 +5,11 @@ 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.
|
||||
In the current release of the FunKey-OS (DrUm78's version), the **OPK** files
|
||||
are available both for the GMenu2X and RetroFE launchers. See documentation [here.][3]
|
||||
|
||||
[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
|
||||
Creator][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**
|
||||
@@ -33,6 +33,7 @@ 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
|
||||
[3]: https://github.com/DrUm78/FunKey-OS/releases/latest
|
||||
|
||||
[^1]: You can create additional 1st-level folders in order to organize your **OPK** files just like you want.
|
||||
|
||||
|
||||
@@ -5,9 +5,7 @@ purchase and play famous ROMs legally such as Sonic, Castlevania,
|
||||
Megaman and more, read the note below for more details.
|
||||
|
||||
**The FunKey Wiki** maintains [lists][1]{target=_blank} of legal
|
||||
sources for ROMs, including [freeware ROMs][2]{target=_blank},
|
||||
[commercial ROMs][3]{target=_blank}, and
|
||||
[utilities][4]{target=_blank}.
|
||||
sources for ROMs, including [freeware ROMs][2]{target=_blank} and [commercial ROMs][3]{target=_blank}.
|
||||
|
||||
!!! note "Note about ROM emulation"
|
||||
|
||||
@@ -42,7 +40,7 @@ as simply as you would do it with a simple USB memory stick:
|
||||
| {.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |
|
||||
| {.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) |
|
||||
| {.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<br /><br />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)<br />An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster <a href="https://drive.google.com/drive/folders/1UY4J8b6eMtG_IEtvHLOqGLm-DSgMkokA" target="_blank">here</a>. <br />An otherwise complete list of artwork can be found <a href="https://github.com/libretro-thumbnails/libretro-thumbnails" target="_blank">here</a>. |
|
||||
| {.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<br /><br />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)<br />An extensive **list of artwork files** (already resized to 240x240) has been made by Coolie Coolster <a href="https://drive.google.com/drive/folders/1k55I5ig_wISP5RGjnH6K63H4LV9s-g3U" target="_blank">here</a>. <br />An otherwise complete list of artwork can be found <a href="https://github.com/libretro-thumbnails/libretro-thumbnails" target="_blank">here</a>. |
|
||||
| {.lightbox} | Eject cleanly the USB drive from your computer |
|
||||
| {.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |
|
||||
|
||||
@@ -5,7 +5,7 @@ Get the latest "**_FunKey-rootfs-x.y.z.fwu_**" firmware update file
|
||||
directly from [here][1] or from the bottom of the latest release page
|
||||
in the "assets" section:
|
||||
|
||||
[https://github.com/FunKey-Project/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
[https://github.com/DrUm78/FunKey-OS/releases/latest][2]{target=_blank}
|
||||
|
||||
{.lightbox}
|
||||
|
||||
@@ -22,8 +22,8 @@ in the "assets" section:
|
||||
| {.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | The **FunKey S** will then reboot and perform the upgrade |
|
||||
|
||||
[1]: https://github.com/FunKey-Project/FunKey-OS/releases/download/FunKey-OS-2.3.0/FunKey-rootfs-2.3.0.fwu
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/latest
|
||||
[1]: https://github.com/DrUm78/FunKey-OS/releases/download/FunKey-OS-DrUm78/FunKey-rootfs-DrUm78.fwu
|
||||
[2]: https://github.com/DrUm78/FunKey-OS/releases/latest
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
|
||||
@@ -44,6 +44,8 @@ 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** |
|
||||
@@ -54,7 +56,7 @@ BIOS file name: SCPH1001.BIN
|
||||
| {.lightbox} | Press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | "**EJECT USB**" is now displayed instead, now go to your host computer and open a File Explorer window |
|
||||
| {.lightbox} | You should see the **FunKey S** appear as an USB drive on your computer in the File Explorer (example here with Windows 10) |
|
||||
| {.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**PS1/bios**_ folder in this USB drive on your computer |
|
||||
| {.lightbox} | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**FunKey/.pcsx/bios**_ folder in this USB drive on your computer |
|
||||
| {.lightbox} | Eject cleanly the USB drive from your computer |
|
||||
| {.lightbox} | Back on the **FunKey S**, at the "**EJECT USB**" menu entry, press the <i class="funkey-A"></i> key twice to confirm |
|
||||
| {.lightbox} | Press the <i class="funkey-menu"></i> key to return to the launcher screen |
|
||||
|
||||
Reference in New Issue
Block a user