plumOS for Miyoo Mini Flip

Japanese counterpart: README.ja.md

This repository is the Miyoo Mini Flip (MMF) port of plumOS. The project keeps the plumOS-A30 layout and release model where possible, while isolating MMF specific display, input, audio, power, and performance work behind device profiles and runtime backends.

The current MMF user package is an SD-card root archive for fresh installs. It includes the MMF stock boot/audio/input/library boundary files collected from hardware plus the plumOS runtime. ROMs, BIOS files, saves, screenshots, videos, music, network secrets, and user media are not included.

Documentation

• Documentation index
• User guide
• Developer guide
• MMF install and rollback notes
• MMF release artifact policy
• MMF runtime port boundary

End-User Notes

Start with the user guide. The guide follows the same basic topics as plumOS-A30: installation, operation, SD-card layout, save data, scraping, and emulator profiles. MMF-only behavior is linked from those pages, including power behavior, USB disk-mode limits, and the current SD-root release format.

Important MMF differences:

• Install builds currently produce plumos-mmf-sdroot-<version>.7z, an archive that expands directly to the SD-card root.
• USB disk mode is not exposed as a working user feature on MMF; see MMF USB disk mode.
• Sleep is implemented as an Onion-style userland standby and timed shutdown flow, not kernel mem suspend; see MMF power policy.
• Some computer-style systems still depend on keyboard, mouse, BIOS, or content availability; see supported systems.

Developer Notes

Start with the developer guide. The normal build entry points are:

./scripts/docker-build.sh image
./scripts/docker-build.sh frontend
./scripts/docker-build.sh mmf-package
./scripts/docker-build.sh mmf-sdroot
./scripts/docker-build.sh release-bundle --version <version>

For hardware work, prefer the MMF helper scripts:

./scripts/run-mmf.sh "command"
./scripts/deploy-mmf.sh <local> <remote>
./scripts/mmf-fe-control.sh status
./scripts/mmf-fe-control.sh stop
./scripts/mmf-fe-control.sh start

MMF FE restart is intentionally disabled. When full OS restart validation is needed, shut the device down and power it on physically.