mirror of
https://github.com/FunKey-Project/FunKey-Project.github.io.git
synced 2026-03-19 10:22:42 +01:00
change directory structure to match index
Signed-off-by: Michel-FK <michel.stempin@funkey-project.com>
This commit is contained in:
Michel-FK
5
docs/user_manual/tutorials/hardware/change_buttons.md
Normal file
5
docs/user_manual/tutorials/hardware/change_buttons.md
Normal file
@@ -0,0 +1,5 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
|
||||
124
docs/user_manual/tutorials/hardware/flash_change_sd_card.md
Normal file
124
docs/user_manual/tutorials/hardware/flash_change_sd_card.md
Normal file
@@ -0,0 +1,124 @@
|
||||
# Flashing a new micro-SD card
|
||||
|
||||
The following steps describe how to flash a micro-SD card with the
|
||||
latest version of FunKey-OS. This must be done before switching
|
||||
micro-SD cards inside the console.
|
||||
|
||||
Note: Everything on the micro-SD card will be lost, be sure to save
|
||||
your data.
|
||||
|
||||
## Download the latest FunKey-OS image file
|
||||
|
||||
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}
|
||||
|
||||
{.lightbox}
|
||||
|
||||
## Flash the micro-SD card with balenaEtcher
|
||||
|
||||
- Download and install balenaEtcher for Windows/Mac OS/Linux from
|
||||
[balena.io][3]{target=_blank}
|
||||
|
||||
- Run balenaEtcher and click on "Flash from file" to select the
|
||||
FunKey-OS image file
|
||||
|
||||
- Insert the micro-SD card in your computer and select the SD card
|
||||
drive (balenaEtcher should automatically detect it for you)
|
||||
|
||||
- Finally, click **Flash**
|
||||
|
||||
- You'll see a progress bar. Once complete, **make sure the flashing
|
||||
was successful, otherwise retry to flash the SD card**. The program
|
||||
will automatically unmount the SD card so it's safe to remove it
|
||||
from your computer.
|
||||
|
||||
{.lightbox}
|
||||
|
||||
<br />
|
||||
|
||||
# Switching micro-SD cards
|
||||
|
||||
On the **FunKey S**, the micro-SD card was voluntarily placed against
|
||||
the casing so that it has no degree of freedom and cannot move by
|
||||
accident during the eventful life of a keychain.
|
||||
|
||||
Removing/switching the micro-SD card was nevertheless designed to be
|
||||
pretty straightforward and only require a standard **Phillips
|
||||
screwdriver (PH0)** and optionally some **tweezers**.
|
||||
|
||||
Please follow the steps below carefully:
|
||||
|
||||
### **STEP 1 - Removing the screws** {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
Using a standard **Phillips PH0 screwdriver**, remove the 2 screws on
|
||||
the back of your FunKey S.
|
||||
|
||||
Be careful to use the correct screwdriver head size and type to
|
||||
prevent damaging the screws (do not use JIS screwdrivers!).
|
||||
|
||||
### **STEP 2 - Opening up the console** {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
Carefully remove:
|
||||
|
||||
1. The plastic back of the console by pulling up the hinge side first
|
||||
3. The L/R plastic buttons by gently pulling them up out of their axis
|
||||
2. The keychain lanyard and axis
|
||||
|
||||
!!! warning
|
||||
Be careful not to damage the L/R switches on the circuit board!
|
||||
|
||||
### **STEP 3 - Exposing the circuit board** {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
Lift the battery (but leave it connected) to expose the circuit board.
|
||||
|
||||
### **STEP 4 - Accessing the SD card** {.step-title}
|
||||
{.step-thumb}
|
||||
|
||||
By grabbing it **by the micro-USB port**, gently pull up the circuit
|
||||
board until you have access to the SD card.
|
||||
|
||||
### **STEP 5 - Switching SD cards** {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
You can now remove the old micro-SD card from its socket and insert
|
||||
the new one (previously flashed as described [in the 1st part of this
|
||||
tutorial][4]).
|
||||
|
||||
!!! note
|
||||
You may need to use some tweezers and pull with some strength in
|
||||
order to remove the micro-SD card from its socket, as it is
|
||||
strongly inserted to prevent loose connections.
|
||||
|
||||
### **STEP 6 - Reassembly** {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
Insert first the speaker into its location in the casing before
|
||||
putting the circuit board back in the case, like in the pictures.
|
||||
|
||||
Reassemble the console by following the previous steps in reverse order.
|
||||
|
||||
!!! warning
|
||||
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.0.0/FunKey-sdcard-2.0.0.img
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/latest
|
||||
[3]: https://www.balena.io/etcher/
|
||||
[4]: #flashing-a-new-micro-sd-card
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/user_manual/tutorials/hardware/force_shutdown.md
Normal file
4
docs/user_manual/tutorials/hardware/force_shutdown.md
Normal file
@@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
18
docs/user_manual/tutorials/hardware/teardown.md
Normal file
18
docs/user_manual/tutorials/hardware/teardown.md
Normal file
@@ -0,0 +1,18 @@
|
||||
## Step 1 {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
- You will need a Philips PH0 screwdriver
|
||||
- Insert the screwdriver in the hole
|
||||
- Turn the screwdriver counter-clockwise
|
||||
|
||||
## Step 2 {.step-title}
|
||||
{.step-thumb}
|
||||
{.step-thumb}
|
||||
|
||||
Now all the _screws_ are removed!
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
41
docs/user_manual/tutorials/software/add_opk.md
Normal file
41
docs/user_manual/tutorials/software/add_opk.md
Normal file
@@ -0,0 +1,41 @@
|
||||
**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** |
|
||||
|:---------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with gmenu2x), press the <i class="funkey-menu"></i> key |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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 **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** |
|
||||
| {.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 |
|
||||
|
||||
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<--
|
||||
61
docs/user_manual/tutorials/software/add_roms.md
Normal file
61
docs/user_manual/tutorials/software/add_roms.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# How to get ROMs legally
|
||||
|
||||
Yes legally! Despite the general opinion, it is perfectly possible to
|
||||
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}.
|
||||
|
||||
!!! note "Note about ROM emulation"
|
||||
|
||||
While ROM emulation is often seen as illegal, and sometimes by
|
||||
extension emulation itself, it is simply not _true_.
|
||||
|
||||
Emulating hardware is perfectly legal, no gray area about this.
|
||||
|
||||
Sharing a software copy though is illegal, so websites that host
|
||||
copied ROMs or bios are illegal, as well as downloading ROMs or
|
||||
bios from them.
|
||||
|
||||
However, if some videogame companies have decided not to share
|
||||
their games as ROMs, it is not the case for all of them. Many
|
||||
companies, even such giants as SEGA, ATARI or Konami sell their
|
||||
retro-games online as ROMs.
|
||||
|
||||
For example, it is perfectly legal to purchase the SEGA Mega Drive
|
||||
and Genesis Classics on [Steam][5]{target=_blank} and play Sonic
|
||||
on your **FunKey S**.
|
||||
|
||||
# Add ROMs to the FunKey S
|
||||
|
||||
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** |
|
||||
| :-----------------------------------------------------------------------------: | :----------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with RetroFE), press the <i class="funkey-menu"></i> key |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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} | 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 |
|
||||
|
||||
Of course, you can remove games from the **FunKey S** console as you
|
||||
would do with a USB memory stick, too!
|
||||
|
||||
[1]: https://wiki.funkey-project.com/wiki/Available_third-party_software
|
||||
[2]: https://wiki.funkey-project.com/wiki/List_of_emulatable_games_(freeware)
|
||||
[3]: https://wiki.funkey-project.com/wiki/List_of_emulatable_games_(commercial)
|
||||
[4]: https://wiki.funkey-project.com/wiki/List_of_utilities
|
||||
[5]: https://store.steampowered.com/app/34270/SEGA_Mega_Drive_and_Genesis_Classics/
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
70
docs/user_manual/tutorials/software/aspect_ratio.md
Normal file
70
docs/user_manual/tutorials/software/aspect_ratio.md
Normal file
@@ -0,0 +1,70 @@
|
||||
The **FunKey S** provides 2 ways to to allow in-game change of the
|
||||
display aspect ratio:
|
||||
|
||||
1. Using quick shortcuts
|
||||
|
||||
2. Using the FunKey menu
|
||||
|
||||
## Quick shortcuts
|
||||
|
||||
- <i class="funkey-fn"></i> + <i class="funkey-down"></i>: Change
|
||||
Aspect Ratio (AR), cycle between:
|
||||
|
||||
- Stretched (default)
|
||||
|
||||
- Cropped
|
||||
|
||||
- Scaled
|
||||
|
||||
- Manual Zoom
|
||||
|
||||
- <i class="funkey-fn"></i> + <i class="funkey-left"></i>: Decrease
|
||||
zoom level by 10%
|
||||
|
||||
- <i class="funkey-fn"></i> + <i class="funkey-right"></i>: Increase
|
||||
Zoom level by 10%
|
||||
|
||||
## FunKey menu
|
||||
|
||||
- Press the <i class="funkey-menu"></i> key to enter the FunKey menu
|
||||
|
||||
- Press the <i class="funkey-up"></i> or <i class="funkey-down"></i>
|
||||
key to select the "**ASPECT RATIO**" setting
|
||||
|
||||
- Use the <i class="funkey-left"></i> and <i
|
||||
class="funkey-right"></i> keys to change the aspect ratio
|
||||
|
||||
| **Display** | **Aspect Ratio** |
|
||||
|:-------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions |
|
||||
| {.lightbox} | Cropped (Zoom 100%), The display fills the screen vertically, and is clipped vertically to the left and right of the screen |
|
||||
| {.lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically |
|
||||
| {.lightbox} | Manual zoom: The display is zoomed in/out manually |
|
||||
|
||||
- Press the <i class="funkey-menu"></i> key again to exit from the
|
||||
FunKey menu
|
||||
|
||||
## Aspect ratio preview
|
||||
|
||||
Here is a short preview of what the different aspect ratios look like:
|
||||
|
||||
| **Display** | **Aspect Ratio** |
|
||||
|:-----------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Stretched (default): The display is stretched horizontally and vertically to fill the screen in both directions |
|
||||
| {.lightbox} | Cropped (Zoom 100%): The display fills the screen vertically, and is clipped vertically to the left and right of the screen |
|
||||
| {.lightbox} | Scaled (Zoom 0%): The display is scaled down in both directions to be fully visible, both horizontally and vertically |
|
||||
| {.lightbox} | Manual zoom 0% (Scaled): The display is scaled down in both directions to be fully visible, both horizontally and vertically |
|
||||
| {.lightbox} | Manual zoom 10% |
|
||||
| {.lightbox} | Manual zoom 20% |
|
||||
| {.lightbox} | Manual zoom 30% |
|
||||
| {.lightbox} | Manual zoom 40% |
|
||||
| {.lightbox} | Manual zoom 50% (default zoom level) |
|
||||
| {.lightbox} | Manual zoom 60% |
|
||||
| {.lightbox} | Manual zoom 70% |
|
||||
| {.lightbox} | Manual zoom 80% |
|
||||
| {.lightbox} | Manual zoom 90% |
|
||||
| {.lightbox} | Manual zoom 100% (Cropped): The display fills the screen vertically, and is clipped vertically to the left and right of the screen |
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/user_manual/tutorials/software/create_themes.md
Normal file
4
docs/user_manual/tutorials/software/create_themes.md
Normal file
@@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
30
docs/user_manual/tutorials/software/firmware_update.md
Normal file
30
docs/user_manual/tutorials/software/firmware_update.md
Normal file
@@ -0,0 +1,30 @@
|
||||
A firmware upgrade can be performed simply over USB without opening
|
||||
the **FunKey S** console.
|
||||
|
||||
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}
|
||||
|
||||
{.lightbox}
|
||||
|
||||
| **Display** | **Action** |
|
||||
|:-------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with RetroFE), press the <i class="funkey-menu"></i> key |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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 _FunKey-roots-2.0.0.fwu_ file you just downloaded at the root of 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} | 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
|
||||
[2]: https://github.com/FunKey-Project/FunKey-OS/releases/latest
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
140
docs/user_manual/tutorials/software/gb_palette.md
Normal file
140
docs/user_manual/tutorials/software/gb_palette.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# Palette description
|
||||
|
||||
The default **FunKey S** Game Boy emulator: _[gnuboy][1]_ allows to
|
||||
set the palette used for grayscale when running DMG (original mono
|
||||
Gameboy) ROMs.
|
||||
|
||||
There are four variables for this purpose, allowing the background,
|
||||
window, and both sprite palettes to be colored differently. Each one
|
||||
is made up of four numbers, the color to use for each shade of gray,
|
||||
from lightest to darkest.
|
||||
|
||||
Colors are represented as 24-bit hexadecimal numbers, with red
|
||||
component in the low (rightmost) 2 digits, green component in the
|
||||
middle 2 digits and blue component in the upper (leftmost) 2 digits.
|
||||
|
||||
For example, to set the background to shades of white, the window to
|
||||
shades of red, and the sprite palettes to shades of green and blue,
|
||||
you could use:
|
||||
|
||||
```
|
||||
set dmg_bgp 0xffffff 0xaaaaaa 0x555555 0x000000
|
||||
set dmg_wndp 0x0000ff 0x0000aa 0x000055 0x000000
|
||||
set dmg_obp0 0x00ff00 0x00aa00 0x005500 0x000000
|
||||
set dmg_obp1 0xff0000 0xaa0000 0x550000 0x000000
|
||||
```
|
||||
|
||||
This will of course look rather ugly, but it does the job illustrating
|
||||
how you set various colors.
|
||||
|
||||
Here is a list of example palettes proposed by the gnuboy emulator:
|
||||
|
||||
```
|
||||
# Default palette used in the FunKey S.
|
||||
set dmg_bgp 0x98d0e0 0x68a0b0 0x60707C 0x2C3C3C
|
||||
set dmg_wndp 0x98d0e0 0x68a0b0 0x60707C 0x2C3C3C
|
||||
set dmg_obp0 0x98d0e0 0x68a0b0 0x60707C 0x2C3C3C
|
||||
set dmg_obp1 0x98d0e0 0x68a0b0 0x60707C 0x2C3C3C
|
||||
|
||||
# Old default palette from 0.8.0 thru 0.9.13.
|
||||
# This was designed for use on a laptop display,
|
||||
# so it's probably way too yellowish.
|
||||
set dmg_bgp 0x78f0f0 0x58b8b8 0x487878 0x184848
|
||||
set dmg_wndp 0x78f0f0 0x58b8b8 0x487878 0x184848
|
||||
set dmg_obp0 0x78f0f0 0x58b8b8 0x487878 0x184848
|
||||
set dmg_obp1 0x78f0f0 0x58b8b8 0x487878 0x184848
|
||||
|
||||
# Old dim grayscale.
|
||||
set dmg_bgp 0xc0c0c0 0x808080 0x404040 0x000000
|
||||
set dmg_wndp 0xc0c0c0 0x808080 0x404040 0x000000
|
||||
set dmg_obp0 0xc0c0c0 0x808080 0x404040 0x000000
|
||||
set dmg_obp1 0xc0c0c0 0x808080 0x404040 0x000000
|
||||
|
||||
# Light grayscale.
|
||||
set dmg_bgp 0xffffff 0xc0c0c0 0x808080 0x404040
|
||||
set dmg_wndp 0xffffff 0xc0c0c0 0x808080 0x404040
|
||||
set dmg_obp0 0xffffff 0xc0c0c0 0x808080 0x404040
|
||||
set dmg_obp1 0xffffff 0xc0c0c0 0x808080 0x404040
|
||||
|
||||
# Full contrast grayscale.
|
||||
set dmg_bgp 0xffffff 0xaaaaaa 0x555555 0x000000
|
||||
set dmg_wndp 0xffffff 0xaaaaaa 0x555555 0x000000
|
||||
set dmg_obp0 0xffffff 0xaaaaaa 0x555555 0x000000
|
||||
set dmg_obp1 0xffffff 0xaaaaaa 0x555555 0x000000
|
||||
|
||||
# Debug palette.
|
||||
# Each of the four layers is colored differently,
|
||||
# making it easier to debug visual glitches in
|
||||
# roms that use them all together cleverly.
|
||||
set dmg_bgp 0xf898c8 0xf83098 0xc80060 0x600030
|
||||
set dmg_wndp 0xd0c0c0 0xa88080 0x785050 0x382828
|
||||
set dmg_obp0 0x9898f8 0x3030f8 0x0000c8 0x000060
|
||||
set dmg_obp1 0xc8f898 0x98f830 0x60c800 0x306000
|
||||
|
||||
# Sprites standout.
|
||||
# Similar to above, but the colors are more subdued and
|
||||
# the window and background are the same. This palette
|
||||
# may actually be suitable for playing some games...
|
||||
set dmg_bgp 0xd0c0c0 0xa88080 0x785050 0x382828
|
||||
set dmg_wndp 0xd0c0c0 0xa88080 0x785050 0x382828
|
||||
set dmg_obp0 0xc8e0f8 0x90a8e8 0x4878a8 0x183850
|
||||
set dmg_obp1 0x98b8f8 0x3050f8 0x2040a8 0x002060
|
||||
|
||||
# LCD yellows and grays.
|
||||
# An earlier version of the new default palette.
|
||||
set dmg_bgp 0x88e0f0 0x68a8b8 0x586878 0x283838
|
||||
set dmg_wndp 0x88e0f0 0x68a8b8 0x586878 0x283838
|
||||
set dmg_obp0 0x88e0f0 0x68a8b8 0x586878 0x283838
|
||||
set dmg_obp1 0x88e0f0 0x68a8b8 0x586878 0x283838
|
||||
|
||||
# LCD yellowscale.
|
||||
# And another similar one.
|
||||
set dmg_bgp 0x88e0f0 0x68a8b8 0x486878 0x203838
|
||||
set dmg_wndp 0x88e0f0 0x68a8b8 0x486878 0x203838
|
||||
set dmg_obp0 0x88e0f0 0x68a8b8 0x486878 0x203838
|
||||
set dmg_obp1 0x88e0f0 0x68a8b8 0x486878 0x203838
|
||||
|
||||
# Slightly colorful.
|
||||
# Not just a plain lightness gradient, but some
|
||||
# change in hue as well. Looks ok with some games;
|
||||
# designed in particular for the FFL series.
|
||||
set dmg_bgp 0x98e0f8 0x78a0c0 0x747080 0x604038
|
||||
set dmg_wndp 0x98e0f8 0x78a0c0 0x747080 0x604038
|
||||
set dmg_obp0 0x98e0f8 0x78a0c0 0x747080 0x604038
|
||||
set dmg_obp1 0x98e0f8 0x78a0c0 0x747080 0x604038
|
||||
|
||||
# Optionally use these with the above palette to
|
||||
# make sprites stand out a bit.
|
||||
set dmg_obp0 0x98e0f8 0x5090c0 0x507898 0x583838
|
||||
set dmg_obp1 0x98e0f8 0x5090c0 0x686078 0x383838
|
||||
|
||||
# R-Type 1 palette from R-Type DX
|
||||
set dmg_bgp 0xc0ffff 0x408080 0x204040 0x000000
|
||||
set dmg_wndp 0xc0ffff 0x408080 0x204040 0x000000
|
||||
set dmg_obp0 0xc0ffff 0x408080 0x204040 0x000000
|
||||
set dmg_obp1 0xc0ffff 0x408080 0x204040 0x000000`
|
||||
```
|
||||
|
||||
# Changing the palette
|
||||
|
||||
| **Display** | **Action** |
|
||||
| :-----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with RetroFE), press the <i class="funkey-menu"></i> key |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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} | In the FunKey folder, create a new folder .gnuboy if it does not already exist. |
|
||||
| {.lightbox} | In the FunKey/.gnuboy folder create a file gnuboy.rc if it does not already exist. |
|
||||
| {.lightbox} | Open the gnuboy.rc file with a text editor and add the palette you want. |
|
||||
| {.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 |
|
||||
| {.lightbox} | Launch any Gameboy game to see the results of your new palette settings. |
|
||||
|
||||
[1]: https://github.com/rofl0r/gnuboy
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
64
docs/user_manual/tutorials/software/gba_bios.md
Normal file
64
docs/user_manual/tutorials/software/gba_bios.md
Normal file
@@ -0,0 +1,64 @@
|
||||
Most retro-gaming console software emulators are able to run game ROMs
|
||||
directly.
|
||||
|
||||
However, the Game Boy Advance an PS1 emulators do require an
|
||||
additional BIOS file in order to emulate all or some of the game ROMs.
|
||||
|
||||
## GBA
|
||||
|
||||
If you launch a GBA game in the first place, you will get this screen:
|
||||
|
||||
|
||||
|
||||
This means that you will need to install on the **FunKey S** a BIOS
|
||||
file with the right name, size and MD5 checksum before you can
|
||||
actually play.
|
||||
|
||||
- BIOS file name: gba_bios.bin
|
||||
- MD5: a860e8c0b6d573d191e4ec7d
|
||||
|
||||
### Installation procedure
|
||||
|
||||
| **Display** | **Action** |
|
||||
|:-------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with RetroFE), press the <i class="funkey-menu"></i> key |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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 _**gba_bios.bin**_ BIOS file into the _**Game Boy Advance**_ 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 |
|
||||
|
||||
## PS1
|
||||
|
||||
As for the GBA, if you launch a GBA game in the first place, you will
|
||||
get this screen:
|
||||
|
||||
|
||||
|
||||
This means that you will need to install on the **FunKey S** a BIOS
|
||||
file with the right name and size before you can actually play.
|
||||
|
||||
BIOS file name: SCPH1001.BIN
|
||||
|
||||
### Installation procedure
|
||||
|
||||
| **Display** | **Action** |
|
||||
|:-------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with RetroFE), press the <i class="funkey-menu"></i> |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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} | 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 |
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
4
docs/user_manual/tutorials/software/restore_games.md
Normal file
4
docs/user_manual/tutorials/software/restore_games.md
Normal file
@@ -0,0 +1,4 @@
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
26
docs/user_manual/tutorials/software/snapshot.md
Normal file
26
docs/user_manual/tutorials/software/snapshot.md
Normal file
@@ -0,0 +1,26 @@
|
||||
The **FunKey S** allows to take in-game snapshots using a simple
|
||||
shortcut: just press the **Fn** + **UP** keys simultaneously.
|
||||
|
||||
The snapshot files will be located in the _FunKey/snapshots_ folder on
|
||||
the host computer and they will be numbered following a
|
||||
"**IMG_nnnn.PNG**" pattern, with "_nnnn_" being a number starting at
|
||||
0001 and up to 9999.
|
||||
|
||||
In order to access the snapshots, follow these simple steps:
|
||||
|
||||
| **Display** | **Action** |
|
||||
|:-------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| {.lightbox} | Connect the **FunKey S** to your computer using the provided micro USB cable, then open it to turn it on |
|
||||
| {.lightbox} | At the launcher's main screen (example here with RetroFE), press the <i class="funkey-menu"></i> key |
|
||||
| {.lightbox} | Press the <i class="funkey-up"></i> or <i class="funkey-down"></i> keys until you see "**MOUNT USB**" |
|
||||
| {.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 / Copy / Move / Delete the snapshots files from the _FunKey/snapshots/_ folder in this USB drive on your computer as required |
|
||||
| {.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 |
|
||||
|
||||
--8<--
|
||||
includes/glossary.md
|
||||
--8<--
|
||||
Reference in New Issue
Block a user