vphone
  • English

      • Research library

      Project overview · User documentation

      This directory keeps the evidence behind firmware patches, restore and the self-contained host runtime. The current public workflow is JB only. Many notes record earlier experiments and command names; use the user guides and vphone-cli --help for current instructions.

      Working on vphone

      • vphone-launchpad: a Mac app that downloads and installs VPhone.bundle and sets up the host. Released separately.
      • vphone-cli: prepares firmware, patches it, restores the system, and manages VMs.
      • vphone-vm: runs the VM and shows its window.
      • vphoned: the control service inside the VM. The window's features and the API work through it.
      PathContents
      VPhoneExecutable/vphone-cli, vphone-vm, firmware patching and restore
      VPhoneKit/Shared host libraries and API client
      VPhoneDaemon/vphoned
      VPhoneGuestComponents/Hooks and helper programs inside the VM
      VPhoneLaunchpad/The Launchpad app and its helper
      VPhoneWebsite/This documentation site, built with Rspress from Documents/ and Research/
      • xcodebuild -workspace VPhone.xcworkspace -scheme VPhone build produces and validates VPhone.bundle. Run each project's test scheme separately.
      • The user manual is Documents/<lang>/, one identical tree per language (en is the source). Every manual page is listed in its language's README.md; the site's sidebar is built from those tables. Research notes stay in English.
      • Preview the site with npm ci && npm run dev in VPhoneWebsite/.

      Start here

      1. Patch comparison is the canonical per-component inventory. Its regular/dev/exp columns are historical.
      2. Firmware manifest and origins explains the hybrid firmware inputs.
      3. CFW kernel patch notes and the individual patch index lead to the kernel evidence.
      4. Native restore design and self-contained runtime explain the host migration.

      By subject

      SubjectNotes
      Guest orientationSpringBoard language-change wedge and virtual gravity
      Firmware and boot chainManifest and origins, iBoot patches, TXM full chain, TXM JB patches, selector 24, variant differences
      KernelNative KDK extraction and byte-parity tests, CFW overview, patcher verification, FairPlay kexts, base validation 1–5, 11–15, 16–20, sandbox hooks, individual patch notes
      Other patches and capturesLaunchd jetsam, user-mode hypervisor references, reference capture
      RestoreDFU probe, in-process restore
      Host and archivesBinary split, runtime dependency tiers, archive extraction contracts, libarchive validation, guest MAC, fixed address, port forwarding and names, machine identity and vm clone --new-identity
      VM disk spaceWhere a VM's disk space goes (overview and measured savings), machine templates, sharing identical disk blocks with vm rebase, guest TRIM and offline compaction, why the disk layout was not made deterministic, why there is no content-addressed block store over NBD
      Guest interaction and VM identityDevMode XPC, keyboard events, machine identifier, Auto-Lock on the Lock Screen, display refresh rate, GPU acceleration, RootHide bootstrap base, the Mac's .local name, locationd startup deadlock, host clock sync, trimming system services, deleting the orig-fs snapshot for templates
      Historical project recordsMigration ledger, manifest refactoring summary

      KernelSymbols/ holds symbol datasets and indexes; Reference/ holds source references when present. They are evidence inputs, not steps for running the distributed app. The files in History/ are preserved snapshots and may describe scripts or variants that have since been removed.