Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions website/docs/01-features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ description: Overview of the most important features
<p align="center"><a href="./apps/shortcuts"><img src={require('../07-apps/01-included-in-onion/assets/shortcuts.webp').default} style={{width: 320}} /></a></p>

:::note <a href="./apps/shortcuts">Shortcuts overview</a>
The Onion **Shortcuts** are very powerful it allows you quick actions like rewind, fast forward, screenshots, volume boost...
The Onion **Shortcuts** are very powerful and allow you quick actions like rewind, fast forward, screenshots, volume boost...
:::


Expand All @@ -54,7 +54,7 @@ The Onion **Shortcuts** are very powerful it allows you quick actions like rewin


:::note <a href="apps/game-switcher">Game Switcher overview</a>
The **GameSwitcher** is designed to be the central user interface of Onion. It allows browse and resume the last games played in few seconds.
The **GameSwitcher** is designed to be the central user interface of Onion. It allows you to browse and resume the last games played in few seconds.
Launch the **GameSwitcher** by pressing the <kbd>MENU</kbd> button, then you'll see a screenshot of where you were in your game! Use <kbd>LEFT</kbd> and <kbd>RIGHT</kbd> to browse the last games played like this.
It also allows you to quickly change games and many other features.
:::
Expand Down Expand Up @@ -88,7 +88,7 @@ The **Package Manager** app is a powerful tool that allows users to easily insta

:::note <a href="apps/search">Search overview</a>
The **Search** application is the perfect companion for large game collections. It lets you find all the games containing the keyword you've entered.
**Search** also allows to filter a game list to include only games containing a specific keyword.
**Search** also allows you to filter a game list to include only games containing a specific keyword.
:::


Expand All @@ -99,9 +99,9 @@ The **Search** application is the perfect companion for large game collections.

:::note <a href="apps/theme-switcher">Theme-switcher overview</a>
Onion loves themes. Onion **Themes** allows you to customize the background, the entry categories, console icons, music background, fonts... And best of all, the chosen theme impacts all Onion's internal applications!<br />
**Themes** in Onion are two things : <br />
**Themes** in Onion are two things:<br />
- [A fabulous theme repository](https://github.com/OnionUI/Themes/blob/main/README.md) with a very active participation from Onion community <sup><sub>❤️</sub></sup>
- An application called <a href="apps/theme-switcher">Theme-switcher</a> included in Onion which allows to preview and change themes.
- An application called <a href="apps/theme-switcher">Theme-switcher</a> included in Onion that allows you to preview and change themes.
:::


Expand All @@ -119,7 +119,7 @@ Thanks to **Activity Tracker** app you can :
## <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!
Thanks to the **Blue Light Filter** feature from Tweaks app, take care of your eyes!
It allows you to change the color temperature of the screen to have more eye comfort in low-light environments.
:::

Expand Down Expand Up @@ -215,12 +215,12 @@ Check the <a href="included-apps">included apps</a> documentation for more infor
<img title="Included apps" src={require('./assets/network-features.gif').default} style={{width: 320}} />

:::note <a href="network-features">Network Features</a>
For the Miyoo Mini Plus (equipped with wifi) Onion offers many additional possibilities :<br />
For the Miyoo Mini Plus (equipped with Wi-Fi) Onion offers many additional possibilities :<br />
- [Multiplayer/Netplay](multiplayer): play in multiplayer over internet or on your local network to your favorite retro games:
- [Easy Netplay](multiplayer/easynetplay): play multiplayer games anywhere (compatible with GB/GBC Pokemon trading!)
- [OTA (Over The Air) updates](apps/ota-update): update Onion directly from your MMP
- [Automatic date/time synchronisation](apps/tweaks#set-automatically-via-the-internet) (NTP, via Tweaks app)
- [Retroachivements](https://www.retroarch.com/?page=achievements)
- [RetroAchievements](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), [VNC server](network/vnc)...
:::
Expand Down Expand Up @@ -248,7 +248,7 @@ MainUI is the main interface of Onion provided by Miyoo and modified by Onion Te
<sup>Credit: Eggs</sup>
- New default theme inspired by the Lilla theme by Evolve
<sup>Credit: DiMo</sup>
- OnionOS icon by Evolve
- Onion icon by Evolve
- Textures are compressed for faster results
<sup>Credit: DiMo</sup>
- Box art size fix in the included themes
Expand Down
2 changes: 1 addition & 1 deletion website/docs/02-installation/01-fresh-install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Chrome already has a tool to format an SD card. Insert the card into your Chrome
</Tabs>

:::note Installation files
The Onion installation files consists of the following folders:
The Onion installation files consist of the following folders:
```sh showLineNumbers
.tmp_update/ # Might be hidden
BIOS/
Expand Down
6 changes: 3 additions & 3 deletions website/docs/02-installation/02-upgrading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
configs will carry over to the updated system.*

:::note OTA UPDATES (MMP)
The Miyoo Mini+ (Plus) can update Onion via the Wi-Fi connection using the OTA Update app. If the OTA update fails, simply follow the steps below to perform a manual update.
The Miyoo Mini Plus can update Onion via the Wi-Fi connection using the OTA Update app. If the OTA update fails, simply follow the steps below to perform a manual update.
:::


Expand Down Expand Up @@ -61,13 +61,13 @@ please **make sure to create in-game saves** before upgrading.
<TabItem value="chromeos" label="Chrome OS">

:::tip Recommended method
Due to limitations in the way the Chrome OS File Manager works, it's recommended to backup your personal files, perform a clean install of Onion OS on the SD card, and then restore your backed up files. The following instructions go through this procedure.
Due to limitations in the way the Chrome OS File Manager works, it's recommended to backup your personal files, perform a clean install of Onion on the SD card, and then restore your backed up files. The following instructions go through this procedure.
:::

1. Display the contents of the SD card on the File Manager by double-clicking the drive icon.
2. Backup your personal files such as the ones under `Roms`, `BIOS`, `Saves` and `Themes` directories.
3. Perform a [clean install](/docs/installation/fresh) on the SD card.
4. Restore your files on the newly installed Onion SD card. **Do not move a file to the same location as one with the same name**. This will cause the moved file to be duplicated with a number appended to it, and won't be recognized by Onion OS.
4. Restore your files on the newly installed Onion SD card. **Do not move a file to the same location as one with the same name**. This will cause the moved file to be duplicated with a number appended to it, and won't be recognized by Onion.

</TabItem>
</Tabs>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/02-installation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM
:::

</TabItem>
<TabItem value="mmp" label="Miyoo Mini+ (MMP)">
<TabItem value="mmp" label="Miyoo Mini Plus (MMP)">


3. You need at least firmware version `20230505****`, if you have an older version please download the recommended firmware linked below.
Expand All @@ -93,7 +93,7 @@ Firmware `2023 10 27 1401` and newer in conjunction with Onion 4.3 allow the MM
## <sup><img align="left" src="https://user-images.githubusercontent.com/44569252/179302769-4169e57a-860f-4c0e-8792-007e7557ba48.png" width="54" /></sup> Download the installation files

:::info MMP support
You need to install **Onion V4.2** for MMP, as earlier versions doesn't support the new hardware.
You need to install **Onion V4.2** for MMP, as earlier versions don't support the new hardware.
:::

Download the latest version of Onion:
Expand Down
16 changes: 8 additions & 8 deletions website/docs/03-faq/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ For example:
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 sensitive).
The *Game manual* option is not displayed in GLO menu if the pdf file doesn't exist or if it is not well named (file names are case sensitive).
:::

</details>
Expand Down Expand Up @@ -228,7 +228,7 @@ To easily make bulk changes to your console or system names you can also use the
Visit the [onionos-console-renamer github](https://github.com/Andrea922/onionos-console-renamer) to download and follow the instructions detailed there.

> Notes:
> Systems in Onion OS are displayed in alphabetical order so the name will determine where in your list it sits.
> Systems in Onion are displayed in alphabetical order so the name will determine where in your list it sits.
> An alternative method to order the systems is by adding an equal number of spaces both sides of the label name.
> The number of spaces determines the position it is displayed on the Mini, with the most spaces being first.
> For example, _“ Arcade “_ will appear before _“Arcade”_.
Expand Down Expand Up @@ -429,9 +429,9 @@ START + L2 / R2 Adjust volume boost ([see shortcuts](/docs/apps/shortcuts))

</summary>

You can copy in-game save files from another device or emulator for use in OnionOS.
You can copy in-game save files from another device or emulator for use in Onion.
* In most cases, Save files should be in `.srm` format, named identically to the rom and are case sensitive. Note that `.sav` files can be renamed to `.srm`, other formats may require a conversion tool.
* To add your saves to OnionOS just copy your individual save files into the correct emulator folder in: `Saves/CurrentProfile/saves/[CORENAME]`
* To add your saves to Onion just copy your individual save files into the correct emulator folder in: `Saves/CurrentProfile/saves/[CORENAME]`
* If you have already launched the game prior to adding your saves then you will also need to go to the `Saves/CurrentProfile/states/[CORENAME]` folder ...and delete any Save States here for the same game(s) in order for your newly added game saves to be recognised.

> `[CORENAME]` = The folder with name of the RA core for the particular emulator or system the save file(s) relates to.
Expand Down Expand Up @@ -502,7 +502,7 @@ To manage your current Save State slot:
> - Launch a game and press <kbd>MENU</kbd>+<kbd>SELECT</kbd> to go into the RetroArch `Quick Menu`
> - Press <kbd>B</kbd> once, to go to RA `Main Menu`
> - Go to `Settings` > `Saving` > `Increment Save State Index Automatically` (and toggle this off)
> - Press <kbd>B</kbd> twice and go to `Quick Menu` > `Overrides` to [save the RA settings](#how-do-i-save-retroarch-settings)
> - Press <kbd>B</kbd> twice and go to `Quick Menu` > `Overrides` to [save the RA settings](#how-do-i-save-RetroArch-settings)



Expand Down Expand Up @@ -661,7 +661,7 @@ Onion doesn't modify the firmware of your Miyoo Mini so this is not a CFW. It ca
The way how your Miyoo Mini is booting will not change and it is a good thing because:
- it avoids the risk of bad flash.
- the original firmware of the Miyoo Mini starts up really fast !
After the boot, the first binary launched from the SD card by the firmware is the Onion scripts directly, making the boot of Onion OS fast and safe.
After the boot, the first binary launched from the SD card by the firmware is the Onion scripts directly, making the boot of Onion fast and safe.

> Notes:
> The community is working on [a real alternative firmware](https://github.com/orgs/miyoo-oss/repositories). It's currently not usable with Onion. The objective is to obtain a better control of the hardware part and a more recent linux kernel which could simplify the compilation of additional apps.
Expand All @@ -676,9 +676,9 @@ After the boot, the first binary launched from the SD card by the firmware is th

It is possible to overclock your device starting from Onion 4.2.0. The speed improvement can be up to 20% and is very noticeable. The current overclocking procedure is a manual process.

To overclock Retroarch for all cores, create a `cpuclock.txt` text file in the main Retroarch folder (e.g. `Retroarch/cpuclock.txt`) containing just the 4-digit Mhz number of the desired overclock speed (e.g. `1600`).
To overclock RetroArch for all cores, create a `cpuclock.txt` text file in the main RetroArch folder (e.g. `RetroArch/cpuclock.txt`) containing just the 4-digit Mhz number of the desired overclock speed (e.g. `1600`).

To overclock just a specific Retroarch core, create the `cpuclock.txt` text file within that core's configuration folder in `Saves/CurrentProfile/config/<core>/`. For example, if you want to improve the PSX speed of PCSX-ReARMed (which will allow you to enable *enhanced resolution* for many additional games) you can create a `cpuclock.txt` file containing `1600` inside `Saves/CurrentProfile/config/PCSX-ReARMed/`.
To overclock just a specific RetroArch core, create the `cpuclock.txt` text file within that core's configuration folder in `Saves/CurrentProfile/config/<core>/`. For example, if you want to improve the PSX speed of PCSX-ReARMed (which will allow you to enable *enhanced resolution* for many additional games) you can create a `cpuclock.txt` file containing `1600` inside `Saves/CurrentProfile/config/PCSX-ReARMed/`.

The maximum device overclock speeds are:
- Miyoo Mini: 1700Mhz (1600 recommended for optimal stability)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/04-emulators/01-arcade/01-arcade-default.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ slug: /emulators/arcade/default
- Required rom set version: `MAME 2003-Plus Reference: Full Non-Merged Romsets`
- Samples: Audio Samples for Mame2003Plus should be placed in the `/BIOS/mame2003-plus/samples` folder

MAME does not play well with save states this is a core issue and cannot be fixed. It is recommended to disable 'auto-loading of save states' in the Retroarch menu (and save core overrides).
MAME does not play well with save states this is a core issue and cannot be fixed. It is recommended to disable 'auto-loading of save states' in the RetroArch menu (and save core overrides).

An onscreen message saying ‘This Game Will Not Work’ is MAME letting you know that the game is not emulated in the MAME version and you will not find a compatible/playable rom for that game.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/04-emulators/01-arcade/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ While MAME supports many classic arcade games, for best compatibility and perfor

Both MAME and FB require your romsets to be matched exactly to the emulator version so you will need to source the recommended romsets. MAME romsets are not compatible with FB cores (and vice versa) and not every game in a full romset will be playable but the majority will be.

Arcade roms in general do not play well with save states (some will work but the majority don’t), you can [disable auto-loading of save states](../faq#how-do-i-disable-auto-load-save-states) in the Retroarch menu (and save content or core overrides).
Arcade roms in general do not play well with save states (some will work but the majority don’t), you can [disable auto-loading of save states](../faq#how-do-i-disable-auto-load-save-states) in the RetroArch menu (and save content or core overrides).

MAME and FB both rely on internal databases to translate the rom file name into the displayed game name, some games may be missing from the db. You should never rename these roms, instead you can use the [miyoogamelist](../faq#how-can-i-use-a-miyoogamelistxml-to-customize-game-names) functionality to give your arcade roms appropriate names.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ See [this link](https://docs.libretro.com/library/puae/) for more information.

- <kbd>SELECT</kbd> toggles the onscreen keyboard, <kbd>L</kbd> & <kbd>R</kbd> are mapped to the mouse buttons.
- This emulator will play Amiga CD32 games though some perform better than others.
- Setting CPU speed to -700 (negative 700) in the Retroarch menu may improve A1200/CD32 performance.
- 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.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/04-emulators/02-consoles/35-snk-neo-geo.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ 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 supports GNO files.
This emulator is a standalone emulator (not RetroArch core) which natively supports 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).
2 changes: 1 addition & 1 deletion website/docs/04-emulators/04-add-ons/02-dreamcast-vmu.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
- Extensions: `.vms` `.bin`
- Bios: None

A pixelated screen displays on launch. Open Retroarch (<kbd>MENU</kbd>+<kbd>SELECT</kbd>) and choose `Close Content`. Now select `History` and load the game file you just closed. Choose Run. The game should now display correctly but plays too fast. To fix this go back into Retroarch and set `Automatic Frame Delay` to ON in the Latency Menu.
A pixelated screen displays on launch. Open RetroArch (<kbd>MENU</kbd>+<kbd>SELECT</kbd>) and choose `Close Content`. Now select `History` and load the game file you just closed. Choose Run. The game should now display correctly but plays too fast. To fix this go back into RetroArch and set `Automatic Frame Delay` to ON in the Latency Menu.

<sup>(Credit: dwmccoy)</sup>
2 changes: 1 addition & 1 deletion website/docs/04-emulators/05-miscellaneous/04-chailove.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ slug: /emulators/chailove
- Bios: None


Like Pico-8, Lowres NX, MicroW8 or LÖVE, [ChaiLove](https://docs.libretro.com/library/chailove/) is a framework for making 2D games. This Retroarch core, inspired by LÖVE engine, uses the ChaiScript scripting language.
Like Pico-8, Lowres NX, MicroW8 or LÖVE, [ChaiLove](https://docs.libretro.com/library/chailove/) is a framework for making 2D games. This RetroArch core, inspired by LÖVE engine, uses the ChaiScript scripting language.

However the compatibility concerns to [a short list of Löve games](https://buildbot.libretro.com/assets/cores/ChaiLove/) (less than 10 games).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/04-emulators/05-miscellaneous/06-lowres-nx.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ slug: /emulators/lowresnx


Like Pico-8, Chailove, MicroW8 or LÖVE, [LowRes NX](https://lowresnx.inutilis.com/) is a framework for making 2D games.
This Retroarch core uses the BASIC language to allow you to create your own retro games on a virtual game console.
This RetroArch core uses the BASIC language to allow you to create your own retro games on a virtual game console.

You can discover [a lot of their games here](https://lowresnx.inutilis.com/programs.php?category=featured).
2 changes: 1 addition & 1 deletion website/docs/04-emulators/05-miscellaneous/07-lutro.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ slug: /emulators/lutro
- Bios: None


Like Pico-8, Chailove, MicroW8 or LowRes NX, [Lutro](https://lutro.libretro.com/) is a framework for making 2D games. This Retroarch core uses the LÖVE API to allow you to create your own retro games on a virtual game console.
Like Pico-8, Chailove, MicroW8 or LowRes NX, [Lutro](https://lutro.libretro.com/) is a framework for making 2D games. This RetroArch core uses the LÖVE API to allow you to create your own retro games on a virtual game console.

However the compatibility is concerning to [a short list of Löve games](https://buildbot.libretro.com/assets/cores/Lutro/).
Loading