Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
XK9274 authored May 3, 2024
2 parents 0f894d5 + 0f1cf6f commit 219e211
Show file tree
Hide file tree
Showing 23 changed files with 161 additions and 161 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions website/docs/04-emulators/05-miscellaneous/15-superbroswar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
:::
:::
16 changes: 8 additions & 8 deletions website/docs/07-apps/01-included-in-onion/activity-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>MENU</kbd>+<kbd>POWER</kbd> - 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 <kbd>MENU</kbd>+<kbd>POWER</kbd> - 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

Expand Down
12 changes: 6 additions & 6 deletions website/docs/07-apps/01-included-in-onion/advance-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -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*

Expand Down Expand Up @@ -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.



Expand Down
10 changes: 5 additions & 5 deletions website/docs/07-apps/01-included-in-onion/blue-light-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions website/docs/07-apps/01-included-in-onion/clock.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
---
slug: /apps/clock
description: Set your Onions time
description: Set your Onion's time
---

# Clock
<p><i>{frontMatter.description}</i></p>

## 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.

![](./assets/clock.png)


:::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
Expand Down
38 changes: 19 additions & 19 deletions website/docs/07-apps/01-included-in-onion/game-list-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. <br />
Press <kbd>Y</kbd> 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 <kbd>Y</kbd> 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

Expand All @@ -28,32 +28,32 @@ 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 <sub>(Miyoo Mini Plus only)</sub> :*
- **Scraper** - *Download image covers for your games. <a href="scraper">More details here</a>*
- **Netplay** - *Launch or join a multiplayer game. <a href="../multiplayer">More details here</a>*
- **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: <sub>(Miyoo Mini Plus only)</sub>*
- **Scraper**: *Download image covers for your games. <a href="scraper">More details here</a>*
- **Netplay**: *Launch or join a multiplayer game. <a href="../multiplayer">More details here</a>*


## Advanced

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
- `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
24 changes: 12 additions & 12 deletions website/docs/07-apps/01-included-in-onion/game-switcher.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>POWER</kbd>).
- 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 <kbd>POWER</kbd>)
- 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

Expand All @@ -55,10 +55,10 @@ The last game played will be resumed in a few seconds, and with the simple press
| <kbd>Left/Right</kbd> | Navigate between last played games |
| <kbd>Up/Down</kbd> | Set brightness |
| <kbd>A</kbd> or <kbd>Menu</kbd> | Resume selected game |
| <kbd>B</kbd> | quit |
| <kbd>X</kbd> | Remove from Game Switcher <br /><sub>(it will keep the save state)</sub> |
| <kbd>B</kbd> | Quit |
| <kbd>X</kbd> | Remove from GameSwitcher <br /><sub>(it will keep the save state)</sub> |
| <kbd>Y</kbd> | Toggle fullscreen |
| <kbd>Select</kbd> | toggle playtime display |
| <kbd>Select</kbd> | Toggle playtime display |

</p>

Expand All @@ -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.
:::
GameSwitcher builds on RetroArch's Save State functionality so it's not compatible with standalone emulators.
:::
4 changes: 2 additions & 2 deletions website/docs/07-apps/01-included-in-onion/guest-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
| --------------- | --------------- |
Expand All @@ -34,4 +34,4 @@ The profile contains the following properties:
- Timers for your games
<sup>Play Activity app</sup>
- RGUI config
<sup>RetroArch Graphic User Interface</sup>
<sup>RetroArch Graphic User Interface</sup>
12 changes: 6 additions & 6 deletions website/docs/07-apps/01-included-in-onion/music-player.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ Gmu supports MPEG audio, Ogg Vorbis and Ogg Opus for internet audio

| Function | Button |
| --------------- | ----------------------------------- |
| play | <kbd>A</kbd> (in playlist and in filebrowser) |
| pause | <kbd>start</kbd> |
| seek in track | <kbd>Left/Right</kbd> |
| prev/next track | <kbd>L1/R1</kbd> |
| Play | <kbd>A</kbd> (In playlist and in filebrowser) |
| Pause | <kbd>Start</kbd> |
| Seek in track | <kbd>Left/Right</kbd> |
| Prev/Next track | <kbd>L1/R1</kbd> |
| ToggleView | <kbd>Select</kbd> |
| exit | <kbd>Menu</kbd> + <kbd>Select</kbd> (similar to RA menu) |
| help | <kbd>Menu</kbd> + <kbd>Start</kbd> |
| Exit | <kbd>Menu</kbd> + <kbd>Select</kbd> (similar to RA menu) |
| Help | <kbd>Menu</kbd> + <kbd>Start</kbd> |


### Playlist Controls
Expand Down
12 changes: 6 additions & 6 deletions website/docs/07-apps/01-included-in-onion/ota-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@ 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.

## Advanced

[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
- check disk integrity with fsck.fat, important to avoid SD card FAT file system corruption
- generate different exit error codes
Loading

0 comments on commit 219e211

Please sign in to comment.