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

dos2unix

Browse Source 
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK 2021-01-23 19:26:20 +01:00
parent 73b2a257a8
commit 33a9f6d237
22 changed files with 173 additions and 173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/developers/software_ref/boot_process/bootloader.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/software_ref/boot_process/shutdown.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/tutorials/build_system/build_program_using_sdk.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/tutorials/build_system/build_system.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/tutorials/build_system/compilation_environments.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/tutorials/recovery.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/tutorials/ssh_connection.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/developers/tutorials/uart_connection.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/emulators.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/folder_organization.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/funkey_menu.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/games_apps.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/instant_action.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/key_mapping.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/launchers.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/features/quick_save.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/tutorials/hardware/change_sd_card.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/tutorials/hardware/force_shutdown.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

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

@ -1,26 +1,26 @@
Connect your **FunKey S** console to your computer and add new games 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: as simply as you would do it with a simple USB memory stick:
| **Display** | **Action** | | **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 | | ![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 **MENU** key | | ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the **MENU** key |
| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" | | ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" |
| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the **A** key twice to confirm | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the **A** 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 | | ![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 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[^1] into the folder corresponding to the emulated console in this USB drive on your computer | | ![Copy ROM](/assets/images/Copy_ROM.png){: .lightbox} | 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){: .lightbox} | Eject cleanly the USB drive from 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 "**A**" 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 "**A**" key twice to confirm |
| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **MENU** key to return to the launcher screen | | ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **MENU** key to return to the launcher screen |
Of course, you can remove games from the **FunKey S** console as you Of course, you can remove games from the **FunKey S** console as you
would do with a USB memory stick, too! would do with a USB memory stick, too!
[^1]: The artwork file must have the same base name as the ROM file, [^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 with a _.png_ or _.jpg_ extension, preferably with a 240 x 240
resolution. resolution.
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

128
docs/tutorials/software/aspect_ratio.md
View File

@ -1,64 +1,64 @@
The **FunKey S** provides 2 ways to to allow in-game change of the The **FunKey S** provides 2 ways to to allow in-game change of the
display aspect ratio: display aspect ratio:
1. Using quick shortcuts 1. Using quick shortcuts
2. Using the FunKey menu 2. Using the FunKey menu
## Quick shortcuts ## Quick shortcuts
- **Fn** + **DOWN**: Change Aspect Ratio (AR), cycle between: - **Fn** + **DOWN**: Change Aspect Ratio (AR), cycle between:
- Stretched (default) - Stretched (default)
- Cropped - Cropped
- Scaled - Scaled
- Manual Zoom - Manual Zoom
- **Fn** + **LEFT**: Decrease zoom level by 10% - **Fn** + **LEFT**: Decrease zoom level by 10%
- **Fn** + **RIGHT**: Increase Zoom level by 10% - **Fn** + **RIGHT**: Increase Zoom level by 10%
## FunKey menu ## FunKey menu
- Press the **MENU** key to enter the FunKey menu - Press the **MENU** key to enter the FunKey menu
- Press the **UP** or **DOWN** key to select the "**ASPECT RATIO**" setting - Press the **UP** or **DOWN** key to select the "**ASPECT RATIO**" setting
- Use the **LEFT** and **RIGHT** keys to change the aspect ratio - Use the **LEFT** and **RIGHT** keys to change the aspect ratio
| **Display** | **Aspect Ratio** | | **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 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 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 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 |
- Press the **MENU** key again to exit from the FunKey menu - Press the **MENU** key again to exit from the FunKey menu
## Aspect ratio preview ## Aspect ratio preview
Here is a short preview of what the different aspect ratios look like: Here is a short preview of what the different aspect ratios look like:
| **Display** | **Aspect Ratio** | | **Display** | **Aspect Ratio** |
|:-------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------| |:-------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------|
| ![Stretched](/assets/images/Stretched.png){: .lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | | ![Stretched](/assets/images/Stretched.png){: .lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions |
| ![Cropped](/assets/images/Cropped.png){: .lightbox} | Cropped (Zoom 100%): The display fills the screen vertically, and is clipped vertically to the left and right of the screen | | ![Cropped](/assets/images/Cropped.png){: .lightbox} | Cropped (Zoom 100%): The display fills the screen vertically, and is clipped vertically to the left and right of the screen |
| ![Scaled](/assets/images/Scaled.png){: .lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically | | ![Scaled](/assets/images/Scaled.png){: .lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically |
| ![Scaled](/assets/images/Scaled.png){: .lightbox} | Manual zoom 0% (Scaled): The display is scaled down in both directions to be fully visible, both horizontally and vertically | | ![Scaled](/assets/images/Scaled.png){: .lightbox} | Manual zoom 0% (Scaled): The display is scaled down in both directions to be fully visible, both horizontally and vertically |
| ![Zoom 10%](/assets/images/Zoom10.png){: .lightbox} | Manual zoom 10% | | ![Zoom 10%](/assets/images/Zoom10.png){: .lightbox} | Manual zoom 10% |
| ![Zoom 20%](/assets/images/Zoom20.png){: .lightbox} | Manual zoom 20% | | ![Zoom 20%](/assets/images/Zoom20.png){: .lightbox} | Manual zoom 20% |
| ![Zoom 30%](/assets/images/Zoom30.png){: .lightbox} | Manual zoom 30% | | ![Zoom 30%](/assets/images/Zoom30.png){: .lightbox} | Manual zoom 30% |
| ![Zoom 40%](/assets/images/Zoom40.png){: .lightbox} | Manual zoom 40% | | ![Zoom 40%](/assets/images/Zoom40.png){: .lightbox} | Manual zoom 40% |
| ![Zoom 50%](/assets/images/Zoom50.png){: .lightbox} | Manual zoom 50% (default zoom level) | | ![Zoom 50%](/assets/images/Zoom50.png){: .lightbox} | Manual zoom 50% (default zoom level) |
| ![Zoom 60%](/assets/images/Zoom60.png){: .lightbox} | Manual zoom 60% | | ![Zoom 60%](/assets/images/Zoom60.png){: .lightbox} | Manual zoom 60% |
| ![Zoom 70%](/assets/images/Zoom70.png){: .lightbox} | Manual zoom 70% | | ![Zoom 70%](/assets/images/Zoom70.png){: .lightbox} | Manual zoom 70% |
| ![Zoom 80%](/assets/images/Zoom80.png){: .lightbox} | Manual zoom 80% | | ![Zoom 80%](/assets/images/Zoom80.png){: .lightbox} | Manual zoom 80% |
| ![Zoom 90%](/assets/images/Zoom90.png){: .lightbox} | Manual zoom 90% | | ![Zoom 90%](/assets/images/Zoom90.png){: .lightbox} | Manual zoom 90% |
| ![Cropped](/assets/images/Cropped.png){: .lightbox} | Manual zoom 100% (Cropped): The display fills the screen vertically, and is clipped vertically to the left and right of the screen | | ![Cropped](/assets/images/Cropped.png){: .lightbox} | Manual zoom 100% (Cropped): The display fills the screen vertically, and is clipped vertically to the left and right of the screen |
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

6
docs/tutorials/software/restore_games.md
View File

@ -1,4 +1,4 @@
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--

52
docs/tutorials/software/snapshot.md
View File

@ -1,26 +1,26 @@
The **FunKey S** allows to take in-game snapshots using a simple The **FunKey S** allows to take in-game snapshots using a simple
shortcut: just press the **Fn** + **UP** keys simultaneously. shortcut: just press the **Fn** + **UP** keys simultaneously.
The snapshot files will be located in the _FunKey/snapshots_ folder on The snapshot files will be located in the _FunKey/snapshots_ folder on
the host computer and they will be numbered following a the host computer and they will be numbered following a
"**IMG_nnnn.PNG**" pattern, with "_nnnn_" being a number starting at "**IMG_nnnn.PNG**" pattern, with "_nnnn_" being a number starting at
0001 and up to 9999. 0001 and up to 9999.
In order to access the snapshots, follow these simple steps: In order to access the snapshots, follow these simple steps:
| **Display** | **Action** | | **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 | | ![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 **MENU** key | | ![RetroFE](/assets/images/RetroFE.png){: .lightbox} | At the launcher's main screen (example here with RetroFE), press the **MENU** key |
| ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" | | ![Mount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **UP**/**DOWN** keys until you see "**MOUNT USB**" |
| ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the **A** key twice to confirm | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox} | Press the **A** 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 | | ![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 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 | | ![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 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 "**A**" 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 "**A**" key twice to confirm |
| ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **MENU** key to return to the launcher screen | | ![Unmount USB](/assets/images/Mount_USB.png){: .lightbox} | Press the **MENU** key to return to the launcher screen |
--8<-- --8<--
includes/glossary.md includes/glossary.md
--8<-- --8<--