plumOS MF

plumOS MF is the development repository for plumOS on the Miyoo Flip (RK3566 / ARM64).

The current design uses the stockOS kernel and boot foundation until control passes to /mnt/SDCARD/.tmp_update/updater. plumOS then owns the System, frontend, emulators, applications, services, settings, and update policy. A normal SD card uses one FAT32 partition and does not require an additional partition or a NAND modification.

Documentation

Documentation is separated by audience and is available in English and Japanese.

• Documentation index
• User guide
• Developer guide
• 日本語プロジェクト概要

The user guide covers normal installation and operation. Build, deployment, release, implementation, and hardware-validation material is kept in the developer guide.

Quick Start

Start Docker Desktop and prepare the ARM64 toolchain image.

./scripts/docker-build.sh image
./scripts/docker-build.sh --help

Representative component builds:

./scripts/docker-build.sh frontend
./scripts/docker-build.sh retroarch
./scripts/docker-build.sh cores
./scripts/docker-build.sh app-layer --strict
./scripts/docker-build.sh system-rootfs
./scripts/docker-build.sh stock-hook

To run release checks and create a .7z package that is extracted to the root of a FAT32 SD card:

./scripts/docker-build.sh strict-release
./scripts/docker-build.sh sdroot-package

Generated artifacts are written below output/ and are not tracked by Git. ROMs, user-supplied BIOS files, saves, network credentials, and private keys are not included in the repository or release artifacts.

License

plumOS-authored files are licensed under the MIT License. Vendor and third-party components retain their original terms.

• NOTICE
• Third-party notices
• Third-party notices in Japanese

Release-time license, ROM/BIOS, secret, and checksum checks:

./scripts/docker-build.sh license-audit
./scripts/docker-build.sh strict-release