Skip to content

Commit 827e26c

Browse files
authored
Revise README for clarity and project details
Updated README to reflect project goals and features.
1 parent 8e04434 commit 827e26c

File tree

1 file changed

+139
-7
lines changed

1 file changed

+139
-7
lines changed

README.md

Lines changed: 139 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,141 @@
1-
# 这里是OCLP-R 的3.0.0测试版
2-
## 如果不是开发/测试人员,或者有一定调试能力的人,建议不要下载
3-
## 这个测试版难免会出问题,因此请求的issue除非有帮助,否则issue很可能会被关闭
1+
<img src="docs/images/OC-Patcher.png" alt="OpenCore Patcher Logo" width="256" />
2+
<h1OCLP-R</h1>
3+
</div>
44

5-
---
5+
A Python-based project revolving around [Acidanthera's OpenCorePkg](https://github.com/acidanthera/OpenCorePkg) and [Lilu](https://github.com/acidanthera/Lilu) for both running and unlocking features in macOS on supported and unsupported Macs.
66

7-
# This is the 3.0.0 beta version of OCLP-R.
8-
## If you are not a developer/tester, or someone with some debugging skills, please do not download this.
9-
## This beta version is bound to have issues, so issues you request will likely be closed unless they are helpful.
7+
Our project's main goal is to breathe new life into Macs no longer supported by Apple, allowing for the installation and usage of macOS Big Sur and newer on machines as old as 2007.
8+
9+
----------
10+
11+
![GitHub all releases](https://img.shields.io/github/downloads/dortania/OpenCore-Legacy-Patcher/total?color=white&style=plastic) ![GitHub top language](https://img.shields.io/github/languages/top/dortania/OpenCore-Legacy-Patcher?color=4B8BBE&style=plastic) ![Discord](https://img.shields.io/discord/417165963327176704?color=7289da&label=discord&style=plastic)
12+
13+
----------
14+
15+
Noteworthy features of OCLP-R:
16+
17+
* Support for macOS Big Sur, Monterey, Ventura, Sonoma and Sequoia
18+
* Native Over the Air (OTA) System Updates
19+
* Supports Penryn and newer Macs
20+
* Full support for WPA Wi-Fi and Personal Hotspot on BCM943224 and newer wireless chipsets
21+
* System Integrity Protection, FileVault 2, .im4m Secure Boot and Vaulting
22+
* Recovery OS, Safe Mode and Single-user Mode booting on non-native OSes
23+
* Unlocks features such as Sidecar and AirPlay to Mac even on native Macs
24+
* Enables enhanced SATA and NVMe power management on non-Apple storage devices
25+
* Zero firmware patching required (ie. APFS ROM patching)
26+
* Graphics acceleration for both Metal and non-Metal GPUs
27+
28+
----------
29+
30+
Note: Only clean-installs and upgrades are supported. macOS Big Sur installs already patched with other patchers, such as [Patched Sur](https://github.com/BenSova/Patched-Sur) or [bigmac](https://github.com/StarPlayrX/bigmac), cannot be used due to broken file integrity with APFS snapshots and SIP.
31+
32+
* You can, however, reinstall macOS with this patcher and retain your original data
33+
34+
Note 2: Currently, OCLP-R officially supports patching to run macOS Big Sur through Sonoma installs. For older OSes, OpenCore may function; however, support is currently not provided from Dortania and Hackdoc.
35+
36+
* For macOS Mojave and Catalina support, we recommend the use of [dosdude1's patchers](http://dosdude1.com)
37+
38+
## Getting Started
39+
40+
To start using the project, please see our in-depth guide:
41+
42+
* [OpenCore Legacy Patcher Guide](https://dortania.github.io/OpenCore-Legacy-Patcher/)
43+
44+
## Support
45+
46+
This project is offered on an AS-IS basis, we do not guarantee support for any issues that may arise. However, there is a community server with other passionate users and developers that can aid you:
47+
48+
* [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN)
49+
* Keep in mind that the Discord server is maintained by the community, so we ask everyone to be respectful.
50+
* Please review our docs on [how to debug with OpenCore](https://dortania.github.io/OpenCore-Legacy-Patcher/DEBUG.html) to gather important information to help others with troubleshooting.
51+
52+
## Running from source
53+
54+
To run the project from source, see here: [Build and run from source](./SOURCE.md)
55+
56+
## Credits
57+
58+
* [Acidanthera](https://github.com/Acidanthera)
59+
* OpenCorePkg, as well as many of the core kexts and tools
60+
* [DhinakG](https://github.com/DhinakG)
61+
* Main co-author
62+
* [Khronokernel](https://github.com/Khronokernel)
63+
* Main co-author
64+
* [Ausdauersportler](https://github.com/Ausdauersportler)
65+
* iMacs Metal GPUs Upgrade Patch set and documentation
66+
* Great amounts of help with debugging, and code suggestions
67+
* [vit9696](https://github.com/vit9696)
68+
* Endless amount of help troubleshooting, determining fixes and writing patches
69+
* [EduCovas](https://github.com/covasedu)
70+
* [non-Metal patch set](https://github.com/moraea/non-metal-frameworks) for nVidia Tesla/Fermi/Maxwell/Pascal, AMD TeraScale 1/2, and Intel Core 1st/2nd Generation GPUs
71+
* [3802 Metal patch set](https://github.com/moraea/misc-patches/tree/main/3802-Metal-15) and [MetallibSupportPkg](https://github.com/dortania/MetallibSupportPkg) for nVidia Kepler and Intel Core 3rd/4th Generation GPUs
72+
* Metal bundle patches and shims for [nVidia Kepler](https://github.com/moraea/misc-patches/tree/main/Kepler%2013%2B), [AMD GCN 1 - 4](https://github.com/moraea/misc-patches/tree/main/GCN%2013%2B), and [AMD GCN 5 (Vega)](https://github.com/moraea/misc-patches/tree/main/vega%2013%2B)
73+
* [IOSurface offset patches](https://github.com/moraea/misc-patches/tree/main/Sonoma%2014.4%20IOSurface) for nVidia Kepler, AMD GCN 1 - 5, and Intel Core 3rd - 6th Generation GPUs
74+
* [legacy Wi-Fi patch set](https://github.com/moraea/unsupported-wifi-patches) restores functionality for Wi-Fi cards in all 2007 - 2017 models
75+
* [T1 patch set](https://github.com/moraea/misc-patches/tree/main/T1-Patch) restores Touch ID, Apple Pay, and other secure functionality in 2016 - 2017 models
76+
* AppleGVA downgrade for accelerated video decoding on 2012 - 2016 models
77+
* OpenCL and OpenGL downgrade for AMD GCN
78+
* [USB 1 patch](https://github.com/moraea/misc-patches/tree/main/IOUSBHostFamily-14.4)
79+
* [ASentientHedgehog](https://github.com/moosethegoose2213)
80+
* [non-Metal patch set](https://github.com/moraea/non-metal-frameworks) for nVidia Tesla/Fermi/Maxwell/Pascal, AMD TeraScale 1/2, and Intel Core 1st/2nd Generation GPUs
81+
* [ASentientBot](https://github.com/ASentientBot)
82+
* [non-Metal patch set](https://github.com/moraea/non-metal-frameworks) for nVidia Tesla/Fermi/Maxwell/Pascal, AMD TeraScale 1/2, and Intel Core 1st/2nd Generation GPUs
83+
* [Metal bundle interposer](https://github.com/moraea/misc-patches/tree/main/sequoia%2031001%20interposer) for AMD GCN 1 - 5 and Intel Core 5th/6th Generation GPUs
84+
* [dsce](https://github.com/moraea/dsce) and [shared code](https://github.com/moraea/moraea-common) used by some other patches
85+
* [cdf](https://github.com/cdf)
86+
* Mac Pro on OpenCore Patch set and documentation
87+
* [Innie](https://github.com/cdf/Innie) and [NightShiftEnabler](https://github.com/cdf/NightShiftEnabler)
88+
* [Syncretic](https://forums.macrumors.com/members/syncretic.1173816/)
89+
* [AAAMouSSE](https://forums.macrumors.com/threads/mp3-1-others-sse-4-2-emulation-to-enable-amd-metal-driver.2206682/), [telemetrap](https://forums.macrumors.com/threads/mp3-1-others-sse-4-2-emulation-to-enable-amd-metal-driver.2206682/post-28447707) and [SurPlus](https://github.com/reenigneorcim/SurPlus)
90+
* [dosdude1](https://github.com/dosdude1)
91+
* Main author of the [original GUI](https://github.com/dortania/OCLP-GUI)
92+
* Development of previous patchers, laying out much of what needs to be patched
93+
* [parrotgeek1](https://github.com/parrotgeek1)
94+
* [VMM Patch Set](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/4a8f61a01da72b38a4b2250386cc4b497a31a839/payloads/Config/config.plist#L1222-L1281)
95+
* [BarryKN](https://github.com/BarryKN)
96+
* Development of previous patchers, laying out much of what needs to be patched
97+
* [mario_bros_tech](https://github.com/mariobrostech) and the rest of the Unsupported Mac Discord
98+
* Catalyst that started OpenCore Legacy Patcher
99+
* [arter97](https://github.com/arter97/)
100+
* [SimpleMSR](https://github.com/arter97/SimpleMSR/) to disable firmware throttling in Nehalem+ MacBooks without batteries
101+
* [Mr.Macintosh](https://mrmacintosh.com)
102+
* Endless hours helping architect and troubleshoot many portions of the project
103+
* [flagers](https://github.com/flagersgit)
104+
* Aid with Nvidia Web Driver research and development
105+
* [non-Metal patch set](https://github.com/moraea/non-metal-frameworks) for nVidia Tesla/Fermi/Maxwell/Pascal, AMD TeraScale 1/2, and Intel Core 1st/2nd Generation GPUs
106+
* [Metal bundle interposer](https://github.com/moraea/misc-patches/tree/main/sequoia%2031001%20interposer) for AMD GCN 1 - 5 and Intel Core 5th/6th Generation GPUs
107+
* LegacyRVPL, SnapshotIsKill, etc. to aid in rapid testing and development
108+
* [joevt](https://github.com/joevt)
109+
* [FixPCIeLinkrate](https://github.com/joevt/joevtApps)
110+
* [Jazzzny](https://github.com/Jazzzny)
111+
* Research and various contributions to the project
112+
* UEFI Legacy XHCI research and development
113+
* NVIDIA OpenCL research and development
114+
* `MacBook5,2` research and development
115+
* LegacyKeyboardInjector
116+
* Pre-Ivy Bridge Aquantia Ethernet Patch
117+
* Non-Metal Photo Booth Patch for Monterey+
118+
* GUI and Backend Development
119+
* Updater UI
120+
* macOS Downloader UI
121+
* Downloader UI
122+
* USB Top Case probing
123+
* Developer root patching
124+
* Vaulting implementation
125+
* macOS 15 3802 Helios Research
126+
* UEFI bootx64.efi research
127+
* universal2 build research
128+
* Various documentation contributions
129+
* Amazing users who've graciously donate hardware:
130+
* [JohnD](https://forums.macrumors.com/members/johnd.53633/) - 2013 Mac Pro
131+
* [SpiGAndromeda](https://github.com/SpiGAndromeda) - AMD Vega 64
132+
* [turbomacs](https://github.com/turbomacs) - 2014 5k iMac
133+
* [vinaypundith](https://forums.macrumors.com/members/vinaypundith.1212357/) - MacBook7,1
134+
* [ThatStella7922](https://github.com/ThatStella7922) - 2017 13" MacBook Pro (A1708)
135+
* zephar - 2008 Mac Pro
136+
* jazo97 - 2011 15" MacBook Pro
137+
* And others (reach out if we forgot you!)
138+
* MacRumors and Unsupported Mac Communities
139+
* Endless testing and reporting issues
140+
* Apple
141+
* for macOS and many of the kexts, frameworks and other binaries we reimplemented into newer OSes

0 commit comments

Comments
 (0)