4.3.0 documentation

website/docs/01-features/index.md

@@ -6,15 +6,21 @@ description: Overview of the most important features
 
 # Features
 
-<p align="center">
+<table align="center">
+<tbody>
+<tr>
 <a href="#shortcuts"><img title="Shortcuts" src="https://user-images.githubusercontent.com/44569252/189434056-b1148ff9-393b-43d1-b362-20d97b64b393.png" width="48" /></a>
 <a href="#gameswitcher"><img title="GameSwitcher" src="https://user-images.githubusercontent.com/44569252/179301923-635b60fa-22de-4cf3-894a-2f3c34702d64.png" width="48" /></a>
 <a href="#package-manager"><img title="Package Manager" src="https://user-images.githubusercontent.com/44569252/179315622-e29e0971-87c8-4855-85e6-fc8de4ccd940.png" width="48" /></a>
 <a href="#tweaks"><img title="Tweaks" src="https://user-images.githubusercontent.com/44569252/189439761-e03a9684-ade4-4dcc-8fdd-c006a1663c05.png" width="48" /></a>
 <a href="#search"><img title="Search" src="https://user-images.githubusercontent.com/44569252/189498482-2590f31f-cca2-46e9-a316-3af98828446a.png" width="48" /></a>
 <a href="#themes"><img title="Themes" src="https://user-images.githubusercontent.com/44569252/179304061-647e63ff-5113-4a8a-aaa9-4dfda248d54e.png" width="48" /></a>
 <a href="#activity-tracker"><img title="Activity Tracker" src="https://user-images.githubusercontent.com/44569252/179302722-7fa82e4d-d72d-4b1e-bb4d-96a2a52aaa62.png" width="48" /></a>
+<a href="#blue-light-filter"><img title="Blue light filter" src={require('./assets/blue-light-filter.webp').default} style={{width: 48}} /></a>
+<a href="#screen-recorder"><img title="Screen Recorder" src={require('./assets/screen-recorder.webp').default} style={{width: 48}} /></a>
 <a href="#retroarch"><img title="RetroArch" src="https://user-images.githubusercontent.com/44569252/179318731-7e262588-cb92-4ea3-9001-2991c4f8ccbe.png" width="48" /></a>
+</tr>
+<tr>
 <a href="#optimized-emulators"><img title="Optimized Emulators" src={require('./assets/optimized.png').default} style={{width: 48}} /></a>
 <a href="#game-list-options-glo-menu"><img title="GLO Menu" src={require('./assets/icon-glo-menu.png').default} style={{width: 48}} /></a>
 <a href="#guest-mode"><img title="Guest Mode" src="https://user-images.githubusercontent.com/44569252/179304290-8c7e5140-5fb4-4ae1-bd90-faa416f9a37c.png" width="48" /></a>
@@ -25,7 +31,10 @@ description: Overview of the most important features
 <a href="#connected-features"><img title="Connected Features" src={require('./assets/wifi.png').default} style={{width: 48}} /></a>
 <a href="#personal-files-gathered-in-one-place"><img title="Personal files gathered in one place" src="https://user-images.githubusercontent.com/44569252/179305837-59922e34-e18f-45d1-b5fb-89593ee08152.png" width="48" /></a>
 <a href="#mainui-improvements"><img title="MainUI improvements" src="https://user-images.githubusercontent.com/44569252/179305495-2ae1f522-6918-469f-a2eb-63dd30262e17.png" width="48" /></a>
-</p>
+</tr>
+</tbody>
+</table>
+
 
 
 ## <sup><img align="left" src="https://user-images.githubusercontent.com/44569252/189434056-b1148ff9-393b-43d1-b362-20d97b64b393.png" width="54" /></sup>Shortcuts
@@ -107,7 +116,18 @@ Thanks to `Activity Tracker` app you can :
 - Share your playtimes by taking a screenshot (press <kbd>MENU</kbd>+<kbd>POWER</kbd> - screenshot is saved in `Screenshots` folder).
 :::
 
+## <sup><img src={require('./assets/blue-light-filter.webp').default} style={{width: 54}} /></sup>Blue light filter
+
+:::note <a href="apps/blue-light-filter">Blue light filter</a>
+Thanks to `Blue light filter` feature from Tweaks app take care to your eyes !
+It allows you to change the colortemp of the screen to have more eye confort in low-light environments.
+:::
 
+## <sup><img src={require('./assets/screen-recorder.webp').default} style={{width: 54}} /></sup>Screen Recorder
+
+:::note <a href="apps/screen-recorder">Screen Recorder</a>
+Screen Recorder adds screen record ability for demoing apps/content/features/bugs.
+:::
 
 
 ## <sup><img align="left" src="https://user-images.githubusercontent.com/44569252/179318731-7e262588-cb92-4ea3-9001-2991c4f8ccbe.png" width="54" /></sup>RetroArch
@@ -202,7 +222,7 @@ For the Miyoo Mini Plus (equiped with wifi) Onion offers many additional possibi
 - [Automatic date/time synchronisation](apps/tweaks#set-automatically-via-the-internet) (NTP, via Tweaks app)
 - [Retroachivements](https://www.retroarch.com/?page=achievements)
 - [Scraper](/docs/apps/scraper) : import game covers directly from your MMP
-- [Network Services](network-features) : [Samba/SMB share](network/samba), [http server](network/http), [SSH](network/ssh), [FTP](network/ftp), [Telnet](network/telnet), [Hotspot](network/hotspot)...
+- [Network Services](network-features) : [Samba/SMB share](network/samba), [http server](network/http), [SSH](network/ssh), [FTP](network/ftp), [Telnet](network/telnet), [Hotspot](network/hotspot), [VNC server](network/vnc)...
 :::
 
 

website/docs/02-installation/index.mdx

@@ -53,6 +53,9 @@ Please apply the community patch found below. [Read more](https://docs.google.co
    - `2022 12 24 0121` ⚠️
    - `2023 01 04 1337` ✔️ (community patch)
    - `2023 06 11 1426` ✔️
+   - `2023 10 27 1401` ✔️ (**only for MM v4**)
+
+Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM v4 to run games at 752x560.
 
 :::note Firmware downloads (MM)
 

website/docs/03-faq/index.mdx

@@ -33,6 +33,33 @@ If you have a regular Mini, or just want to scrape images off-device, follow thi
 </details>
 
 
+<details><summary>
+
+### How can I <u>add manuals</u> for my games?
+
+</summary>
+
+Just add a `Manuals` folder containing pdf files named with the same names as the roms.
+
+For example : 
+
+- 📁`Roms/GB/`
+  - 📄`Tetris.gb`
+  - 📁`Manuals/`
+    - 📄`Tetris.pdf` 
+
+1. When inside a game list, select a rom and press <kbd>Y</kbd> to access [GLO menu](/docs/apps/game-list-options)
+2. Scroll down and find the "Game manual" option
+
+It will run Green pdf reader with the manual of the selected rom.
+
+:::note
+The *Game manual* option is not displayed in GLO menu if the pdf file doesn't exist or if it is not wall named (the files names are key sensistive).
+:::
+
+</details>
+
+
 <details><summary>
 
 ### How can I use a `miyoogamelist.xml` to <u>customize game names</u>?
@@ -105,23 +132,85 @@ Your first task is to find cheat files for your games (usually provided in `.cht
 
 </summary>
 
-<sup>(Credit: Dwmccoy)</sup>
+<sup>(Credit: Schmurtz)</sup>
+
+PSX multidisc roms require to create a playslist file (.m3u). It allows to have only one entry for each multidisc game and one unique save file for each game.
+Since Onion 4.3.0 you can use Tweaks app to generate automatically the m3u playlist files which will group your multidisk games.
+
+The tool is available from `Tweaks` -> `Tools` section.
+By default the script is systematically applied to `PS`, `SEGACD`, `NEOCD`, `PCE`, `PCFX` and `AMIGA` rom folders.
+
+The supported multidisc file names are numerous (not key sensitive and support "disc" or "disk"), for example : 
+ - `MyGame (Disc 1).chd` or `MyGame (disc 1).chd` or `MyGame (DISC 1).chd` or `MyGame (Disk 1).chd`
+ - `MyGame (USA) (Disc 1).bin` + `MyGame (USA) (Disc 1).cue`
+ - `MyGame (USA) (Disc 1) (Rev 1).chd`
+ - `MyGame (Disc 1 of .2).chd`
+...
+
+
+When you run multidisc playlist (.m3u) generator from Tweaks app, it will propose you 2 solutions to hide the multidisk roms files (and keep only the playlist visible). 
+- Multiple directories (.Game_Name)  ---> One directory for each game: "`.Game_Name`".
+- Single directory (.multi-disc) ---> One single directory "`.multi-disc`" will contains all multi-disc files.
+
+:::note
+This choice has no impact on the daily use experience: it's up to you to choose the file storage that suits you best.
+:::
+
+<br /><br />
 
-My solution for multi-disc games was to store the Roms in a different folder. 
+**Example:** With "Driver 2" and "Metal Gear Solid"
 
-**Example:** Driver 2
+Copy the bin/cue or chd files for the multi-disc games *Driver 2* and *Metal Gear Solid* into the following folder of `Roms/PS`. You'll obtain :
 
-Copy the bin/cue files for the multi-disc game *Driver 2* into the following folder of `Roms/PSX/Driver 2`
 
-I had two disc files to copy into the `Roms/PSX/Driver 2` folder `Driver 2 (Disc 1) (v1.1)` and `Driver 2 (Disc 2) (v1.1)`
-I then created an m3u file named `Driver 2 (v1.1).m3u` with the following content and placed it into the /Roms/PS folder
+<table><td>
 
-`../../Roms/PSX/Driver 2/Driver 2 (Disc 1) (v1.1).cue`  
-`../../Roms/PSX/Driver 2/Driver 2 (Disc 2) (v1.1).cue`
+- 📁`Roms/PS/`
+  - 📄`Driver 2 (Disc 1) (v1.1).cue`
+  - 📄`Driver 2 (Disc 1) (v1.1).bin`
+  - 📄`Driver 2 (Disc 2) (v1.1).cue`
+  - 📄`Driver 2 (Disc 2) (v1.1).bin`
+  - 📄`Metal Gear Solid (USA) (Disc 1) (Rev 1).chd`
+  - 📄`Metal Gear Solid (USA) (Disc 2) (Rev 1).chd`
 
-Launch the PlayStation Emulator and the only file you should see for the "Driver 2" game is the m3u file since the disc(s) for the game reside in a different folder.
+</td></table>
 
-You can store the files in whatever folder you want as long as the path to the cue file is correct. I created the folder PSX to store the multi-disc images in for simplicity. It's a bit of a hassle but it does work.
+Result after running multidisc playlist (.m3u) generator from Tweaks app :
+
+- if you choose *Multiple directories (.Game_Name)*
+
+<table><td>
+
+- 📁`Roms/PS/`
+  - 📄`Driver 2 (v1.1).m3u`
+  - 📄`Metal Gear Solid (USA) (Rev 1).m3u`
+  - 📁`.Driver 2 (v1.1)/`
+    - 📄`Driver 2 (Disc 1) (v1.1).cue` 
+    - 📄`Driver 2 (Disc 1) (v1.1).bin`
+    - 📄`Driver 2 (Disc 2) (v1.1).cue`
+    - 📄`Driver 2 (Disc 2) (v1.1).bin`
+  - 📁`.Metal Gear Solid (USA) (Rev 1)/`
+    - 📄`Metal Gear Solid (USA) (Disc 1) (Rev 1).chd`
+    - 📄`Metal Gear Solid (USA) (Disc 2) (Rev 1).chd`
+
+</td></table>
+
+- if you choose *Single directory (.multi-disc)*
+
+<table><td>
+
+- 📁`Roms/PS/`
+  - 📄`Driver 2 (v1.1).m3u`
+  - 📄`Metal Gear Solid (USA) (Rev 1).m3u`
+  - 📁`.multi-disc/`
+    - 📄`Driver 2 (Disc 1) (v1.1).cue` 
+    - 📄`Driver 2 (Disc 1) (v1.1).bin`
+    - 📄`Driver 2 (Disc 2) (v1.1).cue`
+    - 📄`Driver 2 (Disc 2) (v1.1).bin`
+    - 📄`Metal Gear Solid (USA) (Disc 1) (Rev 1).chd`
+    - 📄`Metal Gear Solid (USA) (Disc 2) (Rev 1).chd`
+
+</td></table>
 
 </details>
 
@@ -579,7 +668,33 @@ After the boot, the first binary launched from the SD card by the firmware is th
 
 </details>
 
+<details><summary>
+
+### How to <u>overclock</u> my Miyoo Mini?
+
+</summary>
+
+Since Onion 4.2.0, overclock is possible. The speed improvement can be very noticable (up to 20%).
+
+For now the overclock feature is manual.
+
+Onion's overclock works with `cpuclock.txt` text files.
+Retroarch will check the presence of this file in the core config folder first, then the RA root folder.
+The content of cpuclock.txt is simply a 4-digit number(MHz).
+
+The max speed overclock speed are :
+
+    For the Miyoo Mini : 1700Mhz (1600 recommended for optimal stability)
+    For the Miyoo Mini Plus : 1900Mhz (1800 recommended for optimal stability)
 
+For example, if you want to improve the PSX speed with PCSX-ReARMed (which can allow to enable *enhanced resolution* on many additional games) you can create a `cpuclock.txt` file in `Saves/CurrentProfile/config/PCSX-ReARMed` folder with the value `1600` inside.
+
+> Notes:  
+> Do not use values above the recommend ones. It could impact the stability of your device or damage your device.
+
+https://youtu.be/2ptdAy3nZ8Y
+
+</details>
 
 
 

website/docs/04-emulators/02-consoles/01-amstrad-cpc.md

@@ -11,3 +11,8 @@ slug: /emulators/cpc
 - Rom Folder: `CPC`
 - Extensions: `.sna` `.dsk` `.kcr`
 - Bios: None
+
+:::note
+Caprice32 probably offers a better compatibility and performances than the current default CrocoDS for CPC games (require testers).
+A remap file allows to use the keypad to display the virtual keyboard (Select + Start)
+:::

website/docs/04-emulators/02-consoles/09-commodore-64.md

@@ -8,3 +8,17 @@ slug: /emulators/c64
 - Rom Folder: `COMMODORE`
 - Extensions: `.d64` `.zip` `.7z` `.t64` `.crt` `.prg` `.nib` `.tap`
 - Bios: None
+
+
+## Note
+
+`.crt` roms boot fast and not `.d64`.
+
+`.d64` games can take up to 2 minutes to boot. Fortunately after that the save state allows to restart it quickly.
+
+You can convert `.d64` to `.crt` thanks to [disk2easyflash](https://csdb.dk/release/?id=150323).
+
+Command line to convert :
+`disk2easyflash.exe -c mygame.d64 mygame.crt`
+
+`.crt` games boot in only few seconds but are only compatible with Vice core and not Frodo core.

website/docs/04-emulators/02-consoles/10-commodore-amiga.md

@@ -7,7 +7,7 @@ slug: /emulators/amiga
 <img src="https://user-images.githubusercontent.com/44569252/188292584-cdc85cef-c384-4134-91c0-1e87d3360d76.png" align="right" width="240" />
 
 - Alias: Amiga CD32
-- Emulator: **lr-puae**, lr-uae4arm
+- Emulator: **lr-puae**, lr-uae4arm, lr-PUAE 2021 extreme
 - Rom Folder: `AMIGA`
 - Extensions: `.adf` `.hdf` `.lha` `.zip` (For CD32: `.bin/.cue` `.iso`)
 - Bios: `kick33180.A500`, `kick34005.A500`, `kick34005.CDTV`, `kick37175.A500`, `kick37350.A600`, `kick39106.A1200`, `kick39106.A4000`, `kick40060.CD32`, `kick40060.CD32.ext`, `kick40063.A600`, `kick40068.A1200`, and `kick40068.A4000`
@@ -21,3 +21,7 @@ See [this link](https://docs.libretro.com/library/puae/) for more information.
 - Setting CPU speed to -700 (negative 700) in the Retroarch menu may improve A1200/CD32 performance.
 - Other Core Settings that might be useful for some games are frameskip set to 1, or setting off the blitter wait in Video options.
 - Some games will have stuttering audio or behave very slowly regardless of the CPU speed, frameskip etc. Many of these games will work fine if you find another format for them. .hdf (hard disk files) are the most problematic. .adf or .lha games usually work better although you might have to open RA options to switch or add floppy disks when required. If you find a game that won't run correctly no matter the options you set for it, simply try to find another version in another format.
+
+:::note
+"PUAE 2021 extreme" is a core made by KMFD. It includes some optimisations which could be useful for some demanding games. This alternative core is available in Expert section of Package Manager.
+:::

website/docs/04-emulators/02-consoles/22-nec-turbografx-16.md

@@ -7,7 +7,11 @@ slug: /emulators/turbografx
 <img src="https://user-images.githubusercontent.com/44569252/188292695-08c9ac3c-b206-4ea5-aaba-c60683d4b4a0.png" align="right" width="90" />
 
 - Alias: *PC Engine*
-- Emulator: **lr-mednafen-pce-fast**
+- Emulator: **lr-mednafen-pce-fast**, Beetle PCE
 - Rom Folder: `PCE`
 - Extensions: `.pce` `.chd` `.zip` `.7z` `.ccd` `.iso` `.img` `.bin/.cue`
 - Bios: None
+
+:::note
+"Beetle PCE" slower than "Beetle PCE Fast" but more accurate, full speed with a 1900mhz [overclock](../faq#how-to-overclock-my-miyoo-mini), so more reserved to MMP.
+:::

website/docs/04-emulators/02-consoles/35-snk-neo-geo.md

@@ -6,7 +6,7 @@ slug: /emulators/neogeo
 
 <img src="https://user-images.githubusercontent.com/44569252/188292808-3addb46b-9939-4461-bc17-c7323911900f.png" align="right" width="220" />
 
-- Emulator: **lr_fbalpha2012_neogeo**
+- Emulator: **lr_fbalpha2012_neogeo**, GnGeo
 - Required ROM Version: `"FBA Arcade Set v0.2.97.29 for FBA 2012 libretro"` (search with quotes for exact match)
 - Alternative ROM Pack: `"Neo-Geo Rom Collection By Ghostware"` (search with quotes for exact match)
 - Rom Folder: `NEOGEO`
@@ -20,3 +20,11 @@ Because Neo Geo roms can come in different formats (split or non-merged), it's r
 For best game compatibility, seek out the recommended romset above. Alternative romsets for Final Burn cores may be largely compatible (i.e. v0.2.97.24, v0.2.97.39, v0.2.97.40, v0.2.97.44).
 
 https://www.youtube.com/watch?v=CGKX6yPG2nE
+
+## Notes on GnGeo
+
+The GnGeo is an AES/MVS Neo Geo emulator (without NG-CD support) based of MAME ROMsets.
+This emulator is a standalone emulator (not Retroarch core) which natively supporte GNO files.
+GnGeo is interesting because of loading times. Tested a few big games like kof2000 and it starts just a few seconds instead of 45 seconds. The framerate is also very good.
+
+Interesting information about GnGeo [here](https://github.com/TriForceX/MiyooCFW/discussions/369) (with compatibility list).

website/docs/04-emulators/02-consoles/37-sony-playstation.md

@@ -7,7 +7,7 @@ slug: /emulators/psx
 <img src="https://user-images.githubusercontent.com/44569252/188292823-4d971dd0-9c8a-4c99-a132-db16416e352a.png" align="right" width="240" />
 
 - Alias: *PS*, *PS1*, *PSX*
-- Emulator: **lr-pcsx-rearmed**
+- Emulator: **lr-pcsx-rearmed**, km_duckswanstation_xtreme_amped, PCSX-ReARMed standalone
 - Rom Folder: `PS`
 - Extensions: `.chd` `.pbp` `.bin/.cue` `.img` `.mdf` `.toc` `.cbn` `.m3u` `.ccd` (must be lowercase)
 - Bios: `PSXONPSP660.bin`, `scph101.bin`, `scph7001.bin`, `scph5501.bin`, `scph1001.bin`
@@ -19,16 +19,30 @@ Alternatively, you can create `.cue` files using a free online tool such as [cue
 
 All Bios files are 512kb in size and are case sensitive, they must be named _exactly_ as shown above.  
 Using the `PSXONPSP660.bin` bios is recommended for best compatibility.  
-If you experience issues loading games, you can use [md5 checker](http://getmd5checker.com/) to verify your bios files against the md5sum provided in the [official core documentation](https://docs.libretro.com/library/pcsx_rearmed/).
+If you experience issues loading games, you can use [md5 checker](http://getmd5checker.com/) to verify your bios files against the md5sum provided in the [official core documentation](https://docs.libretro.com/library/pcsx_rearmed/#bios).
 
 
 https://www.youtube.com/watch?v=5DdSP1KxzSE
 
+:::note
+Concerning multidisc games :
+ Since Onion 4.3.0 Tweaks app contains a multidisc playlist (.m3u) generator so no need to create your m3u files manually or to convert your multidisc roms to `.pbp` anymore. More info [here](../faq#what-is-the-optimal-way-to-organize-multi-disk-games).
+:::
 
 ## Notes on performance
 
+- Most of PSX games run at 60 FPS natively on the Miyoo Mini. For most demanding games you'll find solutions here to run it at full speed.
 - Rewind and Fast Forward capability should be disabled while playing PSX as performance may suffer greatly. 
-
 - PAL/EUR games run at 50fps, NTSC/USA/JP games run at 60fps. This is by design and as per original hardware.
-
 - Some titles (e.g. Looney Tunes Sheep Rider, Jedi Power Battles, and 2xtreme/espn extreme games) need to have `SMC Checks` disabled or games will eventually slow down and crash. Go to RetroArch Quick Menu (<kbd>MENU</kbd>+<kbd>SELECT</kbd> while in-game), select `Options` and toggle on `(Speed Hack) Disable SMC Checks`.  
+- PCSX-ReARMed standalone offer better performances than the default RetroArch core (see below for details)
+- overclocking is also an excellent way to improve PCSX-ReARMed performances on most demanding games. [More information in the FAQ](../faq#how-to-overclock-my-miyoo-mini). 
+
+## Notes on PCSX-ReARMed standalone
+
+PCSX-ReARMed standalone (not a RetroArch core but the classical emulator) offers much improved performances. It allows for using *enhanced resolution* in most games.
+However its integration in Onion is not perfect : no automatic save states, no resume at boot , different shortcuts...
+
+## Notes on Duckstation/SwanStation
+
+Duckstation is a core from Expert section compiled by KMFD. It is slower than PCSX, however it allows to run some games like [Fromage](https://www.reddit.com/r/MiyooMini/comments/190avun/swanstation_fromage/). Could be interesting on rhythm games too.