143 lines
5 KiB
Markdown
143 lines
5 KiB
Markdown
# FinUI
|
|
|
|
FinUI is a fork of [MinUI](https://github.com/shauninman/union-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](https://github.com/shauninman/union-minui/releases).
|
|
|
|
### Additional FinUI features
|
|
|
|
- Add to Favorites
|
|
- Clear Recently Played
|
|
- All extras included in default installation
|
|
- Improved developer onboarding
|
|
|
|
### Shortcuts
|
|
|
|
| Description | Shortcut |
|
|
| ---------------------------- | ---------------------------- |
|
|
| Adjust brightness | MENU + VOLUME_DOWN/VOLUME_UP |
|
|
| Add to Favorites (from menu) | SELECT |
|
|
|
|
## 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](https://github.com/shauninman/union-minui/releases)
|
|
- An [administrator user account](https://support.apple.com/guide/mac-help/change-users-groups-settings-mtusr001/mac)
|
|
- [Full Disk Access](https://support.apple.com/guide/mac-help/change-privacy-security-settings-on-mac-mchl211c911f/13.0/mac/13.0)
|
|
for the app `Terminal.app`
|
|
|
|
### Install MinUI
|
|
|
|
1. Connect your microSD card to your Mac
|
|
1. Start the app `Terminal`
|
|
1. Run the command `diskutil list` and identify your microSD by looking at the `SIZE`
|
|
column. It is `/dev/disk4` in this example.
|
|
1. Run the command `diskutil unmountDisk /dev/disk4`
|
|
1. Unzip the RG35XX firmware to your desktop and then run the command `cd ~/Desktop`
|
|
in the Terminal
|
|
1. 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.
|
|
1. 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!
|
|
1. 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.
|
|
1. 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.
|
|
1. Unzip the MinUI release to your desktop
|
|
1. 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.
|
|
1. Finally, to remove dotfiles created by macOS on your microSD, run:
|
|
|
|
```shell
|
|
dot_clean -m /Volumes/misc
|
|
rm -fr /Volumes/misc/.feventsd
|
|
rm -fr /Volumes/misc/.Spotlight-V100
|
|
rm -fr /Volumes/misc/.Trashes
|
|
|
|
dot_clean -m /Volumes/ROMS
|
|
rm -fr /Volumes/ROMS/.feventsd
|
|
rm -fr /Volumes/ROMS/.Spotlight-V100
|
|
rm -fr /Volumes/ROMS/.Trashes
|
|
```
|
|
|
|
Done. Insert your microSD to your RG35XX and boot it up!
|
|
|
|
## Development
|
|
|
|
### Prerequisites
|
|
|
|
- [Docker Desktop](https://docker.com/products/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 to Favorites~~
|
|
- Improve battery capacity readings (2100 mAh, 2600 mAh, 3500 mAh)
|
|
- Adjust overclocking and CPU usage (to maximize battery life)
|
|
- 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?...](./todo.txt)
|
|
|
|
## 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
|