union-minui/README.md

FinUI

FinUI is a fork of MinUI. MinUI is a focused custom launcher for the Anbernic RG35XX. FinUI adds additional features on top of MinUI.

Features

MinUI features

• Simple launcher, simple SD card
• No settings or configuration
• No boxart, themes, or distractions
• Automatically hides extension and region/version cruft in display names
• Consistent in-emulator menu with quick access to save states, disc changing, and emulator options
• Automatically sleeps after 30 seconds or press POWER to sleep (and wake)
• Automatically powers off while asleep after two minutes or hold POWER for one second
• Automatically resumes right where you left off if powered off while in-game, manually or while asleep
• Resume from manually created, last used save state by pressing X in the launcher instead of A
• Streamlined emulator frontend (minarch + libretro cores)

You can grab the latest version here.

Additional FinUI features

• Clear Recently Played
• All extras included in default installation
• Improved developer onboarding

Installation

The following section explains how to install MinUI using macOS, without having to download any additional tools. These instructions currently only work with 64GB microSD cards. Other sizes require additional partitioning steps that this guide does not cover yet.

Prerequisites

• A new 64GB microSD card from a reputable brand
• The offical Anbernic RG355XX firmware (35XX-64GB230309EN.IMG)
• A MinUI release
• An administrator user account
• Full Disk Access for the app Terminal.app

Install MinUI

1. Connect your microSD card to your Mac
2. Start the app Terminal
3. Run the command diskutil list and identify your microSD by looking at the SIZE column. It is /dev/disk4 in this example.
4. Run the command diskutil unmountDisk /dev/disk4
5. Unzip the RG35XX firmware to your desktop and then run the command cd ~/Desktop in the Terminal
6. Run the command sudo dd bs=1m if=35XX-64GB230309EN.IMG of=/dev/disk4 to flash the firmware onto your microSD. Enter your user account password if prompted. Wait.
7. Run the command diskutil list again and identify the largest partition on your microSD by looking at the SIZE column. It is /dev/disk4s4 in this example. Note that it differs from the previous path!
8. Run sudo diskutil eraseVolume FAT32 ROMS /dev/disk4s4 to format that partition as FAT32 with the name ROMS. Enter your user account password if prompted. Wait.
9. You should now have a misc and a ROMS disk connected to your Mac. If you don't then try reconnecting your microSD card to your Mac.
10. Unzip the MinUI release to your desktop
11. Copy dmenu.bin to the root of the misc disk. Copy MinUI.zip and the Bios, Emus, Roms, Saves, Tools folders to the root of the ROMS disk. Optionally, follow the additional instructions in the MinUI README if you wish.
12. Finally, run dot_clean -m /Volumes/misc and dot_clean -m /Volumes/ROMS to remove any dot-underscore files created by macOS on your microSD.

Done. Insert your microSD to your RG35XX and boot it up!

Development

Prerequisites

• Docker Desktop

Build project

Run ./start-toolchain.sh and then make all in the Docker container shell.

TODO

• Add macOS CLI installation instructions
• Move toolchain to repo
• Include extras in release by default
• Add Clear Recent setting
• Refactor Tools to Settings
• Add "mark as finished" OR "add as favorite" to menu
• Improve battery capacity readings (2100 mAh, 2600 mAh, 3500 mAh)
• Adjust overclocking
• Update Installation instructions for microSD cards of all sizes
• Automate installation and update
• Update visible MinUI strings and boot logo (show that it is the FinUI fork)
• Release using GitHub Actions
• ...Things in the old todo?...

Disclaimer

This software is provided without warranty of any kind. In no event shall the authors or contributors be liable for any claim, damages, or other liability, arising from, out of, or in connection with this software, the use of this software, or other dealings with this software.

Use at your own risk.

Contributors

robshape, guiburi