Flags, paths, and scripts may change without notice. Metal, macOS are trademarks of Apple Inc. Reims vGPU is an independent project and is not affiliated with, sponsored by, or endorsed by Apple Inc.
Docs
Reims vGPU ships boot scripts and the device — not a ready-made macOS disk image. The flow on every pathway: pick a pathway → provision a guest once → freeze a golden snapshot → use snapshot-revert boots day to day.
macOS 13 Ventura is the recommended guest on both rails. Other macOS versions may or may not work. The project never distributes disk images, IPSWs, or OpenCore/OVMF blobs — these guides describe provisioning, and point at the tools that fetch Apple's own media.
Guides
x86_64 guest on Linux (KVM)
Provision with OSX-KVM, place the OpenCore/OVMF artifacts where vm/boot-x86.sh expects them, capture a golden snapshot, then boot with --device reims-vgpu-pci on the Vulkan backend.
arm64 guest on Apple Silicon (HVF / vmapple)
Provision from a UniversalMac IPSW with scripts/vmapple-provision/, configure the guest once, capture a golden snapshot, then boot with --device reims-vgpu-mmio — Vulkan via MoltenVK today, direct Metal planned.
Where things live in the repo
| Path | What it is |
|---|---|
crates/reims-vgpu | The product: protocol decode, device model, scheduling, host GPU backends (Rust staticlib) |
vendor/qemu | Vendored QEMU fork with the thin device shim — rebuilt after product changes |
vm/ | Boot scripts (boot-x86.sh, boot-arm64.sh), guest artifacts (private, gitignored) |
scripts/ | QEMU builds, vmapple provisioning/config/snapshot, QMP helper, screenshot capture |
Rules of thumb
- Prefer
--testingfor agent/measurement boots — time-bounded, always reverts. - Use
--interactivefor open-ended GUI sessions — still reverts unless capturing. - Never commit disks, IPSWs, or OpenCore/OVMF runtime under
vm/. - Rebuild QEMU after product changes before claiming a live boot result.