mvietri/union-minui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

updating readmes (still not done)

Browse source
This commit is contained in:
Shaun Inman 2023-02-12 14:37:58 -05:00
parent cff45efe32
commit 01d83149d0
2 changed files with 29 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

29
skeleton/BASE/README.txt
View file

@ -30,12 +30,16 @@ Features
----------------------------------------
Install
TODO
Step 1. Copy "dmenu.bin" to the root of the MISC partition of the SD card that goes in the TF1 slot.
Step 2. Where you copy "MinUI.zip" will depend on if you are using one or two SD cards (using two SD cards is recommended). If using one SD card, copy "MinUI.zip" to the root of the ROMS partition of the SD card that goes in the TF1 slot. Otherwise copy "MinUI.zip" to the root of the SD card that goes in the TF2 slot.
During installation (but not on subsequent updates) MinUI will install a custom boot logo. It will save a backup of your existing "boot_logo.bmp.gz" in a folder named "bak" at the root of the ROMS partition of the SD card that goes into the TF1 slot.
----------------------------------------
Update
TODO
Follow Step 2 of the Install instructions above.
----------------------------------------
Shortcuts
@ -49,7 +53,7 @@ Roms
Included in this zip is a Roms folder containing folders for each console MinUI currently supports. You can rename these folders but you must keep the uppercase tag name in parentheses in order to retain the mapping to the correct emulator (eg. "Nintendo Entertainment System (FC)" could be renamed to "Nintendo (FC)", "NES (FC)", or "Famicom (FC)").
You should probably preload these folders with roms and copy each one to the Roms folder on your SD card before installing. Or not, I'm not the boss of you.
You can (and probably should) preload these folders with roms and copy each one to the Roms folder on your SD card before installing.
When one or more folder share the same display name (eg. "Game Boy Advance (GBA)" and "Game Boy Advance (MGBA)") they will be combined into a single menu item containing the roms from both folders (continuing the previous example, "Game Boy Advance"). This allows opening specific roms with an alternate pak.
@ -89,7 +93,7 @@ the m3u file would contain just:
Policenauts (Japan) (Disc 1).cue
Policenauts (Japan) (Disc 2).cue
MinUI also reportedly supports chd files and official pbp files (multi-disc pbp files larger than 2GB are not supported).
MinUI also supports chd files and official pbp files (multi-disc pbp files larger than 2GB are not supported). Regardless of the multi-disc file format used, every disc of the same game share the same memory card and save state slots.
----------------------------------------
Collections
@ -106,4 +110,19 @@ Advanced
MinUI can automatically run a user-authored shell script on boot. Just place a file named "auto.sh" to "/.userdata/".
TODO
----------------------------------------
Thanks
To BlackSeraph, for sharing his modified uImage which provides overclocking (and underclocking) and increases the available framebuffer memory.
To eggs, for his NEON scalers, years of top-notch example code, and patience in the face of my endless questions.
Check out eggs' RG35XX releases: https://www.dropbox.com/sh/3av70t99ffdgzk1/AAAKPQ4y0kBtTsO3e_Xlrhqha
To neonloop, for putting together the Trimui toolchain from which I learned everything I know about docker and buildroot and is the basis for every toolchain I've put together since, and for picoarch, the inspiration for minarch.
Check out neonloop's repos: https://git.crowdedwood.com
And to Jim Gray, for commiserating during development, for early alpha testing, and for providing the soundtrack for much of MinUI's development.
Check out Jim's music: https://ourghosts.bandcamp.com/music

33
skeleton/EXTRAS/README.txt
View file

@ -1,38 +1,15 @@
MinUI is an extensible launcher
Source: https://github.com/shauninman/MinUI2
Source: TODO
----------------------------------------
Adding Paks
Install
A pak is a folder with a pak extension that contains a shell script named launch.sh.
There are two kinds of paks, emulators and tools. Emulator paks live in the Emus folder. Tool paks live in the Tools folder. Both of those folders live at the root of your SD card. If you're adding paks created by someone else (sharing is caring) just copy each pak into the corresponding folder. That's usually it but they may have additional steps (eg. additions to the Roms or Bios folders). Check for a readme or ask the original author if you're unsure.
----------------------------------------
Creating an emulator pak
There are two kinds of emulator paks, both similar, both super simple. The first re-uses an existing MinUI libretro core. The second uses a custom libretro core. To illustrate the different approaches, let's create a Sega Game Gear pak (already part of this zip file).
First create an "Emus" folder at the root of your SD card if one doesn't already exist. Then make sure your file browser is showing invisible files for this next step. Copy "/.system/paks/Emus/MD.pak/" into the Emus folder and rename it to GG.pak. GG is your emulator tag. The tag is used to map its roms folder to the pak. That's it. You're done. You just created your first MinUI emulator pak! Now create the corresponding roms folder "/Roms/Game Gear (GG)/" (see, there's that tag again!) and load it up with a few roms. Boot up MinUI and give it a shot. Easy, right? Let's do the next one.
First download the smsplus-gx_libretro.so core and put it in your GG.pak. Then open launch.sh in a plain text editor (make sure this editor uses just `\n` for newlines, Linux is picky Windows friends). We need to change two things this time. Replace `EMU_EXE=picodrive` with `EMU_EXE=smsplus-gx` then right below that line add `CORES_PATH=$(dirname "$0")`. Save and you're done. Still pretty damn easy.
There are two things to consider when creating your own emulator pak. If a core doesn't support save states, autoresume will not work. That means if a player manually powers off in game or it falls alseep while on the menu and automatically powers off, they will lose any unsaved progress. Please don't do this to people. It doesn't matter if you mention it in a readme (!), people won't read it and they will be angry at you (or more likely, me). Just don't. The other thing worth noting is that MinUI doesn't enable swap by default (it can degrade performance of emulators that don't need it). For emulators that require more memory than is physically available on the Miyoo Mini, just call `needs-swap` before launching `picoarch` to enabled a 128MB swap image.
TODO
----------------------------------------
Bios files
You'll need to BYOB for these emulator paks included in this zip file.
You'll need to BYOB for the emulator paks included in this zip file.
MGBA: gba_bios.bin
PCE: syscard3.pce
PKM: bios.min
SGB: sgb_bios.bin
----------------------------------------
Creating a tool pak
Tool paks can run a GUI program, setup a daemon, or just script a quick action before exiting. See the Files and Screenshots paks for examples but usually a tool pak will change to the current directory, set any necessary environmental variables, and then launch a binary relative to the folder.
MinUI comes with a couple of binaries to simplify providing feedback to users: show, blank, say, and confirm. (If you need to perform a longer action with discrete steps there is also the more advanced progressui.) Check out the Example pak for...um, an example of how those work.
PKM: bios.min