diff --git a/static/build/RetroArch/.retroarch/overlay/GBA/Perfect_GBA(read-instructions)/Perfect_GBA.png b/static/build/RetroArch/.retroarch/overlay/GBA/Perfect_GBA(read-instructions)/Perfect_GBA.png index f390a073b5..c6952e3ebd 100644 Binary files a/static/build/RetroArch/.retroarch/overlay/GBA/Perfect_GBA(read-instructions)/Perfect_GBA.png and b/static/build/RetroArch/.retroarch/overlay/GBA/Perfect_GBA(read-instructions)/Perfect_GBA.png differ diff --git a/website/docs/04-emulators/05-miscellaneous/15-superbroswar.md b/website/docs/04-emulators/05-miscellaneous/15-superbroswar.md index 278d5763c6..e6c3a71ae8 100644 --- a/website/docs/04-emulators/05-miscellaneous/15-superbroswar.md +++ b/website/docs/04-emulators/05-miscellaneous/15-superbroswar.md @@ -18,9 +18,9 @@ slug: /emulators/superbroswar Super Mario War / Super Cat Wars is a fan-made multiplayer Super Mario Bros. Very customizable with many mods. Onion includes the Retroarch core. The standalone version (which includes the multiplayer mode) will be distributed as a port in the Onion Ports repository. -The RetroArch core version allows to fight against enemies controled by the computer. +The RetroArch core version allows you to fight against enemies controlled by the computer. -## 2 main assets : +## 2 main assets: ### Super Mario War - Download the last linux version from [the official repo](https://github.com/mmatyas/supermariowar/releases/tag/continuous), "supermariowar_2023-11-23_linux.zip" for example @@ -49,13 +49,13 @@ The RetroArch core version allows to fight against enemies controled by the comp :::note -The official website contains many maps and skins : http://smwstuff.net +The official website contains many maps and skins: http://smwstuff.net ::: :::note -"Super Cat Wars LITE" contains more assets than "Super Mario War" which are all loaded in memory at start so : it can be long to load and it can potentially crash sometimes due to a lack of memory. +"Super Cat Wars LITE" contains more assets than "Super Mario War" which are all loaded in memory at start, so it can take some time to load and rarely might even crash due to lack of memory ::: :::note Only the standalone version includes the multiplayer mode (not tested) -::: \ No newline at end of file +::: diff --git a/website/docs/07-apps/01-included-in-onion/activity-tracker.md b/website/docs/07-apps/01-included-in-onion/activity-tracker.md index 6a5d5335e2..adac9fe6f5 100644 --- a/website/docs/07-apps/01-included-in-onion/activity-tracker.md +++ b/website/docs/07-apps/01-included-in-onion/activity-tracker.md @@ -13,19 +13,19 @@ Activity Tracker tracks your game time for all the games you play! Also shows yo ![](./assets/activity-tracker.webp) -Thanks to `Activity Tracker` app you can : -- Track your game playtimes. -- View your total playtime in the top bar. -- Share your playtimes by taking a screenshot (press MENU+POWER - screenshot is saved in `Screenshots` folder). +Thanks to `Activity Tracker` app you can: +- Track your game playtimes +- View your total playtime in the top bar +- Share your playtimes by taking a screenshot (press MENU+POWER - screenshot is saved in `Screenshots` folder) ## Usage Activity Tracker is installed by default in Onion. -For each game you'll see : -- `TOTAL` = total playtime on this game. -- `AVG` = average session time on this game -- `PLAY` = number of times you have launched the game +For each game you'll see: +- `TOTAL`: total playtime on this game +- `AVG`: average session time on this game +- `PLAY`: number of times you have launched the game ### Controls diff --git a/website/docs/07-apps/01-included-in-onion/advance-menu.md b/website/docs/07-apps/01-included-in-onion/advance-menu.md index e8e253def0..67a09eb8f2 100644 --- a/website/docs/07-apps/01-included-in-onion/advance-menu.md +++ b/website/docs/07-apps/01-included-in-onion/advance-menu.md @@ -12,7 +12,7 @@ slug: /apps/advancemenu ## About -[AdvanceMENU](http://www.advancemame.it/menu-readme) is an awesome frontend which has the ability to display video thumbnails of games. The performance of this frontend are impressive on low CPU devices like the Miyoo Mini. The animated thumbnails require a particular format, `.mng` files, which are a type of animated `.png` file and a separated `.mp3` sound file. +[AdvanceMENU](http://www.advancemame.it/menu-readme) is an awesome frontend which has the ability to display video thumbnails of games. The performance of this frontend is impressive on low CPU devices like the Miyoo Mini. The animated thumbnails require a particular format, `.mng` files, which are a type of animated `.png` file and a separated `.mp3` sound file. *This app is included in Onion 4.1.2* @@ -55,12 +55,12 @@ Furthermore, you can also set AdvanceMENU to be the start application, this is d ## Instructions for scraping your ROM collection 1. Download Skraper (https://www.skraper.net/) -2. Scrape your ROM collection every system at a time and on the media tab select only videos; -3. On the OnionUI SDCARD find the folder `App\AdvanceMENU\tools\Roms_and_Medias_Management\mp4_to_mng`, copy it to your PC, make a new folder named videos and then copy the video files there, every system at a time, and run the script to convert to mng+mp3 files; -4. Skraper video files start with 10 frames that are black so I made a script that removes the first 10 frames of every .mng file inside a folder. Download the script, copy it to your mng folder then run it. This step is optional. ([remove10.zip](https://github.com/OnionUI/Onion/files/11100644/remove10.zip)); -5. Copy the mng folder content to the Snaps folder in every systems folder. +2. Scrape your ROM collection every system at a time and on the media tab select only videos +3. On the OnionUI SDCARD find the folder `App\AdvanceMENU\tools\Roms_and_Medias_Management\mp4_to_mng`, copy it to your PC, make a new folder named videos and then copy the video files there, every system at a time, and run the script to convert to mng+mp3 files +4. Skraper video files start with 10 frames that are black so I made a script that removes the first 10 frames of every .mng file inside a folder. Download the script, copy it to your mng folder then run it. This step is optional. ([remove10.zip](https://github.com/OnionUI/Onion/files/11100644/remove10.zip)) +5. Copy the mng folder content to the Snaps folder in every systems folder -This process can take some time and it can be a little bit tricky. Videos scraped with Skraper ar not the best resolution, they are not as sharp as the snap pack for MAME. +This process can take some time and it can be a little bit tricky. Videos scraped with Skraper don't have the best resolution, they are not as sharp as the snap pack for MAME. diff --git a/website/docs/07-apps/01-included-in-onion/blue-light-filter.md b/website/docs/07-apps/01-included-in-onion/blue-light-filter.md index 77959bafd1..4f1a36c8f5 100644 --- a/website/docs/07-apps/01-included-in-onion/blue-light-filter.md +++ b/website/docs/07-apps/01-included-in-onion/blue-light-filter.md @@ -10,7 +10,7 @@ slug: /apps/blue-light-filter ## Presentation -Blue Light Filter is a tool included in Tweaks app which allows you to change the colortemp of the screen to have more eye confort in low-light environments. +Blue Light Filter is a tool included in Tweaks app which allows you to change the colortemp of the screen to have more eye comfort in low-light environments. It can be compared to "f.lux", "Night Shift" on IOS or "Night Light" on Windows. ![](./assets/blue-light-filter.webp) @@ -19,7 +19,7 @@ It can be compared to "f.lux", "Night Shift" on IOS or "Night Light" on Windows. - Gradually change of the colortemp of the screen - Time scheduling -- 5 presets available : +- 5 presets available: - Subtle - Moderate - Balanced @@ -33,9 +33,9 @@ It can be compared to "f.lux", "Night Shift" on IOS or "Night Light" on Windows. You'll find it in Tweaks app: [`Appearance` -› `Blue light filter...`](/docs/apps/tweaks#blue-light-filter) and you'll get 5 options: -1. **State** - Shows the current state of Blue Light Filter, can be used too to enable/disable Blue Light Filter now. -2. **Schedule** - Allow to enable Blue Light Filter automatically during the time interval defined below. -3. **Strength** - Choose one of the 5 presets available here. +1. **State** - Shows the current state of Blue Light Filter, can be used too to enable/disable Blue Light Filter now +2. **Schedule** - Allow to enable Blue Light Filter automatically during the time interval defined below +3. **Strength** - Choose one of the 5 presets available here 4. **Time (On)** - Time Blue light filter will be activated 5. **Time (Off)** - Time Blue light filter will be disabled diff --git a/website/docs/07-apps/01-included-in-onion/clock.md b/website/docs/07-apps/01-included-in-onion/clock.md index ee01101b11..af59b2fb43 100644 --- a/website/docs/07-apps/01-included-in-onion/clock.md +++ b/website/docs/07-apps/01-included-in-onion/clock.md @@ -1,6 +1,6 @@ --- slug: /apps/clock -description: Set your Onions time +description: Set your Onion's time --- # Clock @@ -8,7 +8,7 @@ description: Set your Onions time ## Presentation -Simple clock app which allows you to manually set the clock of your device. Especially usefull for the Miyoo Mini which doesn't have an internal RTC (which means that the time is reset at each boot). By default, Onion preserves the current time during shutdown, and upon the subsequent boot, it is restored with 4 hours added. +Simple clock app which allows you to manually set the clock of your device. Especially useful for the Miyoo Mini which doesn't have an internal RTC (which means that the time is reset at each boot). By default, Onion preserves the current time during shutdown, and upon the subsequent boot, it is restored with 4 hours added. If you don't want the device to restore the time on boot (e.g. you have modded your device to have hardware RTC), you can create the file `SDCARD\.tmp_update\config\.noTimeRestore`. Doing so will prevent the time restore. @@ -16,7 +16,7 @@ If you don't want the device to restore the time on boot (e.g. you have modded y :::note -On the Miyoo Mini Plus, Onion can use the wifi connection to set the time at each boot. Configure it from [Tweaks app](tweaks#set-automatically-via-the-internet). +On the Miyoo Mini Plus, Onion can use the WiFi connection to set the time at each boot. Configure it from [Tweaks app](tweaks#set-automatically-via-the-internet). ::: ## Usage diff --git a/website/docs/07-apps/01-included-in-onion/game-list-options.md b/website/docs/07-apps/01-included-in-onion/game-list-options.md index 07a0497196..fa5124dd74 100644 --- a/website/docs/07-apps/01-included-in-onion/game-list-options.md +++ b/website/docs/07-apps/01-included-in-onion/game-list-options.md @@ -8,9 +8,9 @@ slug: /apps/game-list-options ## Presentation Game List Options (GLO menu) is a tool for performing actions for the selected game or for the entire list.
-Press Y in a game list then from this menu you can choose the Retroarch core, download the image cover of your game (wifi/MMP required), launch a Netplay session, reset your game (to skip the last save state), filter the list of games with a keyword,... +Press Y in a game list then from this menu you can choose the RetroArch core, download the image cover of your game (WiFi/MMP required), launch a Netplay session, reset your game (to skip the last save state), filter the list of games with a keyword,... -Thanks to GLO menu flexibility, you can even add your own scripts here !* +Thanks to GLO menu flexibility, you can even add your own scripts here! ## Usage @@ -28,16 +28,16 @@ GLO Menu is a native application of Onion, it is installed by default. ### Scripts available in Onion -- **Reset game** - *load game without save state, useful to start a game from beginning* -- **Game core** - *set custom Retroarch core per game, useful to switch from mGBA to gPSP for example* -- **Filter list** - *use a keyword to filter the list* -- **Refresh roms** - *refresh the list’s game cache, useful when you have added some games* +- **Reset game**: *load game without save state, useful to start a game from beginning* +- **Game core**: *set custom Retroarch core per game, useful to switch from mGBA to gPSP for example* +- **Filter list**: *use a keyword to filter the list* +- **Refresh roms**: *refresh the list’s game cache, useful when you have added some games* - *Custom scripts:* - - **Random game** - *added by Random Game app - launches a random game from the list* - - **Set time** - *added by Clock app - quick access to setting date and time* -- *Wifi scripts (Miyoo Mini Plus only) :* - - **Scraper** - *Download image covers for your games. More details here* - - **Netplay** - *Launch or join a multiplayer game. More details here* + - **Random game**: *added by Random Game app - launches a random game from the list* + - **Set time**: *added by Clock app - quick access to setting date and time* +- *WiFi scripts: (Miyoo Mini Plus only)* + - **Scraper**: *Download image covers for your games. More details here* + - **Netplay**: *Launch or join a multiplayer game. More details here* ## Advanced @@ -45,15 +45,15 @@ GLO Menu is a native application of Onion, it is installed by default. GLO Menu allows you to create your own scripts. The GLO scripts are located in `sdcard/App/romscripts`. -The existing scripts are a great source of inspiration for your future script. Here some examples : -- [Scraper script](https://github.com/OnionUI/Onion/blob/main/static/build/App/romscripts/emu/Scraper.sh) (Good example to use rom path) -- [Random game script](https://github.com/OnionUI/Onion/blob/main/static/packages/App/Random%20Game/App/romscripts/Random%20game.sh) (good example to get the current section) -- [Netplay script](https://github.com/OnionUI/Onion/blob/main/static/build/App/romscripts/emu/Netplay.sh) (good example for dynamic labels entry in GLO menu) +The existing scripts are a great source of inspiration for your future script. Here some examples: +- [Scraper script](https://github.com/OnionUI/Onion/blob/main/static/build/App/romscripts/emu/Scraper.sh): good example to use rom path +- [Random game script](https://github.com/OnionUI/Onion/blob/main/static/packages/App/Random%20Game/App/romscripts/Random%20game.sh): good example to get the current section +- [Netplay script](https://github.com/OnionUI/Onion/blob/main/static/build/App/romscripts/emu/Netplay.sh): good example for dynamic labels entry in GLO menu *Some useful variables: * -- `require_networking=1` will show this GLO entry only on the MMP which is equiped of wifi. -- `%LIST%` is the name of the current system (for example GENESIS) -- `$1` will contain the full path of the selected rom -- `$2` will contain the full path of the current emulator \ No newline at end of file +- `require_networking=1`: will show this GLO entry only on the MMP which is equipped of WiFi +- `%LIST%`: is the name of the current system (for example GENESIS) +- `$1`: will contain the full path of the selected rom +- `$2`: will contain the full path of the current emulator diff --git a/website/docs/07-apps/01-included-in-onion/game-switcher.md b/website/docs/07-apps/01-included-in-onion/game-switcher.md index be5421b99e..08c93c84b3 100644 --- a/website/docs/07-apps/01-included-in-onion/game-switcher.md +++ b/website/docs/07-apps/01-included-in-onion/game-switcher.md @@ -28,14 +28,14 @@ The GameSwitcher is designed to be the central user interface of Onion. It allow It also allows you to quickly change games and many other features: -- Quick boot your last played game. -- Quickly switch games from your history. -- Full overlay with accurate brightness, battery readings and playtimes. -- Display playtime (current game playtime / Total games playtime). +- Quick boot your last played game +- Quickly switch games from your history +- Full overlay with accurate brightness, battery readings and playtimes +- Display playtime (current game playtime/Total games playtime) - Minimal view mode: beautiful full screen mode -- Improved *Sleep Mode* with full game suspension (press POWER). -- Low battery indicator: Red frame when <15% (can be adjusted in Tweaks). -- When the battery goes below 4%, the device will automatically save and exit to prevent losing progress. +- Improved *Sleep Mode* with full game suspension (press POWER) +- Low battery indicator: Red frame when <15% (can be adjusted in Tweaks) +- When the battery goes below 4%, the device will automatically save and exit to prevent losing progress ## Usage @@ -55,10 +55,10 @@ The last game played will be resumed in a few seconds, and with the simple press | Left/Right | Navigate between last played games | | Up/Down | Set brightness | | A or Menu | Resume selected game | -| B | quit | -| X | Remove from Game Switcher
(it will keep the save state) | +| B | Quit | +| X | Remove from GameSwitcher
(it will keep the save state) | | Y | Toggle fullscreen | -| Select | toggle playtime display | +| Select | Toggle playtime display |

@@ -70,5 +70,5 @@ In game you can double click on menu button to quickly switch to the previous ga :::info standalone emulators are not compatible -Game Switcher builds on Retroarch's Save State functionality so it's not compatible with standalone emulators. -::: \ No newline at end of file +GameSwitcher builds on RetroArch's Save State functionality so it's not compatible with standalone emulators. +::: diff --git a/website/docs/07-apps/01-included-in-onion/guest-mode.md b/website/docs/07-apps/01-included-in-onion/guest-mode.md index be29a2d816..5b32f30ba5 100644 --- a/website/docs/07-apps/01-included-in-onion/guest-mode.md +++ b/website/docs/07-apps/01-included-in-onion/guest-mode.md @@ -13,7 +13,7 @@ The Guest profile will have its own save and save states. Guest mode makes the O ## Usage -Go in Apps section and run "Guest mode", the icon will change to show the current state : +Go in Apps section and run "Guest Mode", the icon will change to show the current state: | ![](./assets/guest-mode-off.webp) | ![](./assets/guest-mode-on.webp) | | --------------- | --------------- | @@ -34,4 +34,4 @@ The profile contains the following properties: - Timers for your games Play Activity app - RGUI config - RetroArch Graphic User Interface \ No newline at end of file + RetroArch Graphic User Interface diff --git a/website/docs/07-apps/01-included-in-onion/music-player.md b/website/docs/07-apps/01-included-in-onion/music-player.md index a9a09fb3e8..83910f4a72 100644 --- a/website/docs/07-apps/01-included-in-onion/music-player.md +++ b/website/docs/07-apps/01-included-in-onion/music-player.md @@ -36,13 +36,13 @@ Gmu supports MPEG audio, Ogg Vorbis and Ogg Opus for internet audio | Function | Button | | --------------- | ----------------------------------- | -| play | A (in playlist and in filebrowser) | -| pause | start | -| seek in track | Left/Right | -| prev/next track | L1/R1 | +| Play | A (In playlist and in filebrowser) | +| Pause | Start | +| Seek in track | Left/Right | +| Prev/Next track | L1/R1 | | ToggleView | Select | -| exit | Menu + Select (similar to RA menu) | -| help | Menu + Start | +| Exit | Menu + Select (similar to RA menu) | +| Help | Menu + Start | ### Playlist Controls diff --git a/website/docs/07-apps/01-included-in-onion/ota-update.md b/website/docs/07-apps/01-included-in-onion/ota-update.md index 97207fcd3c..eee3a59e23 100644 --- a/website/docs/07-apps/01-included-in-onion/ota-update.md +++ b/website/docs/07-apps/01-included-in-onion/ota-update.md @@ -17,7 +17,7 @@ Allows you to select stable or beta channel. ## Usage -Onion OTA update is available in [Package Manager](package-manager). It will work only with Wifi / Miyoo Mini Plus. +Onion OTA update is available in [Package Manager](package-manager). It will work only with WiFi/Miyoo Mini+. Once installed run it from Apps section. @@ -25,13 +25,13 @@ Once installed run it from Apps section. [Onion OTA update script](https://github.com/OnionUI/Onion/blob/main/static/build/.tmp_update/script/ota_update.sh). -### detailed features +### Detailed features - stable or beta channel available (set on beta currently) -- check and enable wifi connection if necessary -- compare current Onion version vs Last released version on Github +- check and enable WiFi connection if necessary +- compare current Onion version vs last released version on Github - displays the size of the release before downloading - verify the size of the downloaded file before applying - check the current space available before applying update (currently 1GB is required) -- check disk integrity with fsck.fat, important to avoid SD card FAT file system corruption. -- generate different exit error codes \ No newline at end of file +- check disk integrity with fsck.fat, important to avoid SD card FAT file system corruption +- generate different exit error codes diff --git a/website/docs/07-apps/01-included-in-onion/package-manager.md b/website/docs/07-apps/01-included-in-onion/package-manager.md index f961fea3c3..2f2f85f978 100644 --- a/website/docs/07-apps/01-included-in-onion/package-manager.md +++ b/website/docs/07-apps/01-included-in-onion/package-manager.md @@ -18,14 +18,14 @@ The "Package Manager" app is a powerful tool that allows users to easily install Package Manager is a native application of Onion, it is installed by default. -- run Package Manager from Apps section. +- Run Package Manager from Apps section - Packages are divided into three sections: - - **Verified:** Contains all verified systems which are fully compatible with Onion and the Game Switcher (see [Emulators](../emulators) for more information). - - **Apps:** Contains all the included Onion and third-party apps. - - **Expert:** Contains experimental/expert systems. Some are just alternative, some are standalone emulators (not compatible with Game Switcher) and some are just not fully tested. (see [Emulators](../emulators) for more information). -- Choose the systems and apps you need and press start. -- at the top right of the screen you'll see the number of current modifications (on the screenshot above we see that 1 item will be insntalled) -- Package Manager will display a summary of the modifications, press start again to confirm and apply the modifications. + - **Verified:**: Contains all verified systems which are fully compatible with Onion and the GameSwitcher (see [Emulators](../emulators) for more information) + - **Apps:**: Contains all the included Onion and third-party apps + - **Expert:**: Contains experimental/expert systems. Some are just alternative, some are standalone emulators (not compatible with GameSwitcher) and some are just not fully tested. (see [Emulators](../emulators) for more information) +- Choose the systems and apps you need and press start +- At the top right of the screen you'll see the number of current modifications (on the screenshot above we see that 1 item will be installed) +- Package Manager will display a summary of the modifications, press start again to confirm and apply the modifications :::note Removing an emulator or an app will not remove the associated roms and data. @@ -44,14 +44,14 @@ Since Onion 4.3.0, Package Manager allows to auto select emulators that has roms | Button | Function | | ------ | ------------------- | -| D-pad | Navigate & Check/uncheck | -| A | Check/uncheck the current item | +| D-pad | Navigate & Check/Uncheck | +| A | Check/Uncheck the current item | | B | Quit | -| X | Check / uncheck everything /check emulators with roms in the current tab | +| X | Check/Uncheck everything /check emulators with roms in the current tab | | Y | Reset all the current modification | | L1/R1 | Previous/Next tab | | L2/R2 | Previous/Next item page | -| Start | Install summary / validate the modifications | +| Start | Install summary/validate the modifications | diff --git a/website/docs/07-apps/01-included-in-onion/quick-guide.md b/website/docs/07-apps/01-included-in-onion/quick-guide.md index 121c8cfdf6..60c5e76009 100644 --- a/website/docs/07-apps/01-included-in-onion/quick-guide.md +++ b/website/docs/07-apps/01-included-in-onion/quick-guide.md @@ -21,13 +21,13 @@ Shows the quick guide that is shown after installing Onion | D-pad | Navigate | | A | Next slide | | B | Previous slide | -| X | Check/uncheck everything in the current tab | +| X | Check/Uncheck everything in the current tab | | Y | Reset all the current modification | | L1/R1 | Previous/Next tab | | L2/R2 | Previous/Next item page | -| Start | Install summary / validate the modifications | +| Start | Install summary/validate the modifications | ## Advanced -Quick Guide app and Screenshot Viewer app use the same binary called `infoPanel`. It use the `-d` command to read all the png files from a directory passed in parameter. \ No newline at end of file +Quick Guide app and Screenshot Viewer app use the same binary called `infoPanel`. It use the `-d` command to read all the png files from a directory passed in parameter. diff --git a/website/docs/07-apps/01-included-in-onion/random-game.md b/website/docs/07-apps/01-included-in-onion/random-game.md index 002cea3689..0348eb6b12 100644 --- a/website/docs/07-apps/01-included-in-onion/random-game.md +++ b/website/docs/07-apps/01-included-in-onion/random-game.md @@ -8,7 +8,7 @@ slug: /apps/random-game ## Presentation -Random Game will allow you to discover new games in your collection ! +Random Game will allow you to discover new games in your collection! | | | @@ -20,8 +20,8 @@ Random Game will allow you to discover new games in your collection ! Random Game is available in [Package Manager](package-manager). Once installed you can run it from 3 different ways: -- From the app section, Random Game will pick a game between all games available on your device. -- From the [GLO Menu](game-list-options), Random Game will pick a game from the current games list (not limited by subfolder). +- From the app section, Random Game will pick a game between all games available on your device +- From the [GLO Menu](game-list-options), Random Game will pick a game from the current games list (not limited by subfolder) - You can also assign a shortcut button (X or Y) in [Tweaks app](tweaks) ### Controls diff --git a/website/docs/07-apps/01-included-in-onion/retroarch.md b/website/docs/07-apps/01-included-in-onion/retroarch.md index 07a845db26..e90f79a369 100644 --- a/website/docs/07-apps/01-included-in-onion/retroarch.md +++ b/website/docs/07-apps/01-included-in-onion/retroarch.md @@ -9,7 +9,7 @@ slug: /apps/retroarch ## Presentation -A full Retroarch in a such tiny device ! Retroarch is regularly updated from the offcial repository. +A full RetroArch in a such tiny device! RetroArch is regularly updated from the official repository.

@@ -23,7 +23,7 @@ A full Retroarch in a such tiny device ! Retroarch is regularly updated from the - Customs cores - Fine-tuned with optimal best settings for the Miyoo Mini in mind - Automatically choosing the best resolution for your device - - 640x480 for the Miyoo Mini v1-3 and the Miyoo Mini + + - 640x480 for the Miyoo Mini v1-3 and the Miyoo Mini+ - 752x560 for the Miyoo Mini v4 with firmware >= `202310271401` - Can also work as a game launcher > Cores embedded, playlists and favorites unlocked @@ -48,17 +48,17 @@ A full Retroarch in a such tiny device ! Retroarch is regularly updated from the Running from apps section allows you to start RetroArch without immediately loading a game, useful for changing global settings in RetroArch. -To display the Retroarch Menu press Menu + Select. +To display the RetroArch Menu press Menu + Select. -Meny additional shortcuts are available for Retroarch, do not forget to check [Onion in-game shortcuts](shortcuts). +Many additional shortcuts are available for RetroArch, do not forget to check [Onion in-game shortcuts](shortcuts). ## Advanced ### [Onion Retroarch Repository](https://github.com/OnionUI/RetroArch) -### customized overlays and filters -[Here](https://github.com/OnionUI/Onion/discussions/708) you'll find some advices to customize overlays and filters.
(Jeltr0n overlays and filters are now directly included in Onion, no need to download them). +### Customized overlays and filters +You'll find some advices to customize overlays and filters [Here](https://github.com/OnionUI/Onion/discussions/708).
(Jeltr0n overlays and filters are now directly included in Onion, no need to download them).
@@ -76,4 +76,4 @@ Meny additional shortcuts are available for Retroarch, do not forget to check [O ### Overclocking -Onion's Retroarch includes overclocking feature. There's no UI for it currently. This feature is described [in this post](https://github.com/OnionUI/Onion/issues/768#issuecomment-1659968668). +Onion's RetroArch includes overclocking feature. There's no UI for it currently. This feature is described [in this post](https://github.com/OnionUI/Onion/issues/768#issuecomment-1659968668). diff --git a/website/docs/07-apps/01-included-in-onion/scraper.md b/website/docs/07-apps/01-included-in-onion/scraper.md index 0b45be7af2..01ed565f28 100644 --- a/website/docs/07-apps/01-included-in-onion/scraper.md +++ b/website/docs/07-apps/01-included-in-onion/scraper.md @@ -5,19 +5,19 @@ description: Download your box arts using WiFi # Scraper -A missing illustration in your game list ? Onion Scraper can solve that ! -Using WiFi (so Miyoo Mini Plus only), this app allows you to download game covers without even touching your SD card or a computer. +A missing illustration in your game list? Onion Scraper can solve that! +Using WiFi (so Miyoo Mini+ only), this app allows you to download game covers without even touching your SD card or a computer. https://www.youtube.com/watch?v=lOMP0ozb0I0 ## Features -- Automatically download covers from 3 different sources (ScreenScraper, Retroarch and Launchbox) +- Automatically download covers from 3 different sources (ScreenScraper, RetroArch and LaunchBox) - Media type selection (Boxart, 3D, Screenshot, Title Screen, Marquee, Mix) -- Prefered region selection (will give a priority to the covers from your own region) -- Manage ScreenScraper accounts (less errors and faster when registered / logged in) -- Download one covers or all the missing covers of the current console -- Auto converstion and resize of images for the Miyoo Mini +- Preferred region selection (will give a priority to the covers from your own region) +- Manage ScreenScraper accounts (less errors and faster when registered/logged in) +- Download one cover or all the missing covers of the current console +- Auto conversion and resize of images for the Miyoo Mini - Find game match even if your rom is not well named thanks to ScreenScraper CRC search @@ -40,7 +40,7 @@ https://www.youtube.com/watch?v=lOMP0ozb0I0 Choose the desired kind of media. -| name | preview example | available on | +| Name | Preview example | Available on | | ------------------------- | ----------------------------------- | ---------------- | | Box Art |![](./assets/scraper_2dbox.png) | SS,LB,RA | | Screenshot - Title Screen |![](./assets/scraper_screentitle.png)| SS,LB,RA | @@ -48,28 +48,28 @@ Choose the desired kind of media. | Box Art - 3D |![](./assets/scraper_3dbox.png) | SS,LB | | Wheel |![](./assets/scraper_wheel.png) | SS,LB | | Marquee |![](./assets/scraper_marquee.png) | SS,LB | -| Screenscraper Mix V1 |![](./assets/scraper_mix1.png) | SS | -| Screenscraper Mix V2 |![](./assets/scraper_mix2.png) | SS | +| ScreenScraper Mix V1 |![](./assets/scraper_mix1.png) | SS | +| ScreenScraper Mix V2 |![](./assets/scraper_mix2.png) | SS | -SS = Screenscraper, LB = Launchbox, RA = Retroarch +SS = ScreenScraper, LB = LaunchBox, RA = RetroArch ### Region selection -Choose your prefered region. If no media is found for your country code, other countries will be searched as fallback. +Choose your preferred region. If no media is found for your country code, other countries will be searched as fallback. ### Scraping source Select where the covers will be searched. -- ScreenScraper is probably the best supplied, it supports all the media types proposed in Scraper and it also allows to search by CRC which provide a lot of additional matches. -- Launchbox offers a fast alternative to ScreenScraper. -- Retroarch is quite fast the the match level is low. +- ScreenScraper is probably the best supplied, it supports all the media types proposed in Scraper and it also allows to search by CRC which provide a lot of additional matches +- LaunchBox offers a fast alternative to ScreenScraper +- RetroArch is quite fast but the match level is low. -### Screenscraper: account settings +### ScreenScraper: account settings -- Screenscraper information: technical information about ScreenScraper (a retrogaming project to support). -- Username & password: to set your ScreenScraper credentials. -- Account state and stats: will show your screenscraper account state (useful to check if your account credentials are well configured and if you don't exceed quotas). +- ScreenScraper information: technical information about ScreenScraper (a retrogaming project to support) +- Username & password: to set your ScreenScraper credentials +- Account state and stats: will show your ScreenScraper account state (useful to check if your account credentials are well configured and if you don't exceed quotas) ### Toggle background Scraping diff --git a/website/docs/07-apps/01-included-in-onion/screen-recorder.md b/website/docs/07-apps/01-included-in-onion/screen-recorder.md index eb54ae9134..bb9f37b14e 100644 --- a/website/docs/07-apps/01-included-in-onion/screen-recorder.md +++ b/website/docs/07-apps/01-included-in-onion/screen-recorder.md @@ -18,8 +18,8 @@ Screen Recorder adds screen record ability for demoing apps/content/features/bug ## Features -- Record your current screen. -- Recording indicator icon. +- Record your current screen +- Recording indicator icon - Customizable countdown before starting recording - Hotkey to launch/stop a record from anywhere @@ -33,12 +33,12 @@ Not really suitable to record games in current build as it's CPU encoding and th You'll find it in Tweaks app: [`Tools` -› `Screen recorder...`](/docs/apps/tweaks#screen-recorder) and you'll get these options: - - Start/stop recorder - launch or stop a record - - Countdown (seconds) - Countdown when starting recording. The screen will pulse white n times to signify recording has started/stopped. - - Toggle indicator icon - Flashes/shows an icon to remind you you're recording - - Toggle hotkey - Enables or disables the hotkey to start/stop recording (Hold MENU+A for 2 seconds) - - Reset screen recorder - Hardkills ffmpeg, removes all flags and stops any recording - - Delete all recordings - a quick way to delete all recordings in the directory + - Start/Stop recorder: Launch or stop a record + - Countdown (seconds): Countdown when starting recording. The screen will pulse white n times to signify recording has started/stopped + - Toggle indicator icon: Flashes/Shows an icon to remind you that you're recording + - Toggle hotkey: Enables or disables the hotkey to start/stop recording (Hold MENU+A for 2 seconds) + - Reset screen recorder: Hardkills ffmpeg, removes all flags and stops any recording + - Delete all recordings: A quick way to delete all recordings in the directory Recorded videos are located in `Media\Videos\Recorded` and can be viewed with [Onion Video Player](video-player) diff --git a/website/docs/07-apps/01-included-in-onion/search.md b/website/docs/07-apps/01-included-in-onion/search.md index a1be0fbb02..3b8f7dbcf7 100644 --- a/website/docs/07-apps/01-included-in-onion/search.md +++ b/website/docs/07-apps/01-included-in-onion/search.md @@ -26,26 +26,26 @@ Search also allows to filter a game list to include only games containing a spec -## usage +## Usage #### **Search** -- You'll find Search under `Apps` - and it's a popular choice for mapping to X (configured by default in Onion) or Y (via Tweaks). +- You'll find Search under `Apps` - and it's a popular choice for mapping to X (configured by default in Onion) or Y (via Tweaks) - You can start search using the `X` button by default. You can change this keybinding in Tweaks -- When a search is active, the results will be shown under `Games` › `Search`, you can remove the search again by choosing "Clear search". -- "Missing caches" lists all systems which haven't been cached yet, and thereby haven't been included in the search. - - *Reason:* All game caches are cleared everytime you "Refresh all roms". - - *Solution:* Go into each system you want included in the search. +- When a search is active, the results will be shown under `Games` › `Search`, you can remove the search again by choosing "Clear search" +- "Missing caches" lists all systems which haven't been cached yet, and thereby haven't been included in the search + - *Reason:* All game caches are cleared everytime you "Refresh all roms" + - *Solution:* Go into each system you want included in the search #### **Filter** - *Filter* is accessible via the `GLO Menu` When in a game list, press Y - - **Filter:** Will prompt you to enter a keyword for filtering the selected game list. - - in your filtered game list you will find 3 new options : - - **~Clear filter:** Will remove the current filter to display your full game list again. - - **~Filter: "keyword":** run filter app again to quickly modify your keywork. - - **~Refresh roms:** Will refresh roms only for the current filtered game list. -- *Note: If you're using a `miyoogamelist.xml` you will need to add an entry for `~Filter.miyoocmd` and `~Refresh roms.miyoocmd`.* + - **Filter:** Will prompt you to enter a keyword for filtering the selected game list + - In your filtered game list you will find 3 new options: + - **~Clear filter:** Will remove the current filter to display your full game list again + - **~Filter: "keyword":** Run filter app again to quickly modify your keywork + - **~Refresh roms:** Will refresh roms only for the current filtered game list +- *Note: If you're using a `miyoogamelist.xml` you will need to add an entry for `~Filter.miyoocmd` and `~Refresh roms.miyoocmd`* diff --git a/website/docs/07-apps/01-included-in-onion/terminal.md b/website/docs/07-apps/01-included-in-onion/terminal.md index b45f1e49bd..709a80eba6 100644 --- a/website/docs/07-apps/01-included-in-onion/terminal.md +++ b/website/docs/07-apps/01-included-in-onion/terminal.md @@ -22,7 +22,7 @@ A simple terminal emulator with a complete on-screen keyboard for Onion! | D-pad | Navigate left/right/up/down arrows | | A | Press key | | B | Toggle key | -| X | Show / hide keyboard | +| X | Show/Hide keyboard | | Y | Change keyboard location (top/bottom) | | L1 | Shift | | R1 | Backspace | diff --git a/website/docs/07-apps/01-included-in-onion/theme-switcher.md b/website/docs/07-apps/01-included-in-onion/theme-switcher.md index 169b1a2f83..a30514c174 100644 --- a/website/docs/07-apps/01-included-in-onion/theme-switcher.md +++ b/website/docs/07-apps/01-included-in-onion/theme-switcher.md @@ -8,9 +8,9 @@ slug: /apps/theme-switcher ## Presentation -Onion loves themes. Themes in Onion are two things : +Onion loves themes. Themes in Onion are two things: - [A fabulous theme repository](https://github.com/OnionUI/Themes/blob/main/README.md) with a very active participation from Onion community ❤️ -- An application called Theme-switcher included in Onion which allows to preview and change themes. +- An application called "Theme Switcher" included in Onion which allows to preview and change themes

@@ -29,13 +29,13 @@ When installing a theme you can choose if you want to install the icons as well, #### To install a theme: - Visit [Onion themes repository](https://github.com/OnionUI/Themes/blob/main/README.md) -- Download a theme to `/Themes` folder on your SD card. -- Apply your theme with the Theme Switcher app. +- Download a theme to `/Themes` folder on your SD card +- Apply your theme with the Theme Switcher app #### Icon switching -- ThemeSwitcher now supports themes with icon packs - *remember to visit our [themes repository](https://github.com/OnionUI/Themes/blob/main/README.md) for additional themes and icon packs!* +- Theme Switcher now supports themes with icon packs - *remember to visit our [themes repository](https://github.com/OnionUI/Themes/blob/main/README.md) for additional themes and icon packs!* - Change icon pack and edit individual icons in Tweaks diff --git a/website/docs/07-apps/01-included-in-onion/video-player.md b/website/docs/07-apps/01-included-in-onion/video-player.md index 61fd54d408..484aef4469 100644 --- a/website/docs/07-apps/01-included-in-onion/video-player.md +++ b/website/docs/07-apps/01-included-in-onion/video-player.md @@ -16,7 +16,7 @@ A fully featured video player for Onion based on FFplay. ## Installation - Run Package Manager from apps section and install the Video Player -- Place your videos in `Media/Videos` folder of your SD card, using Subfolders is possible. +- Place your videos in `Media/Videos` folder of your SD card, using subfolders is possible ## Usage @@ -81,7 +81,7 @@ Many formats are supported, after a few tests a little everything below 1080p is - + diff --git a/website/docs/07-apps/02-community-apps/index.mdx b/website/docs/07-apps/02-community-apps/index.mdx index 35e31e773f..9d0e3c2283 100644 --- a/website/docs/07-apps/02-community-apps/index.mdx +++ b/website/docs/07-apps/02-community-apps/index.mdx @@ -15,31 +15,31 @@ Here you will find a selection of third party applications and tools compatible -## MMP only (Wi-Fi required) +## Miyoo Mini+ only (WiFi required) -1. [**Better Wifi Tools**](https://github.com/XK9274/better-wifi-miyoo) by XK9274 +1. [**Better WiFi Tools**](https://github.com/XK9274/better-wifi-miyoo) by XK9274 *Better WiFi management for the MMP (OnionOS)* 2. [**Cloud Saves**](https://github.com/hotcereal/cloud-saves-miyoo-mini-plus) by hotcereal - *Utilizing rclone, upload and download saves to and from your Miyoo Mini Plus.* + *Utilizing rclone, upload and download saves to and from your Miyoo Mini+* 3. [**Screen Capture Toolkit**](https://github.com/XK9274/screencap-toolkit-miyoo) by XK9274 - *A Screencapturing toolkit for the Miyoo Mini + (Twitch/VNC/RTMP/Outputfile)* + *A Screencapturing toolkit for the Miyoo Mini+ (Twitch/VNC/RTMP/Outputfile)* 4. [**Speed Test**](https://github.com/josegonzalez/miyoo-speedtest) by josegonzalez - *An app to allow testing internet speed on the miyoo mini plus* + *An app to allow testing internet speed on the Miyoo Mini+* 5. [**Spotify Client**](https://github.com/XK9274/ncspotcli-compile-miyoo) by XK9274 - *Builds ncspot for the Miyoo Mini + (contains appfolder)* + *Builds ncspot for the Miyoo Mini+ (contains appfolder)* 6. [**syncthing**](https://github.com/XK9274/syncthing-app-miyoo) by XK9274 *Sets up Syncthing and injects into Onion 4.2.0 beta runtime.sh* 7. [**Time Quick Fix**](https://github.com/hotcereal/time-quick-fix) by hotcereal - *Using NTP and CloudFlare, fix your system time.* + *Using NTP and CloudFlare, fix your system time* 8. [**VNC Server**](https://github.com/XK9274/vncserver-miyoo) by XK9274 *VNC Server (upside down fixed)* -9. [**Wi-Fi Password Saver**](https://github.com/funkykovalski/WIFI) by funkykovalski - *Script to save WIFI password* +9. [**WiFi Password Saver**](https://github.com/funkykovalski/WIFI) by funkykovalski + *Script to save WiFi password* diff --git a/website/docs/07-apps/03-network-features/07-vnc-server.md b/website/docs/07-apps/03-network-features/07-vnc-server.md index 53416162ec..f73d57eb44 100644 --- a/website/docs/07-apps/03-network-features/07-vnc-server.md +++ b/website/docs/07-apps/03-network-features/07-vnc-server.md @@ -3,27 +3,27 @@ slug: /network/vnc --- -# VNC server +# VNC Server ![](./assets/vnc.webp) -Remote display and remote control of your Miyoo Mini Plus from your computer thanks to VNC. +Remote display and remote control of your Miyoo Mini+ from your computer thanks to VNC. ## Features -- Remote display of the Miyoo Mini Plus -- Remote control of the Miyoo Mini Plus +- Remote display of the Miyoo Mini+ +- Remote control of the Miyoo Mini+ ## Enabling VNC access You'll find it in Tweaks app: [`Network` -› `VNC: Screen share`](/docs/apps/tweaks#vnc-screen-share). -You can either use the master toggle to turn the VNC server on with your Right/Left arrows, or press A to enter the submenu and you'll get 2 options: +You can either use the master toggle to turn the VNC Server on with your right/left arrows, or press A to enter the submenu and you'll get 2 options: 1. **Enable** - Activate VNC Server -2. **Framerate** - Set the framerate of the VNC Server between 1 and 20. The higher the framerate, the more CPU will be use. +2. **Framerate** - Set the framerate of the VNC Server between 1 and 20. The higher the framerate, the more CPU will be use ## Logging in @@ -33,13 +33,13 @@ You'll need the IP of the device, found below (**Tweaks** › **Network**) ![](https://github.com/OnionUI/Onion/assets/47260768/23ee6dbf-48c8-4484-b98b-9a8642b8fd49) -Copy it to your VNC client (the default port is used so no need to specify it : 5900). +Copy it to your VNC client (the default port is used so no need to specify it: 5900). -For example : +For example: ![](./assets/vnc-client.webp) -Once connected, Keybinds need to match what MainUI/SDL is expecting, which is: +Once connected, Keybinds need to match what MainUI/SDL is expecting, which are: ``` # A = K_SPACE
STARTFull screen / 16:9Full screen/16:9
SELECT