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 picture lightbox

Browse Source 
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK 2021-01-23 18:03:13 +01:00
parent 1077996988
commit f14ab87c84
15 changed files with 196 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/assets/css/custom.css Normal file
View File

@ -0,0 +1,27 @@
/* custom.css */
a.boxedThumb {
display: block;
padding: 4px;
line-height: 20px;
border: 1px solid #ddd;
-webkit-border-radius: 4px;
-moz-border-radius: 4px;
border-radius: 4px;
-webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.055);
-moz-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.055);
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.055);
-webkit-transition: -webkit-transform .15s ease;
-moz-transition: -moz-transform .15s ease;
-o-transition: -o-transform .15s ease;
-ms-transition: -ms-transform .15s ease;
transition: transform .15s ease;
}
a.boxedThumb:hover {
-webkit-transform: scale(1.05);
-moz-transform: scale(1.05);
-o-transform: scale(1.05);
-ms-transform: scale(1.05);
transform: scale(1.05);
z-index: 5;
}

7
docs/assets/css/simple-lightbox.min.css vendored Normal file
View File

@ -0,0 +1,7 @@
/*!
By André Rinas, www.andrerinas.de
Documentation, www.simplelightbox.de
Available for use under the MIT License
Version 2.7.0
*/
body.hidden-scroll{overflow:hidden}.sl-overlay{position:fixed;left:0;right:0;top:0;bottom:0;background:#fff;opacity:.7;display:none;z-index:1035}.sl-wrapper{z-index:1040;width:100%;height:100%;left:0;top:0;position:fixed}.sl-wrapper *{box-sizing:border-box}.sl-wrapper button{border:0 none;background:transparent;font-size:28px;padding:0;cursor:pointer}.sl-wrapper button:hover{opacity:0.7}.sl-wrapper .sl-close{display:none;position:fixed;right:30px;top:30px;z-index:10060;margin-top:-14px;margin-right:-14px;height:44px;width:44px;line-height:44px;font-family:Arial,Baskerville,monospace;color:#000;font-size:3rem}.sl-wrapper .sl-counter{display:none;position:fixed;top:30px;left:30px;z-index:1060;color:#000;font-size:1rem}.sl-wrapper .sl-navigation{width:100%;display:none}.sl-wrapper .sl-navigation button{position:fixed;top:50%;margin-top:-22px;height:44px;width:22px;line-height:44px;text-align:center;display:block;z-index:10060;font-family:Arial,Baskerville,monospace;color:#000}.sl-wrapper .sl-navigation button.sl-next{right:5px;font-size:2rem}.sl-wrapper .sl-navigation button.sl-prev{left:5px;font-size:2rem}@media (min-width: 35.5em){.sl-wrapper .sl-navigation button{width:44px}.sl-wrapper .sl-navigation button.sl-next{right:10px;font-size:3rem}.sl-wrapper .sl-navigation button.sl-prev{left:10px;font-size:3rem}}@media (min-width: 50em){.sl-wrapper .sl-navigation button{width:44px}.sl-wrapper .sl-navigation button.sl-next{right:20px;font-size:3rem}.sl-wrapper .sl-navigation button.sl-prev{left:20px;font-size:3rem}}.sl-wrapper.sl-dir-rtl .sl-navigation{direction:ltr}.sl-wrapper .sl-image{position:fixed;-ms-touch-action:none;touch-action:none;z-index:10000}.sl-wrapper .sl-image img{margin:0;padding:0;display:block;border:0 none;width:100%;height:auto}@media (min-width: 35.5em){.sl-wrapper .sl-image img{border:0 none}}@media (min-width: 50em){.sl-wrapper .sl-image img{border:0 none}}.sl-wrapper .sl-image iframe{background:#000;border:0 none}@media (min-width: 35.5em){.sl-wrapper .sl-image iframe{border:0 none}}@media (min-width: 50em){.sl-wrapper .sl-image iframe{border:0 none}}.sl-wrapper .sl-image .sl-caption{display:none;padding:10px;color:#fff;background:rgba(0,0,0,0.8);font-size:1rem;position:absolute;bottom:0;left:0;right:0}.sl-wrapper .sl-image .sl-caption.pos-top{bottom:auto;top:0}.sl-wrapper .sl-image .sl-caption.pos-outside{bottom:auto}.sl-wrapper .sl-image .sl-download{display:none;position:absolute;bottom:5px;right:5px;color:#000;z-index:1060}.sl-spinner{display:none;border:5px solid #333;border-radius:40px;height:40px;left:50%;margin:-20px 0 0 -20px;opacity:0;position:fixed;top:50%;width:40px;z-index:1007;-webkit-animation:pulsate 1s ease-out infinite;-moz-animation:pulsate 1s ease-out infinite;-ms-animation:pulsate 1s ease-out infinite;-o-animation:pulsate 1s ease-out infinite;animation:pulsate 1s ease-out infinite}.sl-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}.sl-transition{transition:-moz-transform ease 200ms;transition:-ms-transform ease 200ms;transition:-o-transform ease 200ms;transition:-webkit-transform ease 200ms;transition:transform ease 200ms}@-webkit-keyframes pulsate{0%{transform:scale(0.1);opacity:0.0}50%{opacity:1}100%{transform:scale(1.2);opacity:0}}@keyframes pulsate{0%{transform:scale(0.1);opacity:0.0}50%{opacity:1}100%{transform:scale(1.2);opacity:0}}@-moz-keyframes pulsate{0%{transform:scale(0.1);opacity:0.0}50%{opacity:1}100%{transform:scale(1.2);opacity:0}}@-o-keyframes pulsate{0%{transform:scale(0.1);opacity:0.0}50%{opacity:1}100%{transform:scale(1.2);opacity:0}}@-ms-keyframes pulsate{0%{transform:scale(0.1);opacity:0.0}50%{opacity:1}100%{transform:scale(1.2);opacity:0}}

24
docs/assets/js/custom.js Normal file
View File

@ -0,0 +1,24 @@
$(document).ready(function () {
let imageGroups = []
$(".lightbox").each(function () {
let imageSource = $(this).attr('src')
let imageTag = $(this).attr('tag')
let imageTitle = $(this).attr('title')
if (imageTitle) {
imageTitle = 'title="' + imageTitle + '" '
}
else {
imageTitle = ''
}
$(this).
wrap('<a class="boxedThumb ' + imageTag + '" ' +
imageTitle + 'href="' + imageSource + '"></a>')
imageGroups.push('.' + imageTag)
})
jQuery.unique(imageGroups)
imageGroups.forEach(imageGroupsSet)
function imageGroupsSet (value) {
$(value).simpleLightbox()
}
})

24
docs/assets/js/custom.js~ Normal file
View File

@ -0,0 +1,24 @@
$(document).ready(function () {
let productImageGroups = []
$('.img-fluid').each(function () {
let productImageSource = $(this).attr('src')
let productImageTag = $(this).attr('tag')
let productImageTitle = $(this).attr('title')
if (productImageTitle) {
productImageTitle = 'title="' + productImageTitle + '" '
}
else {
productImageTitle = ''
}
$(this).
wrap('<a class="boxedThumb ' + productImageTag + '" ' +
productImageTitle + 'href="' + productImageSource + '"></a>')
productImageGroups.push('.' + productImageTag)
})
jQuery.unique(productImageGroups)
productImageGroups.forEach(productImageGroupsSet)
function productImageGroupsSet (value) {
$(value).simpleLightbox()
}
})

2
docs/assets/js/jquery-3.5.1.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/simple-lightbox.jquery.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/assets/js/simple-lightbox.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

6
docs/tutorials/hardware/open_console.md → docs/tutorials/hardware/disassembling_console.md
View File

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

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

@ -1,18 +1,18 @@
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** |
|:--------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------| |:---------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------|
| ![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 | | ![PC Connection](/assets/images/Connection_PC.png){: .lightbox tag=1} | 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){: .lightbox tag=2} | 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](/assets/images/Mount_USB.png){: .lightbox tag=3} | 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 | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox tag=4} | 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 | | ![Eject USB](/assets/images/Eject_USB.png){: .lightbox tag=5} | "**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 Drive](/assets/images/USB_Drive.png){: .lightbox tag=6} | 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 | | ![Copy ROM](/assets/images/Copy_ROM.png){: .lightbox tag=7} | 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 Drive](/assets/images/Eject_Drive.png){: .lightbox tag=8} | 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 | | ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox tag=9} | 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 | | ![Unmout USB](/assets/images/Mount_USB.png){: .lightbox tag=10} | 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!

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

@ -29,12 +29,12 @@ display aspect ratio:
- 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) | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | | ![Menu Stretched](/assets/images/Menu_Stretched.png){: .lightbox tag=1} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions |
| ![Menu Cropped](/assets/images/Menu_Cropped.png) | 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 tag=2} | 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) | 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 tag=3} | 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) | Manual zoom: The display is zoomed in/out manually | | ![Menu Manual Zoom](/assets/images/Menu_Manual_Zoom.png){: .lightbox tag=4} | 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
@ -42,22 +42,22 @@ display aspect ratio:
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) | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions | | ![Stretched](/assets/images/Stretched.png){: .lightbox tag=5} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions |
| ![Cropped](/assets/images/Cropped.png) | 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 tag=6} | 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) | 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 tag=7} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically |
| ![Scaled](/assets/images/Scaled.png) | 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 tag=8} | 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) | Manual zoom 10% | | ![Zoom 10%](/assets/images/Zoom10.png){: .lightbox tag=9} | Manual zoom 10% |
| ![Zoom 20%](/assets/images/Zoom20.png) | Manual zoom 20% | | ![Zoom 20%](/assets/images/Zoom20.png){: .lightbox tag=10} | Manual zoom 20% |
| ![Zoom 30%](/assets/images/Zoom30.png) | Manual zoom 30% | | ![Zoom 30%](/assets/images/Zoom30.png){: .lightbox tag=11} | Manual zoom 30% |
| ![Zoom 40%](/assets/images/Zoom40.png) | Manual zoom 40% | | ![Zoom 40%](/assets/images/Zoom40.png){: .lightbox tag=12} | Manual zoom 40% |
| ![Zoom 50%](/assets/images/Zoom50.png) | Manual zoom 50% (default zoom level) | | ![Zoom 50%](/assets/images/Zoom50.png){: .lightbox tag=13} | Manual zoom 50% (default zoom level) |
| ![Zoom 60%](/assets/images/Zoom60.png) | Manual zoom 60% | | ![Zoom 60%](/assets/images/Zoom60.png){: .lightbox tag=14} | Manual zoom 60% |
| ![Zoom 70%](/assets/images/Zoom70.png) | Manual zoom 70% | | ![Zoom 70%](/assets/images/Zoom70.png){: .lightbox tag=15} | Manual zoom 70% |
| ![Zoom 80%](/assets/images/Zoom80.png) | Manual zoom 80% | | ![Zoom 80%](/assets/images/Zoom80.png){: .lightbox tag=16} | Manual zoom 80% |
| ![Zoom 90%](/assets/images/Zoom90.png) | Manual zoom 90% | | ![Zoom 90%](/assets/images/Zoom90.png){: .lightbox tag=17} | Manual zoom 90% |
| ![Cropped](/assets/images/Cropped.png) | 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 tag=18} | 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

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

@ -14,18 +14,18 @@ Creator (v1.1.2)][2] is a useful tool if you want to re-package an
Connect your **FunKey S** console to your computer and add **OPK** 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: files as simply as you would do it with a simple USB memory stick:
| **Display** | **Action** | | **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 | | ![Connection PC](/assets/images/Connection_PC.png){: .lightbox tag=1} | 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 | | ![RetroFE](/assets/images/gmenu2x.png){: .lightbox tag=2} | 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](/assets/images/Mount_USB_gmenu2x.png){: .lightbox tag=3} | 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 | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure_gmenu2x.png){: .lightbox tag=4} | 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 | | ![Eject USB](/assets/images/Eject_USB_gmenu2x.png){: .lightbox tag=5} | "**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 Drive](/assets/images/USB_Drive.png){: .lightbox tag=6} | 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** | | ![Copy OPK](/assets/images/Copy_OPK.png){: .lightbox tag=7} | 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 Drive](/assets/images/Eject_Drive.png){: .lightbox tag=8} | 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 | | ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure_gmenu2x.png){: .lightbox tag=9} | 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 | | ![Unmout USB](/assets/images/Mount_USB_gmenu2x.png){: .lightbox tag=10} | Press the **MENU** key to return to the launcher screen |
Of course, you can remove **OPK** files from the **FunKey S** console Of course, you can remove **OPK** files from the **FunKey S** console
as you would do with a USB memory stick, too! as you would do with a USB memory stick, too!

48
docs/tutorials/software/gba_bios.md
View File

@ -22,18 +22,18 @@ one of the proposed links.
### Installation procedure ### Installation procedure
| **Display** | **Action** | | **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 | | ![Connection PC](/assets/images/Connection_PC.png){: .lightbox tag=1} | 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){: .lightbox tag=2} | 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](/assets/images/Mount_USB.png){: .lightbox tag=3} | 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 | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox tag=4} | 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 | | ![Eject USB](/assets/images/Eject_USB.png){: .lightbox tag=5} | "**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 Drive](/assets/images/USB_Drive.png){: .lightbox tag=6} | 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) | Drag & drop the _**gba_bios.bin**_ BIOS file into the _**Game Boy Advance**_ folder in this USB drive on your computer | | ![Copy ROM](/assets/images/Copy_GBA_BIOS.png){: .lightbox tag=7} | 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) | Eject cleanly the USB drive from your computer | | ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox tag=8} | 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 | | ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox tag=9} | 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 | | ![Unmout USB](/assets/images/Mount_USB.png){: .lightbox tag=10} | Press the **MENU** key to return to the launcher screen |
## PS1 ## PS1
@ -53,18 +53,18 @@ links.
### Installation procedure ### Installation procedure
| **Display** | **Action** | | **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 | | ![Connection PC](/assets/images/Connection_PC.png){: .lightbox tag=11} | 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){: .lightbox tag=12} | 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](/assets/images/Mount_USB.png){: .lightbox tag=13} | 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 | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox tag=14} | 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 | | ![Eject USB](/assets/images/Eject_USB.png){: .lightbox tag=15} | "**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 Drive](/assets/images/USB_Drive.png){: .lightbox tag=16} | 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) | Drag & drop the _**SCPH1001.BIN**_ BIOS file into the _**PS1/bios**_ folder in this USB drive on your computer | | ![Copy ROM](/assets/images/Copy_PS1_BIOS.png){: .lightbox tag=17} | 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) | Eject cleanly the USB drive from your computer | | ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox tag=18} | 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 | | ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox tag=19} | 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 | | ![Unmout USB](/assets/images/Mount_USB.png){: .lightbox tag=20} | Press the **MENU** key to return to the launcher screen |
--8<-- --8<--
includes/glossary.md includes/glossary.md

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

@ -8,18 +8,18 @@ the host computer and they will be numbered following a
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) | 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 tag=1} | 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){: .lightbox tag=2} | 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](/assets/images/Mount_USB.png){: .lightbox tag=3} | 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 | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox tag=4} | 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 | | ![Eject USB](/assets/images/Eject_USB.png){: .lightbox tag=5} | "**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 Drive](/assets/images/USB_Drive.png){: .lightbox tag=6} | 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) | 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 tag=7} | 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) | Eject cleanly the USB drive from your computer | | ![Eject Drive](/assets/images/Eject_Drive.png){: .lightbox tag=8} | 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 | | ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox tag=9} | 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 | | ![Unmout USB](/assets/images/Mount_USB.png){: .lightbox tag=10} | Press the **MENU** key to return to the launcher screen |
--8<-- --8<--
includes/glossary.md includes/glossary.md

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

@ -7,20 +7,20 @@ in the "assets" section:
https://github.com/FunKey-Project/FunKey-OS/releases/latest https://github.com/FunKey-Project/FunKey-OS/releases/latest
![Github Release](/assets/images/Github_Release.png) ![Github Release](/assets/images/Github_Release.png){: .lightbox tag=1}
| **Display** | **Action** | | **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 | | ![Connection PC](/assets/images/Connection_PC.png){: .lightbox tag=2} | 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){: .lightbox tag=3} | 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](/assets/images/Mount_USB.png){: .lightbox tag=4} | 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 | | ![Mount USB Are you sure](/assets/images/Mount_USB_are_you_sure.png){: .lightbox tag=5} | 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 | | ![Eject USB](/assets/images/Eject_USB.png){: .lightbox tag=6} | "**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 Drive](/assets/images/USB_Drive.png){: .lightbox tag=7} | 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 | | ![USB Drag and Drop](/assets/images/USB_Drag_Drop.png){: .lightbox tag=8} | 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 Drive](/assets/images/Eject_Drive.png){: .lightbox tag=9} | 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 | | ![Eject USB Are you sure](/assets/images/Eject_USB_are_you_sure.png){: .lightbox tag=10} | 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 | | ![Updating](/assets/images/Updating.png){: .lightbox tag=11} | 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

13
mkdocs.yml
View File

@ -59,6 +59,17 @@ extra:
- icon: fontawesome/brands/docker - icon: fontawesome/brands/docker
link: https://hub.docker.com/r/funkeyproject/funkey-os/ link: https://hub.docker.com/r/funkeyproject/funkey-os/
# Custom CSS
extra_css:
- 'assets/css/custom.css'
- 'assets/css/simple-lightbox.min.css'
# Custom JS
extra_javascript:
- 'assets/js/jquery-3.5.1.min.js'
- 'assets/js/simple-lightbox.jquery.min.js'
- 'assets/js/custom.js'
# Extensions # Extensions
markdown_extensions: markdown_extensions:
- admonition - admonition
@ -126,7 +137,7 @@ nav:
- 'Create themes': 'tutorials/software/themes.md' - 'Create themes': 'tutorials/software/themes.md'
- 'Restore default games & emulators': 'tutorials/software/restore_games.md' - 'Restore default games & emulators': 'tutorials/software/restore_games.md'
- Hardware: - Hardware:
- 'Open/close the console': 'tutorials/hardware/open_console.md' - 'Disassembling/Assembling the console': 'tutorials/hardware/disassembling_console.md'
- 'Flash & change the SD card': 'tutorials/hardware/change_sd_card.md' - 'Flash & change the SD card': 'tutorials/hardware/change_sd_card.md'
- 'Change the buttons': 'tutorials/hardware/buttons.md' - 'Change the buttons': 'tutorials/hardware/buttons.md'
- 'Force shutdown': 'tutorials/hardware/force_shutdown.md' - 'Force shutdown': 'tutorials/hardware/force_shutdown.md'