Skip to content

Commit dc63b42

Browse files
authored
Update README.md
1 parent 6593c15 commit dc63b42

1 file changed

Lines changed: 119 additions & 4 deletions

File tree

README.md

Lines changed: 119 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,123 @@
1-
## macrecovery
1+
# OSX4VM — Mastered Edition
2+
### Windows Edition 1.0 · OpenCore 1.0.5
23

3-
macrecovery is a tool that helps to automate recovery interaction. It can be used to download diagnostics and recovery as well as analyse MLB.
4+
> Highly engineered. Optimized kernel. Intelligent boot engine.
45
5-
Requires python3 to run. Run with `-h` argument to see all available arguments.
6+
OSX4VM is a hand-crafted OpenCore + QEMU/KVM configuration for running macOS on Windows (via WSL2) or native Linux. Built for maximum responsiveness, real Mac-like behavior, and the cleanest possible implementation.
67

7-
To create a disk image for a virtual machine installation use `build-image.sh`.
8+
---
89

10+
## Getting Started
11+
12+
```bash
13+
git clone https://github.com/ltnproject/OSX4VM.git
14+
cd OSX4VM
15+
```
16+
17+
---
18+
19+
## Prerequisites
20+
21+
Before running, make sure the following are in place:
22+
23+
- **Virtualization enabled** in your BIOS (VT-x for Intel, AMD-V/SVM for AMD)
24+
- **WSL2** installed (Windows users) — or a native Linux environment
25+
- **QEMU** and **KVM** installed on your system
26+
- **Python 3** available in your terminal
27+
28+
> Not sure if virtualization is enabled? Check Task Manager → Performance → CPU and look for **Virtualization: Enabled**. If it shows Disabled, enter your BIOS and enable it before continuing.
29+
30+
---
31+
32+
## Setup Guide
33+
34+
### 1 — Fetch macOS Installer
35+
36+
Download the official macOS Recovery image directly from Apple's servers. Supports **macOS Tahoe (26)** and earlier.
37+
38+
```bash
39+
python3 fetch_macos.py
40+
```
41+
42+
### 2 — Create Virtual Disk
43+
44+
Create a high-performance QCOW2 virtual disk. 64 GB minimum, **128 GB recommended**.
45+
46+
```bash
47+
qemu-img create -f qcow2 mac_hdd.qcow2 128G
48+
```
49+
50+
### 3 — Initialize Boot Engine
51+
52+
Launch the boot engine. It automatically detects your hardware, verifies KVM health, and optimizes memory mapping.
53+
54+
```bash
55+
chmod +x boot.sh && ./boot.sh
56+
```
57+
58+
### 4 — Install macOS
59+
60+
Once OpenCore loads:
61+
62+
1. Select **macOS Base System**
63+
2. Open **Disk Utility** and format your virtual drive as **APFS**
64+
3. Close Disk Utility and proceed with the installation
65+
4. Reboot when prompted — you're done
66+
67+
---
68+
69+
## What's Included
70+
71+
| Component | Description |
72+
|---|---|
73+
| `OpenCore/config.plist` | Hand-tuned OpenCore config with custom ACPI & RTC patches |
74+
| `fetch_macos.py` | Direct Apple CDN fetcher with automated BaseSystem logic |
75+
| `boot.sh` | Diagnostic boot engine with dynamic RAM/core allocation |
76+
77+
---
78+
79+
## Features
80+
81+
- **Advanced ACPI & RTC Patches** — Real Mac-like power behavior
82+
- **Power Management Optimizations** — Tuned for KVM host environments
83+
- **Enhanced WSL2 SMBios Data** — Seamless integration on Windows
84+
- **Real-time KVM Health Check** — Validates your setup before every boot
85+
- **Auto-Hardware Optimization** — Detects and adapts to your host machine
86+
- **Dynamic RAM/Core Allocation** — Maximizes guest performance automatically
87+
- **macOS Tahoe (26) Support** — Always up to date with the latest releases
88+
89+
---
90+
91+
## Configuration
92+
93+
The OpenCore configuration lives at `OpenCore/config.plist`. It includes custom kernel tweaks and resource allocation logic not found in standard repositories. Edit with caution — most users will not need to touch this file.
94+
95+
---
96+
97+
## Platform Support
98+
99+
| Platform | Status |
100+
|---|---|
101+
| Windows + WSL2 | ✅ Fully supported |
102+
| Native Linux (KVM) | ✅ Fully supported |
103+
| macOS host | ❌ Not supported |
104+
105+
---
106+
107+
## Notes
108+
109+
**Is this optimized?**
110+
Yes. This version includes custom kernel tweaks and resource allocation logic not found in standard repositories. Hand-tuned ACPI patches ensure real Mac-like power behavior.
111+
112+
**Which macOS versions are supported?**
113+
All modern macOS versions up to and including Tahoe (26). Select your target version when running `fetch_macos.py`.
114+
115+
---
116+
117+
## License
118+
119+
© 2026 Ltn Project. Privacy and power.
120+
121+
---
122+
123+
*For more detailed information, visit [github.com/ltnproject/OSX4VM](https://github.com/ltnproject/OSX4VM)*

0 commit comments

Comments
 (0)