Sync PatcherSupportPkg

commit 07c274ccd388e83d9054aed09a03c40384c3fad3
Author: Amy <asentientbot@gmail.com>
Date:   Fri Nov 29 12:05:29 2024 -0500

    fix typo

    vega is gcn 5 not 4

commit d929f044a585a24c8cd3c25e5776e009a02aa195
Author: Amy <asentientbot@gmail.com>
Date:   Thu Nov 28 21:45:31 2024 -0500

    split and update moraea credits

    address outdated credits in areas im personally familiar with; this isn't exhaustive and other people's need updates too

.flake8

@@ -1,4 +1,4 @@
 [flake8]
-ignore = E501
+extend-ignore = E501, E203
 per-file-ignores =
-    Resources/Constants.py:E704
+    Resources/constants.py:E704

.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: opencore-legacy-patcher

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,34 +0,0 @@
----
-name: Bug report
-about: Create a report to help notify of issues
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the issue is. 
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Open app or .command '...'
-2. Enter '....'
-3. See error
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Build Folder**
-If applicable, add the generated OpenCore Build to help explain your problem.
-
-**Hardware (please complete the following information):**
- - OS Running (ie. macOS 10.15.7, Catalina)
- - OS Patching (ie. macOS 11.2.3, Big Sur)
- - Model Patching (ie. MacPro5,1)
-
-For in-depth hardware logs, we highly encourage users to run [IORegistryExplorer](https://github.com/khronokernel/IORegistryClone/blob/master/ioreg-210.zip?raw=true) and send the output
-* ie. `File -> SaveAs`
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,184 @@
+name: Bug Report
+description: File a bug report
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: dropdown
+    id: machine
+    attributes:
+      label: Machine Model
+      description: What model was being patched?
+      options:
+        - MacBook5,1
+        - MacBook5,2
+        - MacBook6,1
+        - MacBook7,1
+        - MacBook8,1
+        - MacBookAir2,1
+        - MacBookAir3,1
+        - MacBookAir3,2
+        - MacBookAir4,1
+        - MacBookAir4,2
+        - MacBookAir5,1
+        - MacBookAir5,2
+        - MacBookAir6,1
+        - MacBookAir6,2
+        - MacBookPro4,1
+        - MacBookPro5,1
+        - MacBookPro5,2
+        - MacBookPro5,3
+        - MacBookPro5,4
+        - MacBookPro5,5
+        - MacBookPro6,1
+        - MacBookPro6,2
+        - MacBookPro7,1
+        - MacBookPro8,1
+        - MacBookPro8,2
+        - MacBookPro8,3
+        - MacBookPro9,1
+        - MacBookPro9,2
+        - MacBookPro10,1
+        - MacBookPro10,2
+        - MacBookPro11,1
+        - MacBookPro11,2
+        - MacBookPro11,3
+        - Macmini3,1
+        - Macmini4,1
+        - Macmini5,1
+        - Macmini5,2
+        - Macmini5,3
+        - Macmini6,1
+        - Macmini6,2
+        - iMac7,1
+        - iMac8,1
+        - iMac9,1
+        - iMac10,1
+        - iMac11,1
+        - iMac11,2
+        - iMac11,3
+        - iMac12,1
+        - iMac12,2
+        - iMac13,1
+        - iMac13,2
+        - iMac13,3
+        - iMac14,1
+        - iMac14,2
+        - iMac14,3
+        - iMac14,4
+        - iMac15,1
+        - MacPro3,1
+        - MacPro4,1
+        - MacPro5,1
+        - Xserve2,1
+        - Xserve3,1
+        - Other/Non-Applicable
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Application Version
+      description: What build version of our software are you running?
+      options:
+        - Latest Build (nightly)
+        - Latest Release
+    validations:
+      required: true
+  - type: dropdown
+    id: variant
+    attributes:
+      label: Application Variant
+      description: What variant of our software are you running?
+      options:
+        - GUI (Graphical User Interface)
+        - CLI (Command Line Interface)
+        - Other/Non-Applicable
+    validations:
+      required: true
+  - type: dropdown
+    id: verify-previously-reported
+    attributes:
+      label: Have you verified whether this issue has been opened before? If no, your issue will be closed
+      description: If no, your issue will be closed. We'd appreciate it if users check with Github Issue's search before filing (https://github.com/dortania/OpenCore-Legacy-Patcher/issues?q=is%3Aissue)
+      multiple: true
+      options:
+        - 'true'
+        - 'false'
+    validations:
+      required: true
+  - type: dropdown
+    id: verify-guide
+    attributes:
+      label: Have you verified whether this issue is covered in our guide? ie. Troubleshooting and Legacy Acceleration pages
+      description: If no, your issue will be closed. We'd appreciate it if users check with Guide before filing (https://dortania.github.io/OpenCore-Legacy-Patcher/)
+      multiple: true
+      options:
+        - 'true'
+        - 'false'
+    validations:
+      required: true
+  - type: dropdown
+    id: used-forums
+    attributes:
+      label: Have you already verified this is a patcher bug and not a macOS bug/user error on our discord servers?
+      description: If no, please do not use issues for this. We'd appreciate it if users check discuss with others before filing. Issues are for valid patcher issues only, not for personal troubleshooting secessions.
+      multiple: true
+      options:
+        - 'true'
+        - 'false'
+    validations:
+      required: true
+  - type: dropdown
+    id: 3rd-party-application
+    attributes:
+      label: Is this issue with a 3rd party application?
+      description: If yes, please move discussions onto forums. We're unable to dedicate time to working on every single application that may be broken in macOS. Only file issues if you have a fix you'd like to add to our project
+      multiple: true
+      options:
+        - 'true'
+        - 'false'
+    validations:
+      required: true
+  - type: dropdown
+    id: os-version
+    attributes:
+      label: What versions of macOS are you seeing the problem on?
+      multiple: true
+      options:
+        - macOS 12, Monterey
+        - macOS 11, Big Sur
+        - macOS 10.15, Catalina
+        - macOS 10.14, Mojave
+        - macOS 10.13, High Sierra
+        - macOS 10.12, Sierra
+        - macOS 10.11, El Capitan
+        - Other/Non-Applicable
+    validations:
+      required: true
+  - type: dropdown
+    id: where-issue
+    attributes:
+      label: Where does this issue happen?
+      multiple: true
+      options:
+        - Between booting macOS and Login Screen
+        - Within macOS (Before Logging in)
+        - Within macOS (After Logging in)
+        - Other/Non-Applicable
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What is the Issue?
+      description: Additionally, explain what you expected to happen?
+      value: "Please clearly explain the issue"
+    validations:
+      required: true
+  - type: textarea
+    id: extra-info
+    attributes:
+      label: What steps have you taken to troubleshoot this? Please include messages from Discord, logs, and screenshots.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/workflows/build-app-wxpython.yml

@@ -0,0 +1,156 @@
+name: CI - Build wxPython
+
+on:
+  push:
+    paths-ignore: 
+      - 'docs/**'
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build wxPython
+    runs-on: x86_64_monterey
+    if: github.repository_owner == 'dortania'
+
+    env:
+      # GitHub Information
+      branch: ${{ github.ref }}
+      commiturl: ${{ github.event.head_commit.url }}${{ github.event.release.html_url }}
+      commitdate: ${{ github.event.head_commit.timestamp }}${{ github.event.release.published_at }}
+
+      # Analytics
+      ANALYTICS_KEY: ${{ secrets.ANALYTICS_KEY }}
+      ANALYTICS_SITE: ${{ secrets.ANALYTICS_SITE }}
+
+      # App Signing
+      ORG_MAC_DEVELOPER_ID_APPLICATION_IDENTITY: ${{ secrets.ORG_MAC_DEVELOPER_ID_APPLICATION_IDENTITY }}
+
+      # PKG Signing
+      ORG_MAC_DEVELOPER_ID_INSTALLER_IDENTITY: ${{ secrets.ORG_MAC_DEVELOPER_ID_INSTALLER_IDENTITY }}
+
+      # Notarization
+      ORG_MAC_NOTARIZATION_TEAM_ID: ${{ secrets.ORG_MAC_NOTARIZATION_TEAM_ID }}
+      ORG_MAC_NOTARIZATION_APPLE_ID: ${{ secrets.ORG_MAC_NOTARIZATION_APPLE_ID }}
+      ORG_MAC_NOTARIZATION_PASSWORD: ${{ secrets.ORG_MAC_NOTARIZATION_PASSWORD }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # - name: Import Application Signing Certificate
+      #   uses: dhinakg/import-codesign-certs@master
+      #   with:
+      #     p12-file-base64: ${{ secrets.ORG_MAC_DEVELOPER_ID_APPLICATION_CERT_P12_BASE64 }}
+      #     p12-password: ${{ secrets.ORG_MAC_DEVELOPER_ID_APPLICATION_CERT_P12_PASSWORD }}
+
+      # - name: Import Installer Signing Certificate
+      #   uses: dhinakg/import-codesign-certs@master
+      #   with:
+      #     p12-file-base64: ${{ secrets.ORG_MAC_DEVELOPER_ID_INSTALLER_CERT_P12_BASE64 }}
+      #     p12-password: ${{ secrets.ORG_MAC_DEVELOPER_ID_INSTALLER_CERT_P12_PASSWORD }}
+
+      # - name: Install Dependencies
+      #   run: /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 -m pip install -r requirements.txt
+
+      # - name: Force Universal2 charset for Python
+      #   run: |
+      #     /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 -m pip uninstall -y charset_normalizer
+      #     /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 -m pip download --platform macosx_10_9_universal2 --only-binary=:all: charset-normalizer
+      #     /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 -m pip install charset_normalizer-*-macosx_10_9_universal2.whl
+
+      - name: Prepare Assets (--prepare-assets)
+        run: >
+          /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 Build-Project.command
+          --run-as-individual-steps --reset-dmg-cache
+          --prepare-assets
+
+      - name: Prepare Application (--prepare-application)
+        run: >
+          /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 Build-Project.command
+          --application-signing-identity "${{ env.ORG_MAC_DEVELOPER_ID_APPLICATION_IDENTITY }}"
+          --notarization-apple-id "${{ env.ORG_MAC_NOTARIZATION_APPLE_ID }}" --notarization-password "${{ env.ORG_MAC_NOTARIZATION_PASSWORD }}" --notarization-team-id "${{ env.ORG_MAC_NOTARIZATION_TEAM_ID }}"
+          --git-branch "${{ env.branch }}" --git-commit-url "${{ env.commiturl }}" --git-commit-date "${{ env.commitdate }}"
+          --analytics-key "${{ env.ANALYTICS_KEY }}" --analytics-endpoint "${{ env.ANALYTICS_SITE }}"
+          --reset-pyinstaller-cache
+          --run-as-individual-steps
+          --prepare-application
+
+      - name: Prepare Package (--prepare-package)
+        run: >
+          /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 Build-Project.command
+          --installer-signing-identity "${{ env.ORG_MAC_DEVELOPER_ID_INSTALLER_IDENTITY }}"
+          --notarization-apple-id "${{ env.ORG_MAC_NOTARIZATION_APPLE_ID }}" --notarization-password "${{ env.ORG_MAC_NOTARIZATION_PASSWORD }}" --notarization-team-id "${{ env.ORG_MAC_NOTARIZATION_TEAM_ID }}"
+          --run-as-individual-steps
+          --prepare-package
+
+      - name: Prepare Update Shim (--prepare-shim)
+        run: >
+          /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 Build-Project.command
+          --application-signing-identity "${{ env.ORG_MAC_DEVELOPER_ID_APPLICATION_IDENTITY }}"
+          --notarization-apple-id "${{ env.ORG_MAC_NOTARIZATION_APPLE_ID }}" --notarization-password "${{ env.ORG_MAC_NOTARIZATION_PASSWORD }}" --notarization-team-id "${{ env.ORG_MAC_NOTARIZATION_TEAM_ID }}"
+          --run-as-individual-steps
+          --prepare-shim
+
+      - name: Prepare App for Upload
+        run: /bin/mv ./dist/OpenCore-Patcher.app.zip ./OpenCore-Patcher-GUI.app.zip
+
+      - name: Upload App to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: OpenCore-Patcher.app (GUI)
+          path: OpenCore-Patcher-GUI.app.zip
+
+      - name: Upload AutoPkg Package to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: AutoPkg-Assets.pkg
+          path: ./dist/AutoPkg-Assets.pkg
+
+      - name: Upload Installation Package to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: OpenCore-Patcher.pkg
+          path: ./dist/OpenCore-Patcher.pkg
+
+      - name: Upload Uninstaller Package to Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: OpenCore-Patcher-Uninstaller.pkg
+          path: ./dist/OpenCore-Patcher-Uninstaller.pkg
+
+      - name: Upload Binary to Release
+        if: github.event_name == 'release'
+        uses: svenstaro/upload-release-action@e74ff71f7d8a4c4745b560a485cc5fdb9b5b999d
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: OpenCore-Patcher-GUI.app.zip
+          tag: ${{ github.ref }}
+          file_glob: true
+
+      - name: Upload AutoPkg Package to Release
+        if: github.event_name == 'release'
+        uses: svenstaro/upload-release-action@e74ff71f7d8a4c4745b560a485cc5fdb9b5b999d
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ./dist/AutoPkg-Assets.pkg
+          tag: ${{ github.ref }}
+          file_glob: true
+
+      - name: Upload Installation Package to Release
+        if: github.event_name == 'release'
+        uses: svenstaro/upload-release-action@e74ff71f7d8a4c4745b560a485cc5fdb9b5b999d
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ./dist/OpenCore-Patcher.pkg
+          tag: ${{ github.ref }}
+          file_glob: true
+
+      - name: Upload Uninstaller Package to Release
+        if: github.event_name == 'release'
+        uses: svenstaro/upload-release-action@e74ff71f7d8a4c4745b560a485cc5fdb9b5b999d
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ./dist/OpenCore-Patcher-Uninstaller.pkg
+          tag: ${{ github.ref }}
+          file_glob: true

.github/workflows/build-app.yml

@@ -1,45 +0,0 @@
-name: CI - Build App
-
-on:
-  push:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  build:
-    name: Build App
-    runs-on: self-hosted
-    steps:
-      - uses: actions/checkout@v2
-
-      # - name: Install Python Dependencies
-      #   run: |
-      #     python3 -m pip install -U pip
-      #     pip3 install pyinstaller
-
-      - run: pyinstaller OpenCore-Patcher.spec
-      - run: ./after_pyinstaller.sh
-      - run: 'codesign -s "Developer ID Application: Mykola Grymalyuk (S74BDJXQMD)" -v --deep --timestamp --entitlements entitlements.plist -o runtime "dist/OpenCore-Patcher.app"'
-
-      - run: cd dist; zip ../OpenCore-Patcher.zip OpenCore-Patcher; zip -r ../OpenCore-Patcher.app.zip OpenCore-Patcher.app
-      - run: ./../sign-app.sh
-      - name: Upload Binary to Artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: OpenCore-Patcher
-          path: OpenCore-Patcher.zip
-      - name: Upload App to Artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: OpenCore-Patcher.app
-          path: OpenCore-Patcher.app.zip
-
-      - name: Upload to Release
-        if: github.event_name == 'release'
-        uses: svenstaro/upload-release-action@e74ff71f7d8a4c4745b560a485cc5fdb9b5b999d
-        with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: OpenCore-Patcher.app.zip
-          tag: ${{ github.ref }}
-          file_glob: true

.github/workflows/build-cli.yml

@@ -1,29 +0,0 @@
-name: CI - Build CLI
-
-on:
-  push:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  build:
-    name: Build CLI
-    runs-on: self-hosted
-    steps:
-      - uses: actions/checkout@v2
-      - run: pyinstaller OCLP-CLI.spec
-      - run: cd dist; zip ../OCLP-CLI.zip OCLP-CLI
-      - name: Upload Binary to Artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: OCLP-CLI
-          path: OCLP-CLI.zip
-      - name: Upload to Release
-        if: github.event_name == 'release'
-        uses: svenstaro/upload-release-action@e74ff71f7d8a4c4745b560a485cc5fdb9b5b999d
-        with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: OCLP-CLI.zip
-          tag: ${{ github.ref }}
-          file_glob: true

.github/workflows/build-site.yml

@@ -1,35 +1,52 @@
 name: CI - Build Site
 on:
   push:
-    branches-ignore:
-      - gh-pages
   workflow_dispatch:
   pull_request:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
 jobs:
   build:
     name: Build Site and Deploy
     runs-on: ubuntu-latest
+    if: github.repository_owner == 'dortania'
     steps:
-      - uses: actions/setup-node@v2-beta
+      - name: Checkout
+        uses: actions/checkout@v4
         with:
-          node-version: '12'
-      - name: Checkout Repository
-        uses: actions/checkout@v2
+          submodules: "recursive"
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          fetch-depth: '0'
-          persist-credentials: false
-          submodules: 'recursive'
-      - name: Install
-        run: npm install
-        working-directory: 'docs'
+          node-version: "22"
+          cache: "yarn"
+          cache-dependency-path: ./docs/yarn.lock
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: docs
       - name: Build
-        run: npm run build
-        working-directory: 'docs'
-      - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@3.7.1
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main'}}
+        run: yarn run build
+        working-directory: docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-          BRANCH: gh-pages
-          FOLDER: docs/.vuepress/dist/
-          CLEAN: true
+          path: docs/.vuepress/dist/
+  deploy:
+    if: ${{ github.repository_owner == 'dortania' && github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/validate-external.yml

@@ -0,0 +1,25 @@
+name: CI - Validation (External)
+
+on:
+  push:
+    paths-ignore: 
+      - 'docs/**'
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Validate
+    runs-on: macos-latest
+    if: github.repository_owner != 'dortania'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+      - name: Install Dependencies
+        run: python3 -m pip install -r requirements.txt
+      - name: Validate
+        run: python3 OpenCore-Patcher-GUI.command --validate

.github/workflows/validate.yml

@@ -0,0 +1,19 @@
+name: CI - Validation
+
+on:
+  push:
+    paths-ignore: 
+      - 'docs/**'
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Validate
+    runs-on: x86_64_monterey
+    if: github.repository_owner == 'dortania'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Validate
+        run: /Library/Frameworks/Python.framework/Versions/3.11/bin/python3 OpenCore-Patcher-GUI.command --validate

.gitignore

@@ -1,6 +1,10 @@
 .DS_Store
 OCLP-GUI.command
 /payloads/Apple
+/payloads/*.zip
+/payloads/BuildManifest.plist
+/payloads/*.sucatalog
+/payloads/*.pkg
 /payloads/__MACOSX
 /App
 /Build-Folder
@@ -13,6 +17,25 @@ __pycache__/
 *$py.class
 /docs/.vuepress/dist
 /docs/.vuepress/.config.js.swp
-/docs/yarn.lock
 /docs/yarn-error.log
-/docs/node_modules/
+/docs/node_modules/
+/payloads/List.txt
+/payloads/Installer.sh
+/payloads/Info.plist
+/payloads/seed.plist
+/payloads/AutoPkg-Assets.pkg
+/payloads/AutoPkg-Assets.pkg.zip
+/payloads/Universal-Binaries
+/payloads/OpenCore-Legacy-Patcher
+/payloads/InstallAssistant.pkg.integrityDataV1
+/payloads.dmg
+/Universal-Binaries.dmg
+/payloads/OpenCore-Legacy-Patcher-*.plist
+/payloads/KDK.dmg
+*.log
+/Universal-Binaries.dmg
+/payloads/KDKInfo.plist
+/payloads/update.sh
+/payloads/OpenCore-Patcher.app
+/.x86_64_venv
+*afdesign~lock~

Build-Project.command

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+"""
+Build-Project.command: Generate OpenCore-Patcher.app and OpenCore-Patcher.pkg
+"""
+
+import os
+import sys
+import time
+import argparse
+import plistlib
+
+from pathlib import Path
+
+from ci_tooling.build_modules import (
+    application,
+    disk_images,
+    package,
+    sign_notarize,
+    shim
+)
+
+from opencore_legacy_patcher import constants
+
+
+def main() -> None:
+    """
+    Parse Command Line Arguments
+    """
+
+    parser = argparse.ArgumentParser(description="Build OpenCore Legacy Patcher Suite", add_help=False)
+
+    # Signing Parameters
+    parser.add_argument("--application-signing-identity", type=str, help="Application Signing Identity")
+    parser.add_argument("--installer-signing-identity", type=str, help="Installer Signing Identity")
+
+
+    # Notarization Parameters
+    parser.add_argument("--notarization-apple-id", type=str, help="Notarization Apple ID", default=None)
+    parser.add_argument("--notarization-password", type=str, help="Notarization Password", default=None)
+    parser.add_argument("--notarization-team-id", type=str, help="Notarization Team ID", default=None)
+
+    # GitHub Actions CI/CD Parameters
+    parser.add_argument("--git-branch", type=str, help="Git Branch", default=None)
+    parser.add_argument("--git-commit-url", type=str, help="Git Commit URL", default=None)
+    parser.add_argument("--git-commit-date", type=str, help="Git Commit Date", default=None)
+
+    # Local Build Parameters
+    parser.add_argument("--reset-dmg-cache", action="store_true", help="Redownload PatcherSupportPkg.dmg and regenerate payloads.dmg", default=False)
+    parser.add_argument("--reset-pyinstaller-cache", action="store_true", help="Clean PyInstaller Cache", default=False)
+
+    # CI/CD Parameters for individual steps
+    # If not specified, will run all steps
+    parser.add_argument("--run-as-individual-steps", action="store_true", help="CI: Run as individual steps", default=False)
+    parser.add_argument("--prepare-application", action="store_true", help="CI: Prepare Application", default=False)
+    parser.add_argument("--prepare-package", action="store_true", help="CI: Prepare Package", default=False)
+    parser.add_argument("--prepare-assets", action="store_true", help="CI: Prepare Assets", default=False)
+
+    # CI/CD Parameters for additional steps
+    # If not specified, will not run additional steps
+    parser.add_argument("--prepare-shim", action="store_true", help="CI: Prepare Update Shim", default=False)
+
+    # Analytics Parameters
+    parser.add_argument("--analytics-key", type=str, help="Analytics Key", default=None)
+    parser.add_argument("--analytics-endpoint", type=str, help="Analytics Endpoint", default=None)
+
+    # Help
+    parser.add_argument("--help", action="store_true", help="Show this help message and exit", default=False)
+
+    # Parse Arguments
+    args = parser.parse_args()
+
+    if args.help:
+        parser.print_help()
+        print("\n\nIf running outside of CI/CD, simply run the following command:")
+        print("$ python3 Build-Project.command")
+        sys.exit(0)
+
+    # Set 'Current Working Directory' to script directory
+    os.chdir(Path(__file__).resolve().parent)
+
+
+    if (args.run_as_individual_steps is False) or (args.run_as_individual_steps and args.prepare_assets):
+        # Prepare workspace
+        disk_images.GenerateDiskImages(args.reset_dmg_cache).generate()
+
+    if (args.run_as_individual_steps is False) or (args.run_as_individual_steps and args.prepare_application):
+        # Prepare Privileged Helper Tool
+        sign_notarize.SignAndNotarize(
+            path=Path("./ci_tooling/privileged_helper_tool/com.dortania.opencore-legacy-patcher.privileged-helper"),
+            signing_identity=args.application_signing_identity,
+            notarization_apple_id=args.notarization_apple_id,
+            notarization_password=args.notarization_password,
+            notarization_team_id=args.notarization_team_id,
+        ).sign_and_notarize()
+
+        # Build OpenCore-Patcher.app
+        application.GenerateApplication(
+            reset_pyinstaller_cache=args.reset_pyinstaller_cache,
+            git_branch=args.git_branch,
+            git_commit_url=args.git_commit_url,
+            git_commit_date=args.git_commit_date,
+            analytics_key=args.analytics_key,
+            analytics_endpoint=args.analytics_endpoint,
+        ).generate()
+
+        # Sign OpenCore-Patcher.app
+        sign_notarize.SignAndNotarize(
+            path=Path("dist/OpenCore-Patcher.app"),
+            signing_identity=args.application_signing_identity,
+            notarization_apple_id=args.notarization_apple_id,
+            notarization_password=args.notarization_password,
+            notarization_team_id=args.notarization_team_id,
+            entitlements=Path("./ci_tooling/entitlements/entitlements.plist"),
+        ).sign_and_notarize()
+
+
+    if (args.run_as_individual_steps is False) or (args.run_as_individual_steps and args.prepare_package):
+        # Build OpenCore-Patcher.pkg and OpenCore-Patcher-Uninstaller.pkg
+        package.GeneratePackage().generate()
+
+        # Sign OpenCore-Patcher.pkg
+        sign_notarize.SignAndNotarize(
+            path=Path("dist/OpenCore-Patcher.pkg"),
+            signing_identity=args.installer_signing_identity,
+            notarization_apple_id=args.notarization_apple_id,
+            notarization_password=args.notarization_password,
+            notarization_team_id=args.notarization_team_id,
+        ).sign_and_notarize()
+
+        # Sign OpenCore-Patcher-Uninstaller.pkg
+        sign_notarize.SignAndNotarize(
+            path=Path("dist/OpenCore-Patcher-Uninstaller.pkg"),
+            signing_identity=args.installer_signing_identity,
+            notarization_apple_id=args.notarization_apple_id,
+            notarization_password=args.notarization_password,
+            notarization_team_id=args.notarization_team_id,
+        ).sign_and_notarize()
+
+    # Create Update Shim
+    if args.prepare_shim:
+        shim.GenerateShim().generate()
+        if Path("dist/OpenCore-Patcher.app").exists():
+            if Path("dist/OpenCore-Patcher (Original).app").exists():
+                Path("dist/OpenCore-Patcher (Original).app").unlink()
+            Path("dist/OpenCore-Patcher.app").rename("dist/OpenCore-Patcher (Original).app")
+        Path("dist/OpenCore-Patcher (Shim).app").rename("dist/OpenCore-Patcher.app")
+
+        # Update app version in Info.plist
+        plist_path = Path("dist/OpenCore-Patcher.app/Contents/Info.plist")
+        contents = plistlib.load(plist_path.open("rb"))
+        contents["CFBundleVersion"] = constants.Constants().patcher_version
+        contents["CFBundleShortVersionString"] = constants.Constants().patcher_version
+        plistlib.dump(contents, plist_path.open("wb"))
+
+        sign_notarize.SignAndNotarize(
+            path=Path("dist/OpenCore-Patcher.app"),
+            signing_identity=args.application_signing_identity,
+            notarization_apple_id=args.notarization_apple_id,
+            notarization_password=args.notarization_password,
+            notarization_team_id=args.notarization_team_id,
+            entitlements=Path("./ci_tooling/entitlements/entitlements.plist"),
+        ).sign_and_notarize()
+
+
+if __name__ == '__main__':
+    _start = time.time()
+    main()
+    print(f"Build script completed in {str(round(time.time() - _start, 2))} seconds")

LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2020-2024 Dhinak G, Mykola Grymalyuk, and individual contributors.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software must display the following acknowledgement:
+This product includes software developed by Dortania and OpenCore Legacy Patcher contributors.
+4. Neither the name of OpenCore Legacy Patcher, nor the names of Dortania, Dhinak G, or Mykola Grymalyuk may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY DHINAK G AND MYKOLA GRYMALYUK "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DHINAK G NOR MYKOLA GRYMALYUK BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

OCLP-CLI.command

@@ -1,193 +0,0 @@
-#!/usr/bin/env python3
-# Copyright (C) 2020-2021 Mykola Grymalyuk
-
-from __future__ import print_function
-
-import binascii
-import plistlib
-import subprocess
-import sys
-import time
-import platform
-import argparse
-from pathlib import Path
-
-from Resources import Build, ModelArray, PCIIDArray, Constants, SysPatch, Utilities, CliMenu, DeviceProbe
-
-
-class OpenCoreLegacyPatcher():
-    def __init__(self):
-        self.constants = Constants.Constants()
-        self.current_model: str = None
-        opencore_model: str = subprocess.run("nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:oem-product".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-        if not opencore_model.startswith("nvram: Error getting variable"):
-            opencore_model = [line.strip().split(":oem-product	", 1)[1] for line in opencore_model.split("\n") if line.strip().startswith("4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:")][0]
-            self.current_model = opencore_model
-        else:
-            self.current_model = subprocess.run("system_profiler SPHardwareDataType".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-            self.current_model = [line.strip().split(": ", 1)[1] for line in self.current_model.stdout.decode().split("\n") if line.strip().startswith("Model Identifier")][0]
-        self.constants.detected_os = int(platform.uname().release.partition(".")[0])
-        if self.current_model in ModelArray.NoAPFSsupport:
-            self.constants.serial_settings = "Moderate"
-        if self.current_model in ModelArray.LegacyGPU:
-            dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-            if dgpu_vendor:
-                if (dgpu_vendor == self.constants.pci_amd_ati and (dgpu_device in PCIIDArray.amd_ids().polaris_ids or dgpu_device in PCIIDArray.amd_ids().vega_ids or dgpu_device in PCIIDArray.amd_ids().navi_ids or dgpu_device in PCIIDArray.amd_ids().legacy_gcn_ids)) or (dgpu_vendor == self.constants.pci_nvidia and dgpu_device in PCIIDArray.nvidia_ids().kepler_ids):
-                    self.constants.sip_status = True
-                    self.constants.secure_status = True
-                else:
-                    self.constants.sip_status = False
-                    self.constants.secure_status = False
-
-        # Logic for when user runs custom OpenCore build and do not expose it
-        # Note: This logic currently only applies for iMacPro1,1 users, see below threads on the culprits:
-        # - https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/post-17425857
-        # - https://forums.macrumors.com/threads/opencore-on-the-mac-pro.2207814/
-        # PLEASE FOR THE LOVE OF GOD JUST SET ExposeSensitiveData CORRECTLY!!!
-        if self.current_model == "iMacPro1,1":
-            serial: str = subprocess.run("system_profiler SPHardwareDataType | grep Serial".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-            serial = [line.strip().split("Number (system): ", 1)[1] for line in serial.split("\n") if line.strip().startswith("Serial")][0]
-            true_model = subprocess.run([str(self.constants.macserial_path), "--info", str(serial)], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-            true_model = [i.partition(" - ")[2] for i in true_model.stdout.decode().split("\n") if "Model: " in i][0]
-            print(f"True Model: {true_model}")
-            if not true_model.startswith("Unknown"):
-                self.current_model = true_model
-
-        custom_cpu_model_value: str = subprocess.run("nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:revcpuname".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-
-        if not custom_cpu_model_value.startswith("nvram: Error getting variable"):
-            custom_cpu_model_value = [line.strip().split(":revcpuname	", 1)[1] for line in custom_cpu_model_value.split("\n") if line.strip().startswith("4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:")][0]
-            if custom_cpu_model_value.split("%00")[0] != "":
-                self.constants.custom_cpu_model = 1
-                self.constants.custom_cpu_model_value = custom_cpu_model_value.split("%00")[0]
-
-
-        parser = argparse.ArgumentParser()
-
-        # Generic building args
-        parser.add_argument('--build', help='Build OpenCore', action='store_true', required=False)
-        parser.add_argument('--verbose', help='Enable verbose boot', action='store_true', required=False)
-        parser.add_argument('--debug_oc', help='Enable OpenCore DEBUG', action='store_true', required=False)
-        parser.add_argument('--debug_kext', help='Enable kext DEBUG', action='store_true', required=False)
-        parser.add_argument('--skip_wifi', help='Skip wifi patches', action='store_true', required=False)
-        parser.add_argument('--hide_picker', help='Hide OpenCore picker', action='store_true', required=False)
-        parser.add_argument('--disable_sip', help='Disable SIP', action='store_true', required=False)
-        parser.add_argument('--disable_smb', help='Disable SecureBootModel', action='store_true', required=False)
-        parser.add_argument('--vault', help='Enable OpenCore Vaulting', action='store_true', required=False)
-        parser.add_argument('--support_all', help='Allow OpenCore on natively supported Models', action='store_true', required=False)
-        parser.add_argument('--force_legacy', help='Allow acceleration on Mac Pros and Xserves', action='store_true', required=False)
-
-        # Building args requiring value values
-        parser.add_argument('--model', action='store', help='Set custom model', required=False)
-        parser.add_argument('--metal_gpu', action='store', help='Set Metal GPU Vendor', required=False)
-        parser.add_argument('--smbios_spoof', action='store', help='Set SMBIOS patching mode', required=False)
-
-        # SysPatch args
-        parser.add_argument('--patch_sys_vol', help='Patches root volume', action='store_true', required=False)
-        parser.add_argument('--unpatch_sys_vol', help='Unpatches root volume, EXPERIMENTAL', action='store_true', required=False)
-
-        args = parser.parse_args()
-
-        self.constants.gui_mode = True
-        self.constants.current_path = Path.cwd()
-
-        if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
-            print("- Rerouting payloads location")
-            self.constants.payload_path = sys._MEIPASS / Path("payloads")
-        else:
-            print("- Using default payloads location")
-
-        if args.verbose:
-            print("- Set verbose configuration")
-            self.constants.verbose_debug = True
-        if args.debug_oc:
-            print("- Set OpenCore DEBUG configuration")
-            self.constants.opencore_debug = True
-            self.constants.opencore_build = "DEBUG"
-        if args.debug_kext:
-            print("- Set kext DEBUG configuration")
-            self.constants.kext_debug = True
-        if args.skip_wifi:
-            print("- Set wifi skip configuration")
-            self.constants.wifi_build = True
-        if args.hide_picker:
-            print("- Set HidePicker configuration")
-            self.constants.showpicker = False
-        if args.disable_sip:
-            print("- Set Disable SIP configuration")
-            self.constants.sip_status = False
-        if args.disable_smb:
-            print("- Set Disable SecureBootModel configuration")
-            self.constants.secure_status = False
-        if args.vault:
-            print("- Set Vault configuration")
-            self.constants.vault = True
-        if args.metal_gpu:
-            if args.metal_gpu == "Nvidia":
-                print("- Set Metal GPU patches to Nvidia")
-                self.constants.metal_build = True
-                self.constants.imac_vendor = "Nvidia"
-            elif args.metal_gpu == "AMD":
-                print("- Set Metal GPU patches to AMD")
-                self.constants.metal_build = True
-                self.constants.imac_vendor = "AMD"
-            else:
-                print(f"- Unknown GPU arg passed: {args.metal_gpu}")
-                self.constants.metal_build = False
-                self.constants.imac_vendor = "None"
-        if args.smbios_spoof:
-            if args.smbios_spoof == "Minimal":
-                self.constants.serial_settings = "Minimal"
-            elif args.smbios_spoof == "Moderate":
-                self.constants.serial_settings = "Moderate"
-            elif args.smbios_spoof == "Advanced":
-                self.constants.serial_settings = "Advanced"
-            else:
-                print(f"- Unknown SMBIOS arg passed: {args.smbios_spoof}")
-
-        if args.support_all:
-            print("- Building for natively supported model")
-            self.constants.allow_oc_everywhere = True
-            self.constants.serial_settings = "None"
-
-        if args.force_legacy:
-            print("- Allowing legacy acceleration patches on newer models")
-            self.constants.assume_legacy = True
-
-        if args.build:
-            if args.model:
-                print(f"- Using custom model: {args.model}")
-                self.constants.custom_model = args.model
-                self.build_opencore()
-            else:
-                print(f"- Using detected model: {self.current_model}")
-                self.build_opencore()
-        if args.patch_sys_vol:
-            print("- Set System Volume patching")
-            self.patch_vol()
-        elif args.unpatch_sys_vol:
-            print("- Set System Volume unpatching")
-            self.unpatch_vol()
-
-    def hexswap(self, input_hex: str):
-        hex_pairs = [input_hex[i:i + 2] for i in range(0, len(input_hex), 2)]
-        hex_rev = hex_pairs[::-1]
-        hex_str = "".join(["".join(x) for x in hex_rev])
-        return hex_str.upper()
-
-    def patch_vol(self):
-        SysPatch.PatchSysVolume(self.constants.custom_model or self.current_model, self.constants).start_patch()
-
-    def unpatch_vol(self):
-        SysPatch.PatchSysVolume(self.constants.custom_model or self.current_model, self.constants).start_unpatch()
-
-    def build_opencore(self):
-        Build.BuildOpenCore(self.constants.custom_model or self.current_model, self.constants).build_opencore()
-
-    def install_opencore(self):
-        Build.BuildOpenCore(self.constants.custom_model or self.current_model, self.constants).copy_efi()
-
-OpenCoreLegacyPatcher()
-
-# Example arg for OCLP command line
-# ./OCLP-CLI --build --verbose --debug_oc --debug_kext --model iMac11,2

OCLP-CLI.spec

@@ -1,34 +0,0 @@
-# -*- mode: python ; coding: utf-8 -*-
-import sys, os
-sys.path.append(os.path.abspath(os.getcwd()))
-from Resources import Constants
-block_cipher = None
-
-
-a = Analysis(['OCLP-CLI.command'],
-             binaries=[],
-             datas=[('payloads', 'payloads'), ('Resources', 'Resources')],
-             hiddenimports=[],
-             hookspath=[],
-             runtime_hooks=[],
-             excludes=[],
-             win_no_prefer_redirects=False,
-             win_private_assemblies=False,
-             cipher=block_cipher,
-             noarchive=False)
-pyz = PYZ(a.pure, a.zipped_data,
-             cipher=block_cipher)
-exe = EXE(pyz,
-          a.scripts,
-          a.binaries,
-          a.zipfiles,
-          a.datas,
-          [],
-          name='OCLP-CLI',
-          debug=False,
-          bootloader_ignore_signals=False,
-          strip=False,
-          upx=True,
-          upx_exclude=[],
-          runtime_tmpdir=None,
-          console=True )

OpenCore-Patcher-GUI.command

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+"""
+PyInstaller Entry Point
+"""
+
+from opencore_legacy_patcher import main
+
+if __name__ == '__main__':
+    main()

OpenCore-Patcher-GUI.spec

@@ -0,0 +1,86 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+import os
+import sys
+import time
+import subprocess
+
+from pathlib import Path
+
+from PyInstaller.building.api import PYZ, EXE, COLLECT
+from PyInstaller.building.osx import BUNDLE
+from PyInstaller.building.build_main import Analysis
+
+sys.path.append(os.path.abspath(os.getcwd()))
+
+from opencore_legacy_patcher import constants
+
+block_cipher = None
+
+datas = [
+   ('payloads.dmg', '.'),
+   ('Universal-Binaries.dmg', '.'),
+]
+
+if Path("DortaniaInternalResources.dmg").exists():
+   datas.append(('DortaniaInternalResources.dmg', '.'))
+
+
+a = Analysis(['OpenCore-Patcher-GUI.command'],
+             pathex=[],
+             binaries=[],
+             datas=datas,
+             hiddenimports=[],
+             hookspath=[],
+             hooksconfig={},
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+
+pyz = PYZ(a.pure,
+          a.zipped_data,
+          cipher=block_cipher)
+
+exe = EXE(pyz,
+          a.scripts,
+          [],
+          exclude_binaries=True,
+          name='OpenCore-Patcher',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=True,
+          console=False,
+          disable_windowed_traceback=False,
+          target_arch="universal2",
+          codesign_identity=None,
+          entitlements_file=None)
+
+coll = COLLECT(exe,
+               a.binaries,
+               a.zipfiles,
+               a.datas,
+               strip=False,
+               upx=True,
+               upx_exclude=[],
+               name='OpenCore-Patcher')
+
+app = BUNDLE(coll,
+             name='OpenCore-Patcher.app',
+             icon="payloads/Icon/AppIcons/OC-Patcher.icns",
+             bundle_identifier="com.dortania.opencore-legacy-patcher",
+             info_plist={
+                "CFBundleName": "OpenCore Legacy Patcher",
+                "CFBundleVersion": constants.Constants().patcher_version,
+                "CFBundleShortVersionString": constants.Constants().patcher_version,
+                "NSHumanReadableCopyright": constants.Constants().copyright_date,
+                "LSMinimumSystemVersion": "10.10.0",
+                "NSRequiresAquaSystemAppearance": False,
+                "NSHighResolutionCapable": True,
+                "Build Date": time.strftime("%Y-%m-%d %H:%M:%S", time.localtime()),
+                "BuildMachineOSBuild": subprocess.run(["/usr/bin/sw_vers", "-buildVersion"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode().strip(),
+                "NSPrincipalClass": "NSApplication",
+             })

OpenCore-Patcher.command

@@ -1,234 +0,0 @@
-#!/usr/bin/env python3
-# Copyright (C) 2020-2021, Dhinak G, Mykola Grymalyuk
-
-from __future__ import print_function
-
-import binascii
-import plistlib
-import subprocess
-import sys
-import time
-import platform
-
-from Resources import Build, ModelArray, PCIIDArray, Constants, SysPatch, Utilities, CliMenu, DeviceProbe
-
-
-class OpenCoreLegacyPatcher():
-    def __init__(self):
-        self.constants = Constants.Constants()
-        self.current_model: str = None
-        opencore_model: str = subprocess.run("nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:oem-product".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-        if not opencore_model.startswith("nvram: Error getting variable"):
-            opencore_model = [line.strip().split(":oem-product	", 1)[1] for line in opencore_model.split("\n") if line.strip().startswith("4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:")][0]
-            self.current_model = opencore_model
-        else:
-            self.current_model = plistlib.loads(subprocess.run("system_profiler -detailLevel mini -xml SPHardwareDataType".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.strip())[0]["_items"][0]["machine_model"]
-        self.constants.detected_os = int(platform.uname().release.partition(".")[0])
-        if self.current_model in ModelArray.NoAPFSsupport:
-            self.constants.serial_settings = "Moderate"
-        if self.current_model in ModelArray.LegacyGPU:
-            dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-
-            if (dgpu_vendor == self.constants.pci_amd_ati and (dgpu_device in PCIIDArray.amd_ids().polaris_ids or dgpu_device in PCIIDArray.amd_ids().vega_ids or dgpu_device in PCIIDArray.amd_ids().navi_ids or dgpu_device in PCIIDArray.amd_ids().legacy_gcn_ids)) or (dgpu_vendor == self.constants.pci_nvidia and dgpu_device in PCIIDArray.nvidia_ids().kepler_ids):
-                self.constants.sip_status = True
-                self.constants.secure_status = True
-            else:
-                self.constants.sip_status = False
-                self.constants.secure_status = False
-
-        # Logic for when user runs custom OpenCore build and do not expose it
-        # Note: This logic currently only applies for iMacPro1,1 users, see below threads on the culprits:
-        # - https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/post-17425857
-        # - https://forums.macrumors.com/threads/opencore-on-the-mac-pro.2207814/
-        # PLEASE FOR THE LOVE OF GOD JUST SET ExposeSensitiveData CORRECTLY!!!
-        if self.current_model == "iMacPro1,1":
-            serial: str = subprocess.run("system_profiler SPHardwareDataType | grep Serial".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-            serial = [line.strip().split("Number (system): ", 1)[1] for line in serial.split("\n") if line.strip().startswith("Serial")][0]
-            true_model = subprocess.run([str(self.constants.macserial_path), "--info", str(serial)], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-            true_model = [i.partition(" - ")[2] for i in true_model.stdout.decode().split("\n") if "Model: " in i][0]
-            print(f"True Model: {true_model}")
-            if not true_model.startswith("Unknown"):
-                self.current_model = true_model
-
-        custom_cpu_model_value: str = subprocess.run("nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:revcpuname".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-
-        if not custom_cpu_model_value.startswith("nvram: Error getting variable"):
-            custom_cpu_model_value = [line.strip().split(":revcpuname	", 1)[1] for line in custom_cpu_model_value.split("\n") if line.strip().startswith("4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:")][0]
-            if custom_cpu_model_value.split("%00")[0] != "":
-                self.constants.custom_cpu_model = 1
-                self.constants.custom_cpu_model_value = custom_cpu_model_value.split("%00")[0]
-
-    def hexswap(self, input_hex: str):
-        hex_pairs = [input_hex[i:i + 2] for i in range(0, len(input_hex), 2)]
-        hex_rev = hex_pairs[::-1]
-        hex_str = "".join(["".join(x) for x in hex_rev])
-        return hex_str.upper()
-
-    def build_opencore(self):
-        Build.BuildOpenCore(self.constants.custom_model or self.current_model, self.constants).build_opencore()
-
-    def install_opencore(self):
-        Build.BuildOpenCore(self.constants.custom_model or self.current_model, self.constants).copy_efi()
-
-    def change_model(self):
-        Utilities.cls()
-        Utilities.header(["Select Different Model"])
-        print("""
-Tip: Run the following command on the target machine to find the model identifier:
-
-system_profiler SPHardwareDataType | grep 'Model Identifier'
-    """)
-        self.constants.custom_model = input("Please enter the model identifier of the target machine: ").strip()
-        if self.constants.custom_model not in ModelArray.SupportedSMBIOS:
-            print(f"""
-        {self.constants.custom_model} is not a valid SMBIOS Identifier for macOS {self.constants.os_support}!
-            """)
-            print_models = input(f"Print list of valid options for macOS {self.constants.os_support}? (y/n)")
-            if print_models in {"y", "Y", "yes", "Yes"}:
-                print("\n".join(ModelArray.SupportedSMBIOS))
-                input("Press any key to continue...")
-        if self.constants.custom_model in ModelArray.NoAPFSsupport:
-            self.constants.serial_settings = "Moderate"
-
-    def patcher_settings(self):
-        response = None
-        while not (response and response == -1):
-            title = [
-                "Adjust Patcher Settings"
-            ]
-            menu = Utilities.TUIMenu(title, "Please select an option: ", auto_number=True, top_level=True)
-            options = [
-                # TODO: Enable setting OS target when more OSes become supported by the patcher
-                #[f"Change OS version:\t\t\tCurrently macOS {self.constants.os_support}", self.change_os],
-                [f"Enable Verbose Mode:\t\tCurrently {self.constants.verbose_debug}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_verbose],
-                [f"Enable OpenCore DEBUG:\t\tCurrently {self.constants.opencore_debug}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_oc],
-                [f"Enable Kext DEBUG:\t\t\tCurrently {self.constants.kext_debug}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_kext],
-                [f"Set ShowPicker Mode:\t\tCurrently {self.constants.showpicker}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_showpicker],
-                [f"Set Vault Mode:\t\t\tCurrently {self.constants.vault}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_vault],
-                [f"Set SIP and SecureBootModel:\tSIP: {self.constants.sip_status} SBM: {self.constants.secure_status}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_sip],
-                [f"Allow OpenCore on native Models:\tCurrently {self.constants.allow_oc_everywhere}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).allow_native_models],
-                [f"Advanced Patch Settings, for developers only", self.advanced_patcher_settings],
-            ]
-
-            for option in options:
-                menu.add_menu_option(option[0], function=option[1])
-
-            response = menu.start()
-
-    def advanced_patcher_settings(self):
-        response = None
-        while not (response and response == -1):
-            title = [
-                "Adjust Advanced Patcher Settings, for developers ONLY"
-            ]
-            menu = Utilities.TUIMenu(title, "Please select an option: ", auto_number=True, top_level=True)
-            options = [
-                [f"Assume Metal GPU Always:\t\tCurrently {self.constants.imac_vendor}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_metal],
-                [f"Assume Upgraded Wifi Always:\tCurrently {self.constants.wifi_build}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_wifi],
-                [f"Set SMBIOS Mode:\t\t\tCurrently {self.constants.serial_settings}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).change_serial],
-                [f"DRM Preferences:\t\t\tCurrently {self.constants.drm_support}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).drm_setting],
-                [f"Set Generic Bootstrap:\t\tCurrently {self.constants.boot_efi}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).bootstrap_setting],
-                [f"Assume Legacy GPU:\t\t\tCurrently {self.constants.assume_legacy}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).force_accel_setting],
-                #[f"Download more RAM:\t\t\tCurrently {self.constants.download_ram}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).download_more_ram_dot_com],
-                [f"Disable CPU Friend:\t\t\tCurrently {self.constants.disallow_cpufriend}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).disable_cpufriend],
-                [f"Set Custom name {self.constants.custom_cpu_model_value}", CliMenu.MenuOptions(self.constants.custom_model or self.current_model, self.constants).custom_cpu],
-            ]
-
-            for option in options:
-                menu.add_menu_option(option[0], function=option[1])
-
-            response = menu.start()
-
-    def credits(self):
-        Utilities.TUIOnlyPrint(["Credits"], "Press [Enter] to go back.\n",
-                               ["""Many thanks to the following:
-
-  - Acidanthera:\tOpenCore, kexts and other tools
-  - Khronokernel:\tWriting and maintaining this patcher
-  - DhinakG:\t\tWriting and maintaining this patcher
-  - ASentientBot:\tLegacy Acceleration Patches
-  - Ausdauersportler:\tLinking fixes for SNBGraphicsFB and AMDX3000
-  - Syncretic:\t\tAAAMouSSE and telemetrap
-  - cdf:\t\tNightShiftEnabler and Innie"""]).start()
-
-    def PatchVolume(self):
-        Utilities.cls()
-        Utilities.header(["Patching System Volume"])
-        print("""Patches Root volume to fix misc issues such as:
-
-- Graphics Acceleration for non-Metal GPUs
-  - Nvidia: Tesla - Fermi (8000-500 series)
-  - Intel: Ironlake - Sandy Bridge
-  - AMD: TeraScale 1 (2000-4000 series)
-- Audio support for iMac7,1 and iMac8,1
-
-WARNING: Root Volume Patching is still in active development, please
-have all important user data backed up. Note when the system volume
-is patched, you can no longer have Delta updates or have FileVault
-enabled.
-
-Supported Options:
-
-1. Patch System Volume
-2. Unpatch System Volume (Experimental)
-B. Exit
-        """)
-        change_menu = input("Patch System Volume?: ")
-        if change_menu == "1":
-            SysPatch.PatchSysVolume(self.constants.custom_model or self.current_model, self.constants).start_patch()
-        elif change_menu == "2":
-            SysPatch.PatchSysVolume(self.constants.custom_model or self.current_model, self.constants).start_unpatch()
-        else:
-            print("Returning to main menu")
-
-    def main_menu(self):
-        response = None
-        ModelArray.SupportedSMBIOS = ModelArray.SupportedSMBIOS11
-        while not (response and response == -1):
-            title = [
-                f"OpenCore Legacy Patcher v{self.constants.patcher_version}",
-                f"Selected Model: {self.constants.custom_model or self.current_model}",
-                f"Target OS: macOS {self.constants.os_support}",
-            ]
-
-            if (self.constants.custom_model or self.current_model) not in ModelArray.SupportedSMBIOS and self.constants.allow_oc_everywhere is False:
-                in_between = [
-                    'Your model is not supported by this patcher for running unsupported OSes!',
-                    '',
-                    'If you plan to create the USB for another machine, please select the "Change Model" option in the menu.'
-                ]
-            elif not self.constants.custom_model and self.current_model == "iMac7,1" and \
-                    "SSE4.1" not in subprocess.run("sysctl machdep.cpu.features".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode():
-                in_between = [
-                    'Your model requires a CPU upgrade to a CPU supporting SSE4.1+ to be supported by this patcher!',
-                    '',
-                    f'If you plan to create the USB for another {self.current_model} with SSE4.1+, please select the "Change Model" option in the menu.'
-                ]
-            elif self.constants.custom_model == "iMac7,1":
-                in_between = ["This model is supported",
-                              "However please ensure the CPU has been upgraded to support SSE4.1+"
-                              ]
-            else:
-                in_between = ["This model is supported"]
-
-            menu = Utilities.TUIMenu(title, "Please select an option: ", in_between=in_between, auto_number=True, top_level=True)
-
-            options = (
-                [["Build OpenCore", self.build_opencore]] if ((self.constants.custom_model or self.current_model) in ModelArray.SupportedSMBIOS) or self.constants.allow_oc_everywhere is True else []) + [
-                ["Install OpenCore to USB/internal drive", self.install_opencore],
-                ["Post-Install Volume Patch", self.PatchVolume],
-                ["Change Model", self.change_model],
-                ["Patcher Settings", self.patcher_settings],
-                ["Credits", self.credits]
-            ]
-
-            for option in options:
-                menu.add_menu_option(option[0], function=option[1])
-
-            response = menu.start()
-
-        if getattr(sys, "frozen", False):
-            subprocess.run("""osascript -e 'tell application "Terminal" to close first window' & exit""", shell=True)
-
-
-OpenCoreLegacyPatcher().main_menu()

OpenCore-Patcher.spec

@@ -1,43 +0,0 @@
-# -*- mode: python ; coding: utf-8 -*-
-import sys, os
-sys.path.append(os.path.abspath(os.getcwd()))
-from Resources import Constants
-block_cipher = None
-
-
-a = Analysis(['OpenCore-Patcher.command'],
-             binaries=[],
-             datas=[('payloads', 'payloads'), ('Resources', 'Resources')],
-             hiddenimports=[],
-             hookspath=[],
-             runtime_hooks=[],
-             excludes=[],
-             win_no_prefer_redirects=False,
-             win_private_assemblies=False,
-             cipher=block_cipher,
-             noarchive=False)
-pyz = PYZ(a.pure, a.zipped_data,
-             cipher=block_cipher)
-exe = EXE(pyz,
-          a.scripts,
-          a.binaries,
-          a.zipfiles,
-          a.datas,
-          [],
-          name='OpenCore-Patcher',
-          debug=False,
-          bootloader_ignore_signals=False,
-          strip=False,
-          upx=True,
-          upx_exclude=[],
-          runtime_tmpdir=None,
-          console=True )
-app = BUNDLE(exe,
-         name='OpenCore-Patcher.app',
-         icon="OC-Patcher.icns",
-         bundle_identifier=None,
-         info_plist={
-             "CFBundleShortVersionString": Constants.Constants().patcher_version,
-             "CFBundleExecutable": "MacOS/Launcher",
-             "NSHumanReadableCopyright": "Copyright 2020-2021 Dortania"
-         })

PRIVACY.md

@@ -0,0 +1,25 @@
+# Privacy Policy
+
+OpenCore Legacy Patcher may collect pseudo-anonymized data about the host system and the OpenCore Legacy Patcher application. This data is used to improve the project and to help diagnose issues. The data collected is as follows:
+
+* System's UUID as a SHA1 hash
+  * This is used to identify the system and to prevent duplicate reports
+  * Cannot be used to identify the system without the user providing the UUID
+* Application name and version
+* System's OS version
+* System's model name, GPUs present and firmware vendor
+  * May include more hardware information in the future (ex. CPU, WiFi, etc)
+* General country code of system's reported region
+  * ex. `US`, `CA`, etc
+
+Identifiable data such as IP addresses, MAC addresses, serial numbers, etc. are not collected.
+
+In the future, crash logs may also be collected to help with diagnosing issues.
+----------
+
+Users who wish to opt-out can do so either via the application's preferences or via the following command:
+```
+defaults write com.dortania.opencore-legacy-patcher DisableCrashAndAnalyticsReporting -bool true
+```
+
+To have your data removed, please contact us via our [Discord server](https://discord.gg/rqdPgH8xSN) and provide the UUID of your system.

README.md

@@ -1,56 +1,142 @@
-# OpenCore Legacy Patcher
+<div align="center">
+             <img src="docs/images/OC-Patcher.png" alt="OpenCore Patcher Logo" width="256" />
+             <h1>OpenCore Legacy Patcher</h1>
+</div>
 
-<img src="images/OC-Patcher.png" width="256">
+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.
 
-A python program for building and booting [OpenCore](https://github.com/acidanthera/OpenCorePkg) on both legacy and modern Macs, see our in-depth [Guide](https://dortania.github.io/OpenCore-Legacy-Patcher/) for more information.
+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.
 
-Supported features:
+----------
 
+![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)
+
+----------
+
+Noteworthy features of OpenCore Legacy Patcher:
+
+* Support for macOS Big Sur, Monterey, Ventura, Sonoma and Sequoia
+* Native Over the Air (OTA) System Updates
+* Supports Penryn and newer Macs
+* Full support for WPA Wi-Fi and Personal Hotspot on BCM943224 and newer wireless chipsets
 * System Integrity Protection, FileVault 2, .im4m Secure Boot and Vaulting
-* WPA Wifi and Personal Hotspot support
-* Native OTA OS DELTA updates on all Macs
-* Recovery OS, Safe Mode and Single-user Mode booting
+* Recovery OS, Safe Mode and Single-user Mode booting on non-native OSes
+* Unlocks features such as Sidecar and AirPlay to Mac even on native Macs
+* Enables enhanced SATA and NVMe power management on non-Apple storage devices
 * Zero firmware patching required (ie. APFS ROM patching)
-* GPU Switching on MacBook Pro models (2012 and newer)
+* Graphics acceleration for both Metal and non-Metal GPUs
 
-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.
+----------
 
-* You can however reinstall macOS with this patcher and retain your original data
+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.
 
-Note 2: Currently OpenCore Legacy Patcher officially supports patching to run macOS 11, Big Sur installs. For older OSes, OpenCore may function however support is currently not provided from Dortania.
+* You can, however, reinstall macOS with this patcher and retain your original data
 
-* For Mojave and Catalina support, we recommend the use of [dosdude1's patchers](http://dosdude1.com)
+Note 2: Currently, OpenCore Legacy Patcher 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.
+
+* For macOS Mojave and Catalina support, we recommend the use of [dosdude1's patchers](http://dosdude1.com)
+
+## Getting Started
+
+To start using the project, please see our in-depth guide:
+
+* [OpenCore Legacy Patcher Guide](https://dortania.github.io/OpenCore-Legacy-Patcher/)
 
 ## Support
 
-To get aid with the patcher, we recommend joining the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN). We're actively there and is the quickest way to receive help. For bigger issues such as patcher crashing on build and such, we recommend opening an issue right here on GitHub(Please review [How to debug with OpenCore](https://dortania.github.io/OpenCore-Legacy-Patcher/DEBUG.html) before opening issues):
+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:
 
-* [OpenCore Legacy Patcher's Issue's tab](https://github.com/dortania/OpenCore-Legacy-Patcher/issues)
+* [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN)
+  * Keep in mind that the Discord server is maintained by the community, so we ask everyone to be respectful.
+  * 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.
+
+## Running from source
+
+To run the project from source, see here: [Build and run from source](./SOURCE.md)
 
 ## Credits
 
 * [Acidanthera](https://github.com/Acidanthera)
-  * OpenCorePkg as well as many of the core kexts and tools
+  * OpenCorePkg, as well as many of the core kexts and tools
 * [DhinakG](https://github.com/DhinakG)
   * Main co-author
 * [Khronokernel](https://github.com/Khronokernel)
   * Main co-author
 * [Ausdauersportler](https://github.com/Ausdauersportler)
   * iMacs Metal GPUs Upgrade Patch set and documentation
+  * Great amounts of help with debugging, and code suggestions
+* [vit9696](https://github.com/vit9696)
+  * Endless amount of help troubleshooting, determining fixes and writing patches
+* [EduCovas](https://github.com/covasedu)
+  * [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
+  * [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
+  * 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)
+  * [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
+  * [legacy Wi-Fi patch set](https://github.com/moraea/unsupported-wifi-patches) restores functionality for Wi-Fi cards in all 2007 - 2017 models
+  * [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
+  * AppleGVA downgrade for accelerated video decoding on 2012 - 2016 models
+  * OpenCL and OpenGL downgrade for AMD GCN
+  * [USB 1 patch](https://github.com/moraea/misc-patches/tree/main/IOUSBHostFamily-14.4)
+* [ASentientHedgehog](https://github.com/moosethegoose2213)
+  * [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
 * [ASentientBot](https://github.com/ASentientBot)
-  * Legacy Acceleration Patch set and documentation
+  * [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
+  * [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
+  * [dsce](https://github.com/moraea/dsce) and [shared code](https://github.com/moraea/moraea-common) used by some other patches
 * [cdf](https://github.com/cdf)
   * Mac Pro on OpenCore Patch set and documentation
   * [Innie](https://github.com/cdf/Innie) and [NightShiftEnabler](https://github.com/cdf/NightShiftEnabler)
 * [Syncretic](https://forums.macrumors.com/members/syncretic.1173816/)
-  * [AAAMouSSE](https://forums.macrumors.com/threads/mp3-1-others-sse-4-2-emulation-to-enable-amd-metal-driver.2206682/) and [telemetrap](https://forums.macrumors.com/threads/mp3-1-others-sse-4-2-emulation-to-enable-amd-metal-driver.2206682/post-28447707)
-* [dosdude1](https://github.com/dosdude1) and [BarryKN](https://github.com/BarryKN)
+  * [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)
+* [dosdude1](https://github.com/dosdude1)
+  * Main author of the [original GUI](https://github.com/dortania/OCLP-GUI)
+  * Development of previous patchers, laying out much of what needs to be patched
+* [parrotgeek1](https://github.com/parrotgeek1)
+  * [VMM Patch Set](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/4a8f61a01da72b38a4b2250386cc4b497a31a839/payloads/Config/config.plist#L1222-L1281)
+* [BarryKN](https://github.com/BarryKN)
   * Development of previous patchers, laying out much of what needs to be patched
-* [vit9696](https://github.com/vit9696)
-  * Endless amount of help troubleshooting, determining fixes and writing patches
 * [mario_bros_tech](https://github.com/mariobrostech) and the rest of the Unsupported Mac Discord
   * Catalyst that started OpenCore Legacy Patcher
+* [arter97](https://github.com/arter97/)
+  * [SimpleMSR](https://github.com/arter97/SimpleMSR/) to disable firmware throttling in Nehalem+ MacBooks without batteries
+* [Mr.Macintosh](https://mrmacintosh.com)
+  * Endless hours helping architect and troubleshoot many portions of the project
+* [flagers](https://github.com/flagersgit)
+  * Aid with Nvidia Web Driver research and development
+  * [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
+  * [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
+  * LegacyRVPL, SnapshotIsKill, etc. to aid in rapid testing and development
+* [joevt](https://github.com/joevt)
+  * [FixPCIeLinkrate](https://github.com/joevt/joevtApps)
+* [Jazzzny](https://github.com/Jazzzny)
+  * Research and various contributions to the project
+  * UEFI Legacy XHCI research and development
+  * NVIDIA OpenCL research and development
+  * `MacBook5,2` research and development
+    * LegacyKeyboardInjector
+  * Pre-Ivy Bridge Aquantia Ethernet Patch
+  * Non-Metal Photo Booth Patch for Monterey+
+  * GUI and Backend Development
+    * Updater UI
+    * macOS Downloader UI
+    * Downloader UI
+    * USB Top Case probing
+    * Developer root patching
+  * Vaulting implementation
+  * macOS 15 3802 Helios Research
+  * UEFI bootx64.efi research
+  * universal2 build research
+  * Various documentation contributions
+* Amazing users who've graciously donate hardware:
+  * [JohnD](https://forums.macrumors.com/members/johnd.53633/) - 2013 Mac Pro
+  * [SpiGAndromeda](https://github.com/SpiGAndromeda) - AMD Vega 64
+  * [turbomacs](https://github.com/turbomacs) - 2014 5k iMac
+  * [vinaypundith](https://forums.macrumors.com/members/vinaypundith.1212357/) - MacBook7,1
+   * [ThatStella7922](https://github.com/ThatStella7922) - 2017 13" MacBook Pro (A1708)
+  * zephar - 2008 Mac Pro
+  * jazo97 - 2011 15" MacBook Pro
+  * And others (reach out if we forgot you!)
 * MacRumors and Unsupported Mac Communities
-  * Endless testing, reporting issues
+  * Endless testing and reporting issues
 * Apple
-  * for macOS and many of the kexts, frameworks and other binaries we reimplemented into newer OSes
+  * for macOS and many of the kexts, frameworks and other binaries we reimplemented into newer OSes

Resources/Build.py

@@ -1,944 +0,0 @@
-# Commands for building the EFI and SMBIOS
-# Copyright (C) 2020-2021, Dhinak G, Mykola Grymalyuk
-from __future__ import print_function
-
-import binascii
-import plistlib
-import shutil
-import subprocess
-import uuid
-import zipfile
-import os
-import sys
-import platform
-import ast
-from pathlib import Path
-from datetime import date
-
-from Resources import Constants, ModelArray, PCIIDArray, Utilities, DeviceProbe
-
-
-def human_fmt(num):
-    for unit in ["B", "KB", "MB", "GB", "TB", "PB"]:
-        if abs(num) < 1000.0:
-            return "%3.1f %s" % (num, unit)
-        num /= 1000.0
-    return "%.1f %s" % (num, "EB")
-
-
-def rmtree_handler(func, path, exc_info):
-    if exc_info[0] == FileNotFoundError:
-        return
-    raise  # pylint: disable=misplaced-bare-raise
-
-
-class BuildOpenCore:
-    def __init__(self, model, versions):
-        self.model = model
-        self.config = None
-        self.constants: Constants.Constants = versions
-
-    def hexswap(self, input_hex: str):
-        hex_pairs = [input_hex[i:i + 2] for i in range(0, len(input_hex), 2)]
-        hex_rev = hex_pairs[::-1]
-        hex_str = "".join(["".join(x) for x in hex_rev])
-        return hex_str.upper()
-
-    def build_efi(self):
-        Utilities.cls()
-        print(f"Building Configuration for model: {self.model}")
-        if not Path(self.constants.build_path).exists():
-            Path(self.constants.build_path).mkdir()
-            print("Created build folder")
-        else:
-            print("Build folder already present, skipping")
-
-        if Path(self.constants.opencore_zip_copied).exists():
-            print("Deleting old copy of OpenCore zip")
-            Path(self.constants.opencore_zip_copied).unlink()
-        if Path(self.constants.opencore_release_folder).exists():
-            print("Deleting old copy of OpenCore folder")
-            shutil.rmtree(self.constants.opencore_release_folder, onerror=rmtree_handler)
-
-        print()
-        print(f"- Adding OpenCore v{self.constants.opencore_version} {self.constants.opencore_build}")
-        shutil.copy(self.constants.opencore_zip_source, self.constants.build_path)
-        zipfile.ZipFile(self.constants.opencore_zip_copied).extractall(self.constants.build_path)
-
-        print("- Adding config.plist for OpenCore")
-        # Setup config.plist for editing
-        shutil.copy(self.constants.plist_template, self.constants.oc_folder)
-        self.config = plistlib.load(Path(self.constants.plist_path).open("rb"))
-
-        # Set revision in config
-        self.config["#Revision"]["Build-Version"] = f"{self.constants.patcher_version} - {date.today()}"
-        if not self.constants.custom_model:
-            self.config["#Revision"]["Build-Type"] = "OpenCore Built on Target Machine"
-        else:
-            self.config["#Revision"]["Build-Type"] = "OpenCore Built for External Machine"
-        self.config["#Revision"]["OpenCore-Version"] = f"{self.constants.opencore_version} - {self.constants.opencore_build} - {self.constants.opencore_commit}"
-        self.config["#Revision"]["Original-Model"] = self.model
-        self.config["NVRAM"]["Add"]["4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102"]["OCLP-Version"] = f"{self.constants.patcher_version}"
-
-        for name, version, path, check in [
-            # Essential kexts
-            ("Lilu.kext", self.constants.lilu_version, self.constants.lilu_path, lambda: True),
-            ("WhateverGreen.kext", self.constants.whatevergreen_version, self.constants.whatevergreen_path, lambda: self.constants.allow_oc_everywhere is False),
-            ("RestrictEvents.kext", self.constants.restrictevents_version, self.constants.restrictevents_path, lambda: self.model in ModelArray.MacPro71),
-            ("RestrictEvents.kext", self.constants.restrictevents_mbp_version, self.constants.restrictevents_mbp_path, lambda: self.model == "MacBookPro9,1"),
-            ("NightShiftEnabler.kext", self.constants.nightshift_version, self.constants.nightshift_path, lambda: self.model not in ModelArray.NightShiftExclude and self.constants.allow_oc_everywhere is False and self.constants.serial_settings == "Minimal"),
-            ("SMC-Spoof.kext", self.constants.smcspoof_version, self.constants.smcspoof_path, lambda: self.constants.allow_oc_everywhere is False),
-            # CPU patches
-            ("AppleMCEReporterDisabler.kext", self.constants.mce_version, self.constants.mce_path, lambda: self.model in ModelArray.DualSocket),
-            ("AAAMouSSE.kext", self.constants.mousse_version, self.constants.mousse_path, lambda: self.model in ModelArray.SSEEmulator),
-            ("telemetrap.kext", self.constants.telemetrap_version, self.constants.telemetrap_path, lambda: self.model in ModelArray.MissingSSE42),
-            ("CPUFriend.kext", self.constants.cpufriend_version, self.constants.cpufriend_path, lambda: self.model != "iMac7,1" and self.constants.allow_oc_everywhere is False and self.constants.disallow_cpufriend is False),
-            # Ethernet patches
-            ("nForceEthernet.kext", self.constants.nforce_version, self.constants.nforce_path, lambda: self.model in ModelArray.EthernetNvidia),
-            ("MarvelYukonEthernet.kext", self.constants.marvel_version, self.constants.marvel_path, lambda: self.model in ModelArray.EthernetMarvell),
-            ("CatalinaBCM5701Ethernet.kext", self.constants.bcm570_version, self.constants.bcm570_path, lambda: self.model in ModelArray.EthernetBroadcom),
-            # Legacy audio
-            ("AppleALC.kext", self.constants.applealc_version, self.constants.applealc_path, lambda: self.model in ModelArray.LegacyAudio or self.model in ModelArray.MacPro71),
-            # IDE patch
-            ("AppleIntelPIIXATA.kext", self.constants.piixata_version, self.constants.piixata_path, lambda: self.model in ModelArray.IDEPatch),
-            # Misc
-            ("SidecarFixup.kext", self.constants.sidecarfixup_version, self.constants.sidecarfixup_path, lambda: self.model in ModelArray.SidecarPatch),
-        ]:
-            self.enable_kext(name, version, path, check)
-
-        if self.constants.allow_oc_everywhere is False:
-            self.get_item_by_kv(self.config["Kernel"]["Patch"], "Identifier", "com.apple.driver.AppleSMC")["Enabled"] = True
-
-
-        if not self.constants.custom_model and (self.constants.allow_oc_everywhere is True or self.model in ModelArray.MacPro71):
-            # Use Innie's same logic:
-            # https://github.com/cdf/Innie/blob/v1.3.0/Innie/Innie.cpp#L90-L97
-            storage_devices = plistlib.loads(subprocess.run("ioreg -c IOPCIDevice -r -d2 -a".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-            storage_devices = [i for i in storage_devices if i["class-code"] == binascii.unhexlify(self.constants.classcode_sata) or i["class-code"] == binascii.unhexlify(self.constants.classcode_nvme)]
-            storage_path_gfx: str = subprocess.run([self.constants.gfxutil_path] + f"-v".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-            try:
-                x = 1
-                for i in storage_devices:
-                    storage_vendor = self.hexswap(binascii.hexlify(i["vendor-id"]).decode()[:4])
-                    storage_device = self.hexswap(binascii.hexlify(i["device-id"]).decode()[:4])
-                    print(f'- Fixing PCIe Storage Controller ({x}) reporting')
-                    try:
-                        storage_path = [line.strip().split("= ", 1)[1] for line in storage_path_gfx.split("\n") if f'{storage_vendor}:{storage_device}'.lower() in line.strip()][0]
-                        self.config["DeviceProperties"]["Add"][storage_path] = { "built-in": 1}
-                    except IndexError:
-                        print(f"- Failed to find Device path for PCIe Storage Controller {x}, falling back to Innie")
-                        if self.get_kext_by_bundle_path("Innie.kext")["Enabled"] is False:
-                            self.enable_kext("Innie.kext", self.constants.innie_version, self.constants.innie_path)
-                    x = x + 1
-            except ValueError:
-                print("- No PCIe Storage Controllers found to fix(V)")
-            except IndexError:
-                print("- No PCIe Storage Controllers found to fix(I)")
-
-        if not self.constants.custom_model:
-            nvme_devices = plistlib.loads(subprocess.run("ioreg -c IOPCIDevice -r -d2 -a".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-            nvme_devices = [i for i in nvme_devices if i.get("IORegistryEntryChildren", None) and i["vendor-id"] != binascii.unhexlify("6B100000") and i["IORegistryEntryChildren"][0]["IORegistryEntryName"] == "IONVMeController"]
-            try:
-                x = 1
-                for i in nvme_devices:
-                    nvme_vendor = self.hexswap(binascii.hexlify(i["vendor-id"]).decode()[:4])
-                    nvme_device = self.hexswap(binascii.hexlify(i["device-id"]).decode()[:4])
-                    print(f'- Found 3rd Party NVMe SSD ({x}): {nvme_vendor}:{nvme_device}')
-                    nvme_aspm = i["pci-aspm-default"]
-                    try:
-                        nvme_acpi = i["acpi-path"]
-                        nvme_acpi = DeviceProbe.pci_probe().acpi_strip(nvme_acpi)
-                    except KeyError:
-                        print(f"- No ACPI entry found for NVMe SSD ({x})")
-                        nvme_acpi = ""
-                    # Disable Bit 0 (L0s), enable Bit 1 (L1)
-                    if not isinstance(nvme_aspm, int):
-                        nvme_aspm = int.from_bytes(nvme_aspm, byteorder='little')
-                    nvme_aspm = (nvme_aspm & (~3)) | 2
-                    #nvme_aspm &= ~1  # Turn off bit 1
-                    #nvme_aspm |= 2  # Turn on bit 2
-                    self.config["#Revision"][f"Hardware-NVMe-{x}"] = f'{nvme_vendor}:{nvme_device}'
-                    try:
-                        nvme_path = DeviceProbe.pci_probe().deviceproperty_probe(nvme_vendor, nvme_device, nvme_acpi)
-                        if nvme_path == "":
-                            raise IndexError
-                        nvme_path_parent = DeviceProbe.pci_probe().device_property_parent(nvme_path)
-                        print(f"- Found NVMe ({x}) at {nvme_path}")
-                        self.config["DeviceProperties"]["Add"][nvme_path] = {"pci-aspm-default": nvme_aspm, "built-in": 1}
-                        self.config["DeviceProperties"]["Add"][nvme_path_parent] = {"pci-aspm-default": nvme_aspm}
-                    except IndexError:
-                        if "-nvmefaspm" not in self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"]:
-                            print("- Falling back to -nvmefaspm")
-                            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -nvmefaspm"
-                    if self.get_kext_by_bundle_path("NVMeFix.kext")["Enabled"] is False:
-                        self.enable_kext("NVMeFix.kext", self.constants.nvmefix_version, self.constants.nvmefix_path)
-                    x = x + 1
-            except ValueError:
-                print("- No 3rd Party NVMe drive found(V)")
-            except IndexError:
-                print("- No 3rd Party NVMe drive found(I)")
-
-        def wifi_fake_id(self):
-            default_path = True
-            self.enable_kext("AirportBrcmFixup.kext", self.constants.airportbcrmfixup_version, self.constants.airportbcrmfixup_path)
-            self.get_kext_by_bundle_path("AirportBrcmFixup.kext/Contents/PlugIns/AirPortBrcmNIC_Injector.kext")["Enabled"] = True
-            if not self.constants.custom_model:
-                arpt_path = DeviceProbe.pci_probe().deviceproperty_probe(wifi_vendor, wifi_device, wifi_acpi)
-                if arpt_path:
-                    print(f"- Found ARPT device at {arpt_path}")
-                    default_path = False
-                else:
-                    default_path = True
-            if default_path is True:
-                if self.model in ModelArray.nvidiaHDEF:
-                    # Nvidia chipsets all have the same path to ARPT
-                    arpt_path = "PciRoot(0x0)/Pci(0x15,0x0)/Pci(0x0,0x0)"
-                elif self.model in ("iMac7,1", "iMac8,1", "MacPro3,1", "MacBookPro4,1"):
-                    arpt_path = "PciRoot(0x0)/Pci(0x1C,0x4)/Pci(0x0,0x0)"
-                elif self.model in ("iMac13,1", "iMac13,2"):
-                    arpt_path = "PciRoot(0x0)/Pci(0x1C,0x3)/Pci(0x0,0x0)"
-                elif self.model in ("MacPro4,1", "MacPro5,1"):
-                    arpt_path = "PciRoot(0x0)/Pci(0x1C,0x5)/Pci(0x0,0x0)"
-                else:
-                    # Assumes we have a laptop with Intel chipset
-                    # iMac11,x-12,x also apply
-                    arpt_path = "PciRoot(0x0)/Pci(0x1C,0x1)/Pci(0x0,0x0)"
-                print(f"- Using known DevicePath {arpt_path}")
-            print("- Applying fake ID for WiFi")
-            self.config["DeviceProperties"]["Add"][arpt_path] = {"device-id": binascii.unhexlify("ba430000"), "compatible": "pci14e4,43ba"}
-
-        # WiFi patches
-        # TODO: -a is not supported in Lion and older, need to add proper fix
-        if self.constants.detected_os > self.constants.lion and not self.constants.custom_model:
-            wifi_vendor,wifi_device,wifi_ioname,wifi_acpi = DeviceProbe.pci_probe().wifi_probe()
-            if wifi_vendor:
-                print(f"- Found Wireless Device {wifi_vendor}:{wifi_device} ({wifi_ioname})")
-                self.config["#Revision"]["Hardware-Wifi"] = f"{wifi_vendor}:{wifi_device} ({wifi_ioname}"
-        else:
-            wifi_vendor = ""
-            print("- Unable to run Wireless hardware detection")
-        if self.constants.wifi_build is True:
-            print("- Skipping Wifi patches on request")
-        elif not self.constants.custom_model and wifi_vendor:
-            if wifi_vendor == self.constants.pci_broadcom:
-                # This works around OCLP spoofing the Wifi card and therefore unable to actually detect the correct device
-                if wifi_device in PCIIDArray.broadcom_ids().BCM4360Wifi and wifi_ioname not in ["pci14e4,4353", "pci14e4,4331"]:
-                    self.enable_kext("AirportBrcmFixup.kext", self.constants.airportbcrmfixup_version, self.constants.airportbcrmfixup_path)
-                elif wifi_ioname in ["pci14e4,4353", "pci14e4,4331"] or wifi_device in PCIIDArray.broadcom_ids().BCM94331Wifi:
-                    wifi_fake_id(self)
-                elif wifi_device in PCIIDArray.broadcom_ids().BCM94322Wifi:
-                    self.enable_kext("IO80211Mojave.kext", self.constants.io80211mojave_version, self.constants.io80211mojave_path)
-                    self.get_kext_by_bundle_path("IO80211Mojave.kext/Contents/PlugIns/AirPortBrcm4331.kext")["Enabled"] = True
-                elif wifi_device in PCIIDArray.broadcom_ids().BCM94328Wifi:
-                    self.enable_kext("corecaptureElCap.kext", self.constants.corecaptureelcap_version, self.constants.corecaptureelcap_path)
-                    self.enable_kext("IO80211ElCap.kext", self.constants.io80211elcap_version, self.constants.io80211elcap_path)
-                    self.get_kext_by_bundle_path("IO80211ElCap.kext/Contents/PlugIns/AppleAirPortBrcm43224.kext")["Enabled"] = True
-            elif wifi_vendor == self.constants.pci_atheros and wifi_device in PCIIDArray.atheros_ids().AtherosWifi:
-                self.enable_kext("IO80211HighSierra.kext", self.constants.io80211high_sierra_version, self.constants.io80211high_sierra_path)
-                self.get_kext_by_bundle_path("IO80211HighSierra.kext/Contents/PlugIns/AirPortAtheros40.kext")["Enabled"] = True
-        else:
-            if self.model in ["iMac14,1", "iMac14,2", "iMac14,3"]:
-                self.enable_kext("AirportBrcmFixup.kext", self.constants.airportbcrmfixup_version, self.constants.airportbcrmfixup_path)
-            elif self.model in ModelArray.WifiBCM94331:
-                wifi_fake_id(self)
-            elif self.model in ModelArray.WifiBCM94322:
-                self.enable_kext("IO80211Mojave.kext", self.constants.io80211mojave_version, self.constants.io80211mojave_path)
-                self.get_kext_by_bundle_path("IO80211Mojave.kext/Contents/PlugIns/AirPortBrcm4331.kext")["Enabled"] = True
-            elif self.model in ModelArray.WifiBCM94328:
-                self.enable_kext("corecaptureElCap.kext", self.constants.corecaptureelcap_version, self.constants.corecaptureelcap_path)
-                self.enable_kext("IO80211ElCap.kext", self.constants.io80211elcap_version, self.constants.io80211elcap_path)
-                self.get_kext_by_bundle_path("IO80211ElCap.kext/Contents/PlugIns/AppleAirPortBrcm43224.kext")["Enabled"] = True
-            elif self.model in ModelArray.WifiAtheros:
-                self.enable_kext("IO80211HighSierra.kext", self.constants.io80211high_sierra_version, self.constants.io80211high_sierra_path)
-                self.get_kext_by_bundle_path("IO80211HighSierra.kext/Contents/PlugIns/AirPortAtheros40.kext")["Enabled"] = True
-
-        # CPUFriend
-        pp_map_path = Path(self.constants.platform_plugin_plist_path) / Path(f"{self.model}/Info.plist")
-        if self.model != "iMac7,1" and self.constants.allow_oc_everywhere is False:
-            Path(self.constants.pp_kext_folder).mkdir()
-            Path(self.constants.pp_contents_folder).mkdir()
-            shutil.copy(pp_map_path, self.constants.pp_contents_folder)
-            self.get_kext_by_bundle_path("CPUFriendDataProvider.kext")["Enabled"] = True
-
-        # HID patches
-        if self.model in ModelArray.LegacyHID:
-            print("- Adding IOHIDFamily patch")
-            self.get_item_by_kv(self.config["Kernel"]["Patch"], "Identifier", "com.apple.iokit.IOHIDFamily")["Enabled"] = True
-
-        # SSDT patches
-        if self.model in ModelArray.pciSSDT:
-            print("- Adding SSDT-CPBG.aml")
-            self.get_item_by_kv(self.config["ACPI"]["Add"], "Path", "SSDT-CPBG.aml")["Enabled"] = True
-            shutil.copy(self.constants.pci_ssdt_path, self.constants.acpi_path)
-
-        if self.model in ModelArray.windows_audio:
-            # Based on: https://egpu.io/forums/pc-setup/fix-dsdt-override-to-correct-error-12/
-            print("- Enabling Windows 10 UEFI Audio support")
-            self.get_item_by_kv(self.config["ACPI"]["Add"], "Path", "SSDT-PCI.aml")["Enabled"] = True
-            self.get_item_by_kv(self.config["ACPI"]["Patch"], "Comment", "BUF0 to BUF1")["Enabled"] = True
-            shutil.copy(self.constants.windows_ssdt_path, self.constants.acpi_path)
-
-        # USB Map
-        usb_map_path = Path(self.constants.plist_folder_path) / Path("AppleUSBMaps/Info.plist")
-        # iMac7,1 kernel panics with USB map installed, remove for time being until properly debugged
-        if usb_map_path.exists() and self.constants.allow_oc_everywhere is False and self.model != "iMac7,1":
-            print(f"- Adding USB-Map.kext")
-            Path(self.constants.map_kext_folder).mkdir()
-            Path(self.constants.map_contents_folder).mkdir()
-            shutil.copy(usb_map_path, self.constants.map_contents_folder)
-            self.get_kext_by_bundle_path("USB-Map.kext")["Enabled"] = True
-
-        agdp_map_path = Path(self.constants.plist_folder_path) / Path("AppleGraphicsDevicePolicy/Info.plist")
-        agpm_map_path = Path(self.constants.plist_folder_path) / Path("AppleGraphicsPowerManagement/Info.plist")
-        amc_map_path = Path(self.constants.plist_folder_path) / Path("AppleMuxControl/Info.plist")
-
-        if self.model == "MacBookPro9,1":
-            print(f"- Adding Display Map Overrides")
-            self.config["DeviceProperties"]["Add"]["PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)"] = {"agdpmod": "vit9696"}
-            Path(self.constants.agdp_kext_folder).mkdir()
-            Path(self.constants.agdp_contents_folder).mkdir()
-            Path(self.constants.agpm_kext_folder).mkdir()
-            Path(self.constants.agpm_contents_folder).mkdir()
-            Path(self.constants.amc_kext_folder).mkdir()
-            Path(self.constants.amc_contents_folder).mkdir()
-
-            shutil.copy(agdp_map_path, self.constants.agdp_contents_folder)
-            shutil.copy(agpm_map_path, self.constants.agpm_contents_folder)
-            shutil.copy(amc_map_path, self.constants.amc_contents_folder)
-            self.get_kext_by_bundle_path("AGDP-Override.kext")["Enabled"] = True
-            self.get_kext_by_bundle_path("AGPM-Override.kext")["Enabled"] = True
-            self.get_kext_by_bundle_path("AMC-Override.kext")["Enabled"] = True
-
-        # AGPM Patch
-        if self.model in ModelArray.DualGPUPatch:
-            print("- Adding dual GPU patch")
-            if not self.constants.custom_model:
-                dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-                self.gfx0_path = DeviceProbe.pci_probe().deviceproperty_probe(dgpu_vendor,dgpu_device,dgpu_acpi)
-                if self.gfx0_path == "":
-                    print("- Failed to find GFX0 Device path, falling back on known logic")
-                    self.gfx0_path = "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)"
-                else:
-                    print(f"- Found GFX0 Device Path: {self.gfx0_path}")
-            else:
-                self.gfx0_path = "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)"
-            if self.model in ModelArray.IntelNvidiaDRM and self.constants.drm_support is True:
-                print("- Prioritizing DRM support over Intel QuickSync")
-                self.config["DeviceProperties"]["Add"][self.gfx0_path] = {"agdpmod": "vit9696", "shikigva": 256}
-                self.config["DeviceProperties"]["Add"]["PciRoot(0x0)/Pci(0x2,0x0)"] = {"disable-gpu-min": "20.0.0"}
-            else:
-                self.config["DeviceProperties"]["Add"][self.gfx0_path] = {"agdpmod": "vit9696"}
-
-        # HiDPI OpenCanopy and FileVault
-        if self.model in ModelArray.HiDPIpicker:
-            print("- Setting HiDPI picker")
-            self.config["NVRAM"]["Add"]["4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14"]["UIScale"] = binascii.unhexlify("02")
-
-        # Audio Patch
-        if self.model in ModelArray.LegacyAudio:
-            print("- Adding audio properties")
-            hdef_path = "PciRoot(0x0)/Pci(0x8,0x0)" if self.model in ModelArray.nvidiaHDEF else "PciRoot(0x0)/Pci(0x1b,0x0)"
-            # In AppleALC, MacPro3,1's original layout is already in use, forcing layout 13 instead
-            if self.model == "MacPro3,1":
-                self.config["DeviceProperties"]["Add"][hdef_path] = {"apple-layout-id": 90, "use-apple-layout-id": 1, "alc-layout-id": 13, }
-            else:
-                self.config["DeviceProperties"]["Add"][hdef_path] = {"apple-layout-id": 90, "use-apple-layout-id": 1, "use-layout-id": 1, }
-
-        def backlight_path_detection(self):
-            if not self.constants.custom_model:
-                dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-                self.gfx0_path = DeviceProbe.pci_probe().deviceproperty_probe(dgpu_vendor,dgpu_device,dgpu_acpi)
-                if self.gfx0_path == "":
-                    print("- Failed to find GFX0 Device path, falling back on known logic")
-                    if self.model in ["iMac11,1", "iMac11,3"]:
-                        self.gfx0_path = "PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0)"
-                    else:
-                        self.gfx0_path = "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)"
-                else:
-                    print(f"- Found GFX0 Device Path: {self.gfx0_path}")
-
-            else:
-                if self.model in ["iMac11,1", "iMac11,3"]:
-                    self.gfx0_path = "PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0)"
-                else:
-                    self.gfx0_path = "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)"
-                print(f"- Using known GFX0 path: {self.gfx0_path}")
-
-
-        def nvidia_patch(self, backlight_path):
-            self.constants.custom_mxm_gpu = True
-            if self.model in ["iMac11,1", "iMac11,2", "iMac11,3"]:
-                print("- Adding Nvidia Brightness Control and DRM patches")
-                self.config["DeviceProperties"]["Add"][backlight_path] = {"@0,backlight-control": binascii.unhexlify("01000000"), "@0,built-in": binascii.unhexlify("01000000"), "shikigva": 256, "agdpmod": "vit9696"}
-                if self.constants.custom_model and self.model == "iMac11,2":
-                    # iMac11,2 can have either PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0) or PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)
-                    # Set both properties when we cannot run hardware detection
-                    self.config["DeviceProperties"]["Add"]["PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0)"] = {"@0,backlight-control": binascii.unhexlify("01000000"), "@0,built-in": binascii.unhexlify("01000000"), "shikigva": 256, "agdpmod": "vit9696"}
-                shutil.copy(self.constants.backlight_path, self.constants.kexts_path)
-                self.get_kext_by_bundle_path("AppleBacklightFixup.kext")["Enabled"] = True
-            elif self.model in ["iMac12,1", "iMac12,2"]:
-                print("- Adding Nvidia Brightness Control and DRM patches")
-                self.config["DeviceProperties"]["Add"][backlight_path] = {"@0,backlight-control": binascii.unhexlify("01000000"), "@0,built-in": binascii.unhexlify("01000000"), "shikigva": 256}
-                print("- Disabling unsupported iGPU")
-                self.config["DeviceProperties"]["Add"]["PciRoot(0x0)/Pci(0x2,0x0)"] = {"name": binascii.unhexlify("23646973706C6179"), "IOName": "#display", "class-code": binascii.unhexlify("FFFFFFFF")}
-                shutil.copy(self.constants.backlight_path, self.constants.kexts_path)
-                self.get_kext_by_bundle_path("AppleBacklightFixup.kext")["Enabled"] = True
-            self.config["UEFI"]["Quirks"]["ForgeUefiSupport"] = True
-            self.config["UEFI"]["Quirks"]["ReloadOptionRoms"] = True
-
-        def amd_patch(self, backlight_path):
-            self.constants.custom_mxm_gpu = True
-            print("- Adding AMD DRM patches")
-            self.config["DeviceProperties"]["Add"][backlight_path] = {"shikigva": 80, "unfairgva": 1}
-            if self.constants.custom_model and self.model == "iMac11,2":
-                    # iMac11,2 can have either PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0) or PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)
-                    # Set both properties when we cannot run hardware detection
-                    self.config["DeviceProperties"]["Add"]["PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0)"] = {"shikigva": 80, "unfairgva": 1}
-            if self.model in ["iMac12,1", "iMac12,2"]:
-                print("- Disabling unsupported iGPU")
-                self.config["DeviceProperties"]["Add"]["PciRoot(0x0)/Pci(0x2,0x0)"] = {"name": binascii.unhexlify("23646973706C6179"), "IOName": "#display", "class-code": binascii.unhexlify("FFFFFFFF")}
-            elif self.model == "iMac10,1":
-                self.enable_kext("AAAMouSSE.kext", self.constants.mousse_version, self.constants.mousse_path)
-
-        # Check GPU Vendor
-        if self.constants.metal_build is True:
-            backlight_path_detection(self)
-            print("- Adding Metal GPU patches on request")
-            if self.constants.imac_vendor == "AMD":
-                amd_patch(self, self.gfx0_path)
-            elif self.constants.imac_vendor == "Nvidia":
-                nvidia_patch(self, self.gfx0_path)
-            else:
-                print("- Failed to find vendor")
-        elif not self.constants.custom_model and self.model in ModelArray.LegacyGPU:
-            dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-            if dgpu_vendor:
-                print(f"- Detected dGPU: {dgpu_vendor}:{dgpu_device}")
-                if dgpu_vendor == self.constants.pci_amd_ati and (dgpu_device in PCIIDArray.amd_ids().polaris_ids or dgpu_device in PCIIDArray.amd_ids().vega_ids or dgpu_device in PCIIDArray.amd_ids().navi_ids or dgpu_device in PCIIDArray.amd_ids().legacy_gcn_ids):
-                    backlight_path_detection(self)
-                    amd_patch(self, self.gfx0_path)
-                elif dgpu_vendor == self.constants.pci_nvidia and dgpu_device in PCIIDArray.nvidia_ids().kepler_ids:
-                    backlight_path_detection(self)
-                    nvidia_patch(self, self.gfx0_path)
-        if self.model in ModelArray.MacPro71:
-            if not self.constants.custom_model:
-                mp_dgpu_devices = plistlib.loads(subprocess.run("ioreg -c IOPCIDevice -r -d2 -a".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-                mp_dgpu_devices = [i for i in mp_dgpu_devices if i["class-code"] == binascii.unhexlify("00000300") or i["class-code"] == binascii.unhexlify("00800300")]
-                mp_dgpu_devices_gfx: str = subprocess.run([self.constants.gfxutil_path] + f"-v".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-                try:
-                    x = 1
-                    for i in mp_dgpu_devices:
-                        mp_dgpu_vendor = self.hexswap(binascii.hexlify(i["vendor-id"]).decode()[:4])
-                        mp_dgpu_device = self.hexswap(binascii.hexlify(i["device-id"]).decode()[:4])
-
-                        print(f'- Found dGPU ({x}): {mp_dgpu_vendor}:{mp_dgpu_device}')
-                        self.config["#Revision"][f"Hardware-MacPro-dGPU-{x}"] = f'{mp_dgpu_vendor}:{mp_dgpu_device}'
-
-                        try:
-                            mp_dgpu_path = [line.strip().split("= ", 1)[1] for line in mp_dgpu_devices_gfx.split("\n") if f'{mp_dgpu_vendor}:{mp_dgpu_device}'.lower() in line.strip()][0]
-                            print(f"- Found dGPU ({x}) at {mp_dgpu_path}")
-                            if mp_dgpu_vendor == self.constants.pci_amd_ati:
-                                print("- Adding Mac Pro, Xserve DRM patches")
-                                self.config["DeviceProperties"]["Add"][mp_dgpu_path] = {"shikigva": 128, "unfairgva": 1, "wegtree": 1}
-                            elif mp_dgpu_vendor == self.constants.pci_nvidia:
-                                print("- Enabling Nvidia Output Patch")
-                                self.config["DeviceProperties"]["Add"][mp_dgpu_path] = {"wegtree": 1}
-                                self.config["UEFI"]["Quirks"]["ForgeUefiSupport"] = True
-                                self.config["UEFI"]["Quirks"]["ReloadOptionRoms"] = True
-
-                        except IndexError:
-                            print(f"- Failed to find Device path for NVMe {x}")
-                            if mp_dgpu_vendor == self.constants.pci_amd_ati:
-                                print("- Adding Mac Pro, Xserve DRM patches")
-                                if "shikigva=128 unfairgva=1 -wegtree" not in self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"]:
-                                    print("- Falling back to boot-args")
-                                    self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " shikigva=128 unfairgva=1 -wegtree"
-                            elif mp_dgpu_vendor == self.constants.pci_nvidia:
-                                print("- Enabling Nvidia Output Patch")
-                                if "-wegtree" not in self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"]:
-                                    print("- Falling back to boot-args")
-                                    self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -wegtree"
-                                self.config["UEFI"]["Quirks"]["ForgeUefiSupport"] = True
-                                self.config["UEFI"]["Quirks"]["ReloadOptionRoms"] = True
-                        x = x + 1
-                except ValueError:
-                    print("- No socketed dGPU found")
-                except IndexError:
-                    print("- No socketed dGPU found")
-            else:
-                print("- Adding Mac Pro, Xserve DRM patches")
-                self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " shikigva=128 unfairgva=1 -wegtree"
-
-        # Add OpenCanopy
-        print("- Adding OpenCanopy GUI")
-        shutil.rmtree(self.constants.resources_path, onerror=rmtree_handler)
-        shutil.copy(self.constants.gui_path, self.constants.oc_folder)
-        self.config["UEFI"]["Drivers"] = ["OpenCanopy.efi", "OpenRuntime.efi"]
-        # Exfat check
-        if self.model in ModelArray.NoExFat:
-            print("- Adding ExFatDxeLegacy.efi")
-            shutil.copy(self.constants.exfat_legacy_driver_path, self.constants.drivers_path)
-            self.config["UEFI"]["Drivers"] += ["ExFatDxeLegacy.efi"]
-
-        # Add UGA to GOP layer
-        if self.model in ModelArray.UGAtoGOP:
-            print("- Adding UGA to GOP Patch")
-            self.config["UEFI"]["Output"]["GopPassThrough"] = True
-
-        # ThirdPartDrives Check
-        if self.model not in ModelArray.NoSATAPatch:
-            print("- Adding SATA Hibernation Patch")
-            self.config["Kernel"]["Quirks"]["ThirdPartyDrives"] = True
-
-        # DEBUG Settings
-        if self.constants.verbose_debug is True:
-            print("- Enabling Verbose boot")
-            self.config["Kernel"]["Quirks"]["PanicNoKextDump"] = True
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -v debug=0x100"
-        if self.constants.kext_debug is True:
-            print("- Enabling DEBUG Kexts")
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " -liludbgall"
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " msgbuf=1048576"
-        if self.constants.opencore_debug is True:
-            print("- Enabling DEBUG OpenCore")
-            self.config["Misc"]["Debug"]["Target"] = 67
-            self.config["Misc"]["Debug"]["DisplayLevel"] = 672151678018
-        if self.constants.showpicker is True:
-            print("- Enabling ShowPicker")
-            self.config["Misc"]["Boot"]["ShowPicker"] = True
-        else:
-            print("- Hiding picker and enabling PollAppleHotKeys")
-            self.config["Misc"]["Boot"]["ShowPicker"] = False
-        if self.constants.vault is True:
-            print("- Setting Vault configuration")
-            self.config["Misc"]["Security"]["Vault"] = "Secure"
-            self.get_tool_by__path("OpenShell.efi")["Enabled"] = False
-        if self.constants.sip_status is False:
-            print("- Disabling SIP")
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["csr-active-config"] = binascii.unhexlify("EF0F0000")
-            self.config["NVRAM"]["Delete"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"] += ["csr-active-config"]
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["boot-args"] += " amfi_get_out_of_my_way=1"
-        if self.constants.secure_status is False:
-            print("- Disabling SecureBootModel")
-            self.config["Misc"]["Security"]["SecureBootModel"] = "Disabled"
-        if self.constants.serial_settings in ["Moderate", "Advanced"]:
-            print("- Enabling USB Rename Patches")
-            self.get_item_by_kv(self.config["ACPI"]["Patch"], "Comment", "XHC1 to SHC1")["Enabled"] = True
-            self.get_item_by_kv(self.config["ACPI"]["Patch"], "Comment", "EHC1 to EH01")["Enabled"] = True
-            self.get_item_by_kv(self.config["ACPI"]["Patch"], "Comment", "EHC2 to EH02")["Enabled"] = True
-        if self.constants.custom_cpu_model == 0 or self.constants.custom_cpu_model == 1:
-            self.config["NVRAM"]["Add"]["4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102"]["revcpu"] = self.constants.custom_cpu_model
-            if self.constants.custom_cpu_model_value != "":
-                print(f"- Adding custom CPU Name: {self.constants.custom_cpu_model_value}")
-                self.config["NVRAM"]["Add"]["4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102"]["revcpuname"] = self.constants.custom_cpu_model_value
-            else:
-                print("- Adding CPU Name Patch")
-            if self.get_kext_by_bundle_path("RestrictEvents.kext")["Enabled"] is False:
-                self.enable_kext("RestrictEvents.kext", self.constants.restrictevents_version, self.constants.restrictevents_path)
-
-    def set_smbios(self):
-        spoofed_model = self.model
-        # TODO: Set check as global variable
-        if self.model in ModelArray.MacBookAir61:
-            print("- Spoofing to MacBookAir6,1")
-            spoofed_model = "MacBookAir6,1"
-            spoofed_board = "Mac-35C1E88140C3E6CF"
-        elif self.model in ModelArray.MacBookAir62:
-            print("- Spoofing to MacBookAir6,2")
-            spoofed_model = "MacBookAir6,2"
-            spoofed_board = "Mac-7DF21CB3ED6977E5"
-        elif self.model in ModelArray.MacBookPro111:
-            print("- Spoofing to MacBookPro11,1")
-            spoofed_model = "MacBookPro11,1"
-            spoofed_board = "Mac-189A3D4F975D5FFC"
-        elif self.model in ModelArray.MacBookPro113:
-            print("- Spoofing to MacBookPro11,3")
-            spoofed_model = "MacBookPro11,3"
-            spoofed_board = "Mac-2BD1B31983FE1663"
-        elif self.model in ModelArray.Macmini71:
-            print("- Spoofing to Macmini7,1")
-            spoofed_model = "Macmini7,1"
-            spoofed_board = "Mac-35C5E08120C7EEAF"
-        elif self.model in ModelArray.iMacPro11:
-            print("- Spoofing to iMacPro1,1")
-            spoofed_model = "iMacPro1,1"
-            spoofed_board = "Mac-7BA5B2D9E42DDD94"
-        elif self.model in ModelArray.iMac151:
-            # Check for upgraded GPUs on iMacs
-            if self.constants.drm_support is True:
-                print("- Spoofing to iMacPro1,1")
-                spoofed_model = "iMacPro1,1"
-                spoofed_board = "Mac-7BA5B2D9E42DDD94"
-            else:
-                print("- Spoofing to iMac15,1")
-                spoofed_model = "iMac15,1"
-                spoofed_board = "Mac-42FD25EABCABB274"
-        elif self.model in ModelArray.iMac144:
-            print("- Spoofing to iMac14,4")
-            spoofed_model = "iMac14,4"
-            spoofed_board = "Mac-81E3E92DD6088272"
-        elif self.model in ModelArray.MacPro71:
-            print("- Spoofing to MacPro7,1")
-            spoofed_model = "MacPro7,1"
-            spoofed_board = "Mac-27AD2F918AE68F61"
-        else:
-            spoofed_model = self.model
-            spoofed_board = ""
-        self.spoofed_model = spoofed_model
-        self.spoofed_board = spoofed_board
-        if self.constants.allow_oc_everywhere is False:
-            self.config["#Revision"]["Spoofed-Model"] = f"{self.spoofed_model} - {self.constants.serial_settings}"
-
-        # Setup menu
-        def minimal_serial_patch(self):
-            if self.constants.custom_cpu_model == 0 or self.constants.custom_cpu_model == 1:
-                self.config["PlatformInfo"]["PlatformNVRAM"]["ProcessorType"] = 1537
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["run-efi-updater"] = "No"
-            self.config["PlatformInfo"]["PlatformNVRAM"]["BID"] = self.spoofed_board
-            self.config["PlatformInfo"]["SMBIOS"]["BoardProduct"] = self.spoofed_board
-            self.config["PlatformInfo"]["SMBIOS"]["BIOSVersion"] = "9999.999.999.999.999"
-            self.config["PlatformInfo"]["UpdateNVRAM"] = True
-            self.config["PlatformInfo"]["UpdateSMBIOS"] = True
-
-        def moderate_serial_patch(self):
-            if self.constants.custom_cpu_model == 0 or self.constants.custom_cpu_model == 1:
-                self.config["PlatformInfo"]["Generic"]["ProcessorType"] = 1537
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["run-efi-updater"] = "No"
-            self.config["PlatformInfo"]["Automatic"] = True
-            self.config["PlatformInfo"]["UpdateDataHub"] = True
-            self.config["PlatformInfo"]["UpdateNVRAM"] = True
-            self.config["PlatformInfo"]["UpdateSMBIOS"] = True
-            self.config["UEFI"]["ProtocolOverrides"]["DataHub"] = True
-            self.config["PlatformInfo"]["Generic"]["SystemProductName"] = self.spoofed_model
-
-        def advanced_serial_patch(self):
-            if self.constants.custom_cpu_model == 0 or self.constants.custom_cpu_model == 1:
-                self.config["PlatformInfo"]["Generic"]["ProcessorType"] = 1537
-            macserial_output = subprocess.run([self.constants.macserial_path] + f"-g -m {self.spoofed_model} -n 1".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-            macserial_output = macserial_output.stdout.decode().strip().split(" | ")
-            self.config["NVRAM"]["Add"]["7C436110-AB2A-4BBB-A880-FE41995C9F82"]["run-efi-updater"] = "No"
-            self.config["PlatformInfo"]["Automatic"] = True
-            self.config["PlatformInfo"]["UpdateDataHub"] = True
-            self.config["PlatformInfo"]["UpdateNVRAM"] = True
-            self.config["PlatformInfo"]["UpdateSMBIOS"] = True
-            self.config["UEFI"]["ProtocolOverrides"]["DataHub"] = True
-            self.config["PlatformInfo"]["Generic"]["ROM"] = binascii.unhexlify("0016CB445566")
-            self.config["PlatformInfo"]["Generic"]["SystemProductName"] = self.spoofed_model
-            self.config["PlatformInfo"]["Generic"]["SystemSerialNumber"] = macserial_output[0]
-            self.config["PlatformInfo"]["Generic"]["MLB"] = macserial_output[1]
-            self.config["PlatformInfo"]["Generic"]["SystemUUID"] = str(uuid.uuid4()).upper()
-
-        if self.constants.serial_settings == "Moderate":
-            print("- Using Moderate SMBIOS patching")
-            moderate_serial_patch(self)
-        elif self.constants.serial_settings == "Advanced":
-            print("- Using Advanced SMBIOS patching")
-            advanced_serial_patch(self)
-        elif self.constants.serial_settings == "Minimal":
-            print("- Using Minimal SMBIOS patching")
-            self.spoofed_model = self.model
-            minimal_serial_patch(self)
-
-        if self.constants.download_ram is False:
-            self.config["PlatformInfo"].pop("Memory")
-        else:
-            print("- Inserting 1.5TB of RAM into your Mac")
-            self.config["PlatformInfo"]["CustomMemory"] = True
-
-        # USB Map and CPUFriend Patching
-        if self.constants.allow_oc_everywhere is False and self.model != "iMac7,1":
-            new_map_ls = Path(self.constants.map_contents_folder) / Path("Info.plist")
-            map_config = plistlib.load(Path(new_map_ls).open("rb"))
-
-            for model_controller in ModelArray.ControllerTypes:
-                model_patch = f"{self.model}{model_controller}"
-                try:
-                    # Avoid erroring out when specific identity not found
-                    map_config["IOKitPersonalities_x86_64"][model_patch]["model"] = self.spoofed_model
-
-                    # Avoid ACPI renaming when not required
-                    if self.constants.serial_settings == "Minimal":
-                        if map_config["IOKitPersonalities_x86_64"][model_patch]["IONameMatch"] == "EH01":
-                            map_config["IOKitPersonalities_x86_64"][model_patch]["IONameMatch"] = "EHC1"
-                        if map_config["IOKitPersonalities_x86_64"][model_patch]["IONameMatch"] == "EH02":
-                            map_config["IOKitPersonalities_x86_64"][model_patch]["IONameMatch"] = "EHC2"
-                        if map_config["IOKitPersonalities_x86_64"][model_patch]["IONameMatch"] == "SHC1":
-                            map_config["IOKitPersonalities_x86_64"][model_patch]["IONameMatch"] = "XHC1"
-
-                except KeyError:
-                    continue
-            plistlib.dump(map_config, Path(new_map_ls).open("wb"), sort_keys=True)
-        if self.constants.allow_oc_everywhere is False and self.model != "iMac7,1" and self.constants.disallow_cpufriend is False:
-            # Adjust CPU Friend Data to correct SMBIOS
-            new_cpu_ls = Path(self.constants.pp_contents_folder) / Path("Info.plist")
-            cpu_config = plistlib.load(Path(new_cpu_ls).open("rb"))
-            string_stuff = str(cpu_config["IOKitPersonalities"]["CPUFriendDataProvider"]["cf-frequency-data"])
-            string_stuff = string_stuff.replace(self.model, self.spoofed_model)
-            string_stuff = ast.literal_eval(string_stuff)
-            cpu_config["IOKitPersonalities"]["CPUFriendDataProvider"]["cf-frequency-data"] = string_stuff
-            #cpu_data_config = plistlib.loads(cpu_config["IOKitPersonalities"]["CPUFriendDataProvider"]["cf-frequency-data"])
-            #print(f'Patching CPUFriend Data to: {cpu_data_config["IOPlatformThermalProfile"]["ConfigArray"][0]["model"]}')
-            plistlib.dump(cpu_config, Path(new_cpu_ls).open("wb"), sort_keys=True)
-
-
-        if self.model == "MacBookPro9,1":
-            new_agdp_ls = Path(self.constants.agdp_contents_folder) / Path("Info.plist")
-            new_agpm_ls = Path(self.constants.agpm_contents_folder) / Path("Info.plist")
-            new_amc_ls = Path(self.constants.amc_contents_folder) / Path("Info.plist")
-
-            agdp_config = plistlib.load(Path(new_agdp_ls).open("rb"))
-            agpm_config = plistlib.load(Path(new_agpm_ls).open("rb"))
-            amc_config = plistlib.load(Path(new_amc_ls).open("rb"))
-
-            agdp_config["IOKitPersonalities"]["AppleGraphicsDevicePolicy"]["ConfigMap"][self.spoofed_board] = agdp_config["IOKitPersonalities"]["AppleGraphicsDevicePolicy"]["ConfigMap"].pop(self.model)
-            agpm_config["IOKitPersonalities"]["AGPM"]["Machines"][self.spoofed_board] = agpm_config["IOKitPersonalities"]["AGPM"]["Machines"].pop(self.model)
-            amc_config["IOKitPersonalities"]["AppleMuxControl"]["ConfigMap"][self.spoofed_board] = amc_config["IOKitPersonalities"]["AppleMuxControl"]["ConfigMap"].pop(self.model)
-
-            plistlib.dump(agdp_config, Path(new_agdp_ls).open("wb"), sort_keys=True)
-            plistlib.dump(agpm_config, Path(new_agpm_ls).open("wb"), sort_keys=True)
-            plistlib.dump(amc_config, Path(new_amc_ls).open("wb"), sort_keys=True)
-
-    @staticmethod
-    def get_item_by_kv(iterable, key, value):
-        item = None
-        for i in iterable:
-            if i[key] == value:
-                item = i
-                break
-        return item
-
-    def get_kext_by_bundle_path(self, bundle_path):
-        kext = self.get_item_by_kv(self.config["Kernel"]["Add"], "BundlePath", bundle_path)
-        if not kext:
-            print(f"- Could not find kext {bundle_path}!")
-            raise IndexError
-        return kext
-
-    def get_tool_by__path(self, bundle_path):
-        tool = self.get_item_by_kv(self.config["Misc"]["Tools"], "Path", bundle_path)
-        if not tool:
-            print(f"- Could not find Tool {bundle_path}!")
-            raise IndexError
-        return tool
-
-    def enable_kext(self, kext_name, kext_version, kext_path, check=False):
-        kext = self.get_kext_by_bundle_path(kext_name)
-
-        if callable(check) and not check():
-            # Check failed
-            return
-
-        print(f"- Adding {kext_name} {kext_version}")
-        shutil.copy(kext_path, self.constants.kexts_path)
-        kext["Enabled"] = True
-
-    def cleanup(self):
-        print("- Cleaning up files")
-        # Remove unused entries
-        for entry in list(self.config["ACPI"]["Add"]):
-            if not entry["Enabled"]:
-                self.config["ACPI"]["Add"].remove(entry)
-        for entry in list(self.config["ACPI"]["Patch"]):
-            if not entry["Enabled"]:
-                self.config["ACPI"]["Patch"].remove(entry)
-        for entry in list(self.config["Kernel"]["Add"]):
-            if not entry["Enabled"]:
-                self.config["Kernel"]["Add"].remove(entry)
-        for entry in list(self.config["Kernel"]["Patch"]):
-            if not entry["Enabled"]:
-                self.config["Kernel"]["Patch"].remove(entry)
-
-        plistlib.dump(self.config, Path(self.constants.plist_path).open("wb"), sort_keys=True)
-        for kext in self.constants.kexts_path.rglob("*.zip"):
-            with zipfile.ZipFile(kext) as zip_file:
-                zip_file.extractall(self.constants.kexts_path)
-            kext.unlink()
-
-        for item in self.constants.oc_folder.rglob("*.zip"):
-            with zipfile.ZipFile(item) as zip_file:
-                zip_file.extractall(self.constants.oc_folder)
-            item.unlink()
-
-        for i in self.constants.build_path.rglob("__MACOSX"):
-            shutil.rmtree(i)
-
-        Path(self.constants.opencore_zip_copied).unlink()
-
-    def sign_files(self):
-        if self.constants.vault is True:
-            print("- Vaulting EFI")
-            subprocess.run([self.constants.vault_path] + f"{self.constants.oc_folder}/".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-
-    def build_opencore(self):
-        self.build_efi()
-        self.set_smbios()
-        self.cleanup()
-        self.sign_files()
-        print("")
-        print(f"Your OpenCore EFI for {self.model} has been built at:")
-        print(f"    {self.constants.opencore_release_folder}")
-        print("")
-        if self.constants.gui_mode is False:
-            input("Press [Enter] to go back.\n")
-
-    def copy_efi(self):
-        Utilities.cls()
-        Utilities.header(["Installing OpenCore to Drive"])
-
-        if not self.constants.opencore_release_folder.exists():
-            Utilities.TUIOnlyPrint(
-                ["Installing OpenCore to Drive"],
-                "Press [Enter] to go back.\n",
-                [
-                    """OpenCore folder missing!
-Please build OpenCore first!"""
-                ],
-            ).start()
-            return
-
-        print("\nDisk picker is loading...")
-
-        all_disks = {}
-        # TODO: AllDisksAndPartitions is not supported in Snow Leopard and older
-        try:
-            # High Sierra and newer
-            disks = plistlib.loads(subprocess.run("diskutil list -plist physical".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        except ValueError:
-            # Sierra and older
-            disks = plistlib.loads(subprocess.run("diskutil list -plist".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        for disk in disks["AllDisksAndPartitions"]:
-            disk_info = plistlib.loads(subprocess.run(f"diskutil info -plist {disk['DeviceIdentifier']}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-            try:
-                all_disks[disk["DeviceIdentifier"]] = {"identifier": disk_info["DeviceNode"], "name": disk_info["MediaName"], "size": disk_info["TotalSize"], "partitions": {}}
-                for partition in disk["Partitions"]:
-                    partition_info = plistlib.loads(subprocess.run(f"diskutil info -plist {partition['DeviceIdentifier']}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-                    all_disks[disk["DeviceIdentifier"]]["partitions"][partition["DeviceIdentifier"]] = {
-                        "fs": partition_info.get("FilesystemType", partition_info["Content"]),
-                        "type": partition_info["Content"],
-                        "name": partition_info.get("VolumeName", ""),
-                        "size": partition_info["TotalSize"],
-                    }
-            except KeyError:
-                # Avoid crashing with CDs installed
-                continue
-        # TODO: Advanced mode
-        menu = Utilities.TUIMenu(
-            ["Select Disk"],
-            "Please select the disk you would like to install OpenCore to: ",
-            in_between=["Missing disks? Ensure they have an EFI or FAT32 partition."],
-            return_number_instead_of_direct_call=True,
-            loop=True,
-        )
-        for disk in all_disks:
-            if not any(all_disks[disk]["partitions"][partition]["fs"] in ("msdos", "EFI") for partition in all_disks[disk]["partitions"]):
-                continue
-            menu.add_menu_option(f"{disk}: {all_disks[disk]['name']} ({human_fmt(all_disks[disk]['size'])})", key=disk[4:])
-
-        response = menu.start()
-
-        if response == -1:
-            return
-
-        disk_identifier = "disk" + response
-        selected_disk = all_disks[disk_identifier]
-
-        menu = Utilities.TUIMenu(
-            ["Select Partition"],
-            "Please select the partition you would like to install OpenCore to: ",
-            return_number_instead_of_direct_call=True,
-            loop=True,
-            in_between=["Missing partitions? Ensure they are formatted as an EFI or FAT32.", "", "* denotes likely candidate."],
-        )
-        for partition in selected_disk["partitions"]:
-            if selected_disk["partitions"][partition]["fs"] not in ("msdos", "EFI"):
-                continue
-            text = f"{partition}: {selected_disk['partitions'][partition]['name']} ({human_fmt(selected_disk['partitions'][partition]['size'])})"
-            if selected_disk["partitions"][partition]["type"] == "EFI" or (
-                selected_disk["partitions"][partition]["type"] == "Microsoft Basic Data" and selected_disk["partitions"][partition]["size"] < 1024 * 1024 * 512
-            ):  # 512 megabytes:
-                text += " *"
-            menu.add_menu_option(text, key=partition[len(disk_identifier) + 1:])
-
-        response = menu.start()
-
-        if response == -1:
-            return
-
-        # TODO: Apple Script fails in Yosemite(?) and older
-        args = [
-            "osascript",
-            "-e",
-            f'''do shell script "diskutil mount {disk_identifier}s{response}"'''
-            ' with prompt "OpenCore Legacy Patcher needs administrator privileges to mount your EFI."'
-            " with administrator privileges"
-            " without altering line endings",
-        ]
-
-        if self.constants.detected_os > self.constants.yosemite:
-            result = subprocess.run(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-        else:
-            result = subprocess.run(f"diskutil mount {disk_identifier}s{response}".split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-
-        if result.returncode != 0:
-            if "execution error" in result.stderr.decode() and result.stderr.decode().strip()[-5:-1] == "-128":
-                # cancelled prompt
-                return
-            else:
-                Utilities.TUIOnlyPrint(
-                    ["Copying OpenCore"], "Press [Enter] to go back.\n", ["An error occurred!"] + result.stderr.decode().split("\n") + ["", "Please report this to the devs at GitHub."]
-                ).start()
-                return
-
-        # TODO: Remount if readonly
-        drive_host_info = plistlib.loads(subprocess.run(f"diskutil info -plist {disk_identifier}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        partition_info = plistlib.loads(subprocess.run(f"diskutil info -plist {disk_identifier}s{response}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        sd_type = drive_host_info["MediaName"]
-        try:
-            ssd_type = drive_host_info["SolidState"]
-        except KeyError:
-            ssd_type = False
-        mount_path = Path(partition_info["MountPoint"])
-        disk_type = partition_info["BusProtocol"]
-        Utilities.cls()
-        Utilities.header(["Copying OpenCore"])
-
-        if mount_path.exists():
-            if (mount_path / Path("EFI/OC")).exists():
-                print("- Removing preexisting EFI/OC folder")
-                shutil.rmtree(mount_path / Path("EFI/OC"), onerror=rmtree_handler)
-            if (mount_path / Path("System")).exists():
-                print("- Removing preexisting System folder")
-                shutil.rmtree(mount_path / Path("System"), onerror=rmtree_handler)
-            print("- Copying OpenCore onto EFI partition")
-            shutil.copytree(self.constants.opencore_release_folder / Path("EFI/OC"), mount_path / Path("EFI/OC"))
-            shutil.copytree(self.constants.opencore_release_folder / Path("System"), mount_path / Path("System"))
-            if self.constants.boot_efi is True:
-                print("- Converting Bootstrap to BOOTx64.efi")
-                if (mount_path / Path("EFI/BOOT")).exists():
-                    shutil.rmtree(mount_path / Path("EFI/BOOT"), onerror=rmtree_handler)
-                Path(mount_path / Path("EFI/BOOT")).mkdir()
-                shutil.move(mount_path / Path("System/Library/CoreServices/boot.efi"), mount_path / Path("EFI/BOOT/BOOTx64.efi"))
-                shutil.rmtree(mount_path / Path("System"), onerror=rmtree_handler)
-            # Array filled with common SD Card names
-            # Note most USB-based SD Card readers generally report as "Storage Device", and no reliable way to detect further
-            if sd_type in ["SD Card Reader", "SD/MMC"]:
-                print("- Adding SD Card icon")
-                shutil.copy(self.constants.icon_path_sd, mount_path)
-            elif ssd_type is True:
-                print("- Adding SSD icon")
-                shutil.copy(self.constants.icon_path_ssd, mount_path)
-            elif disk_type == "USB":
-                print("- Adding External USB Drive icon")
-                shutil.copy(self.constants.icon_path_external, mount_path)
-            else:
-                print("- Adding Internal Drive icon")
-                shutil.copy(self.constants.icon_path_internal, mount_path)
-            print("- Cleaning install location")
-            subprocess.run(f"dot_clean {mount_path}".split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-            print("- Unmounting EFI partition")
-            subprocess.run(f"diskutil umount {mount_path}".split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-            print("- OpenCore transfer complete")
-            print("\nPress [Enter] to continue.\n")
-            input()
-        else:
-            Utilities.TUIOnlyPrint(["Copying OpenCore"], "Press [Enter] to go back.\n", ["EFI failed to mount!", "Please report this to the devs at GitHub."]).start()

Resources/CliMenu.py

@@ -1,385 +0,0 @@
-# Handle misc CLI menu options
-# Copyright (C) 2020-2021, Dhinak G, Mykola Grymalyuk
-from __future__ import print_function
-
-import subprocess
-import sys
-import time
-import platform
-
-from Resources import Build, ModelArray, Constants, SysPatch, Utilities
-
-
-class MenuOptions:
-    def __init__(self, model, versions):
-        self.model = model
-        self.constants: Constants.Constants = versions
-
-    def change_os(self):
-        Utilities.cls()
-        Utilities.header(["Select Patcher's Target OS"])
-        print(f"""
-Minimum Target:\t{self.constants.min_os_support}
-Maximum Target:\t{self.constants.max_os_support}
-Current target:\t{self.constants.os_support}
-        """)
-        temp_os_support = float(input("Please enter OS target: "))
-        if (self.constants.max_os_support < temp_os_support) or (temp_os_support < self.constants.min_os_support):
-            print("Unsupported entry")
-        else:
-            self.constants.os_support = temp_os_support
-        if temp_os_support == 11.0:
-            ModelArray.SupportedSMBIOS = ModelArray.SupportedSMBIOS11
-        elif temp_os_support == 12.0:
-            ModelArray.SupportedSMBIOS = ModelArray.SupportedSMBIOS12
-
-    def change_verbose(self):
-        Utilities.cls()
-        Utilities.header(["Set Verbose mode"])
-        change_menu = input("Enable Verbose mode(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.verbose_debug = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.verbose_debug = False
-        else:
-            print("Invalid option")
-
-    def change_oc(self):
-        Utilities.cls()
-        Utilities.header(["Set OpenCore DEBUG mode"])
-        change_menu = input("Enable OpenCore DEBUG mode(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.opencore_debug = True
-            self.constants.opencore_build = "DEBUG"
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.opencore_debug = False
-            self.constants.opencore_build = "RELEASE"
-        else:
-            print("Invalid option")
-
-    def change_kext(self):
-        Utilities.cls()
-        Utilities.header(["Set Kext DEBUG mode"])
-        change_menu = input("Enable Kext DEBUG mode(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.kext_debug = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.kext_debug = False
-        else:
-            print("Invalid option")
-
-    def change_metal(self):
-        Utilities.cls()
-        Utilities.header(["Assume Metal GPU Always in iMac"])
-        print("""This is for iMacs that have upgraded Metal GPUs, otherwise
-Patcher assumes based on stock configuration (ie. iMac10,x-12,x)
-
-Valid Options:
-
-1. None(stock GPU)
-2. Nvidia GPU
-3. AMD GPU
-
-Note: Patcher will detect whether hardware has been upgraded regardless, this
-option is for those patching on a different machine or OCLP cannot detect.
-        """)
-        change_menu = input("Set GPU Patch type(ie. 1): ")
-        if change_menu == "1":
-            self.constants.metal_build = False
-            self.constants.imac_vendor = "None"
-        elif change_menu == "2":
-            self.constants.metal_build = True
-            self.constants.imac_vendor = "Nvidia"
-        elif change_menu == "3":
-            self.constants.metal_build = True
-            self.constants.imac_vendor = "AMD"
-        else:
-            print("Invalid option")
-
-    def change_wifi(self):
-        Utilities.cls()
-        Utilities.header(["Assume Upgraded Wifi Always"])
-        print("""This is for Macs with upgraded wifi cards(ie. BCM94360/2)
-
-Note: Patcher will detect whether hardware has been upgraded regardless, this
-option is for those patching on a different machine or cannot detect.
-        """)
-        change_menu = input("Enable Upgraded Wifi build algorithm?(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.wifi_build = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.wifi_build = False
-        else:
-            print("Invalid option")
-
-    def change_serial(self):
-        Utilities.cls()
-        Utilities.header(["Set SMBIOS Mode"])
-        print("""This section is for setting how OpenCore generates the SMBIOS
-Recommended for adanced users who want control how serials are handled
-
-Valid options:
-
-1. Minimal:\tUse original serials and minimally update SMBIOS
-2. Moderate:\tReplace entire SMBIOS but keep original serials
-3. Advanced:\tReplace entire SMBIOS and generate new serials
-
-Note: For new users we recommend leaving as default(1. Minimal)
-        """)
-        change_menu = input("Set SMBIOS Mode(ie. 1): ")
-        if change_menu == "1":
-            self.constants.serial_settings = "Minimal"
-        elif change_menu == "2":
-            self.constants.serial_settings = "Moderate"
-        elif change_menu == "3":
-            self.constants.serial_settings = "Advanced"
-        else:
-            print("Invalid option")
-
-    def change_showpicker(self):
-        Utilities.cls()
-        Utilities.header(["Set OpenCore Picker mode"])
-        print("""By default, OpenCore will show its boot picker each time on boot up,
-however this can be disabled by default and be shown on command by repeatedly
-pressing the "Esc" key
-        """)
-        change_menu = input("Show OpenCore Picker by default(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.showpicker = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.showpicker = False
-        else:
-            print("Invalid option")
-
-    def change_vault(self):
-        Utilities.cls()
-        Utilities.header(["Set OpenCore Vaulting"])
-        print("""By default, this patcher will sign all your files and ensure none of the
-contents can be tampered with. However for more advanced users, you may
-want to be able to freely edit the config.plist and files.
-
-Note: For security reasons, OpenShell will be disabled when Vault is set.
-
-        """)
-        change_menu = input("Enable Vault(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.vault = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.vault = False
-        else:
-            print("Invalid option")
-
-    def change_sip(self):
-        Utilities.cls()
-        Utilities.header(["Set SIP and SecureBootModel"])
-        print("""SIP and SecureBootModel are used to ensure proper OTA functionality,
-however to patch the root volume both of these must be disabled.
-Only disable is absolutely necessary. SIP value = 0xFEF
-
-Note: for minor changes, SIP can be adjusted in recovery like normal.
-Additionally, when disabling SIP via the patcher amfi_get_out_of_my_way=1
-will be added to boot-args.
-
-Valid options:
-
-1. Enable Both
-2. Disable SIP only
-3. Disable SecureBootModel Only
-4. Disable Both
-
-        """)
-        change_menu = input("Set SIP and SecureBootModel(ie. 1): ")
-        if change_menu == "1":
-            self.constants.sip_status = True
-            self.constants.secure_status = True
-        elif change_menu == "2":
-            self.constants.sip_status = False
-            self.constants.secure_status = True
-        elif change_menu == "3":
-            self.constants.sip_status = True
-            self.constants.secure_status = False
-        elif change_menu == "4":
-            self.constants.sip_status = False
-            self.constants.secure_status = False
-        else:
-            print("Invalid option")
-
-    def change_imac_nvidia(self):
-        Utilities.cls()
-        Utilities.header(["Assume Metal GPU Always"])
-        print("""Specifically for iMac10,x-12,x with Metal Nvidia GPU upgrades
-By default the patcher will try to detect what hardware is
-running, however this will enforce iMac Nvidia Build Patches.
-        """)
-        change_menu = input("Assume iMac Nvidia patches(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.imac_nvidia_build = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.imac_nvidia_build = False
-        else:
-            print("Invalid option")
-
-    def bootstrap_setting(self):
-        Utilities.cls()
-        Utilities.header(["Set Bootstrap method"])
-        print("""Sets OpenCore's bootstrap method, currently the patcher supports the
-following options.
-
-Valid options:
-
-1. System/Library/CoreServices/boot.efi (default)
-2. EFI/BOOT/BOOTx64.efi
-3. Exit
-
-Note: S*/L*/C*/boot.efi method is only installed to the EFI partition only
-and not to macOS itself.
-
-Recommended to set to BOOTx64.efi in situations where your Mac cannot
-see the EFI Boot entry in the boot picker.
-
-        """)
-        change_menu = input("Set Bootstrap method: ")
-        if change_menu == "1":
-            self.constants.boot_efi = False
-        elif change_menu == "2":
-            self.constants.boot_efi = True
-        else:
-            print("Invalid option")
-
-
-    def drm_setting(self):
-        Utilities.cls()
-        Utilities.header(["Set DRM preferences"])
-        print("""Sets OpenCore's DRM preferences for iMac13,x and iMac14,x.
-In Big Sur, some DRM based content may be broken by
-default in AppleTV, Photobooth, etc.
-
-To resolve, you can opt to disable Intel QuickSync support in
-favor of Nvidia's Software rendering. This can aid in DRM however
-greatly hampers Video rendering performance in Final Cut Pro and
-other programs relying on such features.
-
-Recommend only disabling if absolutely required.
-        """)
-        change_menu = input("Enable Nvidia's Software DRM rendering(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.drm_support = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.drm_support = False
-        else:
-            print("Invalid option")
-
-    def force_accel_setting(self):
-        Utilities.cls()
-        Utilities.header(["Assume Legacy GPU"])
-        print("""Allows any model to force install Legacy Acceleration
-patches. Only required for Mac Pro and Xserve users.
-
-DO NOT RUN IF METAL GPU IS INSTALLED
-        """)
-        change_menu = input("Enable Beta Acceleration Patches(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.assume_legacy = True
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.assume_legacy = False
-        else:
-            print("Invalid option")
-
-    def allow_native_models(self):
-        Utilities.cls()
-        Utilities.header(["Allow OpenCore on native Models"])
-        print("""Allows natively supported Macs to use OpenCore. Recommended
-for users with 3rd Party NVMe SSDs to achieve improved overall
-power usage.
-
-        """)
-        change_menu = input("Allow OpenCore on all Models(y/n): ")
-        if change_menu in {"y", "Y", "yes", "Yes"}:
-            self.constants.allow_oc_everywhere = True
-            self.constants.serial_settings = "None"
-        elif change_menu in {"n", "N", "no", "No"}:
-            self.constants.allow_oc_everywhere = False
-            self.constants.serial_settings = "Minimal"
-        else:
-            print("Invalid option")
-
-    def custom_cpu(self):
-        Utilities.cls()
-        Utilities.header(["Set custom CPU Model Name"])
-        print("""Change reported CPU Model name in About This Mac
-Custom names will report as follows:
-
-1: Original Name: 2.5 Ghz Dual-Core Intel Core i5
-2. CPU name:      Intel(R) Core(TM) i5-3210M CPU @ 2.50Ghz
-3. Custom Name:   2.5Ghz Cotton Candy (example)
-        """)
-        if self.constants.custom_cpu_model_value == "":
-            if self.constants.custom_cpu_model == 0:
-                print("Currently using original name")
-            else:
-                print("Currently using CPU name")
-        else:
-            print(f"Custom CPU name currently: {self.constants.custom_cpu_model_value}")
-        change_menu = input("Set custom CPU Name(1,2,3): ")
-        if change_menu == "1":
-            self.constants.custom_cpu_model = 2
-            self.constants.custom_cpu_model_value = ""
-        elif change_menu == "2":
-            self.constants.custom_cpu_model = 0
-            self.constants.custom_cpu_model_value = ""
-        elif change_menu == "3":
-            self.constants.custom_cpu_model = 1
-            self.constants.custom_cpu_model_value = input("Enter new CPU Name: ")
-        else:
-            print("Invalid option")
-
-    def custom_color_thing(self):
-        Utilities.cls()
-        Utilities.header(["Set custom CPU Model Name"])
-        print("""Change reported CPU Model name in About This Mac
-Custom names will report as follows:
-
-1: Custom Color
-2. Reset
-        """)
-        change_menu = input("Set custom CPU Name(1,2,3): ")
-        if change_menu == "1":
-            print("")
-            #temp_tk_root = tk.Tk()
-            #temp_tk_root.wm_withdraw()
-            #self.constants.custom_color = colorchooser.askcolor(title="Choose color")
-            #temp_tk_root.destroy()
-        elif change_menu == "2":
-            self.constants.custom_color = ""
-        else:
-            print("Invalid option")
-
-    def download_more_ram_dot_com(self):
-        Utilities.cls()
-        Utilities.header(["Download more RAM"])
-        print("""Downloads more RAM to your Mac!
-Currently only offers 1.5TB bundles
-        """)
-        change_menu = input("Download more RAM?(y/n): ")
-        if change_menu == "y":
-            self.constants.download_ram = True
-        elif change_menu == "n":
-            self.constants.download_ram = False
-        else:
-            print("Invalid option")
-
-    def disable_cpufriend(self):
-        Utilities.cls()
-        Utilities.header(["Disable CPU Friend?"])
-        print("""Only recommended for advanced users
-Disabling CPUFriend forces macOS into using a different
-Mac's power profile for CPUs and GPUs, which can harm the
-hardware
-        """)
-        change_menu = input("Disable CPU Friend?(y/n): ")
-        if change_menu == "y":
-            self.constants.disallow_cpufriend = True
-        elif change_menu == "n":
-            self.constants.disallow_cpufriend = False
-        else:
-            print("Invalid option")

Resources/Constants.py

@@ -1,365 +0,0 @@
-# pylint: disable=multiple-statements
-# Define Files
-# Copyright (C) 2020-2021, Dhinak G, Mykola Grymalyuk
-
-from __future__ import print_function
-
-from pathlib import Path
-
-
-class Constants:
-    def __init__(self):
-        self.patcher_version = "0.1.4"
-        self.opencore_commit = "65cc81b - 05-03-2021"
-        self.opencore_version = "0.6.9"
-        self.lilu_version = "1.5.3"
-        self.whatevergreen_version = "1.4.9"
-        self.airportbcrmfixup_version = "2.1.2"
-        self.bcm570_version = "1.0.1"
-        self.marvel_version = "1.0.0"
-        self.nforce_version = "1.0.0"
-        self.mce_version = "1.0.0"
-        self.mousse_version = "0.93"
-        self.telemetrap_version = "1.0.0"
-        self.corecaptureelcap_version = "1.0.0"
-        self.io80211elcap_version = "1.0.0"
-        self.io80211high_sierra_version = "1.0.0"
-        self.io80211mojave_version = "1.0.0"
-        self.applealc_version = "1.6.1"
-        self.restrictevents_version = "1.0.1"
-        self.restrictevents_mbp_version = "1.0.1"
-        self.piixata_version = "1.0.0"
-        self.backlight_version = "1.0.1"
-        self.cpufriend_version = "1.2.3"
-        self.nightshift_version = "1.1.0"
-        self.smcspoof_version = "1.0.0"
-        self.cputscsync = "1.0.3"
-        self.hibernationfixup = "1.3.9"
-        self.nvmefix_version = "1.0.7"
-        self.sidecarfixup_version = "1.0.0"
-        self.innie_version = "1.3.0"
-        self.payload_version = "0.0.6"
-
-        # Get resource path
-        self.current_path = Path(__file__).parent.parent.resolve()
-        self.payload_path = self.current_path / Path("payloads")
-
-        self.custom_model: str = None
-        self.custom_mxm_gpu: str = None
-        self.current_gpuv: str = None
-        self.current_gpud: str = None
-
-        # Patcher Settings
-        self.opencore_debug = False
-        self.opencore_build = "RELEASE"
-        self.kext_debug = False
-        self.verbose_debug = False
-        self.os_support = 11.0
-        self.min_os_support = 11.0
-        self.max_os_support = 11.0
-        self.metal_build = False
-        self.imac_vendor = "None"
-        self.wifi_build = False
-        self.gui_mode = False
-        self.serial_settings = "Minimal"
-        self.showpicker = True
-        self.vault = False
-        self.sip_status = True
-        self.secure_status = True
-        self.detected_os = 0
-        self.boot_efi = False
-        self.drm_support = False
-        self.legacy_acceleration_patch = True
-        self.assume_legacy = False
-        self.allow_oc_everywhere = False
-        self.custom_cpu_model = 2
-        self.custom_cpu_model_value = ""
-        self.custom_color = ""
-        self.download_ram = False
-        self.disallow_cpufriend = False
-
-        # OS Versions
-        self.tiger = 8
-        self.leopard = 9
-        self.snow_leopard = 10
-        self.lion = 11
-        self.mountain_lion = 12
-        self.mavericks = 13
-        self.yosemite = 14
-        self.el_capitan = 15
-        self.sierra = 16
-        self.high_sierra = 17
-        self.mojave = 18
-        self.catalina = 19
-        self.big_sur = 20
-
-        # Vendor IDs
-        self.pci_nvidia = "10DE"
-        self.pci_amd_ati = "1002"
-        self.pci_intel = "8086"
-        self.pci_broadcom = "14E4"
-        self.pci_atheros = "168C"
-        self.pci_apple = "106B"
-
-        # Class Codes
-        # https://pci-ids.ucw.cz/read/PD
-        self.classcode_sata = "01060100"
-        self.classcode_nvme = "02080100"
-        self.classcode_nvme_generic = "02800100"
-        self.classcode_wifi = "00800200"
-        self.classcode_gpu = "00000300"
-        self.classcode_gpu_variant = "00800300"
-
-        # Nvidia GPU Architecture
-        self.arch_tesla = "NV50"
-        self.arch_fermi = "GF100"
-        self.arch_kepler = "GK100"
-
-        # External Files
-        self.url_apple_binaries = "https://github.com/dortania/Apple-Binaries-OCLP/archive/refs/tags/"
-
-    # Payload Location
-    # OpenCore
-    @property
-    def opencore_zip_source(self): return self.payload_path / Path(f"OpenCore/OpenCore-{self.opencore_build}.zip")
-    @property
-    def plist_template(self): return self.payload_path / Path(f"Config/config.plist")
-
-    # ACPI
-    @property
-    def pci_ssdt_path(self): return self.payload_path / Path("ACPI/SSDT-CPBG.aml")
-    @property
-    def windows_ssdt_path(self): return self.payload_path / Path("ACPI/SSDT-PCI.aml")
-
-    # Drivers
-    @property
-    def nvme_driver_path(self): return self.payload_path / Path("Drivers/NvmExpressDxe.efi")
-    @property
-    def exfat_legacy_driver_path(self): return self.payload_path / Path("Drivers/ExFatDxeLegacy.efi")
-
-    # Kexts
-    @property
-    def payload_kexts_path(self): return self.payload_path / Path("Kexts")
-    @property
-    def lilu_path(self): return self.payload_kexts_path / Path(f"Acidanthera/Lilu-v{self.lilu_version}.zip")
-    @property
-    def whatevergreen_path(self): return self.payload_kexts_path / Path(f"Acidanthera/WhateverGreen-v{self.whatevergreen_version}.zip")
-    @property
-    def airportbcrmfixup_path(self): return self.payload_kexts_path / Path(f"Acidanthera/AirportBrcmFixup-v{self.airportbcrmfixup_version}.zip")
-    @property
-    def restrictevents_path(self): return self.payload_kexts_path / Path(f"Acidanthera/RestrictEvents-v{self.restrictevents_version}.zip")
-    @property
-    def restrictevents_mbp_path(self): return self.payload_kexts_path / Path(f"Acidanthera/RestrictEvents-MBP91-v{self.restrictevents_mbp_version}.zip")
-    @property
-    def bcm570_path(self): return self.payload_kexts_path / Path(f"Ethernet/CatalinaBCM5701Ethernet-v{self.bcm570_version}.zip")
-    @property
-    def marvel_path(self): return self.payload_kexts_path / Path(f"Ethernet/MarvelYukonEthernet-v{self.marvel_version}.zip")
-    @property
-    def nforce_path(self): return self.payload_kexts_path / Path(f"Ethernet/nForceEthernet-v{self.nforce_version}.zip")
-    @property
-    def mce_path(self): return self.payload_kexts_path / Path(f"Misc/AppleMCEReporterDisabler-v{self.mce_version}.zip")
-    @property
-    def mousse_path(self): return self.payload_kexts_path / Path(f"SSE/AAAMouSSE-v{self.mousse_version}.zip")
-    @property
-    def telemetrap_path(self): return self.payload_kexts_path / Path(f"SSE/telemetrap-v{self.telemetrap_version}.zip")
-    @property
-    def corecaptureelcap_path(self): return self.payload_kexts_path / Path(f"Wifi/corecaptureElCap-v{self.corecaptureelcap_version}.zip")
-    @property
-    def io80211elcap_path(self): return self.payload_kexts_path / Path(f"Wifi/IO80211ElCap-v{self.io80211elcap_version}.zip")
-    @property
-    def io80211high_sierra_path(self): return self.payload_kexts_path / Path(f"Wifi/IO80211HighSierra-v{self.io80211high_sierra_version}.zip")
-    @property
-    def io80211mojave_path(self): return self.payload_kexts_path / Path(f"Wifi/IO80211Mojave-v{self.io80211mojave_version}.zip")
-    @property
-    def applealc_path(self): return self.payload_kexts_path / Path(f"Acidanthera/AppleALC-v{self.applealc_version}.zip")
-    @property
-    def piixata_path(self): return self.payload_kexts_path / Path(f"Misc/AppleIntelPIIXATA-v{self.piixata_version}.zip")
-    @property
-    def backlight_path(self): return self.payload_kexts_path / Path(f"Misc/AppleBacklightFixup-v{self.backlight_version}.zip")
-    @property
-    def cpufriend_path(self): return self.payload_kexts_path / Path(f"Acidanthera/CPUFriend-v{self.cpufriend_version}.zip")
-    @property
-    def nightshift_path(self): return self.payload_kexts_path / Path(f"Misc/NightShiftEnabler-v{self.nightshift_version}.zip")
-    @property
-    def smcspoof_path(self): return self.payload_kexts_path / Path(f"Misc/SMC-Spoof-v{self.smcspoof_version}.zip")
-    @property
-    def cputscsync_path(self): return self.payload_kexts_path / Path(f"Acidanthera/CpuTscSync-v{self.cputscsync}.zip")
-    @property
-    def hibernationfixup_path(self): return self.payload_kexts_path / Path(f"Acidanthera/HibernationFixup-v{self.hibernationfixup}.zip")
-    @property
-    def nvmefix_path(self): return self.payload_kexts_path / Path(f"Acidanthera/NVMeFix-v{self.nvmefix_version}.zip")
-    @property
-    def sidecarfixup_path(self): return self.payload_kexts_path / Path(f"Acidanthera/SidecarFixup-v{self.sidecarfixup_version}.zip")
-    @property
-    def innie_path(self): return self.payload_kexts_path / Path(f"Misc/Innie-v{self.innie_version}.zip")
-    @property
-    def plist_folder_path(self): return self.payload_kexts_path / Path(f"Plists")
-    @property
-    def platform_plugin_plist_path(self): return self.plist_folder_path / Path(f"PlatformPlugin")
-
-    # Build Location
-    @property
-    def build_path(self): return self.current_path / Path("Build-Folder/")
-    @property
-    def opencore_release_folder(self): return self.build_path / Path(f"OpenCore-{self.opencore_build}")
-    @property
-    def opencore_zip_copied(self): return self.build_path / Path(f"OpenCore-{self.opencore_build}.zip")
-
-    @property
-    def oc_folder(self): return self.opencore_release_folder / Path("EFI/OC/")
-    @property
-    def plist_path(self): return self.oc_folder / Path("config.plist")
-    @property
-    def acpi_path(self): return self.oc_folder / Path("ACPI")
-    @property
-    def drivers_path(self): return self.oc_folder / Path("Drivers")
-    @property
-    def kexts_path(self): return self.oc_folder / Path("Kexts")
-    @property
-    def resources_path(self): return self.oc_folder / Path("Resources")
-    @property
-    def map_kext_folder(self): return self.kexts_path / Path("USB-Map.kext")
-    @property
-    def map_contents_folder(self): return self.map_kext_folder / Path("Contents")
-    @property
-    def pp_kext_folder(self): return self.kexts_path / Path("CPUFriendDataProvider.kext")
-    @property
-    def pp_contents_folder(self): return self.pp_kext_folder / Path("Contents")
-    @property
-    def agdp_kext_folder(self): return self.kexts_path / Path("AGDP-Override.kext")
-    @property
-    def agdp_contents_folder(self): return self.agdp_kext_folder / Path("Contents")
-    @property
-    def agpm_kext_folder(self): return self.kexts_path / Path("AGPM-Override.kext")
-    @property
-    def agpm_contents_folder(self): return self.agpm_kext_folder / Path("Contents")
-    @property
-    def amc_kext_folder(self): return self.kexts_path / Path("AMC-Override.kext")
-    @property
-    def amc_contents_folder(self): return self.amc_kext_folder / Path("Contents")
-
-    # Tools
-    @property
-    def macserial_path(self): return self.payload_path / Path("Tools/macserial")
-    @property
-    def gfxutil_path(self): return self.payload_path / Path("Tools/gfxutil")
-    @property
-    def vault_path(self): return self.payload_path / Path("Tools/CreateVault/sign.command")
-
-    # Icons
-    @property
-    def app_icon_path(self): return self.current_path / Path("OC-Patcher.icns")
-    @property
-    def icon_path_external(self): return self.payload_path / Path("Icon/External/.VolumeIcon.icns")
-    @property
-    def icon_path_internal(self): return self.payload_path / Path("Icon/Internal/.VolumeIcon.icns")
-    @property
-    def icon_path_sd(self): return self.payload_path / Path("Icon/SD-Card/.VolumeIcon.icns")
-    @property
-    def icon_path_ssd(self): return self.payload_path / Path("Icon/SSD/.VolumeIcon.icns")
-    @property
-    def gui_path(self): return self.payload_path / Path("Icon/Resources.zip")
-
-    # Apple Payloads Paths
-    @property
-    def payload_apple_root_path_unzip(self): return self.payload_path / Path(f"Apple-Binaries-OCLP-{self.payload_version}")
-    @property
-    def payload_apple_root_path_zip(self): return self.payload_path / Path("Apple.zip")
-    @property
-    def payload_apple_root_path(self): return self.payload_path / Path("Apple")
-    @property
-    def payload_apple_kexts_path(self): return self.payload_apple_root_path / Path("Extensions")
-    @property
-    def payload_apple_frameworks_path(self): return self.payload_apple_root_path / Path("Frameworks")
-    @property
-    def payload_apple_frameworks_path_accel(self): return self.payload_apple_frameworks_path / Path("Graphics-Acceleration")
-    @property
-    def payload_apple_lauchd_path(self): return self.payload_apple_root_path / Path("LaunchDaemons")
-    @property
-    def payload_apple_lauchd_path_accel(self): return self.payload_apple_lauchd_path / Path("Graphics-Acceleration")
-    @property
-    def payload_apple_private_frameworks_path(self): return self.payload_apple_root_path / Path("PrivateFrameworks")
-    @property
-    def payload_apple_private_frameworks_path_accel(self): return self.payload_apple_private_frameworks_path / Path("Graphics-Acceleration")
-    @property
-    def payload_apple_private_frameworks_path_brightness(self): return self.payload_apple_private_frameworks_path / Path("Brightness-Control")
-
-    # Apple Extensions
-    @property
-    def audio_path(self): return self.payload_apple_kexts_path / Path("Audio")
-
-    # GPU Kexts and Bundles
-
-    @property
-    def legacy_graphics(self): return self.payload_apple_kexts_path / Path("Graphics-Acceleration")
-    @property
-    def legacy_nvidia_path(self): return self.legacy_graphics / Path("Nvidia-Tesla-Fermi")
-    @property
-    def legacy_nvidia_kepler_path(self): return self.legacy_graphics / Path("Nvidia-Kepler")
-    @property
-    def legacy_amd_path(self): return self.legacy_graphics / Path("AMD-ATI")
-    @property
-    def legacy_intel_gen1_path(self): return self.legacy_graphics / Path("Intel-Gen5-Ironlake")
-    @property
-    def legacy_intel_gen2_path(self): return self.legacy_graphics / Path("Intel-Gen6-SandyBridge")
-    @property
-    def legacy_intel_gen3_path(self): return self.legacy_graphics / Path("Intel-Gen7-IvyBridge")
-    @property
-    def legacy_general_path(self): return self.legacy_graphics / Path("General-Patches")
-
-    @property
-    def legacy_brightness(self): return self.payload_apple_kexts_path / Path("Brightness-Control")
-
-    # Apple Frameworks
-    @property
-    def coredisplay_path(self): return self.payload_apple_frameworks_path_accel / Path("CoreDisplay.framework")
-    @property
-    def iosurface_f_path(self): return self.payload_apple_frameworks_path_accel / Path("IOSurface.framework")
-    @property
-    def opengl_path(self): return self.payload_apple_frameworks_path_accel / Path("OpenGL.framework")
-
-    # Apple LaunchDaemons
-    @property
-    def hiddhack_path(self): return self.payload_apple_lauchd_path_accel / Path("IOHID-Fixup.plist")
-    @property
-    def legacy_hiddhack_path(self): return self.payload_apple_lauchd_path_accel / Path("HiddHack.plist")
-
-    # Apple PrivateFrameworks
-    @property
-    def gpusupport_path(self): return self.payload_apple_private_frameworks_path_accel / Path("GPUSupport.framework")
-    @property
-    def skylight_path(self): return self.payload_apple_private_frameworks_path_accel / Path("SkyLight.framework")
-
-    csr_values = {
-        "CSR_ALLOW_UNTRUSTED_KEXTS           ": False,  # 0x1   - Introduced in El Capitan
-        "CSR_ALLOW_UNRESTRICTED_FS           ": False,  # 0x2   - Introduced in El Capitan
-        "CSR_ALLOW_TASK_FOR_PID              ": False,  # 0x4   - Introduced in El Capitan
-        "CSR_ALLOW_KERNEL_DEBUGGER           ": False,  # 0x8   - Introduced in El Capitan
-        "CSR_ALLOW_APPLE_INTERNAL            ": False,  # 0x10  - Introduced in El Capitan
-        "CSR_ALLOW_UNRESTRICTED_DTRACE       ": False,  # 0x20  - Introduced in El Capitan
-        "CSR_ALLOW_UNRESTRICTED_NVRAM        ": False,  # 0x40  - Introduced in El Capitan
-        "CSR_ALLOW_DEVICE_CONFIGURATION      ": False,  # 0x80  - Introduced in El Capitan
-        "CSR_ALLOW_ANY_RECOVERY_OS           ": False,  # 0x100 - Introduced in Sierra
-        "CSR_ALLOW_UNAPPROVED_KEXTS          ": False,  # 0x200 - Introduced in High Sierra
-        "CSR_ALLOW_EXECUTABLE_POLICY_OVERRIDE": False,  # 0x400 - Introduced in Mojave
-        "CSR_ALLOW_UNAUTHENTICATED_ROOT      ": False,  # 0x800 - Introduced in Big Sur
-    }
-
-    sbm_values = [
-        "j137",
-        "j680",
-        "j132",
-        "j174",
-        "j140k",
-        "j780",
-        "j213",
-        "j140a",
-        "j152f",
-        "j160",
-        "j230k",
-        "j214k",
-        "j223",
-        "j215",
-        "j185",
-        "j185f",
-    ]

Resources/DeviceProbe.py

@@ -1,96 +0,0 @@
-# Probe devices, return device entries
-# Copyright (C) 2021 Mykola Grymalyuk
-from __future__ import print_function
-
-import binascii
-import plistlib
-import shutil
-import subprocess
-import uuid
-import os
-import sys
-import platform
-from pathlib import Path
-
-from Resources import Constants, ModelArray, Utilities
-
-class pci_probe:
-    def __init__(self):
-        self.constants = Constants.Constants()
-
-    def hexswap(self, input_hex: str):
-        hex_pairs = [input_hex[i:i + 2] for i in range(0, len(input_hex), 2)]
-        hex_rev = hex_pairs[::-1]
-        hex_str = "".join(["".join(x) for x in hex_rev])
-        return hex_str.upper()
-
-    # Converts given device IDs to DeviceProperty pathing, requires ACPI pathing as DeviceProperties shouldn't be used otherwise
-    def deviceproperty_probe(self, vendor_id, device_id, acpi_path):
-        gfxutil_output: str = subprocess.run([self.constants.gfxutil_path] + f"-v".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-        try:
-            if acpi_path == "":
-                acpi_path = "No ACPI Path Given"
-                raise IndexError
-            device_path = [line.strip().split("= ", 1)[1] for line in gfxutil_output.split("\n") if f'{vendor_id}:{device_id}'.lower() in line.strip() and acpi_path in line.strip()][0]
-            return device_path
-        except IndexError:
-            print(f"- No DevicePath found for {vendor_id}:{device_id} ({acpi_path})")
-            return ""
-
-    # Returns the device path of parent controller
-    def device_property_parent(self, device_path):
-        device_path_parent = "/".join(device_path.split("/")[:-1])
-        return device_path_parent
-
-    def acpi_strip(self, acpi_path_full):
-        # Strip IOACPIPlane:/_SB, remove 000's, convert ffff into 0 and finally make everything upper case
-        # IOReg                                      | gfxutil
-        # IOACPIPlane:/_SB/PC00@0/DMI0@0             -> /PC00@0/DMI0@0
-        # IOACPIPlane:/_SB/PC03@0/BR3A@0/SL09@ffff   -> /PC03@0/BR3A@0/SL09@0
-        # IOACPIPlane:/_SB/PC03@0/M2U0@150000        -> /PC03@0/M2U0@15
-        # IOACPIPlane:/_SB/PC01@0/CHA6@100000        -> /PC01@0/CHA6@10
-        # IOACPIPlane:/_SB/PC00@0/RP09@1d0000/PXSX@0 -> /PC00@0/RP09@1D/PXSX@0
-        # IOACPIPlane:/_SB/PCI0@0/P0P2@10000         -> /PCI0@0/P0P2@1
-        acpi_path = acpi_path_full.replace("IOACPIPlane:/_SB", "")
-        acpi_path = acpi_path.replace("0000", "")
-        acpi_path = acpi_path.replace("ffff", "0")
-        acpi_path = acpi_path.upper()
-        return acpi_path
-
-    # Note gpu_probe should only be used on IGPU and GFX0 entries
-    def gpu_probe(self, gpu_type):
-        try:
-            devices = plistlib.loads(subprocess.run(f"ioreg -r -n {gpu_type} -a".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-            vendor_id = self.hexswap(binascii.hexlify(devices[0]["vendor-id"]).decode()[:4])
-            device_id = self.hexswap(binascii.hexlify(devices[0]["device-id"]).decode()[:4])
-            try:
-                acpi_path = devices[0]["acpi-path"]
-                acpi_path = self.acpi_strip(acpi_path)
-                return vendor_id, device_id, acpi_path
-            except KeyError:
-                print(f"- No ACPI entry found for {gpu_type}")
-                return vendor_id, device_id, ""
-        except ValueError:
-            print(f"- No IOService entry found for {gpu_type}")
-            return "", "", ""
-
-    def wifi_probe(self):
-        try:
-            devices = plistlib.loads(subprocess.run("ioreg -r -n ARPT -a".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        except ValueError:
-            devices = plistlib.loads(subprocess.run("ioreg -c IOPCIDevice -r -d2 -a".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        try:
-            devices = [i for i in devices if i["class-code"] == binascii.unhexlify(self.constants.classcode_wifi)]
-            vendor_id = self.hexswap(binascii.hexlify(devices[0]["vendor-id"]).decode()[:4])
-            device_id = self.hexswap(binascii.hexlify(devices[0]["device-id"]).decode()[:4])
-            ioname = devices[0]["IOName"]
-            try:
-                acpi_path = devices[0]["acpi-path"]
-                acpi_path = self.acpi_strip(acpi_path)
-                return vendor_id, device_id, ioname, acpi_path
-            except KeyError:
-                print(f"- No ACPI entry found for {vendor_id}:{device_id}")
-                return vendor_id, device_id, ioname, ""
-        except ValueError:
-            print(f"- No IOService entry found for Wireless Card")
-            return "", "", "", ""

Resources/PCIIDArray.py

@@ -1,732 +0,0 @@
-# Array of Device IDs for different devices
-class nvidia_ids:
-    # Courteous of envytools as well as Macrumors:
-    # https://envytools.readthedocs.io/en/latest/hw/pciid.html
-    # https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/
-    tesla_ids = [
-        # G84
-        "0400", # G84 [8600 GTS]
-        "0401", # G84 [8600 GT]
-        "0402", # G84 [8600 GT]
-        "0403", # G84 [8600 GS]
-        "0404", # G84 [8400 GS]
-        "0405", # G84 [9500M GS]
-        "0406", # G84 [8300 GS]
-        "0407", # G84 [8600M GT]
-        "0408", # G84 [9650M GS]
-        "0409", # G84 [8700M GT]
-        "040A", # G84 [FX 370]
-        "040B", # G84 [NVS 320M]
-        "040C", # G84 [FX 570M]
-        "040D", # G84 [FX 1600M]
-        "040E", # G84 [FX 570]
-        "040F", # G84 [FX 1700]
-        # G86
-        "0420", # G86 [8400 SE]
-        "0421", # G86 [8500 GT]
-        "0422", # G86 [8400 GS]
-        "0423", # G86 [8300 GS]
-        "0424", # G86 [8400 GS]
-        "0425", # G86 [8600M GS]
-        "0426", # G86 [8400M GT]
-        "0427", # G86 [8400M GS]
-        "0428", # G86 [8400M G]
-        "0429", # G86 [NVS 140M]
-        "042A", # G86 [NVS 130M]
-        "042B", # G86 [NVS 135M]
-        "042C", # G86 [9400 GT]
-        "042D", # G86 [FX 360M]
-        "042E", # G86 [9300M G]
-        "042F", # G86 [NVS 290]
-        # G92
-        "0410", # G92 [GT 330]
-        "0600", # G92 [8800 GTS 512]
-        "0601", # G92 [9800 GT]
-        "0602", # G92 [8800 GT]
-        "0603", # G92 [GT 230]
-        "0604", # G92 [9800 GX2]
-        "0605", # G92 [9800 GT]
-        "0606", # G92 [8800 GS]
-        "0607", # G92 [GTS 240]
-        "0608", # G92 [9800M GTX]
-        "0609", # G92 [8800M GTS]
-        "060A", # G92 [GTX 280M]
-        "060B", # G92 [9800M GT]
-        "060C", # G92 [8800M GTX]
-        "060F", # G92 [GTX 285M]
-        "0610", # G92 [9600 GSO]
-        "0611", # G92 [8800 GT]
-        "0612", # G92 [9800 GTX/9800 GTX+]
-        "0613", # G92 [9800 GTX+]
-        "0614", # G92 [9800 GT]
-        "0615", # G92 [GTS 250]
-        "0617", # G92 [9800M GTX]
-        "0618", # G92 [GTX 260M]
-        "0619", # G92 [FX 4700 X2]
-        "061A", # G92 [FX 3700]
-        "061B", # G92 [VX 200]
-        "061C", # G92 [FX 3600M]
-        "061D", # G92 [FX 2800M]
-        "061E", # G92 [FX 3700M]
-        "061F", # G92 [FX 3800M]
-        # G94
-        "0621", # G94 [GT 230]
-        "0622", # G94 [9600 GT]
-        "0623", # G94 [9600 GS]
-        "0625", # G94 [9600 GSO 512]
-        "0626", # G94 [GT 130]
-        "0627", # G94 [GT 140]
-        "0628", # G94 [9800M GTS]
-        "062A", # G94 [9700M GTS]
-        "062B", # G94 [9800M GS]
-        "062C", # G94 [9800M GTS ]
-        "062D", # G94 [9600 GT]
-        "062E", # G94 [9600 GT]
-        "0631", # G94 [GTS 160M]
-        "0635", # G94 [9600 GSO]
-        "0637", # G94 [9600 GT]
-        "0638", # G94 [FX 1800]
-        "063A", # G94 [FX 2700M]
-        # G96
-        "0640", # G96 [9500 GT]
-        "0641", # G96 [9400 GT]
-        "0643", # G96 [9500 GT]
-        "0644", # G96 [9500 GS]
-        "0645", # G96 [9500 GS]
-        "0646", # G96 [GT 120]
-        "0647", # G96 [9600M GT]
-        "0648", # G96 [9600M GS]
-        "0649", # G96 [9600M GT]
-        "064A", # G96 [9700M GT]
-        "064B", # G96 [9500M G]
-        "064C", # G96 [9650M GT]
-        "0651", # G96 [G 110M]
-        "0652", # G96 [GT 130M]
-        "0653", # G96 [GT 120M]
-        "0654", # G96 [GT 220M]
-        "0655", # G96 [GT 120]
-        "0656", # G96 [GT 120 ]
-        "0658", # G96 [FX 380]
-        "0659", # G96 [FX 580]
-        "065A", # G96 [FX 1700M]
-        "065B", # G96 [9400 GT]
-        "065C", # G96 [FX 770M]
-        "065F", # G96 [G210]
-        # G98
-        "06E0", # G98 [9300 GE]
-        "06E1", # G98 [9300 GS]
-        "06E2", # G98 [8400]
-        "06E3", # G98 [8400 SE]
-        "06E4", # G98 [8400 GS]
-        "06E6", # G98 [G100]
-        "06E7", # G98 [9300 SE]
-        "06E8", # G98 [9200M GS]
-        "06E9", # G98 [9300M GS]
-        "06EA", # G98 [NVS 150M]
-        "06EB", # G98 [NVS 160M]
-        "06EC", # G98 [G 105M]
-        "06EF", # G98 [G 103M]
-        "06F1", # G98 [G105M]
-        "06F8", # G98 [NVS 420]
-        "06F9", # G98 [FX 370 LP]
-        "06FA", # G98 [NVS 450]
-        "06FB", # G98 [FX 370M]
-        "06FD", # G98 [NVS 295]
-        "06FF", # G98 [HICx16]
-        # G200
-        "05E0", # G200 [GTX 295]
-        "05E1", # G200 [GTX 280]
-        "05E2", # G200 [GTX 260]
-        "05E3", # G200 [GTX 285]
-        "05E6", # G200 [GTX 275]
-        "05E7", # G200 [C1060]
-        "05E9", # G200 [CX]
-        "05EA", # G200 [GTX 260]
-        "05EB", # G200 [GTX 295]
-        "05ED", # G200 [FX 5800]
-        "05EE", # G200 [FX 4800]
-        "05EF", # G200 [FX 3800]
-        # MCP77 GPU
-        "0840", # MCP77 GPU [8200M]
-        "0844", # MCP77 GPU [9100M G]
-        "0845", # MCP77 GPU [8200M G]
-        "0846", # MCP77 GPU [9200]
-        "0847", # MCP77 GPU [9100]
-        "0848", # MCP77 GPU [8300]
-        "0849", # MCP77 GPU [8200]
-        "084A", # MCP77 GPU [730A]
-        "084B", # MCP77 GPU [9200]
-        "084C", # MCP77 GPU [980A/780A SLI]
-        "084D", # MCP77 GPU [750A SLI]
-        "084F", # MCP77 GPU [8100 / 720A]
-        # MCP79 GPU
-        "0860", # MCP79 GPU [9400]
-        "0861", # MCP79 GPU [9400]
-        "0862", # MCP79 GPU [9400M G]
-        "0863", # MCP79 GPU [9400M]
-        "0864", # MCP79 GPU [9300]
-        "0865", # MCP79 GPU [ION]
-        "0866", # MCP79 GPU [9400M G]
-        "0867", # MCP79 GPU [9400]
-        "0868", # MCP79 GPU [760i SLI]
-        "0869", # MCP79 GPU [9400]
-        "086A", # MCP79 GPU [9400]
-        "086C", # MCP79 GPU [9300 / 730i]
-        "086D", # MCP79 GPU [9200]
-        "086E", # MCP79 GPU [9100M G]
-        "086F", # MCP79 GPU [8200M G]
-        "0870", # MCP79 GPU [9400M]
-        "0871", # MCP79 GPU [9200]
-        "0872", # MCP79 GPU [G102M]
-        "0873", # MCP79 GPU [G102M]
-        "0874", # MCP79 GPU [ION]
-        "0876", # MCP79 GPU [ION]
-        "087A", # MCP79 GPU [9400]
-        "087D", # MCP79 GPU [ION]
-        "087E", # MCP79 GPU [ION LE]
-        "087F", # MCP79 GPU [ION LE]
-        # GT215
-        "0CA0", # GT215 [GT 330]
-        "0CA2", # GT215 [GT 320]
-        "0CA3", # GT215 [GT 240]
-        "0CA4", # GT215 [GT 340]
-        "0CA5", # GT215 [GT 220]
-        "0CA7", # GT215 [GT 330]
-        "0CA9", # GT215 [GTS 250M]
-        "0CAC", # GT215 [GT 220]
-        "0CAF", # GT215 [GT 335M]
-        "0CB0", # GT215 [GTS 350M]
-        "0CB1", # GT215 [GTS 360M]
-        "0CBC", # GT215 [FX 1800M]
-        # GT216
-        "0A20", # GT216 [GT 220]
-        "0A22", # GT216 [315]
-        "0A23", # GT216 [210]
-        "0A26", # GT216 [405]
-        "0A27", # GT216 [405]
-        "0A28", # GT216 [GT 230M]
-        "0A29", # GT216 [GT 330M]
-        "0A2A", # GT216 [GT 230M]
-        "0A2B", # GT216 [GT 330M]
-        "0A2C", # GT216 [NVS 5100M]
-        "0A2D", # GT216 [GT 320M]
-        "0A32", # GT216 [GT 415]
-        "0A34", # GT216 [GT 240M]
-        "0A35", # GT216 [GT 325M]
-        "0A38", # GT216 [400]
-        "0A3C", # GT216 [FX 880M]
-        # GT218
-        "0A60", # GT218 [G210]
-        "0A62", # GT218 [205]
-        "0A63", # GT218 [310]
-        "0A64", # GT218 [ION]
-        "0A65", # GT218 [210]
-        "0A66", # GT218 [310]
-        "0A67", # GT218 [315]
-        "0A68", # GT218 [G105M]
-        "0A69", # GT218 [G105M]
-        "0A6A", # GT218 [NVS 2100M]
-        "0A6C", # GT218 [NVS 3100M]
-        "0A6E", # GT218 [305M]
-        "0A6F", # GT218 [ION]
-        "0A70", # GT218 [310M]
-        "0A71", # GT218 [305M]
-        "0A72", # GT218 [310M]
-        "0A73", # GT218 [305M]
-        "0A74", # GT218 [G210M]
-        "0A75", # GT218 [310M]
-        "0A76", # GT218 [ION]
-        "0A78", # GT218 [FX 380 LP]
-        "0A7A", # GT218 [315M]
-        "0A7C", # GT218 [FX 380M]
-        "10C0", # GT218 [9300 GS]
-        "10C3", # GT218 [8400GS]
-        "10C5", # GT218 [405]
-        "10D8", # GT218 [NVS 300]
-        # MCP89 GPU
-        "08A0", # MCP89 GPU [320M]
-        "08A2", # MCP89 GPU [320M]
-        "08A3", # MCP89 GPU [320M]
-        "08A4", # MCP89 GPU [320M]
-    ]
-
-    fermi_ids = [
-            # GF100
-        "06C0", # GF100 [GTX 480]
-        "06C4", # GF100 [GTX 465]
-        "06CA", # GF100 [GTX 480M]
-        "06CB", # GF100 [GTX 480]
-        "06CD", # GF100 [GTX 470]
-        "06D1", # GF100 [C2050 / C2070]
-        "06D2", # GF100 [M2070]
-        "06D8", # GF100 [6000]
-        "06D9", # GF100 [5000]
-        "06DA", # GF100 [5000M]
-        "06DC", # GF100 [6000]
-        "06DD", # GF100 [4000]
-        "06DE", # GF100 [T20]
-        "06DF", # GF100 [M2070-Q]
-        # GF104
-        "0E22", # GF104 [GTX 460]
-        "0E23", # GF104 [GTX 460 SE]
-        "0E24", # GF104 [GTX 460 OEM]
-        "0E30", # GF104 [GTX 470M]
-        "0E31", # GF104 [GTX 485M]
-        "0E3A", # GF104 [3000M]
-        "0E3B", # GF104 [4000M]
-        # GF114
-        "1200", # GF114 [GTX 560 Ti]
-        "1201", # GF114 [GTX 560]
-        "1202", # GF114 [GTX 560 Ti OEM]
-        "1203", # GF114 [GTX 460 SE v2]
-        "1205", # GF114 [GTX 460 v2]
-        "1206", # GF114 [GTX 555]
-        "1207", # GF114 [GT 645 OEM]
-        "1208", # GF114 [GTX 560 SE]
-        "1210", # GF114 [GTX 570M]
-        "1211", # GF114 [GTX 580M]
-        "1212", # GF114 [GTX 675M]
-        "1213", # GF114 [GTX 670M]
-        # GF106
-        "0DC0", # GF106 [GT 440]
-        "0DC4", # GF106 [GTS 450]
-        "0DC5", # GF106 [GTS 450]
-        "0DC6", # GF106 [GTS 450]
-        "0DCD", # GF106 [GT 555M]
-        "0DCE", # GF106 [GT 555M]
-        "0DD1", # GF106 [GTX 460M]
-        "0DD2", # GF106 [GT 445M]
-        "0DD3", # GF106 [GT 435M]
-        "0DD6", # GF106 [GT 550M]
-        "0DD8", # GF106 [2000]
-        "0DDA", # GF106 [2000M]
-        # GF116
-        "1241", # GF116 [GT 545 OEM]
-        "1243", # GF116 [GT 545]
-        "1244", # GF116 [GTX 550 Ti]
-        "1245", # GF116 [GTS 450 Rev. 2]
-        "1246", # GF116 [GT 550M]
-        "1247", # GF116 [GT 635M]
-        "1248", # GF116 [GT 555M]
-        "1249", # GF116 [GTS 450 Rev. 3]
-        "124B", # GF116 [GT 640 OEM]
-        "124D", # GF116 [GT 555M]
-        "1251", # GF116 [GTX 560M]
-        # GF108
-        "0DE0", # GF108 [GT 440]
-        "0DE1", # GF108 [GT 430]
-        "0DE2", # GF108 [GT 420]
-        "0DE3", # GF108 [GT 635M]
-        "0DE4", # GF108 [GT 520]
-        "0DE5", # GF108 [GT 530]
-        "0DE8", # GF108 [GT 620M]
-        "0DE9", # GF108 [GT 630M]
-        "0DEA", # GF108 [610M]
-        "0DEB", # GF108 [GT 555M]
-        "0DEC", # GF108 [GT 525M]
-        "0DED", # GF108 [GT 520M]
-        "0DEE", # GF108 [GT 415M]
-        "0DEF", # GF108 [NVS 5400M]
-        "0DF0", # GF108 [GT 425M]
-        "0DF1", # GF108 [GT 420M]
-        "0DF2", # GF108 [GT 435M]
-        "0DF3", # GF108 [GT 420M]
-        "0DF4", # GF108 [GT 540M]
-        "0DF5", # GF108 [GT 525M]
-        "0DF6", # GF108 [GT 550M]
-        "0DF7", # GF108 [GT 520M]
-        "0DF8", # GF108 [600]
-        "0DF9", # GF108 [500M]
-        "0DFA", # GF108 [1000M]
-        "0DFC", # GF108 [NVS 5200M]
-        "0F00", # GF108 [GT 630]
-        "0F01", # GF108 [GT 620]
-        # GF110
-        "1080", # GF110 [GTX 580]
-        "1081", # GF110 [GTX 570]
-        "1082", # GF110 [GTX 560 Ti]
-        "1084", # GF110 [GTX 560]
-        "1086", # GF110 [GTX 570]
-        "1087", # GF110 [GTX 560 Ti]
-        "1088", # GF110 [GTX 590]
-        "1089", # GF110 [GTX 580]
-        "108B", # GF110 [GTX 580]
-        "1091", # GF110 [M2090]
-        "109A", # GF110 [5010M]
-        "109B", # GF110 [7000]
-        # GF119
-        "1040", # GF119 [GT 520]
-        "1042", # GF119 [510]
-        "1048", # GF119 [605]
-        "1049", # GF119 [GT 620]
-        "104A", # GF119 [GT 610]
-        "1050", # GF119 [GT 520M]
-        "1051", # GF119 [GT 520MX]
-        "1052", # GF119 [GT 520M]
-        "1054", # GF119 [410M]
-        "1055", # GF119 [410M]
-        "1056", # GF119 [NVS 4200M]
-        "1057", # GF119 [NVS 4200M]
-        "1058", # GF119 [610M]
-        "1059", # GF119 [610M]
-        "105A", # GF119 [610M]
-        "107D", # GF119 [NVS 310]
-        # GF117
-        "1140", # GF117 [GT 620M]
-    ]
-
-    kepler_ids = [
-        # GK104
-        "1180", # GK104 [GTX 680]
-        "1183", # GK104 [GTX 660 Ti]
-        "1185", # GK104 [GTX 660]
-        "1188", # GK104 [GTX 690]
-        "1189", # GK104 [GTX 670]
-        "1198", # GTX 880M
-        "1199", # GK104 [GTX 870M]
-        "119A", # GTX 860M
-        "119E", # GTX 780M
-        "119F", # GK104 [GTX 780M]
-        "11A0", # GK104 [GTX 680M]
-        "11A1", # GK104 [GTX 670MX]
-        "11A2", # GK104 [GTX 675MX]
-        "11A3", # GK104 [GTX 680MX]
-        "11A7", # GK104 [GTX 675MX]
-        "11A9", # GTX 870M
-        "11B6",  # Quadro K3100M
-        "11B7",  # Quadro K4100M
-        "11B8",  # Quadro K5100M
-        "11BA", # GK104 [K5000]
-        "11BC", # GK104 [K5000M]
-        "11BD", # GK104 [K4000M]
-        "11BE", # GK104 [K3000M]
-        "11BF", # GK104 [GRID K2]
-        # GK106
-        "11C0", # GK106 [GTX 660]
-        "11C6", # GK106 [GTX 650 Ti]
-        "11E0", # GK106 [GTX 770M]
-        "11E1",  # GTX 765M
-        "11E2",  # GTX 765M
-        "11FA", # GK106 [K4000]
-        "11FC",  # Quadro K2100M
-        # GK107
-        "0FC0", # GK107 [GT 640]
-        "0FC1", # GK107 [GT 640]
-        "0FC2", # GK107 [GT 630]
-        "0FC6", # GK107 [GTX 650]
-        "0FD1", # GK107 [GT 650M]
-        "0FD2", # GK107 [GT 640M]
-        "0FD3", # GK107 [GT 640M LE]
-        "0FD4", # GK107 [GTX 660M]
-        "0FD5", # GK107 [GT 650M]
-        "0FD8", # GK107 [GT 640M]
-        "0FD9", # GK107 [GT 645M]
-        "0FE0", # GK107 [GTX 660M]
-        "0FE9", # GK107 [GT 750M Mac Edition]
-        "0FF6", # Quadro K1100M
-        "0FF9", # GK107 [K2000D]
-        "0FFA", # GK107 [K600]
-        "0FFB", # GK107 [K2000M]
-        "0FFC", # GK107 [K1000M]
-        "0FFD", # GK107 [NVS 510]
-        "0FFE", # GK107 [K2000]
-        "0FFF", # GK107 [410]
-        # GK110
-        "1003", # GK110 [GTX Titan LE]
-        "1004", # GK110 [GTX 780]
-        "1005", # GK110 [GTX Titan]
-        "101F", # GK110 [TEslA K20]
-        "1020", # GK110 [TEslA K2]
-        "1021", # GK110 [TEslA K2m]
-        "1022", # GK110 [TEslA K20C]
-        "1026", # GK110 [TEslA K20s]
-        "1028", # GK110 [TEslA K20m]
-        # GK208
-        "1280", # GK208 [GT 635]
-        "1282", # GK208 [GT 640 REv. 2]
-        "1284", # GK208 [GT 630 REv. 2]
-        "1290", # GK208 [GT 730M]
-        "1291", # GK208 [GT 735M]
-        "1292", # GK208 [GT 740M]
-        "1293", # GK208 [GT 730M]
-        "1294", # GK208 [GT 740M]
-        "1295", # GK208 [710M]
-        "12B9", # GK208 [K610M]
-        "12BA", # GK208 [K510M]
-    ]
-
-class amd_ids:
-    legacy_gcn_ids = [
-        # AMDRadeonX4000
-        # AMDBonaireGraphicsAccelerator
-        "6640",
-        "6641",
-        "6646",
-        "6647",
-        "6650",
-        "6651",
-        "665C",
-        "665D",
-        # AMDFijiGraphicsAccelerator
-        "7300",
-        "730F",
-        # AMDHawaiiGraphicsAccelerator
-        "67B0",
-        # AMDPitcairnGraphicsAccelerator
-        "6800",
-        "6801",
-        "6806",
-        "6808",
-        "6810",
-        "6818",
-        "6819",
-        # AMDTahitiGraphicsAccelerator
-        "6790",
-        "6798",
-        "679A",
-        "679E",
-        "6780",
-        # AMDTongaGraphicsAccelerator
-        "6920",
-        "6921",
-        "6930",
-        "6938",
-        "6939",
-        # AMDVerdeGraphicsAccelerator
-        "6820",
-        "6821",
-        "6823",
-        "6825",
-        "6827",
-        "682B",
-        "682D",
-        "682F",
-        "6835",
-        "6839",
-        "683B",
-        "683D",
-        "683F",
-    ]
-
-    polaris_ids = [
-        # AMDRadeonX4000
-        # AMDBaffinGraphicsAccelerator
-        "67E0",
-        "67E3",
-        "67E8",
-        "67EB",
-        "67EF",
-        "67FF",
-        "67E1",
-        "67E7",
-        "67E9",
-        # AMDEllesmereGraphicsAccelerator
-        "67C0",
-        "67C1",
-        "67C2",
-        "67C4",
-        "67C7",
-        "67DF",
-        "67D0",
-        "67C8",
-        "67C9",
-        "67CA",
-        "67CC",
-        "67CF",
-    ]
-
-    vega_ids = [
-        # AMDRadeonX5000
-        # AMDVega10GraphicsAccelerator
-        "6860",
-        "6861",
-        "6862",
-        "6863",
-        "6864",
-        "6867",
-        "6868",
-        "6869",
-        "686A",
-        "686B",
-        "686C",
-        "686D",
-        "686E",
-        "686F",
-        "687F",
-        # AMDVega12GraphicsAccelerator
-        "69A0",
-        "69A1",
-        "69A2",
-        "69A3",
-        "69AF",
-        # AMDVega20GraphicsAccelerator
-        "66A0",
-        "66A1",
-        "66A2",
-        "66A3",
-        "66A7",
-        "66AF",
-    ]
-
-    navi_ids = [
-        # AMDRadeonX6000
-        # AMDNavi10GraphicsAccelerator
-        "7310",
-        "7312",
-        "7318",
-        "7319",
-        "731A",
-        "731B",
-        "731F",
-        # AMDNavi12GraphicsAccelerator
-        "7360",
-        # AMDNavi14GraphicsAccelerator
-        "7340",
-        "7341",
-        "7343",
-        "7347",
-        "734F",
-        # AMDNavi21GraphicsAccelerator
-        "73A2",
-        "73AB",
-        "73BF",
-    ]
-    terascale_1_ids = [
-        "9400",
-        "9401",
-        "9402",
-        "9403",
-        "9581",
-        "9583",
-        "9588",
-        "94C8",
-        "94C9",
-        "9500",
-        "9501",
-        "9505",
-        "9507",
-        "9504",
-        "9506",
-        "9598",
-        "9488",
-        "9599",
-        "9591",
-        "9593",
-        "9440",
-        "9442",
-        "944A",
-        "945A",
-        "9490",
-        "949E",
-        "9480",
-        "9540",
-        "9541",
-        "954E",
-        "954F",
-        "9552",
-        "9553",
-        "94A0",
-    ]
-
-    terascale_2_ids = [
-        "6738",
-        "6739",
-        "6720",
-        "6722",
-        "6768",
-        "6770",
-        "6779",
-        "6760",
-        "6761",
-        "68E0",
-        "6898",
-        "6899",
-        "68B8",
-        "68B0",
-        "68B1",
-        "68A0",
-        "68A1",
-        "6840",
-        "6841",
-        "68D8",
-        "68C0",
-        "68C1",
-        "68D9",
-        "6750",
-        "6758",
-        "6759",
-        "6740",
-        "6741",
-        "6745",
-    ]
-
-class intel_ids:
-    iron_ids = [
-        # AppleIntelHDGraphics IDs
-        "0044",
-        "0046",
-    ]
-
-    sandy_ids = [
-        # AppleIntelHD3000Graphics IDs
-        # AppleIntelSNBGraphicsFB IDs
-        "0106",
-        "0601",
-        "0116",
-        "0102",
-        "0126",
-    ]
-
-    ivy_ids = [
-        # AppleIntelHD4000Graphics IDs
-        # AppleIntelFramebufferCapri IDs
-        "0152",
-        "0156",
-        "0162",
-        "0166",
-    ]
-
-class broadcom_ids:
-    BCM4360Wifi = [
-        # AirPortBrcmNIC IDs
-        "43BA",  # BCM43602
-        "43A3",  # BCM4350
-        "43A0",  # BCM4360
-    ]
-
-    BCM94331Wifi = [
-        # AirPortBrcm4360 IDs (removed duplicates for 4360 class cards)
-        "4331",  # BCM94331
-        "4353",  # BCM943224
-    ]
-
-    BCM94322Wifi = [
-        # AirPortBrcm4331 IDs (removed duplicates for 4331 class cards)
-        "432B",  # BCM94322
-    ]
-
-    BCM94328Wifi = [
-        # AppleAirPortBrcm43224 IDs
-        "4311", # BCM4311 - never used by Apple
-        "4312", # BCM4311 - never used by Apple
-        "4313", # BCM4311 - never used by Apple
-        "4318", # BCM4318 - never used by Apple
-        "4319", # BCM4318 - never used by Apple
-        "431A", # Unknown - never used by Apple
-        "4320", # BCM4306 - never used by Apple
-        "4324", # BCM4309 - never used by Apple
-        "4325", # BCM4306 - never used by Apple
-        "4328", # BCM94328
-        "432C", # BCM4322 - never used by Apple
-        "432D", # BCM4322 - never used by Apple
-    ]
-
-class atheros_ids:
-    AtherosWifi = [
-        # AirPortAtheros40 IDs
-        "0030", # AR93xx
-        "002A", # AR928X
-        "001C", # AR242x / AR542x
-        "0023", # AR5416 - never used by Apple
-        "0024", # AR5418
-    ]

Resources/SysPatch.py

@@ -1,390 +0,0 @@
-# Framework for mounting and patching macOS root volume
-# Copyright (C) 2020-2021, Dhinak G, Mykola Grymalyuk
-# Missing Features:
-# - Full System/Library Snapshotting (need to research how Apple achieves this)
-#   - Temporary Work-around: sudo bless --mount /System/Volumes/Update/mnt1 --bootefi --last-sealed-snapshot
-# - Work-around battery throttling on laptops with no battery (IOPlatformPluginFamily.kext/Contents/PlugIns/ACPI_SMC_PlatformPlugin.kext/Contents/Resources/)
-from __future__ import print_function
-
-import binascii
-import plistlib
-import shutil
-import signal
-import subprocess
-import sys
-import uuid
-import zipfile
-import os
-from pathlib import Path
-from datetime import date
-
-from Resources import Constants, ModelArray, PCIIDArray, Utilities, DeviceProbe
-
-
-class PatchSysVolume:
-    def __init__(self, model, versions):
-        self.model = model
-        self.constants: Constants.Constants = versions
-
-    def hexswap(self, input_hex: str):
-        hex_pairs = [input_hex[i:i + 2] for i in range(0, len(input_hex), 2)]
-        hex_rev = hex_pairs[::-1]
-        hex_str = "".join(["".join(x) for x in hex_rev])
-        return hex_str.upper()
-
-    def csr_decode(self, sip_raw, print_status):
-        sip_int = int.from_bytes(sip_raw, byteorder='little')
-        i = 0
-        for current_sip_bit in self.constants.csr_values:
-            if sip_int & (1 << i):
-                temp = True
-                self.constants.csr_values[current_sip_bit] = True
-            else:
-                temp = False
-            if print_status is True:
-                print(f"- {current_sip_bit}\t {temp}")
-            i = i + 1
-        if ((self.constants.csr_values["CSR_ALLOW_UNTRUSTED_KEXTS           "] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_UNRESTRICTED_FS           "] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_UNRESTRICTED_DTRACE       "] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_UNRESTRICTED_NVRAM        "] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_DEVICE_CONFIGURATION      "] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_UNAPPROVED_KEXTS          "] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_EXECUTABLE_POLICY_OVERRIDE"] is True) \
-        and (self.constants.csr_values["CSR_ALLOW_UNAUTHENTICATED_ROOT      "] is True)):
-            self.sip_patch_status = False
-        else:
-            self.sip_patch_status = True
-
-    def find_mount_root_vol(self, patch):
-        root_partition_info = plistlib.loads(subprocess.run("diskutil info -plist /".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        self.root_mount_path = root_partition_info["DeviceIdentifier"]
-        self.mount_location = "/System/Volumes/Update/mnt1"
-        self.mount_extensions = f"{self.mount_location}/System/Library/Extensions"
-        self.mount_frameworks = f"{self.mount_location}/System/Library/Frameworks"
-        self.mount_lauchd = f"{self.mount_location}/System/Library/LaunchDaemons"
-        self.mount_private_frameworks = f"{self.mount_location}/System/Library/PrivateFrameworks"
-
-        if self.root_mount_path.startswith("disk"):
-            self.root_mount_path = self.root_mount_path[:-2] if self.root_mount_path.endswith('s1') else self.root_mount_path
-            print(f"- Found Root Volume at: {self.root_mount_path}")
-            if Path(self.mount_extensions).exists():
-                print("- Root Volume is already mounted")
-                if patch is True:
-                    self.patch_root_vol()
-                else:
-                    self.unpatch_root_vol()
-            else:
-                print("- Mounting drive as writable")
-                subprocess.run(f"sudo mount -o nobrowse -t apfs /dev/{self.root_mount_path} {self.mount_location}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-                if Path(self.mount_extensions).exists():
-                    print("- Successfully mounted the Root Volume")
-                    if patch is True:
-                        self.patch_root_vol()
-                    else:
-                        self.unpatch_root_vol()
-                else:
-                    print("- Failed to mount the Root Volume")
-        else:
-            print("- Could not find root volume")
-
-    def delete_old_binaries(self, vendor_patch):
-        for delete_current_kext in vendor_patch:
-            delete_path = Path(self.mount_extensions) / Path(delete_current_kext)
-            if Path(delete_path).exists():
-                print(f"- Deleting {delete_current_kext}")
-                subprocess.run(f"sudo rm -R {delete_path}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-            else:
-                print(f"- Couldn't find {delete_current_kext}, skipping")
-
-    def add_new_binaries(self, vendor_patch, vendor_location):
-        for add_current_kext in vendor_patch:
-            existing_path = Path(self.mount_extensions) / Path(add_current_kext)
-            if Path(existing_path).exists():
-                print(f"- Found conflicting kext, Deleting Root Volume's {add_current_kext}")
-                subprocess.run(f"sudo rm -R {existing_path}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-                print(f"- Adding {add_current_kext}")
-                subprocess.run(f"sudo cp -R {vendor_location}/{add_current_kext} {self.mount_extensions}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-                subprocess.run(f"sudo chmod -Rf 755 {self.mount_extensions}/{add_current_kext}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-                subprocess.run(f"sudo chown -Rf root:wheel {self.mount_extensions}/{add_current_kext}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-            else:
-                print(f"- Adding {add_current_kext}")
-                subprocess.run(f"sudo cp -R {vendor_location}/{add_current_kext} {self.mount_extensions}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-                subprocess.run(f"sudo chmod -Rf 755 {self.mount_extensions}/{add_current_kext}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-                subprocess.run(f"sudo chown -Rf root:wheel {self.mount_extensions}/{add_current_kext}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-    def add_brightness_patch(self):
-        print("- Merging legacy Brightness Control Patches")
-        self.delete_old_binaries(ModelArray.DeleteBrightness)
-        self.add_new_binaries(ModelArray.AddBrightness, self.constants.legacy_brightness)
-        subprocess.run(f"sudo ditto {self.constants.payload_apple_private_frameworks_path_brightness} {self.mount_private_frameworks}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-        subprocess.run(f"sudo chmod -R 755 {self.mount_private_frameworks}/DisplayServices.framework".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-        subprocess.run(f"sudo chown -R root:wheel {self.mount_private_frameworks}/DisplayServices.framework".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-    def gpu_accel_patches_11(self):
-        igpu_vendor,igpu_device,igpu_acpi = DeviceProbe.pci_probe().gpu_probe("IGPU")
-        dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-        if dgpu_vendor:
-            print(f"- Found GFX0: {dgpu_vendor}:{dgpu_device}")
-            if dgpu_vendor == self.constants.pci_nvidia:
-                if dgpu_device in PCIIDArray.nvidia_ids().tesla_ids or dgpu_device in PCIIDArray.nvidia_ids().fermi_ids:
-                    print("- Merging legacy Nvidia Tesla and Fermi Kexts and Bundles")
-                    self.delete_old_binaries(ModelArray.DeleteNvidiaAccel11)
-                    self.add_new_binaries(ModelArray.AddGeneralAccel, self.constants.legacy_general_path)
-                    self.add_new_binaries(ModelArray.AddNvidiaAccel11, self.constants.legacy_nvidia_path)
-                # TODO: Enable below code if macOS 12 drops support
-                #elif dgpu_device in PCIIDArray.nvidia_ids().kepler_ids and self.constants.detected_os > self.constants.big_sur:
-                #    print("- Merging legacy Nvidia Kepler Kexts and Bundles")
-                #    self.add_new_binaries(ModelArray.AddNvidiaKeplerAccel11, self.constants.legacy_nvidia_kepler_path)
-            elif dgpu_vendor == self.constants.pci_amd_ati:
-                if dgpu_device in PCIIDArray.amd_ids().terascale_1_ids:
-                    print("- Merging legacy AMD Kexts and Bundles")
-                    self.delete_old_binaries(ModelArray.DeleteAMDAccel11)
-                    self.add_new_binaries(ModelArray.AddGeneralAccel, self.constants.legacy_general_path)
-                    self.add_new_binaries(ModelArray.AddAMDAccel11, self.constants.legacy_amd_path)
-        if igpu_vendor:
-            print(f"- Found IGPU: {igpu_vendor}:{igpu_device}")
-            if igpu_vendor == self.constants.pci_intel:
-                if igpu_device in PCIIDArray.intel_ids().iron_ids:
-                    print("- Merging legacy Intel 1st Gen Kexts and Bundles")
-                    self.delete_old_binaries(ModelArray.DeleteNvidiaAccel11)
-                    self.add_new_binaries(ModelArray.AddGeneralAccel, self.constants.legacy_general_path)
-                    self.add_new_binaries(ModelArray.AddIntelGen1Accel, self.constants.legacy_intel_gen1_path)
-                elif igpu_device in PCIIDArray.intel_ids().sandy_ids:
-                    print("- Merging legacy Intel 2nd Gen Kexts and Bundles")
-                    self.delete_old_binaries(ModelArray.DeleteNvidiaAccel11)
-                    self.add_new_binaries(ModelArray.AddGeneralAccel, self.constants.legacy_general_path)
-                    self.add_new_binaries(ModelArray.AddIntelGen2Accel, self.constants.legacy_intel_gen2_path)
-
-                # TODO: Enable below code if macOS 12 drops support
-                #elif igpu_device in PCIIDArray.intel_ids().ivy_ids:
-                #    print("- Merging legacy Intel 3rd Gen Kexts and Bundles")
-                #    self.add_new_binaries(ModelArray.AddIntelGen3Accel, self.constants.legacy_intel_gen3_path)
-            elif igpu_vendor == self.constants.pci_nvidia:
-                if not dgpu_vendor:
-                    # Avoid patching twice, as Nvidia iGPUs will only have Nvidia dGPUs
-                    print("- Merging legacy Nvidia Kexts and Bundles")
-                    self.delete_old_binaries(ModelArray.DeleteNvidiaAccel11)
-                    self.add_new_binaries(ModelArray.AddGeneralAccel, self.constants.legacy_general_path)
-                    self.add_new_binaries(ModelArray.AddNvidiaAccel11, self.constants.legacy_nvidia_path)
-
-        # Frameworks
-        print("- Merging legacy Frameworks")
-        subprocess.run(f"sudo ditto {self.constants.payload_apple_frameworks_path_accel} {self.mount_frameworks}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-        if self.model in ModelArray.LegacyBrightness:
-            self.add_brightness_patch()
-
-        # LaunchDaemons
-        if Path(self.mount_lauchd / Path("HiddHack.plist")).exists():
-            print("- Removing legacy HiddHack")
-            subprocess.run(f"sudo rm {self.mount_lauchd}/HiddHack.plist".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-        print("- Adding IOHID-Fixup.plist")
-        subprocess.run(f"sudo ditto {self.constants.payload_apple_lauchd_path_accel} {self.mount_lauchd}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-        subprocess.run(f"sudo chmod 755 {self.mount_lauchd}/IOHID-Fixup.plist".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-        subprocess.run(f"sudo chown root:wheel {self.mount_lauchd}/IOHID-Fixup.plist".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-        # PrivateFrameworks
-        print("- Merging legacy PrivateFrameworks")
-        subprocess.run(f"sudo ditto {self.constants.payload_apple_private_frameworks_path_accel} {self.mount_private_frameworks}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-        # Sets AppKit to Catalina Window Drawing codepath
-        # Disabled upon ASentientBot request
-        print("- Enabling NSDefenestratorModeEnabled")
-        subprocess.run("defaults write -g NSDefenestratorModeEnabled -bool true".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-    def patch_root_vol(self):
-        print(f"- Detecting patches for {self.model}")
-        rebuild_required = False
-        # TODO: Create Backup of S*/L*/Extensions, Frameworks and PrivateFramework to easily revert changes
-        # APFS snapshotting seems to ignore System Volume changes inconsistently, would like a backup to avoid total brick
-        # Perhaps a basic py2 script to run in recovery to restore
-        # Ensures no .DS_Stores got in
-        print("- Preparing Files")
-        subprocess.run(f"sudo find {self.constants.payload_apple_root_path} -name '.DS_Store' -delete".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-        if self.model in ModelArray.LegacyGPU or self.constants.assume_legacy is True:
-            dgpu_vendor,dgpu_device,dgpu_acpi = DeviceProbe.pci_probe().gpu_probe("GFX0")
-            if dgpu_vendor and dgpu_vendor == self.constants.pci_amd_ati and (dgpu_device in PCIIDArray.amd_ids().polaris_ids or dgpu_device in PCIIDArray.amd_ids().vega_ids or dgpu_device in PCIIDArray.amd_ids().navi_ids or dgpu_device in PCIIDArray.amd_ids().legacy_gcn_ids):
-                print("- Detected Metal-based AMD GPU, skipping legacy patches")
-            elif dgpu_vendor and dgpu_vendor == self.constants.pci_nvidia and dgpu_device in PCIIDArray.nvidia_ids().kepler_ids:
-                print("- Detected Metal-based Nvidia GPU, skipping legacy patches")
-            else:
-                print("- Detected legacy GPU, attempting legacy acceleration patches")
-                self.gpu_accel_patches_11()
-                rebuild_required = True
-
-        if self.model in ["iMac7,1", "iMac8,1"]:
-            print("- Fixing Volume Control Support")
-            self.add_new_binaries(ModelArray.AddVolumeControl, self.constants.audio_path)
-
-        if rebuild_required is True:
-            self.rebuild_snapshot()
-
-    def unpatch_root_vol(self):
-        print("- Reverting to last signed APFS snapshot")
-        subprocess.run(f"sudo bless --mount {self.mount_location} --bootefi --last-sealed-snapshot".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-    def rebuild_snapshot(self):
-        if self.constants.gui_mode is False:
-            input("Press [ENTER] to continue with cache rebuild")
-        print("- Rebuilding Kernel Cache (This may take some time)")
-        result = subprocess.run(f"sudo kmutil install --volume-root {self.mount_location} --update-all".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-
-        if result.returncode != 0:
-            self.sucess_status = False
-            print("- Unable to build new kernel cache")
-            print("\nPlease report this to Github")
-            print("Reason for Patch Failure:")
-            print(result.stdout.decode())
-            print("")
-        else:
-            self.sucess_status = True
-            print("- Successfully built new kernel cache")
-            if self.constants.gui_mode is False:
-                input("Press [ENTER] to continue with snapshotting")
-            print("- Creating new APFS snapshot")
-            subprocess.run(f"sudo bless --folder {self.mount_location}/System/Library/CoreServices --bootefi --create-snapshot".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-    def unmount_drive(self):
-        print("- Unmounting Root Volume (Don't worry if this fails)")
-        subprocess.run(f"sudo diskutil unmount {self.root_mount_path}".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode()
-
-    def check_status(self):
-        nvram_dump = plistlib.loads(subprocess.run("nvram -x -p".split(), stdout=subprocess.PIPE).stdout.decode().strip().encode())
-        try:
-            self.sip_status = nvram_dump["csr-active-config"]
-        except KeyError:
-            self.sip_status = b'\x00\x00\x00\x00'
-
-        self.smb_model: str = subprocess.run("nvram 94B73556-2197-4702-82A8-3E1337DAFBFB:HardwareModel	".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-        if not self.smb_model.startswith("nvram: Error getting variable"):
-            self.smb_model = [line.strip().split(":HardwareModel	", 1)[1] for line in self.smb_model.split("\n") if line.strip().startswith("94B73556-2197-4702-82A8-3E1337DAFBFB:")][0]
-            if self.smb_model.startswith("j137"):
-                self.smb_status = True
-            else:
-                self.smb_status = False
-        else:
-            self.smb_status = False
-        self.fv_status = True
-        self.fv_status: str = subprocess.run("fdesetup status".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT).stdout.decode()
-        if self.fv_status.startswith("FileVault is Off"):
-            self.fv_status = False
-        else:
-            self.fv_status = True
-        self.sip_patch_status = True
-        self.csr_decode(self.sip_status, False)
-
-    def check_files(self):
-        if Path(self.constants.payload_apple_root_path).exists():
-            print("- Found Apple Binaries")
-            if self.constants.gui_mode is False:
-                patch_input = input("Would you like to redownload?(y/n): ")
-                if patch_input in {"y", "Y", "yes", "Yes"}:
-                    shutil.rmtree(Path(self.constants.payload_apple_root_path))
-                    self.download_files()
-            else:
-                self.download_files()
-        else:
-            print("- Apple binaries missing")
-            self.download_files()
-
-    def download_files(self):
-        Utilities.cls()
-        print("- Downloading Apple binaries")
-        popen_oclp = subprocess.Popen(f"curl -S -L {self.constants.url_apple_binaries}{self.constants.payload_version}.zip --output {self.constants.payload_apple_root_path_zip}".split(), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
-        for stdout_line in iter(popen_oclp.stdout.readline, ""):
-            print(stdout_line, end="")
-        popen_oclp.stdout.close()
-        if self.constants.payload_apple_root_path_zip.exists():
-            print("- Download completed")
-            print("- Unzipping download...")
-            try:
-                subprocess.run(f"unzip {self.constants.payload_apple_root_path_zip}".split(), stdout=subprocess.PIPE, stderr=subprocess.STDOUT, cwd=self.constants.payload_path).stdout.decode()
-                print("- Renaming folder")
-                os.rename(self.constants.payload_apple_root_path_unzip, self.constants.payload_apple_root_path)
-                print("- Binaries downloaded to:")
-                print(self.constants.payload_path)
-                if self.constants.gui_mode is False:
-                    input("Press [ENTER] to continue")
-            except zipfile.BadZipFile:
-                print("- Couldn't unzip")
-            os.remove(self.constants.payload_apple_root_path_zip)
-        else:
-            print("- Download failed, please verify the below link works:")
-            print(f"{self.constants.url_apple_binaries}{self.constants.payload_version}")
-
-    def start_patch(self):
-        # Check SIP
-        # self.check_files()
-        if self.constants.custom_model is not None:
-            print("Root Patching must be done on target machine!")
-        elif self.model in ModelArray.NoRootPatch11 and self.constants.assume_legacy is False:
-            print("Root Patching not required for this machine!")
-        elif self.model not in ModelArray.SupportedSMBIOS11 and self.constants.assume_legacy is False:
-            print("Cannot run on this machine, model is unsupported!")
-        elif self.constants.detected_os < self.constants.big_sur:
-            print(f"Cannot run on this OS, requires macOS 11!")
-        else:
-            self.check_status()
-            Utilities.cls()
-            if (self.sip_patch_status is False) and (self.smb_status is False):
-                print("- Detected SIP and SecureBootModel are disabled, continuing")
-                if self.constants.gui_mode is False:
-                    input("\nPress [ENTER] to continue")
-                self.check_files()
-                if self.constants.payload_apple_root_path.exists():
-                    self.find_mount_root_vol(True)
-                    self.unmount_drive()
-                    print("- Patching complete")
-                    if self.sucess_status is True:
-                        print("\nPlease reboot the machine for patches to take effect")
-                    else:
-                        print("\nPlease reboot the machine to avoid potential issues rerunning the patcher")
-            if self.sip_patch_status is True:
-                print("SIP set incorrectly, cannot patch on this machine!")
-                print("Please disable SIP and SecureBootModel in Patcher Settings")
-                self.csr_decode(self.sip_status, True)
-                print("")
-            if self.smb_status is True:
-                print("SecureBootModel set incorrectly, unable to patch!")
-                print("Please disable SecureBootModel in Patcher Settings")
-                print("")
-            if self.fv_status is True:
-                print("FileVault enabled, unable to patch!")
-                print("Please disable FileVault in System Preferences")
-                print("")
-        if self.constants.gui_mode is False:
-            input("Press [Enter] to go exit.")
-
-    def start_unpatch(self):
-        if self.constants.custom_model is not None:
-            print("Unpatching must be done on target machine!")
-        elif self.constants.detected_os < self.constants.big_sur:
-            print(f"Cannot run on this OS, requires macOS 11!")
-        else:
-            self.check_status()
-            Utilities.cls()
-            if (self.sip_patch_status is False) and (self.smb_status is False):
-                print("- Detected SIP and SecureBootModel are disabled, continuing")
-                if self.constants.gui_mode is False:
-                    input("\nPress [ENTER] to continue")
-                self.find_mount_root_vol(False)
-                self.unmount_drive()
-                print("- Unpatching complete")
-                print("\nPlease reboot the machine for patches to take effect")
-            if self.sip_patch_status is True:
-                print("SIP set incorrectly, cannot unpatch on this machine!")
-                print("Please disable SIP and SecureBootModel in Patcher Settings")
-                self.csr_decode(self.sip_status, True)
-                print("")
-            if self.smb_status is True:
-                print("SecureBootModel set incorrectly, unable to unpatch!")
-                print("Please disable SecureBootModel in Patcher Settings")
-                print("")
-            if self.fv_status is True:
-                print("FileVault enabled, unable to unpatch!")
-                print("Please disable FileVault in System Preferences")
-                print("")
-        if self.constants.gui_mode is False:
-            input("Press [Enter] to go exit.")

Resources/Utilities.py

@@ -1,124 +0,0 @@
-# Copyright (C) 2020-2021, Dhinak G
-from __future__ import print_function
-
-import os
-import math as m
-
-
-def header(lines):
-    lines = [i for i in lines if i is not None]
-    total_length = len(max(lines, key=len)) + 4
-    print("#" * (total_length))
-    for line in lines:
-        left_side = m.floor(((total_length - 2 - len(line.strip())) / 2))
-        print("#" + " " * left_side + line.strip() + " " * (total_length - len("#" + " " * left_side + line.strip()) - 1) + "#")
-    print("#" * total_length)
-
-
-def cls():
-    os.system('cls' if os.name == 'nt' else 'clear')
-
-# def menu(title, prompt, menu_options, add_quit=True, auto_number=False, in_between=[], top_level=False):
-#     return_option = ["Q", "Quit", None] if top_level else ["B", "Back", None]
-#     if add_quit: menu_options.append(return_option)
-
-#     cls()
-#     header(title)
-#     print()
-
-#     for i in in_between: print(i)
-#     if in_between: print()
-
-#     for index, option in enumerate(menu_options):
-#         if auto_number and not (index == (len(menu_options) - 1) and add_quit):
-#             option[0] = str((index + 1))
-#         print(option[0] + ".  " + option[1])
-
-#     print()
-#     selected = input(prompt)
-
-#     keys = [option[0].upper() for option in menu_options]
-#     if not selected or selected.upper() not in keys:
-#         return
-#     if selected.upper() == return_option[0]:
-#         return -1
-#     else:
-#         menu_options[keys.index(selected.upper())][2]() if menu_options[keys.index(selected.upper())][2] else None
-
-
-class TUIMenu():
-    def __init__(self, title, prompt, options=None, return_number_instead_of_direct_call=False, add_quit=True, auto_number=False, in_between=None, top_level=False, loop=False):
-        self.title = title
-        self.prompt = prompt
-        self.in_between = in_between or []
-        self.options = options or []
-        self.return_number_instead_of_direct_call = return_number_instead_of_direct_call
-        self.auto_number = auto_number
-        self.add_quit = add_quit
-        self.top_level = top_level
-        self.loop = loop
-        self.added_quit = False
-
-    def add_menu_option(self, name, description="", function=None, key=""):
-        self.options.append([key, name, description, function])
-
-    def start(self):
-        return_option = ["Q", "Quit"] if self.top_level else ["B", "Back"]
-        if self.add_quit and not self.added_quit:
-            self.add_menu_option(
-                return_option[1], function=None, key=return_option[0])
-            self.added_quit = True
-
-        while True:
-            cls()
-            header(self.title)
-            print()
-
-            for i in self.in_between:
-                print(i)
-            if self.in_between:
-                print()
-
-            for index, option in enumerate(self.options):
-                if self.auto_number and not (index == (len(self.options) - 1) and self.add_quit):
-                    option[0] = str((index + 1))
-                print(option[0] + ".  " + option[1])
-                for i in option[2]:
-                    print("\t" + i)
-
-            print()
-            selected = input(self.prompt)
-
-            keys = [option[0].upper() for option in self.options]
-            if not selected or selected.upper() not in keys:
-                if self.loop:
-                    continue
-                else:
-                    return
-            if self.add_quit and selected.upper() == return_option[0]:
-                return -1
-            elif self.return_number_instead_of_direct_call:
-                return self.options[keys.index(selected.upper())][0]
-            else:
-                self.options[keys.index(selected.upper())][3]() if self.options[keys.index(selected.upper())][3] else None
-                if not self.loop:
-                    return
-
-
-class TUIOnlyPrint():
-    def __init__(self, title, prompt, in_between=None):
-        self.title = title
-        self.prompt = prompt
-        self.in_between = in_between or []
-
-    def start(self):
-        cls()
-        header(self.title)
-        print()
-
-        for i in self.in_between:
-            print(i)
-        if self.in_between:
-            print()
-
-        return input(self.prompt)

Resources/__init__.py

@@ -1,5 +0,0 @@
-# Credit: CorpNewt
-from os.path import dirname, basename, isfile
-import glob
-modules = glob.glob(dirname(__file__)+"/*.py")
-__all__ = [ basename(f)[:-3] for f in modules if isfile(f) and not f.endswith('__init__.py')]

Resources/models.json

@@ -1,303 +0,0 @@
-[
-    {
-        "models": [
-            "MacBook5,1",
-            "MacBook5,2"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "LegacyAudio",
-            "MissingSSE42",
-            "EthernetNvidia",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBook6,1",
-            "MacBook7,1"
-        ],
-        "patches": [
-            "WifiBCM943224",
-            "LegacyAudio",
-            "MissingSSE42",
-            "EthernetNvidia",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookAir2,1",
-            "MacBookAir3,1",
-            "MacBookAir3,2"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookAir4,1",
-            "MacBookAir4,2"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "LegacyAudio",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookAir5,1",
-            "MacBookAir5,2"
-        ],
-        "patches": [
-            "WifiBCM94322"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro3,1"
-        ],
-        "patches": [
-            "WifiAtheros",
-            "EthernetMarvell",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro4,1"
-        ],
-        "patches": [
-            "WifiBCM94328",
-            "EthernetMarvell",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro5,1",
-            "MacBookPro5,2",
-            "MacBookPro5,3",
-            "MacBookPro5,4",
-            "MacBookPro5,5"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "EthernetNvidia",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro6,1",
-            "MacBookPro6,2"
-        ],
-        "patches": [
-            "WifiBCM943224",
-            "EthernetBroadcom",
-            "LegacyAudio",
-            "LegacyGPU",
-            "PCIBridge"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro7,1"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "EthernetNvidia",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro8,1",
-            "MacBookPro8,2",
-            "MacBookPro8,3"
-        ],
-        "patches": [
-            "WifiBCM94331",
-            "EthernetBroadcom",
-            "LegacyAudio",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacBookPro9,1",
-            "MacBookPro9,2",
-            "MacBookPro10,1",
-            "MacBookPro10,2"
-        ],
-        "patches": [
-            "WifiBCM94331"
-        ]
-    },
-    {
-        "models": [
-            "MacMini3,1",
-            "MacMini4,1"
-        ],
-        "patches": [
-            "WifiBCM943224",
-            "EthernetNvidia",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "Macmini5,1",
-            "Macmini5,2",
-            "Macmini5,3"
-        ],
-        "patches": [
-            "WifiBCM94331",
-            "EthernetBroadcom",
-            "LegacyAudio",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "MacMini6,1",
-            "MacMini6,2"
-        ],
-        "patches": [
-            "WifiBCM94331"
-        ]
-    },
-    {
-        "models": [
-            "iMac7,1",
-            "iMac8,1"
-        ],
-        "patches": [
-            "WifiBCM94328",
-            "EthernetNvidia",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "iMac9,1"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "EthernetNvidia",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "iMac10,1"
-        ],
-        "patches": [
-            "WifiAtheros",
-            "EthernetNvidia",
-            "LegacyAudio",
-            "MissingSSE42",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "iMac11,1",
-            "iMac11,2",
-            "iMac11,3"
-        ],
-        "patches": [
-            "WifiAtheros",
-            "EthernetBroadcom",
-            "LegacyAudio",
-            "LegacyGPU",
-            "PCIBridge"
-        ]
-    },
-    {
-        "models": [
-            "iMac12,1",
-            "iMac12,2"
-        ],
-        "patches": [
-            "WifiAtheros",
-            "EthernetBroadcom",
-            "LegacyAudio",
-            "LegacyGPU"
-        ]
-    },
-    {
-        "models": [
-            "iMac13,1",
-            "iMac13,2"
-        ],
-        "patches": [
-            "WifiBCM94331"
-        ]
-    },
-    {
-        "models": [
-            "iMac14,1",
-            "iMac14,2",
-            "iMac14,3"
-        ],
-        "patches": []
-    },
-    {
-        "models": [
-            "MacPro3,1"
-        ],
-        "patches": [
-            "WifiAtheros",
-            "LegacyAudio",
-            "MissingSSE42",
-            "SSEEmulator",
-            "DualSocket"
-        ]
-    },
-    {
-        "models": [
-            "MacPro4,1"
-        ],
-        "patches": [
-            "WifiAtheros",
-            "DualSocket"
-        ]
-    },
-    {
-        "models": [
-            "MacPro5,1"
-        ],
-        "patches": [
-            "WifiBCM94322",
-            "DualSocket"
-        ]
-    },
-    {
-        "models": [
-            "Xserve3,1"
-        ],
-        "patches": [
-            "DualSocket"
-        ]
-    }
-]

SOURCE.md

@@ -0,0 +1,73 @@
+# Build and run from source
+
+OpenCore Legacy Patcher at its core is a Python-based GUI/CLI-based application. In turn, to run the project from source, you simply need to invoke the OpenCore-Patcher-GUI.command file via Python.
+
+For developers wishing to validate mainline changes, you may use this link: [GUI (Graphical Based App)](https://nightly.link/dortania/OpenCore-Legacy-Patcher/workflows/build-app-wxpython/main/OpenCore-Patcher.pkg.zip)
+
+* **Warning**: Nightly builds (untagged builds built from the latest commit) are actively developed OpenCore Legacy Patcher builds. These builds have not been tested, are not guaranteed to work, and are not guaranteed to be safe. Do not use nightlies without a good reason to do so, and do not use them on your main machine. Additionally, these binaries should not be used without first consulting the [CHANGELOG](./CHANGELOG.md).
+
+  **Do not share _any_ links to these binaries** in forums; please link to **this document only**.
+  * Additionally, do not reupload these binaries or download binaries from other sites. Using binaries from untrusted sources is a security issue, as they may have been tampered with.
+* Users running new builds of the project without understanding what has changed and the implications of installing software under active development are at a higher risk of bricking their installation as they do not read any warnings provided in the CHANGELOG. We wish to minimize these situations as much as possible.
+
+## Getting Started
+
+To start, ensure you have Python 3.6 or newer installed. Additionally, ensure that it was downloaded from the official source, [python.org](https://www.python.org/downloads/macos/).
+
+* Python installations either preinstalled or provided with Xcode or the Xcode Command Line Tools are unsupported due to reliability issues.
+
+Once Python is installed, open Terminal and run the following:
+
+```sh
+# Move into a directory to store the project
+cd ~/Developer
+# Clone project
+git clone https://github.com/dortania/OpenCore-Legacy-Patcher
+# Move into Project directory
+cd ./OpenCore-Legacy-Patcher
+# Install Python dependencies used by the project
+pip3 install -r requirements.txt
+```
+
+If you have any installation errors, see the following troubleshooting options:
+
+* Use Python 3.11
+  * Our build server currently uses Python 3.11 for generating binaries used in releases
+* Use .whl snapshots for installing additional dependencies
+
+## Running OpenCore Legacy Patcher
+
+To run the project from source, simply invoke via python3:
+
+```sh
+# Launch GUI
+python3 OpenCore-Patcher-GUI.command
+```
+
+Note that the OpenCore-Patcher-GUI.command file can be run as both a GUI and a CLI utility for other programs to call. If no core arguments are passed, the GUI is initialized. Otherwise the CLI will start:
+
+```sh
+# Launch CLI
+python3 OpenCore-Patcher-GUI.command --build --model iMac12,2 --verbose
+```
+
+Pass `-h` or `--help` for more information on supported CLI arguments.
+
+## Generating prebuilt binaries
+
+The main goal of generating prebuilt binaries is to strip the requirement of a local Python installation for users. For developers, there's very little benefit besides enabling dark mode support in the GUI. For development, simply use the OpenCore-Patcher-GUI.command file with a Python 3 installation.
+
+```sh
+# Install PyInstaller
+pip3 install pyinstaller
+# Move into project directory
+cd ~/Developer/OpenCore-Legacy-Patcher/
+# Create the pyinstaller based Application
+python3 Build-Project.command
+# Open build folder
+open ./dist/
+```
+
+Once done, you'll find the application generated at `./dist/OpenCore-Patcher.app`:
+
+![](./images/build-dist.png)

after_pyinstaller.sh

@@ -1,2 +0,0 @@
-#!/bin/sh
-cp launcher.sh dist/OpenCore-Patcher.app/Contents/MacOS/Launcher

ci_tooling/build_modules/application.py

@@ -0,0 +1,176 @@
+import sys
+import time
+import plistlib
+import subprocess
+
+from pathlib import Path
+
+from opencore_legacy_patcher.volume  import generate_copy_arguments
+from opencore_legacy_patcher.support import subprocess_wrapper
+
+
+class GenerateApplication:
+    """
+    Generate OpenCore-Patcher.app
+    """
+
+    def __init__(self, reset_pyinstaller_cache: bool = False, git_branch: str = None, git_commit_url: str = None, git_commit_date: str = None, analytics_key: str = None, analytics_endpoint: str = None) -> None:
+        """
+        Initialize
+        """
+        self._pyinstaller = [sys.executable, "-m", "PyInstaller"]
+        self._application_output = Path("./dist/OpenCore-Patcher.app")
+
+        self._reset_pyinstaller_cache = reset_pyinstaller_cache
+
+        self._git_branch = git_branch
+        self._git_commit_url = git_commit_url
+        self._git_commit_date = git_commit_date
+
+        self._analytics_key = analytics_key
+        self._analytics_endpoint = analytics_endpoint
+
+
+    def _generate_application(self) -> None:
+        """
+        Generate PyInstaller Application
+        """
+        if self._application_output.exists():
+            subprocess_wrapper.run_and_verify(["/bin/rm", "-rf", self._application_output], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        print("Generating OpenCore-Patcher.app")
+        _args = self._pyinstaller + ["./OpenCore-Patcher-GUI.spec", "--noconfirm"]
+        if self._reset_pyinstaller_cache:
+            _args.append("--clean")
+
+        subprocess_wrapper.run_and_verify(_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+
+    def _embed_analytics_key(self) -> None:
+        """
+        Embed analytics key
+        """
+        _file = Path("./opencore_legacy_patcher/support/analytics_handler.py")
+
+        if not all([self._analytics_key, self._analytics_endpoint]):
+            print("Analytics key or endpoint not provided, skipping embedding")
+            return
+
+        print("Embedding analytics data")
+        if not Path(_file).exists():
+            raise FileNotFoundError("analytics_handler.py not found")
+
+        lines = []
+        with open(_file, "r") as f:
+            lines = f.readlines()
+
+        for i, line in enumerate(lines):
+            if line.startswith("SITE_KEY:         str = "):
+                lines[i] = f"SITE_KEY:         str = \"{self._analytics_key}\"\n"
+            elif line.startswith("ANALYTICS_SERVER: str = "):
+                lines[i] = f"ANALYTICS_SERVER: str = \"{self._analytics_endpoint}\"\n"
+
+        with open(_file, "w") as f:
+            f.writelines(lines)
+
+
+    def _remove_analytics_key(self) -> None:
+        """
+        Remove analytics key
+        """
+        _file = Path("./opencore_legacy_patcher/support/analytics_handler.py")
+
+        if not all([self._analytics_key, self._analytics_endpoint]):
+            return
+
+        print("Removing analytics data")
+        if not _file.exists():
+            raise FileNotFoundError("analytics_handler.py not found")
+
+        lines = []
+        with open(_file, "r") as f:
+            lines = f.readlines()
+
+        for i, line in enumerate(lines):
+            if line.startswith("SITE_KEY:         str = "):
+                lines[i] = "SITE_KEY:         str = \"\"\n"
+            elif line.startswith("ANALYTICS_SERVER: str = "):
+                lines[i] = "ANALYTICS_SERVER: str = \"\"\n"
+
+        with open(_file, "w") as f:
+            f.writelines(lines)
+
+
+    def _patch_load_command(self):
+        """
+        Patch LC_VERSION_MIN_MACOSX in Load Command to report 10.10
+
+        By default Pyinstaller will create binaries supporting 10.13+
+        However this limitation is entirely arbitrary for our libraries
+        and instead we're able to support 10.10 without issues.
+
+        To verify set version:
+          otool -l ./dist/OpenCore-Patcher.app/Contents/MacOS/OpenCore-Patcher
+
+              cmd LC_VERSION_MIN_MACOSX
+          cmdsize 16
+          version 10.13
+              sdk 10.9
+        """
+        _file = self._application_output / "Contents" / "MacOS" / "OpenCore-Patcher"
+
+        _find    = b'\x00\x0D\x0A\x00' # 10.13 (0xA0D)
+        _replace = b'\x00\x0A\x0A\x00' # 10.10 (0xA0A)
+
+        print("Patching LC_VERSION_MIN_MACOSX")
+        with open(_file, "rb") as f:
+            data = f.read()
+            data = data.replace(_find, _replace, 1)
+
+        with open(_file, "wb") as f:
+            f.write(data)
+
+
+    def _embed_git_data(self) -> None:
+        """
+        Embed git data
+        """
+        _file = self._application_output / "Contents" / "Info.plist"
+
+        _git_branch = self._git_branch or "Built from source"
+        _git_commit = self._git_commit_url or ""
+        _git_commit_date = self._git_commit_date or time.strftime("%Y-%m-%d %H:%M:%S", time.localtime())
+
+        print("Embedding git data")
+        _plist = plistlib.load(_file.open("rb"))
+        _plist["Github"] = {
+            "Branch": _git_branch,
+            "Commit URL": _git_commit,
+            "Commit Date": _git_commit_date
+        }
+        plistlib.dump(_plist, _file.open("wb"), sort_keys=True)
+
+
+    def _embed_resources(self) -> None:
+        """
+        Embed resources
+        """
+        print("Embedding resources")
+        for file in Path("payloads/Icon/AppIcons").glob("*.icns"):
+            subprocess_wrapper.run_and_verify(
+                generate_copy_arguments(str(file), self._application_output / "Contents" / "Resources/"),
+                stdout=subprocess.PIPE, stderr=subprocess.PIPE
+            )
+
+
+    def generate(self) -> None:
+        """
+        Generate OpenCore-Patcher.app
+        """
+        self._embed_analytics_key()
+        self._generate_application()
+        self._remove_analytics_key()
+
+        self._patch_load_command()
+        self._embed_git_data()
+        self._embed_resources()

ci_tooling/build_modules/disk_images.py

@@ -0,0 +1,137 @@
+"""
+disk_images.py: Fetch and generate disk images (Universal-Binaries.dmg, payloads.dmg)
+"""
+
+import subprocess
+
+from pathlib import Path
+
+from opencore_legacy_patcher import constants
+from opencore_legacy_patcher.support import subprocess_wrapper
+
+
+
+class GenerateDiskImages:
+
+    def __init__(self, reset_dmg_cache: bool = False) -> None:
+        """
+        Initialize
+        """
+        self.reset_dmg_cache = reset_dmg_cache
+
+
+    def _delete_extra_binaries(self):
+        """
+        Delete extra binaries from payloads directory
+        """
+
+        whitelist_folders = [
+            "ACPI",
+            "Config",
+            "Drivers",
+            "Icon",
+            "Kexts",
+            "OpenCore",
+            "Tools",
+            "Launch Services",
+        ]
+
+        whitelist_files = []
+
+        print("Deleting extra binaries...")
+        for file in Path("payloads").glob(pattern="*"):
+            if file.is_dir():
+                if file.name in whitelist_folders:
+                    continue
+                print(f"- Deleting {file.name}")
+                subprocess_wrapper.run_and_verify(["/bin/rm", "-rf", file])
+            else:
+                if file.name in whitelist_files:
+                    continue
+                print(f"- Deleting {file.name}")
+                subprocess_wrapper.run_and_verify(["/bin/rm", "-f", file])
+
+
+
+    def _generate_payloads_dmg(self):
+        """
+        Generate disk image containing all payloads
+        Disk image will be password protected due to issues with
+        Apple's notarization system and inclusion of kernel extensions
+        """
+
+        if Path("./payloads.dmg").exists():
+            if self.reset_dmg_cache is False:
+                print("- payloads.dmg already exists, skipping creation")
+                return
+
+            print("- Removing old payloads.dmg")
+            subprocess_wrapper.run_and_verify(
+                ["/bin/rm", "-rf", "./payloads.dmg"],
+                stdout=subprocess.PIPE, stderr=subprocess.PIPE
+            )
+
+        print("Generating DMG...")
+        subprocess_wrapper.run_and_verify([
+            '/usr/bin/hdiutil', 'create', './payloads.dmg',
+            '-megabytes', '32000',  # Overlays can only be as large as the disk image allows
+            '-format', 'UDZO', '-ov',
+            '-volname', 'OpenCore Patcher Resources (Base)',
+            '-fs', 'HFS+',
+            '-layout', 'NONE',
+            '-srcfolder', './payloads',
+            '-passphrase', 'password', '-encryption'
+        ], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        print("DMG generation complete")
+
+
+    def _download_resources(self):
+        """
+        Download required dependencies
+        """
+
+        patcher_support_pkg_version = constants.Constants().patcher_support_pkg_version
+        required_resources = [
+            "Universal-Binaries.dmg"
+        ]
+
+        print("Downloading required resources...")
+        for resource in required_resources:
+            if Path(f"./{resource}").exists():
+                if self.reset_dmg_cache is True:
+                    print(f"  - Removing old {resource}")
+                    # Just to be safe
+                    assert resource, "Resource cannot be empty"
+                    assert resource not in ("/", "."), "Resource cannot be root"
+                    subprocess_wrapper.run_and_verify(
+                        ["/bin/rm", "-rf", f"./{resource}"],
+                        stdout=subprocess.PIPE, stderr=subprocess.PIPE
+                    )
+                else:
+                    print(f"- {resource} already exists, skipping download")
+                    continue
+
+            print(f"- Downloading {resource}...")
+
+            subprocess_wrapper.run_and_verify(
+                [
+                    "/usr/bin/curl", "-LO",
+                    f"https://github.com/dortania/PatcherSupportPkg/releases/download/{patcher_support_pkg_version}/{resource}"
+                ],
+                stdout=subprocess.PIPE, stderr=subprocess.PIPE
+            )
+
+            if not Path(f"./{resource}").exists():
+                print(f"- {resource} not found")
+                raise Exception(f"{resource} not found")
+
+
+    def generate(self) -> None:
+        """
+        Generate disk images
+        """
+
+        self._delete_extra_binaries()
+        self._generate_payloads_dmg()
+        self._download_resources()

ci_tooling/build_modules/package.py

@@ -0,0 +1,148 @@
+"""
+package.py: Generate packages (Installer, Uninstaller, AutoPkg-Assets)
+"""
+
+import tempfile
+import macos_pkg_builder
+
+from opencore_legacy_patcher import constants
+
+from .package_scripts import GenerateScripts
+
+
+class GeneratePackage:
+    """
+    Generate OpenCore-Patcher.pkg
+    """
+
+    def __init__(self) -> None:
+        """
+        Initialize
+        """
+        self._files = {
+            "./dist/OpenCore-Patcher.app": "/Library/Application Support/Dortania/OpenCore-Patcher.app",
+            "./ci_tooling/privileged_helper_tool/com.dortania.opencore-legacy-patcher.privileged-helper": "/Library/PrivilegedHelperTools/com.dortania.opencore-legacy-patcher.privileged-helper",
+        }
+        self._autopkg_files = {
+            "./payloads/Launch Services/com.dortania.opencore-legacy-patcher.auto-patch.plist": "/Library/LaunchAgents/com.dortania.opencore-legacy-patcher.auto-patch.plist",
+        }
+        self._autopkg_files.update(self._files)
+
+
+    def _generate_installer_welcome(self) -> str:
+        """
+        Generate Welcome message for installer PKG
+        """
+        _welcome = ""
+
+        _welcome += "# Overview\n"
+        _welcome += f"This package will install the OpenCore Legacy Patcher application (v{constants.Constants().patcher_version}) on your system."
+
+        _welcome += "\n\nAdditionally, a shortcut for OpenCore Legacy Patcher will be added in the '/Applications' folder."
+        _welcome += "\n\nThis package will not 'Build and Install OpenCore' or install any 'Root Patches' on your machine. If required, you can run OpenCore Legacy Patcher to install any patches you may need."
+        _welcome += f"\n\nFor more information on OpenCore Legacy Patcher usage, see our [documentation]({constants.Constants().guide_link}) and [GitHub repository]({constants.Constants().repo_link})."
+        _welcome += "\n\n"
+
+        _welcome += "## Files Installed"
+        _welcome += "\n\nInstallation of this package will add the following files to your system:"
+        for key, value in self._files.items():
+            _welcome += f"\n\n- `{value}`"
+
+        return _welcome
+
+
+    def _generate_uninstaller_welcome(self) -> str:
+        """
+        Generate Welcome message for uninstaller PKG
+        """
+        _welcome = ""
+
+        _welcome += "# Application Uninstaller\n"
+        _welcome += "This package will uninstall the OpenCore Legacy Patcher application and its Privileged Helper Tool from your system."
+        _welcome += "\n\n"
+        _welcome += "This will not remove any root patches or OpenCore configurations that you may have installed using OpenCore Legacy Patcher."
+        _welcome += "\n\n"
+        _welcome += f"For more information on OpenCore Legacy Patcher, see our [documentation]({constants.Constants().guide_link}) and [GitHub repository]({constants.Constants().repo_link})."
+
+        return _welcome
+
+
+    def _generate_autopkg_welcome(self) -> str:
+        """
+        Generate Welcome message for AutoPkg-Assets PKG
+        """
+        _welcome = ""
+
+        _welcome += "# DO NOT RUN AUTOPKG-ASSETS MANUALLY!\n\n"
+        _welcome += "## THIS CAN BREAK YOUR SYSTEM'S INSTALL!\n\n"
+        _welcome += "This package should only ever be invoked by the Patcher itself, never downloaded or run by the user. Download the OpenCore-Patcher.pkg on the Github Repository.\n\n"
+        _welcome += f"[OpenCore Legacy Patcher GitHub Release]({constants.Constants().repo_link})"
+
+        return _welcome
+
+
+    def generate(self) -> None:
+        """
+        Generate OpenCore-Patcher.pkg
+        """
+        print("Generating OpenCore-Patcher-Uninstaller.pkg")
+        _tmp_uninstall = tempfile.NamedTemporaryFile(delete=False)
+        with open(_tmp_uninstall.name, "w") as f:
+            f.write(GenerateScripts().uninstall())
+
+        assert macos_pkg_builder.Packages(
+            pkg_output="./dist/OpenCore-Patcher-Uninstaller.pkg",
+            pkg_bundle_id="com.dortania.opencore-legacy-patcher-uninstaller",
+            pkg_version=constants.Constants().patcher_version,
+            pkg_background="./ci_tooling/pkg_assets/PkgBackground-Uninstaller.png",
+            pkg_preinstall_script=_tmp_uninstall.name,
+            pkg_as_distribution=True,
+            pkg_title="OpenCore Legacy Patcher Uninstaller",
+            pkg_welcome=self._generate_uninstaller_welcome(),
+        ).build() is True
+
+        print("Generating OpenCore-Patcher.pkg")
+
+        _tmp_pkg_preinstall = tempfile.NamedTemporaryFile(delete=False)
+        _tmp_pkg_postinstall = tempfile.NamedTemporaryFile(delete=False)
+        with open(_tmp_pkg_preinstall.name, "w") as f:
+            f.write(GenerateScripts().preinstall_pkg())
+        with open(_tmp_pkg_postinstall.name, "w") as f:
+            f.write(GenerateScripts().postinstall_pkg())
+
+        assert macos_pkg_builder.Packages(
+            pkg_output="./dist/OpenCore-Patcher.pkg",
+            pkg_bundle_id="com.dortania.opencore-legacy-patcher",
+            pkg_version=constants.Constants().patcher_version,
+            pkg_allow_relocation=False,
+            pkg_as_distribution=True,
+            pkg_background="./ci_tooling/pkg_assets/PkgBackground-Installer.png",
+            pkg_preinstall_script=_tmp_pkg_preinstall.name,
+            pkg_postinstall_script=_tmp_pkg_postinstall.name,
+            pkg_file_structure=self._files,
+            pkg_title="OpenCore Legacy Patcher",
+            pkg_welcome=self._generate_installer_welcome(),
+        ).build() is True
+
+        print("Generating AutoPkg-Assets.pkg")
+
+        _tmp_auto_pkg_preinstall = tempfile.NamedTemporaryFile(delete=False)
+        _tmp_auto_pkg_postinstall = tempfile.NamedTemporaryFile(delete=False)
+        with open(_tmp_auto_pkg_preinstall.name, "w") as f:
+            f.write(GenerateScripts().preinstall_autopkg())
+        with open(_tmp_auto_pkg_postinstall.name, "w") as f:
+            f.write(GenerateScripts().postinstall_autopkg())
+
+        assert macos_pkg_builder.Packages(
+            pkg_output="./dist/AutoPkg-Assets.pkg",
+            pkg_bundle_id="com.dortania.pkg.AutoPkg-Assets",
+            pkg_version=constants.Constants().patcher_version,
+            pkg_allow_relocation=False,
+            pkg_as_distribution=True,
+            pkg_background="./ci_tooling/pkg_assets/PkgBackground-AutoPkg.png",
+            pkg_preinstall_script=_tmp_auto_pkg_preinstall.name,
+            pkg_postinstall_script=_tmp_auto_pkg_postinstall.name,
+            pkg_file_structure=self._autopkg_files,
+            pkg_title="AutoPkg Assets",
+            pkg_welcome=self._generate_autopkg_welcome(),
+        ).build() is True

ci_tooling/build_modules/package_scripts.py

@@ -0,0 +1,556 @@
+"""
+package_scripts.py: Generate pre/postinstall scripts for PKG and AutoPkg
+"""
+
+
+class ZSHFunctions:
+
+    def __init__(self) -> None:
+        pass
+
+
+    def generate_standard_pkg_parameters(self) -> str:
+        """
+        ZSH variables for standard PackageKit parameters
+        """
+
+        _script = ""
+
+        _script += "# MARK: PackageKit Parameters\n"
+        _script += "# " + "-" * 27 + "\n\n"
+
+        _script += "pathToScript=$0          # ex. /tmp/PKInstallSandbox.*/Scripts/*/preinstall\n"
+        _script += "pathToPackage=$1         # ex. ~/Downloads/Installer.pkg\n"
+        _script += "pathToTargetLocation=$2  # ex. '/', '/Applications', etc (depends on pkgbuild's '--install-location' argument)\n"
+        _script += "pathToTargetVolume=$3    # ex. '/', '/Volumes/MyVolume', etc\n"
+        _script += "pathToStartupDisk=$4     # ex. '/'\n"
+
+        return _script
+
+
+    def generate_script_remove_file(self) -> str:
+        """
+        ZSH function to remove files
+        """
+
+        _script = ""
+
+        _script += "function _removeFile() {\n"
+        _script += "    local file=$1\n\n"
+
+        _script += "    if [[ ! -e $file ]]; then\n"
+        _script += "        # Check if file is a symbolic link\n"
+        _script += "        if [[ -L $file ]]; then\n"
+        _script += "            echo \"Removing symbolic link: $file\"\n"
+        _script += "            /bin/rm -f $file\n"
+        _script += "        fi\n"
+        _script += "        return\n"
+        _script += "    fi\n\n"
+
+        _script += "    echo \"Removing file: $file\"\n\n"
+
+        _script += "    # Check if file is a directory\n"
+        _script += "    if [[ -d $file ]]; then\n"
+        _script += "        /bin/rm -rf $file\n"
+        _script += "    else\n"
+        _script += "        /bin/rm -f $file\n"
+        _script += "    fi\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_script_create_parent_directory(self) -> str:
+        """
+        ZSH function to create parent directory
+        """
+
+        _script = ""
+
+        _script += "function _createParentDirectory() {\n"
+        _script += "    local file=$1\n\n"
+
+        _script += "    local parentDirectory=\"$(/usr/bin/dirname $file)\"\n\n"
+
+        _script += "    # Check if parent directory exists\n"
+        _script += "    if [[ ! -d $parentDirectory ]]; then\n"
+        _script += "        echo \"Creating parent directory: $parentDirectory\"\n"
+        _script += "        /bin/mkdir -p $parentDirectory\n"
+        _script += "    fi\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_set_suid_bit(self) -> str:
+        """
+        ZSH function to set SUID bit
+        """
+
+        _script = ""
+
+        _script += "function _setSUIDBit() {\n"
+        _script += "    local binaryPath=$1\n\n"
+
+        _script += "    echo \"Setting SUID bit on: $binaryPath\"\n\n"
+
+        _script += "    # Check if path is a directory\n"
+        _script += "    if [[ -d $binaryPath ]]; then\n"
+        _script += "        /bin/chmod -R +s $binaryPath\n"
+        _script += "    else\n"
+        _script += "        /bin/chmod +s $binaryPath\n"
+        _script += "    fi\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_create_alias(self) -> str:
+        """
+        ZSH function to create alias
+        """
+
+        _script = ""
+
+        _script += "function _createAlias() {\n"
+        _script += "    local mainPath=$1\n"
+        _script += "    local aliasPath=$2\n\n"
+
+        _script += "    # Check if alias path exists\n"
+        _script += "    if [[ -e $aliasPath ]]; then\n"
+        _script += "        # Check if alias path is a symbolic link\n"
+        _script += "        if [[ -L $aliasPath ]]; then\n"
+        _script += "            echo \"Removing old symbolic link: $aliasPath\"\n"
+        _script += "            /bin/rm -f $aliasPath\n"
+        _script += "        else\n"
+        _script += "            echo \"Removing old file: $aliasPath\"\n"
+        _script += "            /bin/rm -rf $aliasPath\n"
+        _script += "        fi\n"
+        _script += "    fi\n\n"
+
+        _script += "    # Create symbolic link\n"
+        _script += "    echo \"Creating symbolic link: $aliasPath\"\n"
+        _script += "    /bin/ln -s $mainPath $aliasPath\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_start_patching(self) -> str:
+        """
+        ZSH function to start patching
+        """
+
+        _script = ""
+
+        _script += "function _startPatching() {\n"
+        _script += "    local executable=$1\n"
+        _script += "    local logPath=$(_logFile)\n\n"
+
+        _script += "    # Start patching\n"
+        _script += "    \"$executable\" \"--patch_sys_vol\" &> $logPath\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_log_file(self) -> str:
+        """
+        ZSH function to generate log file
+        """
+
+        _script = ""
+
+        _script += "function _logFile() {\n"
+        _script += "    echo \"/Users/Shared/.OCLP-AutoPatcher-Log-$(/bin/date +\"%Y_%m_%d_%I_%M_%p\").txt\"\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_fix_settings_file_permission(self) -> str:
+        """
+        ZSH function to fix settings file permission
+        """
+
+        _script = ""
+
+        _script += "function _fixSettingsFilePermission() {\n"
+        _script += "    local settingsPath=\"$pathToTargetVolume/Users/Shared/.com.dortania.opencore-legacy-patcher.plist\"\n\n"
+
+        _script += "    if [[ -e $settingsPath ]]; then\n"
+        _script += "        echo \"Fixing settings file permissions: $settingsPath\"\n"
+        _script += "        /bin/chmod 666 $settingsPath\n"
+        _script += "    fi\n"
+
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_reboot(self) -> str:
+        """
+        ZSH function to reboot
+        """
+
+        _script = ""
+
+        _script += "function _reboot() {\n"
+        _script += "    /sbin/reboot\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_prewarm_gatekeeper(self) -> str:
+        """
+        ZSH function to prewarm Gatekeeper
+        """
+
+        _script = ""
+
+        _script += "function _prewarmGatekeeper() {\n"
+        _script += "    local appPath=$1\n\n"
+
+        _script += "    # Check if /usr/bin/gktool exists\n"
+        _script += "    if [[ ! -e /usr/bin/gktool ]]; then\n"
+        _script += "        echo \"Host doesn't support Gatekeeper prewarming, skipping...\"\n"
+        _script += "        return\n"
+        _script += "    fi\n\n"
+
+        _script += "    echo \"Prewarming Gatekeeper for application: $appPath\"\n"
+        _script += "    /usr/bin/gktool scan $appPath\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_clean_launch_service(self) -> str:
+        """
+        ZSH function to clean Launch Service
+        """
+
+        _script = ""
+
+        _script += "function _cleanLaunchService() {\n"
+        _script += "    local domain=\"com.dortania.opencore-legacy-patcher\"\n\n"
+
+        _script += "    # Iterate over launch agents and daemons\n"
+        _script += "    for launchServiceVariant in \"$pathToTargetVolume/Library/LaunchAgents\" \"$pathToTargetVolume/Library/LaunchDaemons\"; do\n"
+        _script += "        # Check if directory exists\n"
+        _script += "        if [[ ! -d $launchServiceVariant ]]; then\n"
+        _script += "            continue\n"
+        _script += "        fi\n\n"
+
+        _script += "        # Iterate over launch service files\n"
+        _script += "        for launchServiceFile in $(/bin/ls -1 $launchServiceVariant | /usr/bin/grep $domain); do\n"
+        _script += "            local launchServicePath=\"$launchServiceVariant/$launchServiceFile\"\n\n"
+
+        _script += "            # Remove launch service file\n"
+        _script += "            _removeFile $launchServicePath\n"
+        _script += "        done\n"
+        _script += "    done\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_preinstall_main(self) -> str:
+        """
+        ZSH function for preinstall's main
+        """
+
+        _script = ""
+
+        _script += "function _main() {\n"
+        _script += "    for file in $filesToRemove; do\n"
+        _script += "        _removeFile $pathToTargetVolume/$file\n"
+        _script += "        _createParentDirectory $pathToTargetVolume/$file\n"
+        _script += "    done\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_postinstall_main(self, is_autopkg: bool = False) -> str:
+        """
+        ZSH function for postinstall's main
+        """
+
+        _script = ""
+
+        _script += "function _main() {\n"
+        _script += "    _setSUIDBit \"$pathToTargetVolume/$helperPath\"\n"
+        _script += "    _createAlias \"$pathToTargetVolume/$mainAppPath\" \"$pathToTargetVolume/$shimAppPath\"\n"
+        _script += "    _prewarmGatekeeper \"$pathToTargetVolume/$mainAppPath\"\n"
+        if is_autopkg:
+            _script += "    _startPatching \"$pathToTargetVolume/$executablePath\"\n"
+            _script += "    _fixSettingsFilePermission\n"
+            _script += "    _reboot\n"
+        _script += "}\n"
+
+        return _script
+
+
+    def generate_uninstall_main(self) -> str:
+        """
+        ZSH function for uninstall's main
+        """
+
+        _script = ""
+
+        _script += "function _main() {\n"
+        _script += "    _cleanLaunchService\n"
+        _script += "    for file in $filesToRemove; do\n"
+        _script += "        _removeFile $pathToTargetVolume/$file\n"
+        _script += "    done\n"
+        _script += "}\n"
+
+        return _script
+
+
+class GenerateScripts:
+
+    def __init__(self):
+        self.zsh_functions = ZSHFunctions()
+
+        self.files = [
+            "Applications/OpenCore-Patcher.app",
+            "Library/Application Support/Dortania/Update.plist",
+            "Library/Application Support/Dortania/OpenCore-Patcher.app",
+            "Library/PrivilegedHelperTools/com.dortania.opencore-legacy-patcher.privileged-helper"
+        ]
+
+        self.additional_auto_pkg_files = [
+            "Library/LaunchAgents/com.dortania.opencore-legacy-patcher.auto-patch.plist"
+        ]
+
+
+    def __generate_shebang(self) -> str:
+        """
+        Standard shebang for ZSH
+        """
+        return "#!/bin/zsh --no-rcs\n"
+
+
+    def _generate_header_bar(self) -> str:
+        """
+        # ------------------------------------------------------
+        """
+        return "# " + "-" * 54 + "\n"
+
+
+    def _generate_label_bar(self) -> str:
+        """
+        # ------------------------------
+        """
+        return "# " + "-" * 27 + "\n"
+
+
+    def _generate_preinstall_script(self, is_autopkg: bool = False) -> str:
+        """
+        Generate preinstall script for PKG
+        """
+
+        _script = ""
+
+        _script += self.__generate_shebang()
+
+        _script += self._generate_header_bar()
+        _script += f"# {'AutoPkg Assets' if is_autopkg else 'OpenCore Legacy Patcher'} Preinstall Script\n"
+        _script += self._generate_header_bar()
+        _script += "# Remove old files, and prepare directories.\n"
+        _script += self._generate_header_bar()
+        _script += "\n\n"
+
+        _script += self.zsh_functions.generate_standard_pkg_parameters()
+        _script += "\n\n"
+
+        _script += "# MARK: Variables\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _files = self.files
+        if is_autopkg:
+            _files += self.additional_auto_pkg_files
+
+        _script += f"filesToRemove=(\n"
+        for _file in _files:
+            _script += f"    \"{_file}\"\n"
+
+        _script += ")\n"
+
+        _script += "\n\n"
+
+        _script += "# MARK: Functions\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += self.zsh_functions.generate_script_remove_file()
+        _script += "\n"
+        _script += self.zsh_functions.generate_script_create_parent_directory()
+        _script += "\n"
+        _script += self.zsh_functions.generate_preinstall_main()
+        _script += "\n\n"
+
+        _script += "# MARK: Main\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += "echo \"Starting preinstall script...\"\n"
+        _script += "_main\n"
+
+        return _script
+
+
+    def _generate_postinstall_script(self, is_autopkg: bool = False) -> str:
+        """
+        """
+
+        _script = ""
+
+        _script += self.__generate_shebang()
+
+        _script += self._generate_header_bar()
+        _script += f"# {'AutoPkg Assets' if is_autopkg else 'OpenCore Legacy Patcher'} Post Install Script\n"
+        _script += self._generate_header_bar()
+        if is_autopkg:
+            _script += "# Set UID, create alias, start patching, and reboot.\n"
+        else:
+            _script += "# Set SUID bit on helper tool, and create app alias.\n"
+        _script += self._generate_header_bar()
+        _script += "\n\n"
+
+        _script += self.zsh_functions.generate_standard_pkg_parameters()
+        _script += "\n\n"
+
+        _script += "# MARK: Variables\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += "helperPath=\"Library/PrivilegedHelperTools/com.dortania.opencore-legacy-patcher.privileged-helper\"\n"
+        _script += "mainAppPath=\"Library/Application Support/Dortania/OpenCore-Patcher.app\"\n"
+        _script += "shimAppPath=\"Applications/OpenCore-Patcher.app\"\n"
+        if is_autopkg:
+            _script += "executablePath=\"$mainAppPath/Contents/MacOS/OpenCore-Patcher\"\n"
+
+        _script += "\n\n"
+
+        _script += "# MARK: Functions\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += self.zsh_functions.generate_set_suid_bit()
+        _script += "\n"
+        _script += self.zsh_functions.generate_create_alias()
+        _script += "\n"
+        _script += self.zsh_functions.generate_prewarm_gatekeeper()
+        _script += "\n"
+        if is_autopkg:
+            _script += self.zsh_functions.generate_start_patching()
+            _script += "\n"
+            _script += self.zsh_functions.generate_log_file()
+            _script += "\n"
+            _script += self.zsh_functions.generate_fix_settings_file_permission()
+            _script += "\n"
+            _script += self.zsh_functions.generate_reboot()
+            _script += "\n"
+
+        _script += self.zsh_functions.generate_postinstall_main(is_autopkg)
+        _script += "\n\n"
+
+        _script += "# MARK: Main\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += "echo \"Starting postinstall script...\"\n"
+        _script += "_main\n"
+
+        return _script
+
+
+    def _generate_uninstall_script(self) -> str:
+        """
+        """
+        _script = ""
+
+        _script += self.__generate_shebang()
+
+        _script += self._generate_header_bar()
+        _script += f"# OpenCore Legacy Patcher Uninstall Script\n"
+        _script += self._generate_header_bar()
+        _script += "# Remove OpenCore Legacy Patcher files and directories.\n"
+        _script += self._generate_header_bar()
+        _script += "\n\n"
+
+        _script += self.zsh_functions.generate_standard_pkg_parameters()
+        _script += "\n\n"
+
+        _script += "# MARK: Variables\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _files = self.files
+
+        _script += "filesToRemove=(\n"
+        for _file in _files:
+            _script += f"    \"{_file}\"\n"
+
+        _script += ")\n"
+
+        _script += "\n\n"
+
+        _script += "# MARK: Functions\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += self.zsh_functions.generate_script_remove_file()
+        _script += "\n"
+        _script += self.zsh_functions.generate_clean_launch_service()
+        _script += "\n"
+        _script += self.zsh_functions.generate_uninstall_main()
+        _script += "\n\n"
+
+        _script += "# MARK: Main\n"
+        _script += self._generate_label_bar()
+        _script += "\n"
+
+        _script += "echo \"Starting uninstall script...\"\n"
+        _script += "_main\n"
+
+        return _script
+
+
+    def preinstall_pkg(self) -> str:
+        """
+        Generate preinstall script for PKG
+        """
+        return self._generate_preinstall_script()
+
+
+    def preinstall_autopkg(self) -> str:
+        """
+        Generate preinstall script for AutoPkg
+        """
+        return self._generate_preinstall_script(is_autopkg=True)
+
+
+    def postinstall_pkg(self) -> str:
+        """
+        Generate postinstall script for PKG
+        """
+        return self._generate_postinstall_script()
+
+
+    def postinstall_autopkg(self) -> str:
+        """
+        Generate postinstall script for AutoPkg
+        """
+        return self._generate_postinstall_script(is_autopkg=True)
+
+
+    def uninstall(self) -> str:
+        """
+        Generate uninstall script
+        """
+        return self._generate_uninstall_script()

ci_tooling/build_modules/shim.py

@@ -0,0 +1,34 @@
+"""
+shim.py: Generate Update Shim
+"""
+
+from pathlib import Path
+
+from opencore_legacy_patcher.volume  import generate_copy_arguments
+from opencore_legacy_patcher.support import subprocess_wrapper
+
+
+class GenerateShim:
+
+    def __init__(self) -> None:
+        self._shim_path = "./ci_tooling/update_shim/OpenCore-Patcher.app"
+        self._shim_pkg  = f"{self._shim_path}/Contents/Resources/OpenCore-Patcher.pkg"
+
+        self._build_pkg   = "./dist/OpenCore-Patcher.pkg"
+        self._output_shim = "./dist/OpenCore-Patcher (Shim).app"
+
+
+    def generate(self) -> None:
+        """
+        Generate Update Shim
+        """
+        print("Generating Update Shim")
+        if Path(self._shim_pkg).exists():
+            Path(self._shim_pkg).unlink()
+
+        subprocess_wrapper.run_and_verify(generate_copy_arguments(self._build_pkg, self._shim_pkg))
+
+        if Path(self._output_shim).exists():
+            Path(self._output_shim).unlink()
+
+        subprocess_wrapper.run_and_verify(generate_copy_arguments(self._shim_path, self._output_shim))

ci_tooling/build_modules/sign_notarize.py

@@ -0,0 +1,54 @@
+"""
+sign_notarize.py: Sign and Notarize a file
+"""
+
+import mac_signing_buddy
+import macos_pkg_builder
+
+from pathlib import Path
+
+import macos_pkg_builder.utilities.signing
+
+
+class SignAndNotarize:
+
+    def __init__(self, path: Path, signing_identity: str, notarization_apple_id: str, notarization_password: str, notarization_team_id: str, entitlements: str = None) -> None:
+        """
+        Initialize
+        """
+        self._path = path
+        self._signing_identity = signing_identity
+        self._notarization_apple_id = notarization_apple_id
+        self._notarization_password = notarization_password
+        self._notarization_team_id = notarization_team_id
+        self._entitlements = entitlements
+
+
+    def sign_and_notarize(self) -> None:
+        """
+        Sign and Notarize
+        """
+        if not all([self._signing_identity, self._notarization_apple_id, self._notarization_password, self._notarization_team_id]):
+            print("Signing and Notarization details not provided, skipping")
+            return
+
+        print(f"Signing {self._path.name}")
+        if self._path.name.endswith(".pkg"):
+            macos_pkg_builder.utilities.signing.SignPackage(
+                identity=self._signing_identity,
+                pkg=self._path,
+            ).sign()
+        else:
+            mac_signing_buddy.Sign(
+                identity=self._signing_identity,
+                file=self._path,
+                **({"entitlements": self._entitlements} if self._entitlements else {}),
+            ).sign()
+
+        print(f"Notarizing {self._path.name}")
+        mac_signing_buddy.Notarize(
+            apple_id=self._notarization_apple_id,
+            password=self._notarization_password,
+            team_id=self._notarization_team_id,
+            file=self._path,
+        ).sign()

ci_tooling/entitlements/entitlements.plist

@@ -4,5 +4,7 @@
 <dict>
 	<key>com.apple.security.cs.disable-library-validation</key>
 	<true/>
+	<key>com.apple.security.cs.disable-executable-page-protection</key>
+	<true/>
 </dict>
 </plist>

ci_tooling/installer_backups/macOS_Installer_Backup.command

@@ -0,0 +1,376 @@
+#!/usr/bin/env python3
+
+"""
+--------------------------------
+macOS_Installer_Backup.command
+--------------------------------
+
+Utility for grabbing macOS Installers from Apple's catalogs and AppleDB,
+and saving them to a local directory.
+
+WARNING: Solely for internal usage, not intended for end-users.
+"""
+
+import sys
+import argparse
+import plistlib
+import subprocess
+
+from pathlib import Path
+from datetime import datetime
+
+# To allow easy importing of OpenCore Legacy Patcher's utilities
+sys.path.append(str(Path(__file__).parent.parent.parent))
+
+from opencore_legacy_patcher.support import (
+    macos_installer_handler,
+    network_handler,
+    integrity_verification,
+    utilities,
+)
+from opencore_legacy_patcher.datasets import os_data
+
+
+_DEFAULT_PATH: str = "/Volumes/macOS Installers"
+
+
+class InstallerBackup:
+
+    def __init__(self,
+                 directory:      Path = Path(_DEFAULT_PATH),
+                 supported_oses: list = [
+                     os_data.os_data.big_sur,
+                     os_data.os_data.monterey,
+                     os_data.os_data.ventura,
+                     os_data.os_data.sonoma,
+                     os_data.os_data.sequoia,
+                    ],
+                 first_run:      bool = False
+                ) -> None:
+
+        print(f"Starting macOS Installer Backup: {datetime.now()}")
+
+        self._directory = directory
+        self._supported_oses = supported_oses
+
+        self._os_table = {
+            os_data.os_data.big_sur:  Path(self._directory, "11 Big Sur"),
+            os_data.os_data.monterey: Path(self._directory, "12 Monterey"),
+            os_data.os_data.ventura:  Path(self._directory, "13 Ventura"),
+            os_data.os_data.sonoma:   Path(self._directory, "14 Sonoma"),
+            os_data.os_data.sequoia:  Path(self._directory, "15 Sequoia"),
+        }
+
+        for os_version in self._supported_oses:
+            if os_version not in self._os_table:
+                raise ValueError(f"Unsupported OS version: {os_version}")
+
+        for dir in self._os_table.values():
+            if not Path(dir).exists():
+                if first_run is False:
+                    raise FileNotFoundError(f"Directory does not exist: {dir} (use --first-run to create)")
+                Path(dir).mkdir(parents=True, exist_ok=True)
+
+        self._main()
+
+
+    def _download_installer(self, installer: dict) -> None:
+        """
+        Download installer
+        """
+
+        installer_name = f"{installer['Version']} ({installer['Build']})"
+        if Path(installer['Link']).suffix == ".pkg":
+            installer_name += " InstallAssistant.pkg"
+        else:
+            installer_name += " Restore.ipsw"
+        integrity_name = f"{installer_name}.integrityDataV1"
+        print(f"Downloading {installer_name}")
+
+        # Check if integrity file available
+        integrity = installer["integrity"]
+        if integrity is not None:
+            result = self._downloader(url=integrity, path=Path(self._os_table[installer['OS']], integrity_name), name=integrity_name)
+            if result is False:
+                return
+
+        # Download installer
+        result = self._downloader(url=installer["Link"], path=Path(self._os_table[installer['OS']], installer_name), name=installer_name)
+        if result is False:
+            return
+
+        # Validate against chunklist
+        if integrity is not None:
+            result = self._validate_against_chunklist(installer_path=Path(self._os_table[installer['OS']], installer_name), chunklist=Path(self._os_table[installer['OS']], integrity_name))
+            if result is False:
+                return
+
+
+    def _validate_against_chunklist(self, installer_path: str, chunklist: str) -> bool:
+        """
+        Validate file against chunklist
+        """
+
+        name = Path(installer_path).name
+
+        if not Path(installer_path).exists():
+            print("File does not exist")
+            return False
+
+        if not Path(chunklist).exists():
+            print("Chunklist does not exist")
+            return False
+
+        chunk_obj = integrity_verification.ChunklistVerification(installer_path, chunklist)
+        if not chunk_obj.chunks:
+            print("Failed to generate chunklist dict")
+            return False
+
+        print(f"Validating {name} against chunklist: {chunk_obj.total_chunks} chunks", end="\r")
+        chunk_obj.validate()
+
+        while chunk_obj.status == integrity_verification.ChunklistStatus.IN_PROGRESS:
+            print(f"Validating {name} against chunklist: chunk {chunk_obj.current_chunk} passed", end="\r")
+
+        if chunk_obj.status == integrity_verification.ChunklistStatus.FAILURE:
+            print(chunk_obj.error_msg)
+            print(f"Validating {name} against chunklist: chunk {chunk_obj.current_chunk} failed")
+            for file in [installer_path, chunklist]:
+                result = subprocess.run(["/bin/rm", "-f", file])
+                if result.returncode != 0:
+                    print(f"Failed to delete {file}")
+
+        print(f"Validating {name} against chunklist: chunk {chunk_obj.total_chunks} passed")
+        return True
+
+
+    def _downloader(self, url, path, name) -> bool:
+        """
+        Download file from URL
+        """
+        dl_obj = network_handler.DownloadObject(url, path)
+        dl_obj.download(display_progress=False, spawn_thread=True)
+
+        percentages_displayed = set()
+        while dl_obj.is_active():
+            if dl_obj.get_percent() in percentages_displayed:
+                continue
+            percentages_displayed.add(int(dl_obj.get_percent()))
+            print(f"  Downloading: {name}: {dl_obj.get_percent():.2f}%  ({utilities.human_fmt(dl_obj.get_speed())})/s", end="\r")
+
+        print(f"  Downloading: {name}: 100.00%  ({utilities.human_fmt(dl_obj.get_speed())})/s")
+
+        if not dl_obj.download_complete:
+            print("Download failed")
+            subprocess.run(["/bin/rm", "-f", path]) # Retry later
+            return False
+
+
+        if Path(path).stat().st_size == 0:
+            print("Downloaded file is empty, considering permanent failure") # Likely dead URL
+            if not Path(Path(path).parent, "Dead URLs").exists():
+                Path(Path(path).parent, "Dead URLs").mkdir()
+            if Path(path).exists():
+                subprocess.run(["/bin/mv", path, Path(Path(path).parent, "Dead URLs", Path(path).name)])
+
+        return True
+
+
+
+    def _does_file_exist(self, xnu_version: int, build: str, suffix: str) -> bool:
+        """
+        Check if installer already exists in directory
+        """
+        if xnu_version not in self._os_table:
+            raise ValueError(f"Unsupported OS version: {xnu_version}")
+
+        if not Path(self._os_table[xnu_version]).exists():
+            raise FileNotFoundError(f"Directory does not exist: {self._os_table[xnu_version]}")
+
+        # Check failed, as those are generally dead URLs
+        for path in [Path(self._os_table[xnu_version]), Path(self._os_table[xnu_version], "Dead URLs")]:
+            if not Path(path).exists():
+                continue
+            for file in path.iterdir():
+                if file.is_dir():
+                    continue
+                if not file.name.endswith(suffix):
+                    continue
+                if f"({build})" in file.name:
+                    return True
+
+        return False
+
+
+    def _get_remote_installer_catalog(self, os_version: int) -> dict:
+        """
+        Get remote installer catalog from Apple's servers
+        """
+        installers = {}
+        print(f"SUCATALOG: Getting installers for macOS {os_data.os_conversion.kernel_to_os(os_version)}")
+        for seed in macos_installer_handler.SeedType:
+            print(f"  Catalog: {seed.name}")
+            result = macos_installer_handler.RemoteInstallerCatalog(seed_override=seed, os_override=os_version).available_apps
+            installers.update(result)
+
+        return installers
+
+
+    def _get_apple_db_items(self, variant: str = ".ipsw") -> dict:
+        """
+        Get macOS installers from AppleDB
+        """
+
+        if variant not in ["InstallAssistant.pkg", ".ipsw"]:
+            raise ValueError(f"Invalid variant: {variant}")
+
+        installers = {
+            # "22F82": {
+            #   url: "https://swcdn.apple.com/content/downloads/36/06/042-01917-A_B57IOY75IU/oocuh8ap7y8l8vhu6ria5aqk7edd262orj/InstallAssistant.pkg",
+            #   version: "13.4.1",
+            #   build: "22F82",
+            # }
+        }
+
+        print(f"APPLEDB: Getting installers for variant: {variant}")
+
+        apple_db = network_handler.NetworkUtilities().get("https://api.appledb.dev/main.json")
+        if apple_db is None:
+            return installers
+
+        apple_db = apple_db.json()
+        for group in apple_db:
+            if group != "ios":
+                continue
+            for item in apple_db[group]:
+                if "osStr" not in item:
+                    continue
+                if item["osStr"] != "macOS":
+                    continue
+                if "build" not in item:
+                    continue
+                if "version" not in item:
+                    continue
+                if "sources" not in item:
+                    continue
+                for source in item["sources"]:
+                    if "links" not in source:
+                        continue
+
+                    for entry in source["links"]:
+                        if "url" not in entry:
+                            continue
+                        if entry["url"].endswith(variant) is False:
+                            continue
+
+                        models = []
+                        if "devices" in item:
+                            for device in item["devices"]:
+                                _device = device
+                                if "-" in device:
+                                    _device = device.split("-")[0]
+                                if _device  in models:
+                                    continue
+                                models.append(_device)
+
+                        # Attempt to match macos_installer_handler.py's format
+                        installers[item["build"]] = {
+                            "Version":   item["version"],
+                            "Build":     item["build"],
+                            "Link":      entry["url"],
+                            "Size":      -1,
+                            "integrity": None,
+                            "Source":    "AppleDB",
+                            "Variant":   "Beta" if item["beta"] else "Public",
+                            "OS":        os_data.os_conversion.os_to_kernel(item["version"] if " " not in item["version"] else item["version"].split(" ")[0]),
+                            "Models":    models,
+                            "Date":      item["released"],
+                        }
+
+        return installers
+
+
+    def _main(self) -> None:
+        """
+        Main entry point
+        """
+        installers = {}
+        apple_db_ipsw_installers = {}
+        apple_db_pkg_installers = {}
+        for build in self._supported_oses:
+            installers.update(self._get_remote_installer_catalog(os_version=build))
+
+        for installer in [".ipsw", "InstallAssistant.pkg"]:
+            apple_db_items = self._get_apple_db_items(variant=installer)
+            if installer == ".ipsw":
+                apple_db_ipsw_installers = apple_db_items
+            else:
+                apple_db_pkg_installers = apple_db_items
+            installers.update(apple_db_items)
+
+        # Sort by name
+        installers = dict(sorted(installers.items(), key=lambda item: item[1]["Build"]))
+
+        print(f"Found {len(installers)} installers, checking which ones are missing")
+        missing = []
+        for build in installers:
+            if self._does_file_exist(xnu_version=installers[build]["OS"], build=installers[build]["Build"], suffix=Path(installers[build]["Link"]).suffix) is True:
+                continue
+            missing.append(installers[build])
+
+        print(f"Found {len(missing)} missing installers:" if missing else "No missing installers found")
+        for installer in missing:
+            print(f"  {Path(installer['Link']).suffix}: {installer['Version']} ({installer['Build']})")
+            self._download_installer(installer)
+
+
+        # Finally, fix names
+        for apple_db_installers in [apple_db_ipsw_installers, apple_db_pkg_installers]:
+            for installer in apple_db_installers:
+                _build = apple_db_installers[installer]["Build"]
+                _version = apple_db_installers[installer]["Version"]
+                if _version.lower().endswith(" beta"):
+                    _version += " 1"
+                elif " " not in _version:
+                    _version += " release"
+                _base_name = f"{_version} ({_build})"
+
+                for os in self._os_table:
+                    for directory in [self._os_table[os], Path(self._os_table[os], "Dead URLs")]:
+                        for file in directory.iterdir():
+                            if file.is_dir():
+                                continue
+                            if f"({_build})" not in file.name and f" {_build} " not in file.name:
+                                continue
+
+                            _name = _base_name
+
+                            _current_suffix = Path(file).suffix
+                            if _current_suffix == ".pkg":
+                                _name += " InstallAssistant.pkg"
+                            elif _current_suffix == ".ipsw":
+                                _name += " Restore.ipsw"
+                            elif _current_suffix == ".integrityDataV1":
+                                if Path(file).name.endswith(" Restore.ipsw.integrityDataV1"):
+                                    _name += " Restore.ipsw.integrityDataV1"
+                                elif Path(file).name.endswith("InstallAssistant.pkg.integrityDataV1"):
+                                    _name += " InstallAssistant.pkg.integrityDataV1"
+                                else:
+                                    continue
+                            else:
+                                continue
+
+                            if Path(file).name == _name:
+                                continue
+
+                            print(f"Renaming {file.name} to {_name}")
+                            result = subprocess.run(["/bin/mv", file, Path(directory, _name)])
+                            if result.returncode != 0:
+                                print(f"Failed to rename {file} to {Path(directory, _name)}")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="macOS Installer Backup")
+    parser.add_argument("--first-run", action="store_true", help="Create directories if missing")
+
+    InstallerBackup(**vars(parser.parse_args()))

ci_tooling/privileged_helper_tool/Makefile

@@ -0,0 +1,13 @@
+CC=clang
+OUTPUT=com.dortania.opencore-legacy-patcher.privileged-helper
+
+all: clean release
+
+release: main.m
+	$(CC) -framework Foundation -framework Security -arch x86_64 -arch arm64 -mmacosx-version-min=10.9 -o $(OUTPUT) main.m
+
+debug: main.m
+	$(CC) -framework Foundation -framework Security -arch x86_64 -arch arm64 -mmacosx-version-min=10.9 -o $(OUTPUT) main.m -DDEBUG
+
+clean:
+	/bin/rm -f $(OUTPUT)

ci_tooling/privileged_helper_tool/README.md

@@ -0,0 +1,34 @@
+# OpenCore Legacy Patcher Privileged Helper Tool
+
+`com.dortania.opencore-legacy-patcher.privileged-helper` is OpenCore Legacy Patcher's Privileged Helper Tool.
+
+The architecture is as such:
+1. The main application (OpenCore-Patcher.app) will send arguments to the privileged helper tool to execute.
+2. The privileged helper tool will check the code signature of the main application to ensure it is signed by Dortania.
+3. The privileged helper tool will then execute the command and return the output to the main application.
+
+The helper tool is able to execute code as root by using the "Set UID" bit present on the file.
+
+
+## Running from source
+
+Since running OpenCore Legacy Patcher from source will lack Dortania's code signature, you will need to disable code signature verification in the privileged helper tool otherwise root commands will fail.
+
+To do so, compile the privileged helper tool with debug:
+```
+make debug
+```
+
+Then when you build OpenCore-Patcher.pkg, the debug version of the helper tool will be used.
+
+
+### Security Considerations
+
+When using the Privileged Helper Tool from source, you are now adding a security risk to your system. By disabling the code signature checks, any malicious application is given ability to execute code as root.
+
+If possible, we highly recommend creating a developer account with Apple and signing the application with your own ["Developer ID Application" certificate](https://developer.apple.com/help/account/create-certificates/create-developer-id-certificates/). This will allow you to run the application without disabling code signature checks.
+
+* Note that Dortania's Team ID will need to be replaced in main.m with your own Team ID (`S74BDJXQMD` -> `YOUR_TEAM`)
+* Additionally you will be required to compile OpenCore-Patcher.app with your own Developer ID Application certificate
+
+If this is not possible, we recommend using [OpenCore Legacy Patcher's prebuilt binaries](../../SOURCE.md) instead.

ci_tooling/privileged_helper_tool/install.sh

@@ -0,0 +1,54 @@
+#!/bin/zsh --no-rcs
+# ------------------------------------------------------
+# Privileged Helper Tool Installer
+# ------------------------------------------------------
+# Moves to expected destination and sets SUID bit.
+# ------------------------------------------------------
+# Developed for internal testing, end users should be
+# using the PKG installer when released.
+# ------------------------------------------------------
+
+
+# MARK: Variables
+# ---------------------------
+helperName="com.dortania.opencore-legacy-patcher.privileged-helper"
+helperPath="/Library/PrivilegedHelperTools/$helperName"
+
+# MARK: Functions
+# ---------------------------
+
+function _setSUIDBit() {
+    local binaryPath=$1
+
+    # Check if path is a directory
+    if [[ -d $binaryPath ]]; then
+        /bin/chmod -R +s $binaryPath
+    else
+        /bin/chmod +s $binaryPath
+    fi
+}
+
+function _copyHelper() {
+    local sourcePath=$1
+    local destinationPath=$2
+
+    # Check if destination path exists
+    if [[ -e $destinationPath ]]; then
+        # Check if destination path is a directory
+        if [[ -d $destinationPath ]]; then
+            /bin/rm -rf $destinationPath
+        else
+            /bin/rm -f $destinationPath
+        fi
+    fi
+
+    # Copy source to destination
+    /bin/cp -R $sourcePath $destinationPath
+}
+
+
+# MARK: Main
+# ---------------------------
+
+_copyHelper "./$helperName" $helperPath
+_setSUIDBit $helperPath

ci_tooling/privileged_helper_tool/main.m

@@ -0,0 +1,152 @@
+/*
+    ------------------------------------------------
+    OpenCore Legacy Patcher Privileged Helper Tool
+    ------------------------------------------------
+    Designed as an alternative to an XPC service,
+    this tool is used to run commands as root.
+    ------------------------------------------------
+    Server and client must have the same signing
+    certificate in order to run commands.
+    ------------------------------------------------
+*/
+
+#import <Foundation/Foundation.h>
+#import <Security/Security.h>
+#include <libproc.h>
+
+#define UTILITY_VERSION "1.0.0"
+
+#define VALID_CLIENT_TEAM_ID @"S74BDJXQMD"
+
+#define OCLP_PHT_ERROR_MISSING_ARGUMENTS           160
+#define OCLP_PHT_ERROR_SET_UID_MISSING             161
+#define OCLP_PHT_ERROR_SET_UID_FAILED              162
+#define OCLP_PHT_ERROR_SELF_PATH_MISSING           163
+#define OCLP_PHT_ERROR_PARENT_PATH_MISSING         164
+#define OCLP_PHT_ERROR_SIGNING_INFORMATION_MISSING 165
+#define OCLP_PHT_ERROR_INVALID_TEAM_ID             166
+#define OCLP_PHT_ERROR_INVALID_CERTIFICATES        167
+#define OCLP_PHT_ERROR_COMMAND_MISSING             168
+#define OCLP_PHT_ERROR_COMMAND_FAILED              169
+#define OCLP_PHT_ERROR_CATCH_ALL                   170
+
+
+NSDictionary *getSigningInformationFromPath(NSString *path) {
+    SecStaticCodeRef codeRef;
+    OSStatus status = SecStaticCodeCreateWithPath((__bridge CFURLRef)[NSURL fileURLWithPath:path], kSecCSDefaultFlags, &codeRef);
+    if (status != errSecSuccess) {
+        return nil;
+    }
+
+    CFDictionaryRef codeDict = NULL;
+    status = SecCodeCopySigningInformation(codeRef, kSecCSSigningInformation, &codeDict);
+    if (status != errSecSuccess) {
+        return nil;
+    }
+
+    return (__bridge NSDictionary *)codeDict;
+}
+
+NSString *getParentProcessPath() {
+    char pathbuf[PROC_PIDPATHINFO_MAXSIZE];
+    if (proc_pidpath(getppid(), pathbuf, sizeof(pathbuf)) <= 0) {
+        return nil;
+    }
+    NSString *path = [NSString stringWithUTF8String:pathbuf];
+    return path;
+}
+
+NSString *getProcessPath() {
+    NSString *path = [[NSBundle mainBundle] executablePath];
+    return path;
+}
+
+BOOL isSBitSet(NSString *path) {
+    NSFileManager *fileManager = [NSFileManager defaultManager];
+    NSDictionary *attributes = [fileManager attributesOfItemAtPath:path error:nil];
+    if (attributes == nil) {
+        return NO;
+    }
+    return (attributes.filePosixPermissions & S_ISUID) != 0;
+}
+
+
+int main(int argc, const char * argv[]) {
+    @autoreleasepool {
+        // We simply return if no arguments are passed
+        if (argc < 2) {
+            return OCLP_PHT_ERROR_MISSING_ARGUMENTS;
+        }
+
+        if (argc == 2 && (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-v") == 0)) {
+            printf("%s\n", UTILITY_VERSION);
+            return 0;
+        }
+
+        // Verify whether we can run as root
+        NSString *processPath = getProcessPath();
+        if (processPath == nil) {
+            return OCLP_PHT_ERROR_SELF_PATH_MISSING;
+        }
+
+        if (!isSBitSet(processPath)) {
+            return OCLP_PHT_ERROR_SET_UID_MISSING;
+        }
+
+        setuid(0);
+        if (getuid() != 0) {
+            return OCLP_PHT_ERROR_SET_UID_FAILED;
+        }
+
+        NSString *parentProcessPath = getParentProcessPath();
+        if (parentProcessPath == nil) {
+            return OCLP_PHT_ERROR_PARENT_PATH_MISSING;
+        }
+
+        NSDictionary *processSigningInformation = getSigningInformationFromPath(processPath);
+        NSDictionary *parentProcessSigningInformation = getSigningInformationFromPath(parentProcessPath);
+
+        if (processSigningInformation == nil || parentProcessSigningInformation == nil) {
+            return OCLP_PHT_ERROR_SIGNING_INFORMATION_MISSING;
+        }
+
+        #ifdef DEBUG
+        // Skip Team ID check in debug mode
+        // DO NOT USE IN PRODUCTION
+        #else
+        // Check Team ID
+        if (![processSigningInformation[@"teamid"] isEqualToString:VALID_CLIENT_TEAM_ID] || ![parentProcessSigningInformation[@"teamid"] isEqualToString:VALID_CLIENT_TEAM_ID]) {
+            return OCLP_PHT_ERROR_INVALID_TEAM_ID;
+        }
+
+        // Check Certificates
+        if (![processSigningInformation[@"certificates"] isEqualToArray:parentProcessSigningInformation[@"certificates"]]) {
+            return OCLP_PHT_ERROR_INVALID_CERTIFICATES;
+        }
+        #endif
+
+        NSString *command = nil;
+        NSArray *arguments = @[];
+        if (argc == 2) {
+            command = [NSString stringWithUTF8String:argv[1]];
+        } else {
+            command = [NSString stringWithUTF8String:argv[1]];
+            for (int i = 2; i < argc; i++) {
+                arguments = [arguments arrayByAddingObject:[NSString stringWithUTF8String:argv[i]]];
+            }
+        }
+
+        // Verify command exists
+        if (![[NSFileManager defaultManager] fileExistsAtPath:command]) {
+            return OCLP_PHT_ERROR_COMMAND_MISSING;
+        }
+
+        NSTask *task = [[NSTask alloc] init];
+        [task setLaunchPath:command];
+        [task setArguments:arguments];
+        [task launch];
+        [task waitUntilExit];
+        return [task terminationStatus];
+    }
+    return OCLP_PHT_ERROR_CATCH_ALL; // Should never reach here
+}

ci_tooling/update_shim/OpenCore-Patcher.app/Contents/Info.plist

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDisplayName</key>
+	<string>OpenCore-Patcher</string>
+	<key>CFBundleExecutable</key>
+	<string>OpenCore-Patcher</string>
+	<key>CFBundleIconFile</key>
+	<string>AppIcon.icns</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.dortania.opencore-legacy-patcher</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>OpenCore Legacy Patcher</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>LSMinimumSystemVersion</key>
+	<string>10.10.0</string>
+	<key>NSHighResolutionCapable</key>
+	<true/>
+	<key>NSHumanReadableCopyright</key>
+	<string>Copyright © 2020-2024 Dortania</string>
+	<key>NSPrincipalClass</key>
+	<string>NSApplication</string>
+	<key>NSRequiresAquaSystemAppearance</key>
+	<false/>
+</dict>
+</plist>

ci_tooling/update_shim/README.md

@@ -0,0 +1,8 @@
+# OpenCore-Patcher Update Shim
+
+To handle the new PKG installation method, old versions of OpenCore Legacy Patcher updating to newer versions will still require 'OpenCore-Patcher.app' to be available for download.
+
+Thus the goal of this app is to install an embedded PKG under ./OpenCore-Patcher.app/Contents/Resources/OpenCore-Patcher.pkg to handle the update process.
+
+Source is available at:
+* https://github.com/dortania/OCLP-Helper

docs/.markdownlint.json

@@ -10,5 +10,6 @@
 	"single-title": false,
 	"ul-style": {
 		"style": "asterisk"
-	}
+	},
+	"link-fragments": false
 }

docs/.vuepress/config.js

@@ -24,29 +24,29 @@ module.exports = {
     ],
     base: '/OpenCore-Legacy-Patcher/',
 
-	watch: {
-	    $page(newPage, oldPage) {
-	      if (newPage.key !== oldPage.key) {
-	        requestAnimationFrame(() => {
-	          if (this.$route.hash) {
-	            const element = document.getElementById(this.$route.hash.slice(1));
+    watch: {
+        $page(newPage, oldPage) {
+            if (newPage.key !== oldPage.key) {
+                requestAnimationFrame(() => {
+                    if (this.$route.hash) {
+                        const element = document.getElementById(this.$route.hash.slice(1));
 
-	            if (element && element.scrollIntoView) {
-	              element.scrollIntoView();
-	            }
-	          }
-	        });
-	      }
-	    }
-	  },
+                        if (element && element.scrollIntoView) {
+                            element.scrollIntoView();
+                        }
+                    }
+                });
+            }
+        }
+    },
 
-	markdown: {
-		extendMarkdown: md => {
-			md.use(require('markdown-it-multimd-table'), {
-				rowspan: true,
-			});
-		}
-	},
+    markdown: {
+        extendMarkdown: md => {
+            md.use(require('markdown-it-multimd-table'), {
+                rowspan: true,
+            });
+        }
+    },
 
     theme: 'vuepress-theme-succinct',
     globalUIComponents: [
@@ -56,10 +56,10 @@ module.exports = {
     themeConfig: {
         lastUpdated: true,
         repo: 'https://github.com/dortania/OpenCore-Legacy-Patcher/',
-		docsDir: 'docs',
-		docsBranch: 'main',
-		editLinks: true,
-		editLinkText: 'Help us improve this page!',
+        docsDir: 'docs',
+        docsBranch: 'main',
+        editLinks: true,
+        editLinkText: 'Help us improve this page!',
         logo: 'homepage.png',
 
         sidebar: [{
@@ -67,44 +67,65 @@ module.exports = {
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'START',
-				'MODELS',
-				['BENIFITS', 'Benefits and drawbacks'],
+                'START',
+                'MODELS',
+                'FAQ',
             ]
 
         },
         {
-            title: 'Setting up',
+            title: 'How to install',
             collapsable: false,
             sidebarDepth: 1,
             children: [
                 'INSTALLER',
-				'BUILD',
+                'BUILD',                
+		'BOOT',
+                'POST-INSTALL',
             ]
 
         },
         {
-            title: 'Installation',
+            title: 'macOS Support',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'BOOT',
-				'POST-INSTALL',
+                'SEQUOIA-DROP',
+		'SONOMA-DROP',
+		'VENTURA-DROP',
+		'MONTEREY-DROP',
             ]
-
         },
+ {
+            title: 'Application',
+            collapsable: false,
+            sidebarDepth: 1,
+            children: [
+                'UPDATE',
+                'UNINSTALL',
+                'PROCESS',
+            ]
+        },
+	{
+            title: 'Troubleshooting',
+            collapsable: false,
+            sidebarDepth: 1,
+            children: [
+		'TROUBLESHOOTING',
+                'ACCEL',
+		'DEBUG',
+                
+            ]
+        },	  
         {
             title: 'Misc',
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'ACCEL',
-				'TROUBLESHOOTING',
-				'DEBUG',
-				'UPDATE',
-				'UNINSTALL',
-				'ICNS',
-				'WINDOWS',
+		'TIMEMACHINE',
+                'ICNS',
+                'WINDOWS',
+                'UNIVERSALCONTROL',
             ]
         },
         {
@@ -112,8 +133,8 @@ module.exports = {
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'DONATE',
-				'LICENSE',
+                'DONATE',
+                'LICENSE',
             ]
 
         },
@@ -122,22 +143,22 @@ module.exports = {
             collapsable: false,
             sidebarDepth: 1,
             children: [
-				'TESTED',
-				'TERMS',
-				'HOW',
-				'PATCHEXPLAIN',
-				'CLI',
+                'ISSUES-HOLD',
+                'TERMS',
+                'HOW',
+                'PATCHEXPLAIN',
             ]
 
         },
         ],
     },
     plugins: [
-        '@vuepress/plugin-back-to-top',
+        '@vuepress/back-to-top',
         'vuepress-plugin-smooth-scroll',
-        ['vuepress-plugin-medium-zoom',
+        'vuepress-plugin-fulltext-search',
+        ['@vuepress/medium-zoom',
             {
-                selector: "img",
+                selector: ".theme-succinct-content :not(a) > img",
                 options: {
                     background: 'var(--bodyBgColor)'
                 }

docs/.vuepress/styles/index.styl

@@ -47,3 +47,22 @@ tr
   background-color var(--sideBgColor)!important
   box-shadow 0px 0px 2px var(--bodyBgColor)
   right -12%!important
+
+
+@media (min-width: 1000px)
+  .theme-succinct-content:not(.custom)
+    max-width 70%
+
+.search-box .suggestion a .suggestion-row .page-title
+  border-color var(--borderColor) !important
+  background-color: var(--sideBgColor) !important
+
+.search-box .suggestion a .suggestion-row .suggestion-content
+  border-color var(--borderColor) !important
+
+.search-box .suggestion a .parent-page-title
+  background-color: var(--bodyBgColor) !important
+  color: var(--accentColor) !important
+
+.search-box .suggestion.focused a
+  color: var(--navItemHoverColor) !important

docs/.vuepress/styles/palette.styl

@@ -20,4 +20,6 @@ $accentColorDark = #30BCD5
 $textColorDark = #ccc
 $bodyBgColorDark = #2d3033
 $sideBgColorDark = #363b40
-$badgeTipColorDark = #023e52
+$badgeTipColorDark = #023e52
+
+$contentWidth = 900px

docs/ACCEL.md

@@ -1,19 +1,58 @@
-# Working Around Legacy Acceleration Issues
+# Working Around Non-Metal Issues
 
+* [Broken Background Blurs](#broken-background-blurs)
 * [Downloading older non-Metal Apps](#downloading-older-non-metal-apps)
 * [Unable to run Zoom](#unable-to-run-zoom)
 * [Unable to grant special permissions to apps (ie. Camera Access to Zoom)](#unable-to-grant-special-permissions-to-apps-ie-camera-access-to-zoom)
 * [Keyboard Backlight broken](#keyboard-backlight-broken)
 * [Photos and Maps Apps Heavily Distorted](#photos-and-maps-apps-heavily-distorted)
 * [Cannot press "Done" when editing a Sidebar Widget](#cannot-press-done-when-editing-a-sidebar-widget)
-* [Wake from sleep heavily distorted on AMD/ATI in macOS 11.3 and newer](#wake-from-sleep-heavily-distorted-on-amd-ati-in-macos-11-3-and-newer)
-* [Unable to achieve GPU Acceleration on 2011 15" and 17" MacBook Pros](#unable-to-achieve-gpu-acceleration-on-2011-15-and-17-macbook-pros)
+* [Wake from sleep heavily distorted on AMD/ATI from macOS 11.3 to Monterey](#wake-from-sleep-heavily-distorted-on-amd-ati-from-macos-11-3-to-monterey)
+* [Unable to switch GPUs on 2011 15" and 17" MacBook Pros](#unable-to-switch-gpus-on-2011-15-and-17-macbook-pros)
+* [Erratic Colours on ATI TeraScale 2 GPUs (HD5000/HD6000)](#erratic-colours-on-ati-terascale-2-gpus-hd5000-hd6000)
+* [Unable to allow Safari Extensions](#unable-to-allow-Safari-Extensions)
+* [Cannot Login on 2011 15" and 17" MacBook Pros](#cannot-login-on-2011-15-and-17-macbook-pros)
+* [Black Boxes on HD3000 iGPUs](#black-boxes-on-hd3000-igpus)
+* [Cannot Pair Bluetooth Devices](#cannot-pair-bluetooth-devices)
 
-The below page is for users experiencing issues with their overall usage of macOS Big Sur and the Legacy Graphics Acceleration patches. Note that the following GPUs currently do not have acceleration support in Big Sur:
+The below page is for users experiencing issues with their overall usage of macOS Big Sur / Monterey / Ventura and the Legacy Graphics Acceleration patches. Note that the following GPUs currently do not have acceleration support in Big Sur / Monterey / Ventura:
 
-* AMD/ATI TeraScale 2 - HD5/6000 series
 * Intel 3rd and 4th Gen - GMA series
 
+For those unfamiliar with what is considered a non-Metal GPU, see the chart below:
+
+::: details macOS GPU Chart
+
+Metal is Apple's in-house graphics API that acts as a replacement for OpenGL/OpenCL, introduced in 2015. With the release of macOS Mojave, every system without a Metal-capable GPU was dropped.
+
+| Graphics Vendor | Architecture | Series | Supports Metal |
+| :--- | :--- | :--- | :--- |
+| ATI | TeraScale 1 | HD 2XXX - HD 4XXX | <span style="color:red">No</span> |
+| ^^ | TeraScale 2 | HD 5XXX - HD 6XXX | ^^ |
+| AMD | GCN (and newer) | HD 7XXX+ | <span style="color:green">Yes</span> |
+| NVIDIA | Tesla | 8XXX - 3XX | <span style="color:red">No</span> |
+| ^^ | Fermi | 4XX - 5XX | ^^ |
+| ^^ | Kepler | 6XX - 7XX | <span style="color:green">Yes</span> |
+| ^^ | Maxwell | 8XX - 9XX | <span style="color:red">No (on 10.14 and newer)</span> |
+| ^^ | Pascal | 10XX | ^^ |
+| Intel | GMA | GMA 900 - GMA X3000 | <span style="color:red">No</span> |
+| ^^ | Iron Lake | HD series | ^^ |
+| ^^ | Sandy Bridge | HD 3000 | ^^ |
+| ^^ | Ivy Bridge (and newer) | HD 4000 | <span style="color:green">Yes</span> |
+
+:::
+
+## Broken Background Blurs
+
+By default with the non-Metal acceleration patches, many background blur menus may act distorted when moving a cursor over it. With 0.4.1 and newer, users can enable a new Beta Blur feature to try and resolve the issue:
+
+![]()
+
+<div align="left">
+             <img src="./images/OCLP-GUI-Settings-Beta-Blur.png" alt="Beta Blur settings" width="600" />
+</div>
+
+Do note that enabling beta blurs can be more demanding on slower hardware
 ## Downloading older non-Metal Apps
 
 Many Apple apps now have direct reliance on Metal for proper functioning, however legacy builds of these apps still do work in Big Sur. See below for archive of many apps such as Pages, iMovie, GarageBand.
@@ -29,8 +68,38 @@ Currently Zoom relies partially on Metal and so needs a small binary patch. Dosd
 * [Zoom Non-Metal Fix](http://dosdude1.com/catalina/zoomnonmetal-new.command.zip)
 
 ## Unable to grant special permissions to apps (ie. Camera Access to Zoom)
+Currently for Ventura 13.3 and newer, due to new patches required, permissions are yet again broken. Use TCCPlus in the Workaround dropdown to work around the issue.
 
-Due to the usage of `amfi_get_out_of_my_way=1`, macOS will fail to prompt users for special permissions upon application start as well as omit the entires in System Preferences. To work around this, we recommend users install [tccplus](https://github.com/jslegendre/tccplus) to manage permissions.
+This issue is fully resolved for 13.2.1 and lower starting from 0.2.5.
+
+::: details Workaround for 0.2.4, Ventura 13.3+
+
+Due to the usage of amfi_get_out_of_my_way=1, macOS will fail to prompt users for special permissions upon application start as well as omit the entries in System Preferences. To work around this, we recommend users install tccplus to manage permissions.
+
+[Download TCCPlus](https://github.com/jslegendre/tccplus)
+
+Example usage with Discord and microphone permissions:
+
+```sh
+# Open Terminal and run the following commands
+cd ~/Downloads/
+chmod +x tccplus
+./tccplus add Microphone com.hnc.Discord
+```
+
+For those who may experience issues with `tccplus`, you can manually patch `com.apple.TCC` to add permissions:
+
+```sh
+# get app id (Zoom.us used in example):
+$ osascript -e 'id of app "zoom.us"'
+# output: us.zoom.xos
+
+$ sudo sqlite3 ~/Library/Application\ Support/com.apple.TCC/TCC.db "INSERT or REPLACE INTO access VALUES('kTCCServiceMicrophone','us.zoom.xos',0,2,0,1,NULL,NULL,NULL,'UNUSED',NULL,0,1541440109);"
+
+$ sudo sqlite3 ~/Library/Application\ Support/com.apple.TCC/TCC.db "INSERT or REPLACE INTO access VALUES('kTCCServiceCamera','us.zoom.xos',0,2,0,1,NULL,NULL,NULL,'UNUSED',NULL,0,1541440109);"
+```
+
+:::
 
 ## Keyboard Backlight broken
 
@@ -42,24 +111,97 @@ Due to the Metal Backend, the enhanced color output of these apps seems to heavi
 
 ## Cannot press "Done" when editing a Sidebar Widget
 
-To work around this, simply press Tab to hover over and press spacebar to simulate a click.
+Workaround: Press some combination of Tab, or Tab and then Shift-Tab, or just Shift-Tab until the "Done" button is highlighted. Then press spacebar to activate the button, the same as in any other dialog with a highlighted button halo.
 
-## Wake from sleep heavily distorted on AMD/ATI in macOS 11.3 and newer
+## Wake from sleep heavily distorted on AMD/ATI from macOS 11.3 to Monterey
 
-Unfortunately a very well known issue the community is investigating, current known solution is to simply downgrade to 11.2.3 or older until a proper fix can be found.
+**Fixed for macOS Ventura starting from 0.6.6. Big Sur and Monterey will continue to exhibit the issue.**
+
+For older versions, only known solution is to downgrade to macOS 11.2.3 or older. Additionally, logging out and logging back in can resolve the issue without requiring a reboot.
+
+* Note, this issue should be exclusive to TeraScale 1 GPUs (ie. HD2000-4000). TeraScale 2 GPUs should not exhibit this issue.
 
 In the event Apple removes 11.2.3 from their catalogue, we've provided a mirror below:
 
 * [Install macOS 11.2.3 20D91](https://archive.org/details/install-mac-os-11.2.3-20-d-91)
 
-## Unable to achieve GPU Acceleration on 2011 15" and 17" MacBook Pros
+## Unable to switch GPUs on 2011 15" and 17" MacBook Pros
 
-Currently OpenCore Legacy Patcher doesn't have support for the TeraScale 2 series dGPUs found in the 15" and 17" models. Currently the best way to achieve graphics acceleration is to simply disable the dGPU and force the iGPU always.
+Currently, with OpenCore Legacy Patcher, GPU switching between the iGPU and dGPU is broken. The simplest way to set a specific GPU is to disable the dGPU when you wish to remain on the more power efficient iGPU.
 
-The best way to achieve this is to boot Recovery (or Single User Mode if the dGPU refuses to function at all) and run the following command:
+The best way to achieve this is to boot to Recovery (or Single User Mode if the dGPU refuses to function at all) and run the following command:
 
 ```sh
-nvram fa4ce28d-b62f-4c99-9cc3-6815686e30f9:gpu-power-prefs=%01%00%00%00
+nvram FA4CE28D-B62F-4C99-9CC3-6815686E30F9:gpu-power-prefs=%01%00%00%00
 ```
 
-This will disable the dGPU and allow graphics acceleration in Big Sur. Note that external display outputs are directly routed to the dGPU and therefore can no longer be used. Solutions such as a [DisplayLink Adapters](https://www.displaylink.com/products/usb-adapters) can work around this limitation.
+This will disable the dGPU and allow the iGPU to function in Big Sur. Note that external display outputs are directly routed to the dGPU and therefore can no longer be used. Solutions such as [DisplayLink Adapters](https://www.displaylink.com/products/usb-adapters) can work around this limitation, however, note that you'll need to use older drivers (5.2.6):
+
+* [DisplayLink USB Graphics Software for macOS - For Mojave and Catalina - 5.2.6](https://www.synaptics.com/products/displaylink-graphics/downloads/macos-5.2.6)
+
+Note: This driver only provides partial support in macOS, full graphics acceleration is not currently available on displays driven by DisplayLink.
+
+## Erratic Colours on ATI TeraScale 2 GPUs (HD5000/HD6000)
+
+Resolved with OpenCore Legacy Patcher v0.4.2
+
+::: details Legacy Fix (prior to 0.4.2)
+
+Due to an odd bug with ATI's TeraScale 2 GPUs, many users will experience erratic/strobing colours once finished installing accelerated patches and rebooting into macOS. The issue stems from an incorrect assumption in the GPU drivers where it will enforce the Billion Colour space on your display. To fix, simply force your Display into a lower color depth such as Million Colours.
+
+Applications that can set color depth are:
+
+* [SwitchResX](https://www.madrau.com)
+* [ResXtreme](https://macdownload.informer.com/resxtreme/)
+
+:::
+
+## Unable to allow Safari Extensions
+
+Due to a bug in the legacy acceleration patches, users won't be able to enable Safari Extensions.
+
+The following tool can be used to work-around this issue:
+
+* [Non-Metal Safari Extensions](https://github.com/moosethegoose2213/Non-Metal-Safari-Extensions/)
+
+## Cannot Login on 2011 15" and 17" MacBook Pros
+
+By default, OpenCore Legacy Patcher will assume MacBookPro8,2/3 have a faulty dGPU and disable acceleration. This is the safest option for most users as enabling dGPU acceleration on faulty Macs will result in failed booting.
+
+However, if your machine does not have the dGPU disabled via NVRAM, you'll experience a login loop. To work around this is quite simple:
+
+1. Boot macOS in Single User Mode
+    * Press Cmd+S in OpenCore's menu when you turn the Mac on
+2. When the command line prompt appears, enter the dGPU disabler argument (at the bottom)
+3. Reboot and patched macOS should work normally
+4. If you still want to use the dGPU, run OpenCore Legacy Patcher and enable TS2 Acceleration from settings. Go to `Patcher Settings -> Developer Settings -> Set TeraScale 2 Accel`, then root patch again.
+5. Either Reset NVRAM or set `gpu-power-prefs` to zeros to re-enable the dGPU
+
+```sh
+# Forces GMUX to use iGPU only (ie. disable dGPU)
+nvram FA4CE28D-B62F-4C99-9CC3-6815686E30F9:gpu-power-prefs=%01%00%00%00
+# To reset, simply write zeros or NVRAM Reset your Mac
+nvram FA4CE28D-B62F-4C99-9CC3-6815686E30F9:gpu-power-prefs=%00%00%00%00
+```
+
+## Black Boxes on HD3000 iGPUs
+
+A somewhat strange issue on Intel HD3000-based Macs, on 3rd party displays sometimes UI elements may become black and unreadable. To resolve, select either the generic `Display` or `Display P3` Color Profiles in Display Settings.
+
+* Mainly applicable for HDMI Displays, DVI and DisplayPort are generally unaffected.
+* If you're inside Setup Assistant, press `Cmd` + `Option` + `Control` + `T` to launch Terminal. From there, run `open /System/Applications/System\ Preferences.app`
+* Issue has spread to more Macs with macOS Ventura, including MacBook Airs and MacBook Pros
+
+| Default Color Profile | Display/Display P3 Profile |
+| :---                  | :---                       |
+| ![](./images/HD3000-Default-Colors.png) | ![](./images/HD3000-Display-Colors.png) |
+
+## Cannot Pair Bluetooth Devices
+
+In macOS Ventura, hover states may not function correctly which results in the "Connect" button not appearing in System Settings. To resolve:
+
+1. Enable Keyboard Navigation in System Settings -> Keyboard
+2. Tab + space over Bluetooth devices in System Settings -> Bluetooth
+3. Pair button should appear
+
+For more information, see [ASentientBot's post](https://forums.macrumors.com/threads/macos-13-ventura-on-unsupported-macs-thread.2346881/page-116?post=31858759#post-31858759).

docs/BENIFITS.md

@@ -1,24 +0,0 @@
-# Benefits and Drawbacks between OpenCore Legacy Patcher and other patchers
-
-With OpenCore Legacy Patcher we recommend users go through the below table to understand what the benefits and drawbacks are compared to other patchers. There are positive and negatives to each and we feel transparency is most important when patching another users machine. There should be no grey areas where users may be mislead.
-
-* Note: [Patched Sur](https://github.com/BenSova/Patched-Sur) and [MicropatcherAutomator](https://github.com/moosethegoose2213/automator-for-barrykn-micropatcher) are iterations of [BarryKN's micropatcher](https://github.com/barrykn/big-sur-micropatcher) and therefore share many of the same benefits and limitations. Patched Sur is used for this comparison as it's the most common form of BarryKN's patcher users will find.
-
-| Features | [OpenCore Legacy Patcher](https://github.com/dortania/OpenCore-Legacy-Patcher/) | [Patched Sur](https://github.com/BenSova/Patched-Sur) |
-| :--- | :--- | :--- |
-| Over The Air Updates | <span style="color:#30BCD5">Native System Preferences, additionally supports Deltas (~2GB) for Metal GPUs</span> | <span style="color:red">Inside Patcher Sur app (~12GB), only available when InstallAssistants release.</span> InstallAssistants generally available same day as System Preference updates, however developer betas will lag behind by 1 day compared to OTAs |
-| FileVault | <span style="color:#30BCD5">Supported on Metal GPUs</span> | <span style="color:red">Not supported</span> | 
-| System Integrity Protection | <span style="color:#30BCD5">Fully enabled on Metal GPUs</span> | <span style="color:red">Disabled for early 2013 and older during the patching process and first boot afterwards, otherwise enabled</span> |
-| APFS Snapshots | <span style="color:#30BCD5">Fully enabled</span> | <span style="color:red">Disabled</span> |
-| User facing | <span style="color:red">TUI interface</span> | <span style="color:#30BCD5">SwiftUI interface, more user friendly</span> | 
-| Supported OSes | <span style="color:#30BCD5">10.7-11</span> | <span style="color:red">10.15-11</span> |
-| Firmware Patching | <span style="color:#30BCD5">None required</span> | <span style="color:red">Required for models without native APFS support</span> |
-| BootCamp Switching | <span style="color:red">Requires EFI Conversion for Start Disk support, otherwise still supported</span> | <span style="color:#30BCD5">Native</span> |
-| Legacy GPU Acceleration | <span style="color:#30BCD5">In active development</span>, see Acceleration Progress Tracker: [Link](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108) | <span style="color:red">Currently not researching</span> |
-| El Capitan-era Wifi cards | <span style="color:#30BCD5">Supported</span> | <span style="colorred">Not supported</span> |
-| WPA Wireless Support | <span style="color:#30BCD5">Supported</span> | <span style="color:red">Minority may experience issues on early 2013 and older Models</span> |
-| Personal Hotspot Support | <span style="color:#30BCD5">Native</span> | <span style="color:red">Often requires extra steps to achieve on early 2013 and older Models</span> |
-| HEVC/H.265 Support for Mac Pros and iMacs with Polaris+ GPUs | <span style="color:#30BCD5">Supported</span> | <span style="color:red">Not supported</span> |
-| Big Sur-styled Boot Picker |  <span style="color:#30BCD5">Available</span>, though as a shim to the original boot picker | <span style="color:red">Not available</span> |
-| Hibernation Support | <span style="color:#30BCD5">Supports 3rd party SATA SSDs on 2011 and older models in addition to stock drives</span> | <span style="color:red">Only supports stock drives on 2011 and older models</span> |
-| Sidecar Support | <span style="color:#30BCD5">Supports any Mac with Metal Intel iGPU</span>, artifacting way exhibited on high movement screen content | <span style="color:red">Not supported at all</span> |

docs/BOOT.md

@@ -2,21 +2,115 @@
 
 Now we finally get to boot OpenCore!
 
-Reboot machine while holding `Option` to select the EFI Boot entry with the OpenCore icon (holding the `Control` key will make this the default boot entry):
+Reboot the machine while holding `Option` to select the EFI Boot entry with the OpenCore icon (holding the `Control` key will make this the default boot entry):
 
 * This will be the Mac Boot Picker
 
-![](../images/efi-boot.png)
 
-Now that you've loaded OpenCore, now select Install macOS!:
+<div align="left">
+             <img src="./images/efi-boot.png" alt="EFI boot" width="800" />
+</div>
+
+::: details Note for Mac Pros/Xserves/iMacs with unflashed GPUs
+
+(Adapted from the [OpenCore on the Mac Pro guide](https://forums.macrumors.com/threads/opencore-on-the-mac-pro.2207814/))
+
+For Mac Pro, Xserve and, iMac users with non-flashed GPUs, you can still easily boot OpenCore and view the entire boot process.
+
+Firstly, open the Terminal and run the following command:
+```sh
+sudo nvram "recovery-boot-mode=unused" && sudo reboot recovery
+```
+This will make your machine reboot into the Recovery Environment. Alternatively, holding `Command` + `R` when your machine is starting up will also let you enter the Recovery.
+
+Secondly, open the Recovery Environment's Terminal (Menu bar > Utilities > Terminal).
+
+Now you'll want to get a list of drive identifiers. To do so, run the following command:
+```sh
+diskutil list
+```
+The command should produce a list of drives installed in your system:
+
+<div align="left">
+             <img src="./images/Unflashed-Boot-1.png" alt="Unflashed boot" width="800" />
+</div>
+
+Keep track of the drive with the OCLP install. You will need the drive identifer for later.
+
+Now you'll want to mount the EFI partition (where OCLP is installed, though it may differ if you've installed OCLP to a FAT-32 volume).
+
+Run the following command (Replace X with the drive number):
+```sh
+diskutil mount diskXs1
+```
+
+<div align="left">
+             <img src="./images/Unflashed-Boot-2.png" alt="Unflashed boot 2" width="800" />
+</div>
+
+If everything is correct, the EFI partion should be mounted.
+
+Now you'll want to use the `bless` command to set the default boot device:
+```sh
+bless --mount /Volumes/EFI --setBoot --file /Volumes/EFI/System/Library/CoreServices/boot.efi
+```
+Once the command is run, it should produce no output.
+
+<div align="left">
+             <img src="./images/Unflashed-Boot-3.png" alt="Unflashed boot 3" width="800" />
+</div>
+
+If the command produces an output, ensure that you've typed it in correctly.
+
+Now you can reboot your machine. OCLP is now the default boot option!
+:::
+
+Now that you've loaded OpenCore, "select Install macOS":
 
 * This will be the OpenCore Picker
 
-![](../images/oc-boot.png)
+<div align="left">
+             <img src="./images/oc-boot.png" alt="OpenCore boot" width="800" />
+</div>
 
 
-After plenty of verbose booting, you will reach the installer screen! From there it's just like any normal macOS install. For an example of how the boot process looks, see the following video:
+You will soon reach the installer screen! If you enabled verbose mode when building OCLP, a lot of text will run across the screen. From there, it's just like any normal macOS install. For an example of how the boot process looks, see the following video:
 
 * [OpenCore Legacy Patcher Boot Process](https://www.youtube.com/watch?v=AN3zsbQV_n4)
 
+**Important:** If you're using a brand new disk that has not been used before, choose "View -> Show all devices" in Disk Utility and format the entire disk by choosing the topmost option in the sidebar to avoid a missing internal EFI later when trying to boot OpenCore to internal disk.
+
+
+<div align="left">
+             <img src="./images/wipe-disk.png" alt="Wipe disk" width="800" />
+</div>
+
+::: warning Warning for T1 Macs
+
+When installing macOS Sonoma or newer on a T1 system (2016-2017), full disk wipe will remove T1 functionality (touchbar etc). Therefore when installing, only wipe the volume containing the operating system.  
+
+<div align="left">
+             <img src="./images/wipe-volume.png" alt="WipeVolume" width="800" />
+</div>
+
+[More info here](https://dortania.github.io/OpenCore-Legacy-Patcher/TROUBLESHOOTING.html#no-t1-functionality-after-installing-sonoma-or-newer)
+
+:::
+
+
+If your Mac is looping back into the beginning of the setup after the first reboot, turn it off, start it again and hold Option. This time (after choosing `EFI Boot` first) select the option with a grey hard disk icon in the OpenCore picker. It can either say `macOS Installer` or the name you gave the disk during the installer process. Keep repeating this step after every reboot if necessary.
+
+<div align="left">
+             <img src="./images/oclp-stuck-firstreboot.png" alt="Stuck on first reboot" width="800" />
+</div>
+
+
+::: warning
+
+**MacBookPro11,3 Note**: When booting macOS Monterey, you'll need to boot into safe mode if acceleration patches are not installed yet. [Otherwise, you'll hit a black screen due to missing NVIDIA drivers.](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/522) Safe Mode can be entered by holding `Shift + Enter` when selecting macOS Monterey in OCLP's Boot Menu.
+
+:::
+
+
 # Once installed and booting, head to [Post-Installation](./POST-INSTALL.md)
+

docs/BUILD.md

@@ -1,37 +1,40 @@
 # Building and installing OpenCore
 
-Now that we have a macOS installer, lets now build our OpenCore configuration!
+Now that we have a macOS installer, let's now build our OpenCore configuration!
 
-First Download the latest release: 
+If you haven't downloaded OpenCore Patcher yet, do so now:
 
 * [OpenCore Legacy Patcher Releases](https://github.com/dortania/Opencore-Legacy-Patcher/releases)
 
-Next, run the `OpenCore-Patcher.app`:
+Next, run the `OpenCore-Patcher.app`
 
-![](../images/first-run.png)
+Here we'll select Build and Install OpenCore and start building:
 
-From here you have a couple important options:
 
-* Build OpenCore
-* Install OpenCore to USB/internal drive
-* Change Model
-* Patcher Settings 
+<div align="left">
+             <img src="./images/OCLP-GUI-Main-Menu.png" alt="OCLP GUI Main Menu" width="700" />
+</div>
 
-If you're patching for a different machine than you're running, please select "Change Model" and enter the updated SMBIOS. For more advanced users, you may also tweak the patcher's build settings via "Patcher Settings"
+::: warning
+OpenCore configurations are hardware specific.
+If you're building OpenCore for a different model than you're currently running, it is absolutely necessary to select the proper model from Settings.
+:::
 
-Now lets enter "Build OpenCore":
 
-![](../images/build-efi.png)
-
-The process should be quite quick to build, once finished you'll be plopped back to the main menu.
-
-Next lets run `Install OpenCore to USB/internal drive`:
-
-| Select Drive | Select EFI/FAT32 Partition |
+| Start Building | Finished Building |
 | :--- | :--- |
-| ![](../images/disk-start.png) | ![](../images/disk-efi.png) |
+| <img src="./images/OCLP-GUI-Build-Start.png" alt="Build start" width="600" /> | <img src="./images/OCLP-GUI-Build-Finished.png" alt="Build finished" width="600" /> |
 
-  * If you have issues, please ensure you install OpenCore onto a FAT32 partition to ensure your Mac is able to boot it. You will need to format your drive as GUID/GPT in Disk Utility
-  
 
-# Once finished, head to [Booting OpenCore and macOS](./BOOT.md)
+Once it finishes building, you'll want to select the Install OpenCore button:
+
+* If you created a macOS USB manually and don't see it listed, make sure it's either formatted as GUID/GPT or has a FAT32 partition for OpenCore to reside on.
+
+
+| Select Drive | Select Partition |
+| :--- | :--- |
+| <img src="./images/OCLP-GUI-EFI-Select-Disk.png" alt="Select disk" width="600" /> | <img src="./images/OCLP-GUI-EFI-Select-Partition.png" alt="Select partition" width="600" /> |
+
+
+
+# Once finished, head to [Booting OpenCore and macOS](./BOOT.md)

docs/CLI.md

@@ -1,41 +0,0 @@
-# Command Line Args
-
-With OpenCore Legacy Patcher, we include an extra binary called [OCLP-CLI](https://github.com/dortania/OpenCore-Legacy-Patcher/releases/). The purpose of this binary is to easily run our OpenCore build process for other programs to hook onto. Below is documentation on currently supported arguments.
-
-### Build Arguments
-
-* **--build**: Build OpenCore
-  * **--model xxxx**: override default model detection
-    * ex. **--model iMac11,2**
-  * **--metal_gpu xxxx**: override default GPU detection (ie. Nvidia, AMD)
-    * **--metal_gpu Nvidia** 
-  * **--smbios_spoof xxxx**: set spoofing mode, defaults to Minimal if no arg provided (ie. Minimal, Moderate, Advanced)
-    * ex. **--smbios_spoof Moderate** 
-  * **--verbose**: enable verbose booting
-  * **--debug_oc**: enable debug OpenCore
-  * **--debug_kext**: enable debug kexts
-  * **--skip_wifi**: skip wifi patch
-  * **--hide_picker**: hide OpenCore's picker
-  * **--disable_sip**: disables SIP
-  * **--disable_smb**: disables SecureBootModel
-  * **--vault**: enable OpenCore vaulting
-  
-Example usage:
-
-```bash
-./OCLP-CLI --build --verbose --debug_oc --debug_kext --model iMac11,2
-```
-
-Note, when building OpenCore the output folder will be next to the OCLP binary as OpenCore-RELEASE or OpenCore-DEBUG folder.
-
-### Patch System Arguments
-
-* **--patch_sys_vol**: patches root volume with detected hardware
-
-Example usage:
-
-```bash
-sudo ./OCLP-CLI --patch_sys_vol
-```
-
-Note, root volume patching needs to be run as sudo

docs/DEBUG.md

@@ -1,29 +1,35 @@
 # How to debug with OpenCore
 
-For those who've hit an odd bug and unsure if it's user error or patcher, the below will tell you how to get more verbose debug information as well as logs to help [file issues with us](https://github.com/dortania/OpenCore-Legacy-Patcher/issues)
-
-* For users who are less experienced, we recommend asking on the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN) for help.
+For those who've hit an odd bug and are unsure if it's user error or within the patcher, we recommend asking on the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN) for help.
 
 ## Debugging yourself
 
-The easiest way to debug yourself is via Patcher Settings. Here there are many different settings however the 3 main options that will help are:
+The easiest way to debug yourself is via Patcher Settings. Here there are many different settings, however, the 3 main options that will help are:
 
 * "Enable Verbose Mode"
 * "Enable OpenCore DEBUG"
 * "Enable Kext DEBUG"
 
+<div align="left">
+             <img src="./images/ocdebugimage.png" alt="OCLP debug" width="600" />
+</div>
+
 
 When you've enabled these 3 options, rebuild OpenCore and install to your drive. This will provide much greater debug information as well as write logs to the EFI Partition.
 
 ## Obtaining OpenCore logs from disk
 
-With "Enable OpenCore DEBUG" set, every boot there will be a .txt file generated in your disk. To grab these logs, [download and run MountEFI](https://github.com/corpnewt/MountEFI):
+With "Enable OpenCore DEBUG" set, on every boot there will be a .txt file generated on the EFI Partition. To grab these logs, [download and run MountEFI](https://github.com/corpnewt/MountEFI):
 
-![](../images/mountefi.png)
+<div align="left">
+             <img src="./images/mountefi.png" alt="Mount EFI" width="600" />
+</div>
 
 Once you've mounted the EFI Partition of the drive you have macOS on, you should see some nice logs:
 
-![](../images/logs-efi.png)
+<div align="left">
+             <img src="./images/logs-efi.png" alt="Mount EFI" width="800" />
+</div>
 
 ## Obtaining Kernel logs from macOS
 
@@ -37,13 +43,17 @@ From there, you'll have a log on your desktop.
 
 ## Filing an issue with us
 
-Now that you have proper logs, you can now [file issues with us](https://github.com/dortania/OpenCore-Legacy-Patcher/issues). Reminder we want the following info:
+::: warning
+Currently issues have been disabled due to [current events](ISSUES-HOLD.md). You can continue to receive support in the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN), where there are active members of the community available.
+:::
 
-* Model patching for (ie. MacBookPro10,1)
+Now that you have proper logs, you can now [file issues with us](https://github.com/dortania/OpenCore-Legacy-Patcher/issues). This is a reminder to include the following info:
+
+* Model that you're patching for (ie. MacBookPro10,1)
 * Target OS (ie. macOS 11.2.3)
 * Host OS (ie. macOS 10.15.7)
 * Upload of your OpenCore Build Folder
 * Upload of your OpenCore log (if applicable)
 * Upload of your Kernel log (if applicable)
 
-Additionally, please search whether the issue has been reported before. This avoids having duplicate issues.
+Additionally, please search to see if the issue has been reported before. This avoids having duplicate issues.

docs/DONATE.md

@@ -1,35 +1,7 @@
 # Supporting the patcher
 
-OpenCore Legacy Patcher is a hobby project for us developers, and while we love helping out the community it's very difficult for us to troubleshoot issues remotely. The best way for us to get to work on the patcher, fix issues and add enhancements is having the hardware in-hand. As a hobby project, neither of the main developers can afford to buy every legacy Mac to test on.
+We have opened OpenCollective in order to manage donations as well as be transparent about where the donated money is going. If you want to support the patcher with money donation, you can do so below.
 
-The best way to support us in all honesty is to donate any old hardware you no longer need, as this allows us to have machines to test locally and push fixes much faster. While we appreciate cash donations, this makes it much more difficult for us to handle as an organization.
+[OpenCollective](https://opencollective.com/opencore-legacy-patcher)
 
-Main sections of help we'd appreciate:
-
-* Donating any Mac you own
-  * Does require SSE4,1 CPU to test on Sierra and newer however
-* Donating any spare SATA SSDs
-  * Having extra SSDs on hand allows us to quickly and easily test specific builds of macOS without having to wipe drives and reinstall as much
-* Aiding by buying items in our Amazon Wishlist
-  * Currently we have a few members within Dortania testing so we recommend messaging the email listed below to see which member at the time would something purchased the most 
-  
-Additionally, hardware info dumps are greatly beneficial for us to determine what patches a machine might need:
-
-* [IORegistryExplorer](https://github.com/khronokernel/IORegistryClone/blob/master/ioreg-210.zip?raw=true)
-  * `File -> SaveAs` and open an issue on Github
-  * Note: We want IOReg dumps of hardware not running on OpenCore, instead running a clean, supported OS
-
-If you have any legacy hardware you're willing to donate or what to buy us something, please contact us at the following email:
-
-* khronokernel@icloud.com
-
-Current hardware we own:
-
-| Model | CPU | GPU | Owner | Notes |
-| :--- | :--- | :--- | :--- | :--- |
-| MacBook7,1 | Penryn | GT320M | Dhinak | N/A |
-| MacBook7,1 | Penryn | GT320M | Mykola | N/A |
-| MacBookPro8,1 | Sandy Bridge | HD 3000 | Mykola | N/A |
-| MacBookPro5,3 | Penryn | 9400M + 9600M | Dhinak | Display's partially broken |
-| Macmini4,1 | Penryn | GT320M | Dhinak | N/A |
-| iMac11,2 | Clarksdale | HD4670 | Mykola | N/A |
+If you wish, you can also donate legacy hardware you don't need anymore as long as it makes sense logistically. In this case, reach out on the Discord server.

docs/FAQ.md

@@ -0,0 +1,154 @@
+# FAQ
+
+
+* [Application requirements](#application-requirements)
+* [How do I make sure I'm all up to date?](#how-do-i-make-sure-i-m-all-up-to-date)
+* [Why are the settings "not saving"?](#why-are-the-settings-not-saving)
+* [Can I use the same USB install media as a universal installer?](#can-i-use-the-same-usb-install-media-as-a-universal-installer)
+* [Can I use OTA updates?](#can-i-use-ota-updates)
+* [Can I use automatic updates?](#can-i-use-automatic-updates)
+* [Why are macOS updates so large?](#why-are-macos-updates-so-large)
+* [Can I update to macOS betas?](#can-i-update-to-macos-betas)
+* [Can I downgrade macOS while keeping data?](#can-i-downgrade-macos-while-keeping-data)
+* [Why is my system slow?](#why-is-my-system-slow)
+* [What is Metal and non-Metal?](#what-is-metal-and-non-metal)
+* [What are FeatureUnlock and mediaanalysisd?](#what-are-featureunlock-and-mediaanalysisd)
+* [Why isn't iPhone Mirroring working?](#why-isn-t-iphone-mirroring-working)
+* [Where is Apple Intelligence?](#where-is-apple-intelligence)
+
+
+
+## Application requirements
+The patcher application requires **OS X Yosemite 10.10** or later to run.
+* **OS X El Capitan 10.11** or later is required to make installers for macOS Ventura and later.
+
+The patcher is designed to target **macOS Big Sur 11.x to macOS Sequoia 15.x**.
+* Other versions may work, albeit in a broken state. No support is provided for any version outside of the above.
+
+## How do I make sure I'm all up to date?
+
+Updating the OCLP installation is a three step process, first the application, second the bootloader and finally root patches.
+
+Refer to [Updating OpenCore and patches](https://dortania.github.io/OpenCore-Legacy-Patcher/UPDATE.html) for how to update the application and patches.
+
+## Why are the settings "not saving"?
+
+Starting with OpenCore Legacy Patcher 2.1.0, the status of settings in the GUI will now be saved under ```/Users/Shared/.com.dortania.opencore-legacy-patcher.plist```. The application will utilize this file to keep track of and retain settings for relaunches and application updates, no longer requiring a reconfiguring each time. The user interface will reset if any model other than "Host Model" is selected, as building for a different model will require different settings.
+
+In case of issues, delete the file and restart the application to revert the GUI to default settings, then rebuild OpenCore with newly configured settings.
+
+::: warning
+
+Only settings made within OCLP are accounted for, modifications made directly into the ```config.plist``` file in the EFI partition outside of OCLP **will continue to reset**. Additionally, modifying ```config.plist``` manually may lead to a state where settings showed in the GUI are not in sync compared to settings in use, due to the application not knowing whether the file has been manually modified. 
+
+:::
+
+::: details Explainer for older versions (click to expand)
+
+OpenCore Legacy Patcher is a config build tool and as such the user interface always reverts to safe defaults, the user interface therefore **does not** reflect the status of settings. Settings are accounted for and saved by the OpenCore building process and you will always have to build OpenCore again after settings change. 
+
+Settings are saved to a config.plist file inside your EFI partition.
+
+In SIP settings, booted SIP is reported in text form e.g. "0x803" but the checkboxes **do not** reflect the applied settings. Refer to [SIP Settings](https://dortania.github.io/OpenCore-Legacy-Patcher/POST-INSTALL.html#sip-settings) for more information.
+
+:::
+
+## Can I use the same USB install media as a universal installer?
+
+OpenCore configurations are device specific, due to different quirks needed for different systems. If you are building OpenCore for a different system that you're running, you will have to select the targeted model from Settings before building OpenCore on the USB media.
+
+When building OpenCore on a different system, OCLP cannot be aware of all the hardware installed in the target, meaning safe defaults will be used. However, this may not be the most optimal experience especially with custom hardware. As such it's recommended to rebuild OpenCore **on device** to apply settings that are based on hardware detection, after the OS has been installed.
+
+## Can I use OTA updates?
+
+You can. However it is extremely recommended to use USB drive for major OS upgrades (such as 13 -> 14) to avoid larger issues from potentially occurring.
+
+General updates are usually fine, though it is always a good idea to wait few days to see whether patches break and have to be fixed.
+
+## Can I use automatic updates?
+
+It is extremely recommended to disable automatic updates (even downloading) when using OCLP, as Apple has recently changed the way automatic updates work. Updates are now getting staged during the download process and are already modifying the system volume, which can lead to broken system out of nowhere since the operating system gets into a liminal state between two versions. You can still manually initiate an update when you're ready to do so. 
+
+For a related "System version mismatch" error while root patching and more information, refer to [System version mismatch error when root patching](https://dortania.github.io/OpenCore-Legacy-Patcher/TROUBLESHOOTING.html#system-version-mismatch-error-when-root-patching) for troubleshooting.
+
+### Disabling updates
+
+**macOS Ventura and newer:**
+
+System Settings -> General -> Software Update -> (i) button next to Automatic Updates -> Disable "Download new updates when available".
+
+**macOS Big Sur and Monterey:**
+
+System Preferences -> Software Update -> Advanced -> Disable "Download new updates when available".
+
+## Why are macOS updates so large?
+
+macOS by default uses a sealed system volume that is unwritable. When the seal is broken, macOS thinks the volume is broken and downloads a full copy of macOS for every update to "repair" it to a known state. In order for root patching to work, this seal has to be broken since root patching by design requires on-disk file manipulation. This is also why root patches have to be reinstalled after each update.
+
+## Can I update to macOS betas?
+
+If you are feeling brave and don't mind having to possibly recover your system. However, be advised that no help will be given in situations where a beta was installed.
+
+
+## Can I downgrade macOS while keeping data?
+
+macOS doesn't allow direct downgrades, as such you will have to wipe the disk in order to revert. Backup your data beforehand either via Time Machine, ASR or some other solution.
+
+## Why is my system slow?
+
+This can mean many things. Firstly, newer operating systems are harder to run and can appear more slow. 
+
+Additionally if your macOS installation is recent, Spotlight starts creating a full disk index which can cause high CPU load, high temps and general slowness. It's recommended to keep the system running for few hours, once Spotlight has indexed the load will ease. A way to check whether it's caused by Spotlight is to open Activity Monitor, choosing "All Processes" from the "View" menu item, then sorting by the CPU value to see if a process called ```mds_stores``` is using a lot of CPU resources.
+
+However, if your system is being **really** slow and you have no transparency in Dock and menubar, this typically indicates that root patches are not installed and as such there is no acceleration. Make sure to install root patches to get proper drivers and functionality. Refer to [Applying post install volume patches](https://dortania.github.io/OpenCore-Legacy-Patcher/POST-INSTALL.html#applying-post-install-volume-patches) and the [Troubleshooting](https://dortania.github.io/OpenCore-Legacy-Patcher/TROUBLESHOOTING.html) section for more information.
+
+Patches can also break if automatic updates are enabled and an update modifies the system volume, refer to [System version mismatch error when root patching](https://dortania.github.io/OpenCore-Legacy-Patcher/TROUBLESHOOTING.html#system-version-mismatch-error-when-root-patching) for more information.
+
+## What is Metal and Non-Metal?
+
+Metal is Apple's proprietary graphics API which fully superseded OpenGL rendering of the operating system starting from macOS Mojave. When the word "Non-Metal" is used, it describes GPUs that are not Metal supported and require using OpenGL instead.
+
+GPUs that support Metal are as follows:
+
+* Intel HD 4000 series (Ivy Bridge/3rd gen) and newer
+* AMD HD 7000 series and newer (GCN 1)
+* NVIDIA GTX 600 and 700 series (Kepler)
+
+Everything older than mentioned are Non-Metal and therefore only support OpenGL. A great rule of thumb is that Macs older than 2012 are non-Metal, with the exception of systems with upgradable GPUs. Non-Metal also includes NVIDIA Maxwell (GTX 900 series) and Pascal (GTX 1000 series) when used with patched Web Drivers on newer than macOS High Sierra.
+
+Refer to [Supported models](https://dortania.github.io/OpenCore-Legacy-Patcher/MODELS.html) and [Working Around Non-Metal Issues](https://dortania.github.io/OpenCore-Legacy-Patcher/ACCEL.html) pages for more information.
+
+Due to deprecation of OpenGL, many newer applications may require Metal rendering and as such will fail to run on systems with Non-Metal GPUs.
+
+
+## What are FeatureUnlock and mediaanalysisd?
+
+FeatureUnlock is an extension to enable some macOS features, such as Sidecar or Universal Control. All features enabled by FeatureUnlock are listed [here](https://github.com/acidanthera/FeatureUnlock). Medianalysisd is utilized for face detection in Photos, as well as the Live Text feature. 
+
+These features have the potential to cause instability in many places and as such a decision has been made to disable them by default (mediaanalysisd only on 3802-based* systems) starting from OpenCore Legacy Patcher version 2.1.0.  If you want to enable these features at the risk of additional instability, you can do so in the OCLP settings and rebuilding OpenCore.
+
+| FeatureUnlock | mediaanalysisd |
+| :--- | :--- |
+| ![FeatureUnlock](./images/OCLP_FeatureUnlock_Setting.png) | ![mediaanalysisd](./images/OCLP_Disable_mediaanalysisd_Setting.png) |
+
+
+::: details *3802 systems list (click to expand)
+
+* NVIDIA
+    * Kepler (600-800 series GPUs)
+* Intel
+    * Ivy Bridge (3rd generation, HD 4000 series GPUs)
+    * Haswell (4th generation, HD/Iris 4000-5000 series GPUs)
+
+These GPUs are typically met in systems from 2012-2015.
+
+:::
+
+## Why isn't iPhone Mirroring working?
+
+iPhone Mirroring requires a T2 chip, which means it will not be available on OCLP patched systems. The connection fails due to failure to establish T2 attestation.
+
+## Where is Apple Intelligence?
+
+Apple Intelligence requires Neural Engine, which is only found in Apple Silicon chips.
+

docs/HOW.md

@@ -1,9 +1,9 @@
 # Boot Process with OpenCore Legacy Patcher
 
-OpenCore Legacy Patcher itself is actually quite a "dumb" program, and essentially edits a config.plist file and moves files around, it actually has little logic regarding the boot process.  The real magic of OCLP is [OpenCorePkg](https://github.com/acidanthera/OpenCorePkg), our back-end and what makes this patcher so powerful.
+OpenCore Legacy Patcher itself is actually quite a "dumb" program. It essentially edits a config.plist file and moves files around, actually having little logic regarding the boot process.  The real magic of OCLP is [OpenCorePkg](https://github.com/acidanthera/OpenCorePkg), our back-end, and what makes this patcher so powerful.
 
 ## Boot Process with OpenCore
 
-To understand a bit more of how OpenCore is able revive older Macs in such a native-like way, we need to go over *how* OpenCore works with your Mac:
+To understand a bit more of how OpenCore is able to revive older Macs in such a native-like way, we need to go over *how* OpenCore works with your Mac:
 
-![](../images/oc-explained.png)
+![](./images/oc-explained.png)

docs/ICNS.md

@@ -1,13 +1,11 @@
 # Creating custom icons for OpenCore and Mac Boot Picker
 
-For users who want to customize your setup to be more personal, OpenCore does allow for custom icons and images in the boot picker.
-
+For users who want to customize their setup to be more personal, OpenCore does allow for custom icons and images in the boot picker.
 
 * [Custom OpenCore icons](#custom-opencore-icons)
 * [Custom Mac Boot Picker icons](#custom-mac-boot-picker-icons)
 * [Installing updated icons](#installing-updated-icons)
 
-
 # Custom OpenCore icons
 
 To generate custom OpenCore icons, you'll need the following:
@@ -29,59 +27,59 @@ To generate custom OpenCore icons, you'll need the following:
   * ResetNVRAM — Reset NVRAM system action or tool (128x128).
   * Shell — Entry with UEFI Shell name for e.g. OpenShell (128x128).
   * Tool — Any other tool (128x128).
-  
-Note, for each image we recommend having one of double the size. This ensures that icons are scaled correctly since .icns support dedicated images depending on HiDPI or not.
 
+Note, for each image we recommend having one of double the size. This ensures that icons are scaled correctly since .icns support dedicated images depending on HiDPI or not.
 
 Once you have a custom image you want to use(for example, as a background), download the [latest release of OpenCorePkg](https://github.com/acidanthera/OpenCorePkg/releases) and enter the `Utilities/icnspack/` folder:
 
-![](../images/icnspack-folder.png)
+![](./images/icnspack-folder.png)
 
-Now `cd` this folder in terminal and run the following:
+Now `cd` to this folder in terminal and run the following:
 
 ```sh
 ./icnspack Background.icns <insert_x1_image> <insert_x2_image>
 ```
+
 Once done, you'll see your custom icon generated in `icnspack`'s folder:
 
-![](../images/icnspack-done.png)
+![](./images/icnspack-done.png)
 
 # Custom Mac Boot Picker icons
 
-Custom boot picker icons is much more complicated on Legacy Macs, on late 2013+ Macs the [Custom OpenCore icons](#custom-opencore-icons) method will work just fine. However on many 2012 and older Macs, the icons generated will be incompatible with the firmware.
+Custom boot picker icons are much more complicated on Legacy Macs. On late 2013+ Macs, the [Custom OpenCore icons](#custom-opencore-icons) method will work just fine. However, on many 2012 and older Macs, the icons generated will be incompatible with the firmware.
 
 To generate legacy icons, you'll need the following:
 
 * A machine running macOS 10.4 through 10.11
 * Icon Composer.app (Requires Apple Developer Account for official download)
-  * Users without the developer account can find a mirrors here: 
+  * Users without a developer account can find mirrors here:
     * [Icon Composer 10.6](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/main/docs/Icon-Composer-10.6.zip)
     * [Icon Composer 10.11](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/main/docs/Icon-Composer-10.11.zip)
 * PNG Image you wish to convert
 
 Head to [developer.apple's More Downloads page](https://developer.apple.com/download/more/) and search for `Graphics Tools` that is supported by your OS(note for 10.6 and older, the app is hidden inside `Developer Tools`):
 
-![](../images/graphics-download.png)
+![](./images/graphics-download.png)
 
 Once downloaded, open the disk image and you'll find Icon Composer.app:
 
-![Graphics Open](../images/graphics-open.png)
+![Graphics Open](./images/graphics-open.png)
 
 Now run the app and simply drag the images to each section as so:
 
-![](../images/icon-SL.png)
+![](./images/icon-SL.png)
 
-Now save and export the new icns
+Now save and export the new icns file.
 
 # Installing updated icons
 
-To install, please ensure that Vault is disabled when you built OpenCore. If you're unsure, simply rebuild OpenCore with the Patcher setting "Vault" set to false.
+To install, please ensure that Vault was disabled when you built OpenCore. If you're unsure, simply rebuild OpenCore with the Patcher setting "Vault" set to false.
 
 * <span style="color:red"> Warning</span>: Editing your OpenCore EFI incorrectly can result in a bricked install. Please ensure you have a natively supported version of macOS installed to boot into in case of issues.
 
-Now that you've verified you can edit OpenCore safely, you'll need to mount the drive that OpenCore is stored on. To do this, download [MountEFI](https://github.com/corpnewt/MountEFI) and run it:
+Now that you've verified that you can edit OpenCore safely, you'll need to mount the drive that OpenCore is stored on. To do this, download [MountEFI](https://github.com/corpnewt/MountEFI) and run it:
 
-![](../images/mountefi.png)
+![](./images/mountefi.png)
 
 Select the drive you installed OpenCore to and mount it.
 
@@ -92,14 +90,14 @@ Select the drive you installed OpenCore to and mount it.
 
 Head to `EFI/OC/Resources/Image/` on your drive and you'll see all the custom icons. For Background.icns, we need to ensure the file matches the theme OpenCore has set so we add the prefix `Modern` to it:
 
-![](../images/background-moved.png)
+![](./images/background-moved.png)
 
 Now reboot and you should see your updated icon(s)!
 
 ### Updating Mac Boot Picker icons
 
-To update the Mac Boot Picker icons is actually quite simple, on the root of your drive simply drop the icon onto the root of the drive with the name `.VolumeIcon.icns`
+Updating the Mac Boot Picker icons is actually quite simple. On the root of your drive, simply drop the icon into the root of the drive with the name `.VolumeIcon.icns`
 
-![](../images/mac-icns-drive.png)
+![](./images/mac-icns-drive.png)
 
-Now reboot and you'll see the new icon!
+Now reboot and you'll see the new icon!

docs/INSTALLER.md

@@ -1,58 +1,42 @@
-# Download and build macOS Installers
+# Creating macOS Installers
 
-* [Downloading](#downloading)
-* [Building](#building)
+This document is centered around downloading and writing the macOS installer to a USB drive. If you're planning to install macOS on other system than you're currently running, it is recommended to choose the Mac model in Settings now before proceeding, so that automatic root patching works correctly later on.
 
-This doc is centered around downloading and writing the macOS installer to a USB. If you're already familiar with how to do this, you can skip.
+* Note: A 32GB drive is recommended, later versions of Sonoma and Sequoia cannot fit installer and patches to a 16GB disk. 16GB drive may work for older versions.
 
-* Note: 16GB+ USB will be required for the installer
 
-## Downloading
+## Downloading the installer
 
-The simplest way to download macOS installs would be to use installinstallmacos:
+To start off, you'll want to grab the app:
 
-```sh
-[ ! -d ~/macOS-installer/ ] && mkdir ~/macOS-installer; cd ~/macOS-installer; [ ! -f ~/macOS-installer/installinstallmacos.py ] && curl -O https://raw.githubusercontent.com/munki/macadmin-scripts/main/installinstallmacos.py; sudo python installinstallmacos.py
-```
-* Note: On El Capitan (10.11) and older, you'll need to specify a catalog at the end of the command:
+* [OpenCore Legacy Patcher Release Apps](https://github.com/dortania/OpenCore-Legacy-Patcher/releases)
 
-```
---catalogurl https://swscan.apple.com/content/catalogs/others/index-11-10.15-10.14-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog
-```
+Once downloaded, open the app and you should be greeted by the main menu. 
 
-![](../images/munki.png)
+First, we'll want to select the "Create macOS Installer" button. This will present you with 2 options.
 
-As you can see, we get a nice list of macOS installers. If you need a particular versions of macOS, you can select it by typing the number next to it. For this example we'll choose 10:
+For this example, we'll assume you'll need an installer. Select the "Download macOS installer" to get you a list of installers. Click to download the version you want.
 
-![](../images/munki-process.png)
+| Main menu | Installer creation menu | Available installers |
+| :--- | :--- | --- |
+| ![OCLP GUI Main Menu](./images/OCLP-GUI-Main-Menu.png) | ![OCLP GUI Installer Create Installer Menu](./images/OCLP-GUI-Create-Installer-Menu.png) | ![OCLP GUI Installer Download Listed Products](./images/OCLP-GUI-Installer-Download-Listed-Products.png) |
 
-This is going to take a while as we're downloading the entire 12GB+ macOS installer.
 
-Once finished, you'll find in your `~/macOS-Installer/` folder a DMG containing the macOS Installer, called `Install_macOS_11.1-20C69.dmg` for example. Mount it and you'll find the installer application.
+## Creating the installer
 
-* Note: We recommend to move the Install macOS.app into the `/Applications` folder, as we'll be executing commands from there.
-* Note 2: Running Cmd+Shift+G in Finder will allow you to easily jump to `~/macOS-installer`
+Once the download is finished, you can proceed to write the installer onto a USB drive.
 
-![](../images/munki-done-2.png)
+* Note: The entire USB drive will be formatted
 
-![](../images/munki-dmg.png)
+| Select Downloaded Installer | Select disk to format |
+| :--- | :--- |
+| <img src="./images/OCLP-GUI-Installer-Select-Local-Installer.png" alt="Select local installer" width="600" /> | <img src="./images/OCLP-GUI-Installer-Format-USB.png" alt="Select disk to format" width="600" /> |
 
-## Building
 
-Now we'll be formatting the USB to prep for both the macOS installer and OpenCore. We'll want to use macOS Extended (HFS+) with a GUID partition map(Using GUID is important for the patcher). This will create two partitions: the main `MyVolume` and a second called `EFI` which is used as a boot partition where your Mac's firmware will check for boot files. `EFI` partitions will be hidden by default, so don't worry if you don't immediately see them.
+Now the patcher will start the installer flashing!
 
-* Note: By default, Disk Utility only shows partitions – press Cmd/Win+2 to show all devices (alternatively you can press the View button)
-
-![Formatting the USB](../images/format-usb.png)
-
-Next run the `createinstallmedia` command provided by [Apple](https://support.apple.com/en-us/HT201372). Note that the command is made for USB's formatted with the name `MyVolume`:
-
-```sh
-sudo /Applications/Install\ macOS\ Big\ Sur.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume
-```
-
-* Note: You can also replace the `createinstallmedia` path with that of where your installer's located (same idea with the drive name).
-
-![](../images/createinstallmedia.png)
+| Flashing | Success Prompt | Finished Flashing |
+| :--- | :--- | :--- |
+| ![](./images/OCLP-GUI-Installer-Flashing-Process.png) | ![](./images/OCLP-GUI-Installer-Sucess-Prompt.png) | ![](./images/OCLP-GUI-Installer-Finished-Script.png) |
 
 # Once finished, head to [Building and installing OpenCore](./BUILD.md)

docs/ISSUES-HOLD.md

@@ -0,0 +1,17 @@
+# The current hold on new issues and pull requests
+
+As written with the release of OpenCore Legacy Patcher 0.4.3, and macOS 12.3:
+
+> With today's macOS 12.3 release, I decided it would be best to release this build of OpenCore Legacy Patcher to ensure some important issues are resolved with today's release (namely Open/Save dialog problem introduced by Apple in the 12.3 Betas)
+> 
+> As the situation develops back home with my family in Ukraine, I am unlikely to continue the development of OpenCore Legacy Patcher in the near future. At most, there may be potential PatcherSupportPkg updates from ASentientBot and the rest of the amazing non-Metal development team however otherwise development may potentially be taken over by others later on. Issues will continue to remain closed for the time being.
+>
+> With regards to the future of this project, this release should be treated as its last major release for the next couple of months. When WWDC2022 is presented, I hope my country will be in a calmer situation where we can tinker with Macs again peacefully.
+>
+> This is not a final goodbye for me with this project, just a round-about way to say I'll be returning someday. I want to give the biggest thank you's to the community and to the many amazing developers within it. OpenCore Legacy Patcher is not just my project, it's the cumulation of many people that are all responsible for where we are today.
+>
+> -- Mykola
+
+If you encounter new issues with the patcher that do not have solutions easily available, our helpful community in the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN) can provide support in the meantime. You should still provide as much information as you can by [gathering debug logs](DEBUG.md) when you ask for help.
+
+<!-- And from us developers, tinkerers, and dreamers in this little community, it's definitely a mutual thanks and welcome! crystall1nedev <3 -->

docs/LICENSE.md

@@ -1,4 +1,4 @@
-# OpenCore Legacy Patcher Licence
+# OpenCore Legacy Patcher License
 
 This patcher is made of multiple external applications from different people and organizations. See each program for their licensing:
 
@@ -9,31 +9,17 @@ This patcher is made of multiple external applications from different people and
   * [AirportBrcmFixup](https://github.com/acidanthera/AirportBrcmFixup/blob/master/LICENSE.txt)
   * [CPUFriend](https://github.com/acidanthera/CPUFriend/blob/master/LICENSE)
   * [RestrictEvents](https://github.com/acidanthera/RestrictEvents/blob/master/LICENSE.txt)
-  * [NightShiftEnabler](https://github.com/cdf/NightShiftEnabler/blob/master/LICENSE.txt)
+  * [FeatureUnlock](https://github.com/acidanthera/FeatureUnlock/blob/master/LICENSE.txt)
   * [Innie](https://github.com/cdf/Innie/blob/master/LICENSE.txt)
 * GPL 2.0
   * [NVMeFix](https://github.com/acidanthera/NVMeFix/blob/master/LICENSE.txt)
 * All rights reserved to respective authors
   * [AAAMouSSE](https://forums.macrumors.com/threads/mp3-1-others-sse-4-2-emulation-to-enable-amd-metal-driver.2206682/) - Syncretic
   * [telemetrap](https://forums.macrumors.com/threads/mp3-1-others-sse-4-2-emulation-to-enable-amd-metal-driver.2206682/post-28447707) - Syncretic
-  * [SidecarFixup](https://github.com/khronokernel/SidecarFixup) - Khronokernel
+  * [SurPlus](https://github.com/reenigneorcim/SurPlus) - Syncretic
+  * [VMM Patch Set](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/4a8f61a01da72b38a4b2250386cc4b497a31a839/payloads/Config/config.plist#L1222-L1281) - parrotgeek1
+  * AMFIPass - Dhinak G
   * Apple Binaries - Apple Inc.
+  * All other patches - respective authors
 
-Remaining files within OpenCore Legacy Patcher are copyrighted 2020-2021 Mykola Grymalyuk & Dhinak G, under the BSD-3 Clause license:
-
-```
-Copyright (c) 2020-2021, Dhinak G
-Copyright (c) 2020-2021, Mykola Grymalyuk
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-```
+The remaining files within the OpenCore Legacy Patcher repository are distributed under the [BSD 4-Clause license](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/main/LICENSE.txt).

docs/MODELS.md

@@ -1,13 +1,17 @@
 # Supported Models
 
-Any hardware supporting SSE4.1 CPU and 64-Bit firmware work on this patcher. To check your hardware model, run the below command on the applicable machine in terminal:
+Any Intel-based Mac listed below can install and make use of OpenCore Legacy Patcher. To check your hardware model, open System Information and look for the `Model Identifier` key.
+* This applies even if Apple supports the model natively.
+* OpenCore Legacy Patcher does not support PowerPC- or Apple Silicon-based Macs.
+* If your model is not listed below, it is not supported by this patcher.
 
-```bash
-system_profiler SPHardwareDataType | grep 'Model Identifier'
-```
+::: warning Note
+It is **extremely recommended** to update your Mac to its latest native version before using OpenCore Legacy Patcher, to ensure you're on the highest firmware.
+:::
 
-The below table will list all supported and unsupported functions of the patcher currently:
 
+
+The below tables can be used to reference issues with a particular model, and see which OS would work best on your machine.
 * [MacBook](#macbook)
 * [MacBook Air](#macbook-air)
 * [MacBook Pro](#macbook-pro)
@@ -16,123 +20,130 @@ The below table will list all supported and unsupported functions of the patcher
 * [Mac Pro](#mac-pro)
 * [Xserve](#xserve)
 
-Regarding OS support, see below:
-
-| Support Entry | Supported OSes | Description | Comment |
-| :--- | :--- | :--- | :--- |
-| HostOS | macOS 10.9 - macOS 11 | Refers to OSes where running OpenCore-Patcher.app are supported | Supports 10.7+ if [Python 3.6 or higher](https://www.python.org/downloads/) is manually installed, simply run the `OpenCore-Patcher.command` located in the repo |
-| TargetOS | macOS 11 | Refers to OSes that can be patched to run with OpenCore | May support 10.4 and newer (in a potentially broken state). No support provided. |
 
 ### MacBook
 
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| MacBook1,1 | Mid-2006 | <span style="color:red"> NO </span>  | 32-Bit CPU limitation |
-| MacBook2,1 | Late 2006 | ^^ | 32-Bit Firmware limitation |
-| MacBook3,1 | Late 2007 | ^^ | ^^ |
-| MacBook4,1 | Early 2008 | <span style="color:#30BCD5"> YES </span> | - No GPU Acceleration in Mavericks and newer<br/>- No Keyboard and Trackpad<br/>- No USB |
-| MacBook5,1 | Late 2008 | ^^ | - GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108))<br/> |
-| MacBook5,2 | Early 2009 | ^^ | - GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108))<br/>- Trackpad is recognized as mouse<br/>- Brightness control partially supported |
-| MacBook6,1 | Late 2009 | ^^ | - GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108))<br/> |
-| MacBook7,1 | Mid-2010 | ^^ | ^^ |
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| MacBook (13-inch, Aluminum, Late 2008) | `MacBook5,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)|
+| MacBook (13-inch, Early 2009)<br>MacBook (13-inch, Mid 2009) | `MacBook5,2` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)<br>- Trackpad gestures are partially broken |
+| MacBook (13-inch, Late 2009) | `MacBook6,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021) |
+| MacBook (13-inch, Mid 2010) | `MacBook7,1` | ^^ |
+| MacBook (Retina, 12-inch, Early 2015) | `MacBook8,1` | - [Legacy Metal (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| MacBook (Retina, 12-inch, Early 2016) | `MacBook9,1` | ^^ |
+| MacBook (Retina, 12-inch, 2017) | `MacBook10,1` | - Native graphics support |
 
 ### MacBook Air
 
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| MacBookAir1,1 | Early 2008 | <span style="color:red"> NO </span> | Requires SSE4.1 CPU |
-| MacBookAir2,1 | Late 2008 |<span style="color:#30BCD5"> YES </span> | GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)) |
-| MacBookAir3,1 | Late 2010 | ^^ | ^^ |
-| MacBookAir3,2 | ^^ | ^^ | ^^ |
-| MacBookAir4,1 | Mid-2011 | ^^ | ^^ |
-| MacBookAir4,2 | ^^ | ^^ | ^^ |
-| MacBookAir5,1 | Mid-2012 |^^ | <span style="color:green"> Everything is supported</span> |
-| MacBookAir5,2 | ^^ | ^^ | ^^ |
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| MacBook Air (13-inch, Late 2008)<br>MacBook Air (13-inch, Mid 2009) | `MacBookAir2,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)|
+| MacBook Air (11-inch, Late 2010) | `MacBookAir3,1` | ^^ |
+| MacBook Air (13-inch, Late 2010) | `MacBookAir3,2` | ^^ |
+| MacBook Air (11-inch, Mid 2011) | `MacBookAir4,1` | ^^ |
+| MacBook Air (13-inch, Mid 2011) | `MacBookAir4,2` | ^^ |
+| MacBook Air (11-inch, Mid 2012) | `MacBookAir5,1` | - [Legacy Metal (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| MacBook Air (13-inch, Mid 2012) | `MacBookAir5,2` | ^^ |
+| MacBook Air (11-inch, Mid 2013)<br>MacBook Air (11-inch, Early 2014) | `MacBookAir6,1` | ^^ |
+| MacBook Air (13-inch, Mid 2013)<br>MacBook Air (13-inch, Early 2014) | `MacBookAir6,2` | ^^ |
+| MacBook Air (11-inch, Early 2015) | `MacBookAir7,1` | ^^ |
+| MacBook Air (13-inch, Early 2015)<br>MacBook Air (13-inch, 2017) | `MacBookAir7,2` | ^^ |
+| MacBook Air (Retina, 13-inch, 2018) | `MacBookAir8,1` | - Supported natively up to Sonoma<br>- Currently not supported on Sequoia due to T2 issues<br> |
+| MacBook Air (Retina, 13-inch, 2019) | `MacBookAir8,2` | ^^ |
+| MacBook Air (Retina, 13-inch, 2020) | `MacBookAir9,1` | Supported by Apple |
 
 ### MacBook Pro
 
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| MacBookPro1,1 | Early 2006 | <span style="color:red"> NO </span>  | 32-Bit CPU limitation |
-| MacBookPro1,2 | ^^ | ^^ | ^^ |
-| MacBookPro2,1 | Late 2006 | ^^ | 32-Bit Firmware limitation |
-| MacBookPro2,2 | Late 2006 | ^^ | ^^ |
-| MacBookPro3,1 | Mid-2007 | ^^ | Requires SSE4.1 CPU |
-| MacBookPro4,1 | Early 2008 | <span style="color:#30BCD5"> YES </span> | GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)) |
-| MacBookPro5,1 | Late 2008 | ^^ | ^^ |
-| MacBookPro5,2 | Early 2009 | ^^ | ^^ |
-| MacBookPro5,3 | Mid-2009 | ^^ | ^^ |
-| MacBookPro5,4 | ^^ | ^^ | ^^ |
-| MacBookPro5,5 | ^^ | ^^ | ^^ |
-| MacBookPro6,1 | Mid-2010 | ^^ | ^^ |
-| MacBookPro6,2 | ^^ | ^^ | ^^ |
-| MacBookPro7,1 | ^^ | ^^ | ^^ |
-| MacBookPro8,1 | Early 2011 | ^^ | ^^ |
-| MacBookPro8,2 | ^^ | ^^ | ^^ |
-| MacBookPro8,3 | ^^ | ^^ | ^^ |
-| MacBookPro9,1 | Mid-2012 | ^^ | <span style="color:green"> Everything is supported</span> |
-| MacBookPro9,2 | ^^ | ^^ | ^^ |
-| MacBookPro10,1 | Mid-2012, Early 2013 | ^^ | ^^ |
-| MacBookPro10,2 | Late 2012, Early 2013 | ^^ | ^^ |
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| MacBook Pro (15-inch, Early 2008)<br>MacBook Pro (17-inch, Early 2008) | `MacBookPro4,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)|
+| MacBook Pro (15-inch, Late 2008)<br>MacBook Pro (15-inch, Early 2009) | `MacBookPro5,1` | ^^ |
+| MacBook Pro (17-inch, Early 2009)<br>MacBook Pro (17-inch, Mid 2009) | `MacBookPro5,2` | ^^ |
+| MacBook Pro (15-inch, Mid 2009) | `MacBookPro5,3`<br>`MacBookPro5,4` | ^^ |
+| MacBook Pro (13-inch, Mid 2009) | `MacBookPro5,5` | ^^ |
+| MacBook Pro (17-inch, Mid 2010) | `MacBookPro6,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108) |
+| MacBook Pro (15-inch, Mid 2010) | `MacBookPro6,2` | ^^ |
+| MacBook Pro (13-inch, Mid 2010) | `MacBookPro7,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021) |
+| MacBook Pro (13-inch, Early 2011)<br>MacBook Pro (13-inch, Late 2011) | `MacBookPro8,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108) |
+| MacBook Pro (15-inch, Early 2011)<br>MacBook Pro (15-inch, Late 2011) | `MacBookPro8,2` | ^^ |
+| MacBook Pro (17-inch, Early 2011)<br> | `MacBookPro8,3` | ^^ |
+| MacBook Pro (15-inch, Mid 2012) | `MacBookPro9,1` | - [Legacy Metal (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| MacBook Pro (13-inch, Mid 2012) | `MacBookPro9,2` | ^^ |
+| MacBook Pro (Retina, 15-inch, Mid 2012)<br>MacBook Pro (Retina, 15-inch, Early 2013) | `MacBookPro10,1` | ^^ |
+| MacBook Pro (Retina, 13-inch, Late 2012)<br>MacBook Pro (Retina, 13-inch, Early 2013) | `MacBookPro10,2` | ^^ |
+| MacBook Pro (Retina, 13-inch, Late 2013)<br>MacBook Pro (Retina, 13-inch, Mid 2014) | `MacBookPro11,1` | ^^ |
+| MacBook Pro (Retina, 15-inch, Late 2013)<br>MacBook Pro (Retina, 15-inch, Mid 2014) | `MacBookPro11,2`<br>`MacBookPro11,3` | ^^ |
+| MacBook Pro (Retina, 15-inch, Mid 2015) | `MacBookPro11,4`<br>`MacBookPro11,5` | ^^ |
+| MacBook Pro (Retina, 13-inch, Early 2015) | `MacBookPro12,1` | ^^ |
+| MacBook Pro (13-inch, 2016, 2 Thunderbolt 3 ports) | `MacBookPro13,1` | ^^ |
+| MacBook Pro (13-inch, 2016, 4 Thunderbolt 3 ports) | `MacBookPro13,2` | ^^ |
+| MacBook Pro (15-inch, 2016) | `MacBookPro13,3` | ^^ |
+| MacBook Pro (13-inch, 2017, 2 Thunderbolt 3 ports) | `MacBookPro14,1` | - Native graphics support |
+| MacBook Pro (13-inch, 2017, 4 Thunderbolt 3 ports) | `MacBookPro14,2` | ^^ |
+| MacBook Pro (15-inch, 2017) | `MacBookPro14,3` | - [Legacy Metal (macOS 14+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| MacBook Pro (13-inch, 2018, 4 Thunderbolt 3 ports)<br>MacBook Pro (13-inch, 2019, 4 Thunderbolt 3 ports) | `MacBookPro15,2` | - Supported by Apple |
+| MacBook Pro (15-inch, 2018)<br>MacBook Pro (15-inch, 2019) | `MacBookPro15,1` | ^^ |
+| MacBook Pro (13-inch, 2019, 2 Thunderbolt 3 ports) | `MacBookPro15,4` | ^^ |
+| MacBook Pro (16-inch, 2019) | `MacBookPro16,1`<br>`MacBookPro16,4` | ^^ |
+| MacBook Pro (13-inch, 2020, 4 Thunderbolt 3 ports) | `MacBookPro16,2` | ^^ |
+| MacBook Pro (13-inch, 2020, 2 Thunderbolt 3 ports) | `MacBookPro16,3` | ^^ |
 
 ### Mac mini
 
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| Macmini1,1 | Early 2006 | <span style="color:red"> NO </span> | 32-Bit CPU limitation |
-| Macmini2,1 | Mid-2007 | ^^ | 32-Bit Firmware limitation |
-| Macmini3,1 | Early 2009 | <span style="color:#30BCD5"> YES </span> | GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)) |
-| Macmini4,1 | Mid-2010 | ^^ | ^^ |
-| Macmini5,1 | Mid-2011 | ^^ | ^^ |
-| Macmini5,2 | ^^ | ^^ | ^^ |
-| Macmini5,3 | ^^ | ^^ | ^^ |
-| Macmini6,1 | Late 2012 | ^^ | <span style="color:green"> Everything is supported</span> |
-| Macmini6,2 | ^^ | ^^ | ^^ |
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| Mac mini (Early 2009) | `Macmini3,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021) |
+| Mac mini (Mid 2010) | `Macmini4,1` | ^^ |
+| Mac mini (Mid 2011) | `Macmini5,1`<br>`Macmini5,2`<br>`Macmini5,3` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108) |
+| Mac mini (Late 2012) | `Macmini6,1`<br>`Macmini6,2` | - [Legacy Metal (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| Mac mini (Late 2014) | `Macmini7,1` | ^^ |
+| Mac mini (Late 2018) | `Macmini8,1` | - Supported by Apple |
 
 ### iMac
-
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| iMac4,1 | Early 2006 | <span style="color:red"> NO </span> | 32-Bit CPU limitation |
-| iMac4,2 | Mid-2006 | ^^ | ^^ |
-| iMac5,1 | Late 2006 | ^^ | 32-Bit Firmware limitation |
-| iMac5,2 | ^^ | ^^ | ^^ |
-| iMac6,1 | ^^ | ^^ | ^^ |
-| iMac7,1 | Mid-2007 | <span style="color:#30BCD5"> YES </span> | - Requires an [SSE4.1 CPU Upgrade](https://lowendmac.com/2018/penryn-t9300-9500-cpu-upgrades-for-the-2007-imac/)<br/>- GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108))<br/>- Brightness control partially supported on Nvidia GPUs, AMD unsupported<br/>- Stock Bluetooth 2.0 card non-functional  |
-| iMac8,1 | Early 2008 | ^^ | - GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)))<br/>- Brightness control partially supported on Nvidia GPUs, AMD unsupported |
-| iMac9,1 | Early 2009 | ^^ | ^^ |
-| iMac10,1 | Late 2009 | ^^ | - GPU is socketed, [recommend upgrading to Metal GPU](https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/?post=17425857#post-17425857) <br/>- GPU Acceleration in Public Beta, see current issues ([#108](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)) |
-| iMac11,1 | ^^ | ^^ | ^^ |
-| iMac11,2 | Mid-2010 | ^^ | ^^ |
-| iMac11,3 | ^^ | ^^ | ^^ |
-| iMac12,1 | Mid-2011 | ^^ | ^^ |
-| iMac12,2 | ^^ | ^^ | ^^ |
-| iMac13,1 | Late 2012 | ^^ | <span style="color:green"> Everything is supported</span> |
-| iMac13,2 | ^^ | ^^ | ^^ |
-| iMac13,3 | ^^ | ^^ | ^^ |
-| iMac14,1 | Late 2013 | ^^ | ^^ |
-| iMac14,2 | ^^ | ^^ | ^^ |
-| iMac14,3 | ^^ | ^^ | ^^ |
-
-* For iMac10,1 through iMac12,x, we highly recommend users upgrade the GPU to a Metal supported model. See here for more information: [iMac late 2009 to mid-2011 Graphics Card Upgrade Guide](https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/?post=17425857#post-17425857)
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| iMac (20-inch, Mid 2007)<br>iMac (24-inch, Mid 2007) | `iMac7,1` | - [Requires SSE4.1 CPU](https://lowendmac.com/2018/penryn-t9300-9500-cpu-upgrades-for-the-2007-imac/)<br>- [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)<br>- Remove stock Bluetooth to prevent panics |
+| iMac (20-inch, Early 2008)<br>iMac (24-inch, Early 2008) | `iMac8,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021) |
+| iMac (20-inch, Early 2009)<br>iMac (24-inch, Early 2009)<br>iMac (20-inch, Mid 2009) | `iMac9,1` | - [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)<br>- [Recommend upgrading to Metal GPU](https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/?post=17425857#post-17425857) |
+| iMac (21.5-inch, Late 2009)<br>iMac (27-inch, Late 2009)| `iMac10,1` | ^^ |
+| iMac (27-inch, Late 2009) | `iMac11,1` | ^^ |
+| iMac (21.5-inch, Mid 2010) | `iMac11,2` | ^^ |
+| iMac (27-inch, Mid 2010) | `iMac11,3` | ^^ |
+| iMac (21.5-inch, Mid 2011)<br>iMac (21.5-inch, Late 2011) | `iMac12,1` | ^^ |
+| iMac (27-inch, Mid 2011) | `iMac12,2` | ^^ |
+| iMac (21.5-inch, Late 2012) | `iMac13,1` | - [Legacy Metal (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| iMac (27-inch, Late 2012) | `iMac13,2` | ^^ |
+| iMac (21.5-inch, Early 2013) | `iMac13,3` | ^^ |
+| iMac (21.5-inch, Late 2013) | `iMac14,1` | ^^ |
+| iMac (27-inch, Late 2013) | `iMac14,2`<br>`iMac14,3` | ^^ |
+| iMac (21.5-inch, Mid 2014) | `iMac14,4` | ^^ |
+| iMac (Retina 5K, 27-inch, Late 2014)<br>iMac (Retina 5K, 27-inch, Mid 2015) | `iMac15,1` | ^^ |
+| iMac (21.5-inch, Late 2015) | `iMac16,1` | ^^ |
+| iMac (Retina 4K, 21.5-inch, Late 2015) | `iMac16,2` | ^^ |
+| iMac (Retina 5K, 27-inch, Late 2015) | `iMac17,1` | ^^ |
+| iMac (21.5-inch, 2017) | `iMac18,1` | - Native graphics support |
+| iMac (Retina 4K, 21.5-inch, 2017) | `iMac18,2` | ^^ |
+| iMac (Retina 5K, 27-inch, 2017) | `iMac18,3` | ^^ |
+| iMac (Retina 5K, 27-inch, 2019) | `iMac19,1` | - Supported by Apple |
+| iMac (Retina 4K, 21.5-inch, 2019) | `iMac19,2` | ^^ |
+| iMac (Retina 5K, 27-inch, 2020) | `iMac20,1`<br>`iMac20,2` | ^^ |
+| iMac Pro (2017) | `iMacPro1,1` | ^^ |
 
 ### Mac Pro
 
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| MacPro1,1 | Mid-2006 | <span style="color:red"> NO </span> | 32-Bit Firmware limitation |
-| MacPro2,1 | Mid-2007 | ^^ | ^^ |
-| MacPro3,1 | Early 2008 | <span style="color:#30BCD5"> YES </span> | - Potential boot issues with built-in USB 1.1 ports (recommend using a USB 2.0 hub or dedicated USB PCIe controller)<br/>- Potential boot issues with stock Bluetooth card, recommend removing to avoid kernel panics |
-| MacPro4,1 | Early 2009 | ^^ | <span style="color:green"> Everything is supported as long as GPU is Metal capable </span> |
-| MacPro5,1 | Mid-2010, Mid-2012 | ^^ | ^^ |
-
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| Mac Pro (Early 2008) | `MacPro3,1` | -  [Recommend upgrade to Metal GPU](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008)<br>- [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)<br>- Remove stock Bluetooth to prevent panics |
+| Mac Pro (Early 2009) | `MacPro4,1` | - [Recommend upgrade to Metal GPU](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008)<br>- [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021) |
+| Mac Pro (Mid 2010)<br>Mac Pro (Mid 2012) | `MacPro5,1` | ^^ |
+| Mac Pro (Late 2013) | `MacPro6,1` | - [Legacy Metal (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008) |
+| Mac Pro (2019) | `MacPro7,1` | - Supported by Apple |
 
 ### Xserve
 
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| Xserve1,1 | Mid-2006 | <span style="color:red"> NO </span> | 32-Bit Firmware limitation |
-| Xserve2,1 | Early 2008 | <span style="color:#30BCD5"> YES </span> | <span style="color:green"> Everything is supported as long as GPU is Metal capable </span> |
-| Xserve3,1 | Early 2009 | ^^ | ^^ |
+| Model Name | Identifier | Additional info |
+| :--- | :--- | :--- |
+| Xserve (Early 2008) | `Xserve2,1` | - Recommend upgrade to Metal GPU<br>- [non-Metal GPU (macOS 11+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)<br>- [USB 1.1 (macOS 13+)](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)
+| Xserve (Early 2009) | `Xserve3,1` | ^^ |
 
 # Once you've verified your hardware is supported, head to [Download and build macOS Installers](./INSTALLER.md)

docs/MONTEREY-DROP.md

@@ -0,0 +1,170 @@
+# macOS Monterey
+
+![](./images/macos-monterey.png)
+
+With OpenCore Legacy Patcher v0.1.7 and newer, we've implemented beta macOS Monterey support for users. Please note that Apple has dropped a lot of hardware with this release as well as broken many of our previous patch sets. This page will be used to inform users regarding current issues and will be updated as new patch sets are developed and added to our patcher.
+
+## Newly dropped hardware
+
+With Monterey, Apple continues their their somewhat ruthless march of dropping Intel hardware. This release saw the removal, and thus addition into OpenCore Legacy Patcher, of the following models:
+
+* iMac14,4
+* iMac15,1
+* MacBook8,1
+* MacBookAir6,1
+* MacBookAir6,2
+* MacBookPro11,1
+* MacBookPro11,2
+* MacBookPro11,3
+
+::: details Model names
+
+* iMac (21.5-inch, Mid 2014)
+* iMac (Retina 5K, 27-inch, Late 2014)
+* MacBook (Retina, 12-inch, Early 2015)
+* MacBook Air (11-inch, Mid 2013)
+* MacBook Air (13-inch, Mid 2013)
+* MacBook Air (11-inch, Early 2014)
+* MacBook Air (13-inch, Early 2014)
+* MacBook Pro (Retina, 13-inch, Late 2013)
+* MacBook Pro (Retina, 15-inch, Late 2013)
+* MacBook Pro (Retina, 13-inch, Mid 2014)
+* MacBook Pro (Retina, 15-inch, Mid 2014)
+
+:::
+
+All of these models now have support in OpenCore Legacy Patcher.
+
+## Current Monterey Issues
+
+### MacBookPro11,3 booting issue without Kepler acceleration
+
+Due to the display being routed through the NVIDIA Kepler card and macOS being rendered on the Intel iGPU, users have been experiencing issues booting without post-install patches applied ([see here for more info](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/522).) Currently the only workaround is to install the patches in safe mode, by holding down `Shift+Enter` when you select macOS in the OCLP boot picker.
+
+## Previously Broken Hardware
+
+::: details iMac15,1 5K Display Output Issue (Resolved in 0.3.2 and newer)
+
+* Documentation:
+  * [5K iMac and UEFI: Fixing the dreaded output limitation](https://khronokernel.github.io/macos/2021/12/08/5K-UEFI.html)
+* Associated Github Issue:
+  * [5k Output issues on iMac15,1 (27" 5k iMac - 2014) #359](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/359)
+
+:::
+
+::: details macOS 12.0 Beta 4 issue on 2012 to early 2013 machines (Resolved in 0.2.5 and newer)
+
+Currently in macOS 12.0 Beta 4, many Ivy Bridge Macs have experienced Bluetooth issues relating to their BCM20702 chipset. Currently the exact issue is unknown however is assumed to be a bug on Apple's end. Recommend downgrading to macOS 12.0 Beta 3 till resolved:
+
+* [12.0 Beta 3 (21A5284e) InstallAssistant (Direct)](http://swcdn.apple.com/content/downloads/02/08/071-63739-A_G5RYVW5JHT/dfz5gp3s0jm9vl7m30oewq141zkpv8edr8/InstallAssistant.pkg)
+* [12.0 Beta 3 (21A5284e) InstallAssistant (archive.org)](https://archive.org/details/12.0-21a5284e-beta-3)
+
+A temporary fix is to restart the BlueTool and bluetoothd process with each boot, note it may not work for all users:
+
+```sh
+sudo killall -9 BlueTool bluetoothd
+```
+
+:::
+
+::: details Wireless Support Dropped (Resolved in 0.2.5 and newer)
+
+* Broadcom BCM94328, BCM94322 and Atheros Wireless Chipsets lost support
+
+The following models lost Wifi support in macOS Monterey due to their legacy Wireless chipset:
+
+* iMac12,x and older
+* Macmini3,1 and older
+* MacBook5,x and older
+* MacBookAir2,1 and older
+* MacBookPro7,1 and older
+  * MacBookPro6,x is exempt
+* MacPro5,1 and older
+
+Note: BCM943224, BCM94331, BCM94360 and BCM943602 are still fully supported by OpenCore Legacy Patcher
+
+:::
+
+::: details Bluetooth Support Dropped (Resolved in 0.2.5 and newer)
+
+* BRCM2046 and BRCM2070 Bluetooth Chipsets lost support
+
+The following models lost Bluetooth support in macOS Monterey due to their legacy Bluetooth chipset:
+
+* iMac12,x and older
+* Macmini5,1 and older
+* MacBook7,1 and older
+* MacBookAir4,1 and older
+* MacBookPro8,1 and older
+* MacPro5,1 and older
+
+Note: Native BRCM20702 and BRCM20703 are still fully supported by OpenCore Legacy Patcher
+
+::: details Dropped Firmwares
+
+Here are the firmwares macOS Monterey Dropped (previously located within IOBluetoothUSBDFU.kext):
+
+* 2046_820F.dfu
+* 2046_8210.dfu
+* 2046_8213.dfu
+* 2046_8215.dfu
+* 2046_8216.dfu
+* 2046_8217.dfu
+* 2070_821A.dfu
+* 2070_821B.dfu
+* 2070_8218.dfu
+* 20702_821D.dfu
+* 20702_821F.dfu
+* 20702_828A.dfu
+* 20702_828B.dfu
+* 20702_828C.dfu
+* 20702_8281.dfu
+* 20702_8286.dfu
+
+:::
+
+::: details Ivy Bridge iGPU Acceleration (Resolved in 0.1.7 and newer)
+
+* Intel HD4000 iGPUs lost support
+
+By default these machines require root volume patches to gain graphics acceleration in Monterey. OpenCore Legacy Patcher supports readding support however SIP can no longer be enabled due to root patching:
+
+* Macmini6,x
+* MacBookAir5,x
+* MacBookPro9,x
+* MacBookPro10,x
+
+:::
+
+::: details NVIDIA Kepler dGPU Acceleration (Resolved in 0.2.5 and newer)
+
+* NVIDIA Kepler dGPUs lost support
+
+By default these machines require root volume patches to gain graphics acceleration in Monterey. OpenCore Legacy Patcher supports readding support however SIP can no longer be enabled due to root patching:
+
+* MacBookPro9,1
+* MacBookPro10,1
+* MacBookPro11,3
+* iMac13,x
+* iMac14,x
+
+:::
+
+::: details Non-Metal Acceleration (Resolved in 0.2.5 and newer)
+
+* Non-Metal GPUs no longer have working acceleration patches:
+  * Intel Ironlake and Sandy Bridge iGPUs
+  * NVIDIA Tesla and Fermi GPUs
+  * AMD TeraScale 1 and 2 GPUs
+
+The following machines cannot gain graphics acceleration at all in Monterey, only basic framebuffer and brightness control (iMac8,1/9,1 and MacBook5,2 excluded):
+
+* iMac12,x and older
+* Macmini5,x and older
+* MacBook7,1 and older
+* MacBookAir4,x and older
+* MacBookPro8,x and older
+
+Note: iMac10,1 through iMac12,x can be upgraded with Metal GPUs, [see here for more info](https://forums.macrumors.com/threads/2011-imac-graphics-card-upgrade.1596614/)
+
+:::

docs/PATCHEXPLAIN.md

@@ -1,6 +1,6 @@
 # Explaining the patches in OpenCore Legacy Patcher
 
-In our patcher, there are numerous patches used to ensure a stable system. Here we're going to go over what patches are used and why we recommend or even require them.
+In our patcher, there are numerous patches used to ensure a stable system. Here, we're going to go over what patches are used and why we recommend or even require them.
 
 * [OpenCore Settings](#opencore-settings)
 * [Injected Kexts](#injected-kexts)
@@ -8,18 +8,44 @@ In our patcher, there are numerous patches used to ensure a stable system. Here
 
 ## OpenCore Settings
 
-Below is a run down of the main logic OpenCore Legacy Patcher uses to gain native support in macOS. Note OpenCore's configuration is documented within [OpenCorePkg](https://github.com/acidanthera/OpenCorePkg) as well as an online version provided by us:
+Below is a rundown of the main logic that OpenCore Legacy Patcher uses to gain native support in macOS. Note that OpenCore's configuration is documented within [OpenCorePkg](https://github.com/acidanthera/OpenCorePkg) as well as on an online version provided by us:
 
 * [OpenCorePkg Online Docs](https://dortania.github.io/docs/latest/Configuration.html)
 
 ::: details Configuration Explanation
 
+### ACPI -> Add
+
+* SSDT-CPBG
+  * Reason: Resolves Kernel Panic on Arrandale Macs in early Big Sur builds
+  * Logic: Disable dummy CPBG device in ACPI
+  * Models: MacBookPro6,x and iMac11,x
+* SSDT-PCI
+  * Reason: Patch Windows Audio support for Sandy and Ivy Bridge
+  * Logic: Removes PCI0's 32-bit Allocation Limitation
+  * Models: All Sandy and Ivy Bridge Macs, excluding MacPro6,1
+* SSDT-DGPU
+  * Reason: Allows for software based deMUX disabling dGPUs in 2011 MacBook Pros
+  * Logic: Sends power down request to dGPU via ACPI
+  * Models: MacBookPro8,2 and MacBookPro8,3 with dead dGPUs
+
 ### ACPI -> Patch
 
-* EHCx and XHC1 Patches
+* `EHCx` and `XHC1` Patches
   * Reason: Required for proper USB operation
   * Logic: Avoids USB maps of newer models attaching and breaking USB port functionality
-  * Models: All models require
+  * Models: All models require when spoofing with Moderate or Advanced SMBIOS
+* `BUF0` to `BUF1` Patch
+  * Reason: To be paired with SSDT-PCI
+* `_INI` to `XINI` Patch
+  * Reason: To be paired with SSDT-DGPU
+
+### Booter -> Patch
+
+* Reroute `HW_BID` to `OC_BID`
+  * Reason: Allows macOS installers to be used on unsupported models
+  * Logic: Reroutes Board ID macOS checks to custom variable
+  * Models: All systems using VMM spoofing
 
 ### Booter -> Quirks
 
@@ -30,21 +56,13 @@ Below is a run down of the main logic OpenCore Legacy Patcher uses to gain nativ
 
 ### DeviceProperties -> Add
 
-* `PciRoot(0x0)/Pci(0x15,0x0)/Pci(0x0,0x0)`
-* `PciRoot(0x0)/Pci(0x1C,0x4)/Pci(0x0,0x0)`
-* `PciRoot(0x0)/Pci(0x1C,0x3)/Pci(0x0,0x0)`
-* `PciRoot(0x0)/Pci(0x1C,0x5)/Pci(0x0,0x0)`
-* `PciRoot(0x0)/Pci(0x1C,0x1)/Pci(0x0,0x0)`
-  * Reason: Required to ensure Wifi works with full, native support
-  * Logic: Tricks AirPortBrcmNIC.kext into thinking our device is a BCM94360 (`14e4,43ba`)
-  * Models: Machines with BCM943224 and BCM94331 chipsets
 * `PciRoot(0x0)/Pci(0x3,0x0)/Pci(0x0,0x0)`
 * `PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)`
   * Reason: Required to ensure Brightness Control works on upgraded iMacs
   * Logic: Sets AppleBackLight properties
-  * Models: iMac11,x and iMac12,x with upgraded Nvidia Metal GPUs
+  * Models: iMac11,x and iMac12,x with upgraded NVIDIA Metal GPUs
 * `PciRoot(0x0)/Pci(0x2,0x0)`
-  * Reason: Disables internal GPU to fix sleep issues on upgrades iMacs
+  * Reason: Disables internal GPU to fix sleep issues on upgraded iMacs
   * Logic: Tricks macOS into thinking iGPU is a generic PCI device
   * Models: iMac12,x with upgraded Metal GPUs
 
@@ -53,15 +71,32 @@ Below is a run down of the main logic OpenCore Legacy Patcher uses to gain nativ
 * SMC Patch
   * Reason: Required to avoid SMC Firmware updates
   * Logic: Patches out `smc-version` in AppleSMC.kext, requires SMC-Spoof.kext for full functionality
-  * Models: All models require
+  * Models: All models require when spoofing SMBIOS
 * IOHIDFamily Patch
   * Reason: Required for HID peripheral support in macOS on older hardware
   * Logic: Tricks IOHIDFamily into thinking it's always booting recovery
-  * Models: [2010 and older](https://github.com/dortania/OpenCore-Legacy-Patcher/blob/79ab028b0a039e97a528e0b99c876d95d9c2d41d/Resources/ModelArray.py#L310-L332)
+  * Models: Penryn CPUs (Core2 series)
+* Force FileVault on Broken Seal Patch
+  * Reason: Allow FileVault on root patched Macs
+  * Logic: Forces APFS.kext to always return true on FileVault support
+  * Models: Any model needing root patches
+* Disable Library Validation Enforcement Patch
+  * Reason: non-Metal Root Volume Patches do not pass library validation tests
+  * Logic: Forces Library Validation function to always return not required
+  * Models: Non-Metal GPUs
+* SurPlus Patch
+  * Reason: macOS 11.3-12.0.1 require systems to have RDRAND support in the CPU for stable boot
+  * Logic: Forces RDRAND code to return predetermined value
+  * Models: All pre-Ivy Bridge Macs
+* Reroute `kern.hv_vmm_present` Patch
+  * Reason: Allows macOS to be installed and updated on unsupported hardware
+  * Logic: Forces userspace to see system as Virtual Machine
+  * Models: Any model using VMM spoofing
+
 
 ### Kernel -> Quirks
 
-* ThridPartyDrives
+* ThirdPartyDrives
   * Reason: Required to avoid Hibernation wake issues on 3rd party drives
   * Logic: Patches AppleAHCIPort.kext into support
   * Models: All models with standard SATA ports
@@ -73,13 +108,13 @@ Below is a run down of the main logic OpenCore Legacy Patcher uses to gain nativ
 ### Misc -> Security
 
 * SecureBootModel
-  * Reason: Required to ensure seamless OS updates with Big Sur
-  * Logic: Sets iMacPro1,1's Secure Enclave Identifier (j137)
-  * Models: All models require
+  * Reason: Required to allow native OS updates on T2 model spoofs
+  * Logic: Sets T2's Secure Enclave Identifier
+  * Models: All models required that spoof T2 model with minimal or higher
 
 ### NVRAM -> Add
 
-* `-v debug=0x100`
+* `-v keepsyms=1 debug=0x100`
   * Reason: Used to see debug info of macOS's kernel and kexts, and avoids reboots on panic
   * Logic: Adds args to NVRAM
   * Models: Only set when Verbose Boot is enabled by the user
@@ -100,13 +135,22 @@ Below is a run down of the main logic OpenCore Legacy Patcher uses to gain nativ
   * Reason: Fixes DRM support on models with upgraded AMD Metal GPUs
   * Logic: Adds args to NVRAM
   * Models: Models with upgraded AMD Metal GPUs
+* `-revasset`
+  * Reason: Enables Content Caching when using VMM spoofing
+  * Logic: Adds args to NVRAM
+  * Models: Any model using VMM spoofing
+* `amfi=0x80`
+  * Reason: Disables Apple Mobile File Integrity to allow for root patches
+  * Logic: Adds args to NVRAM
+  * Models: Any model that requires unsigned root patches
+
 ### UEFI -> ProtocolOverrides
 
 * GopPassThrough
   * Reason: Used for proper output on machines with UGA firmware but GOP GPU
-  * Logic: Provide GOP protocol instances on top of UGA protocol instances 
-  * Models: MacPro3,1, MacBook4,1 iMac7,1-8,1
-  
+  * Logic: Provide GOP protocol instances on top of UGA protocol instances
+  * Models: MacPro3,1, iMac7,1-8,1
+
 :::
 
 ## Injected Kext
@@ -122,35 +166,74 @@ Below is an explanation of what Kexts OpenCore Legacy Patcher will inject into m
   * Models: All models require
 * WhateverGreen
   * Reason: Patches GPU Frameworks and kext to ensure proper support
-  * Models: All models require
+  * Models: All models require when spoofing or have non-stock GPU
 * CPUFriend
   * Reason: Patches IOx86PlatformPlugin to restore previous CPU profiles
-  * Models: 2012 and newer models
+  * Models: All models using minimal or higher spoofing
 * AirportBrcmFixup
-  * Reason: Patches IO80211 and co to fix networking support for unsupported cards
-  * Models: BCM943224 and BCM94331
+  * Reason: Patches IO80211 and co to fix networking support for unsupported cards, and fix bugs on native ones as well (ie. random degraded network performance)
+  * Models: BCM943224, BCM94331, BCM94360 and BCM943602
+* BlueToolFixup
+  * Reason: Patches BlueTool to enable bluetooth functionality on Monterey
+  * Models: All models with pre-BCM94360 wireless cards or 3rd-party chipsets
+* Bluetooth-Spoof
+  * Reason: Injects extra data into certain bluetooth chipsets for recognition by the system
+  * Models: Models with the BCM2070 or BCM2046 chipsets
+* FeatureUnlock (Night Shift)
+  * Reason: Patches CoreBrightness.framework to enable Night Shift on unsupported models
+  * Models: 2011 or older
+* FeatureUnlock (Sidecar/AirPlay)
+  * Reason: Patches SidecarCore.framework and AirPlaySupport.framework to enable Sidecar and AirPlay to Mac on unsupported models
+  * Models: All models with Metal capable GPUs
 * RestrictEvents
   * Reason: Disables memory errors on MacPro7,1
   * Models: Mac Pros and Xserves
+* CryptexFixup
+  * Reason: Installs non AVX2.0 Cryptex on non AVX2.0 CPUs
+  * Models: All CPUs Ivy Bridge and older
+* AutoPkgInstaller
+  * Reason: Allows for automatic root patching
+* NVMeFix
+  * Reason: Fixes 3rd party NVMe support
+* RSRHelper
+  * Reason: Fixes Rapid Security Response Support on root patched installs
+* 
 
 ### Ethernet
 
 * nForceEthernet
-  * Reason: Inject old Nvidia Ethernet kext to resolve networking in Catalina and newer
-  * Models: 2010 and older Nvidia Ethernet require
+  * Reason: Inject old NVIDIA Ethernet kext to resolve networking in Catalina and newer
+  * Models: 2010 and older NVIDIA Ethernet require
 * MarvelYukonEthernet
   * Reason: Inject old Marvel Ethernet kext to resolve networking in Catalina and newer
   * Models: 2008 and older Marvel Ethernet require
 * CatalinaBCM5701Ethernet
   * Reason: Inject old Broadcom Ethernet kext to resolve networking in Big Sur
-  * Logic: Patch out conflicting symbols to not colide existing BCM5701Ethernet
+  * Logic: Patch out conflicting symbols to not collide existing BCM5701Ethernet
   * Models: 2011 and older Broadcom Ethernet require
+* Intel82574L
+  * Reason: Resolves Ethernet Support on MacPros 
+  * Models: MacPro3,1 - 5,1
+* CatalinaIntelI210Ethernet
+  * Reason: Fixes Intel i210/i225 NIC support on pre-Ivy Macs
+* AppleIntel8254XEthernet
+  * Reason: Resolves Ethernet Support on MacPros 
+  * Models: MacPro3,1 - 5,1
+
+### Firewire 
+
+* IOFireWireFamily
+  * Reason: Allows for FireWire Boot Support
+* IOFireWireSBP2
+  * Reason: Allows for FireWire Boot Support
+* IOFireWireSerialBusProtoColTransport
+  * Reason: Allows for FireWire Boot Support
 
 ### Maps
 
 * USBMap
   * Reason: Inject old USB map profiles to fix USB
-  * Models: All models require
+  * Models: All models require when spoofing moderate or higher, as well as pre-2012 models
 
 ### SSE
 
@@ -158,60 +241,266 @@ Below is an explanation of what Kexts OpenCore Legacy Patcher will inject into m
   * Reason: Translates SSE4.2 instructions to compatible code for SSE4,1 CPUs, required for AMD Metal drives
   * Models: MacPro3,1
 * telemetrap
-  * Reason: Ensures temelemtry.plugin doesn't run, required for SSE4,1 CPUs
+  * Reason: Ensures telemetry.plugin doesn't run, required for SSE4,1 CPUs
   * Models: Penryn CPUs
 
 ### Wifi
 
-* IO80211HighSierra
-  * Reason: Re-inject Atheros wifi drivers from High Sierra
-  * Logic: Patch out conflicting symbols to not colide existing IO80211Family
-  * Models: Atheros cards
-* IO80211Mojave
-  * Reason: Re-inject Broadcom wifi drivers from Mojave
-  * Logic: Patch out conflicting symbols to not colide existing IO80211Family
-  * Models: BCM94322
+* IO80211ElCap
+  * Reason: Re-inject WiFi drivers from El Capitan 
+  * Models: BCM94328, BCM94322 and Atheros chipsets
+* corecaptureElCap.kext
+  * Reason: Re-inject WiFi drivers from El Capitan 
+  * Models: BCM94328, BCM94322 and Atheros chipsets
 
 ### Misc
 
 * AppleBackLightFixup
-  * Reason: Patch AppleBacklight for iMacs with Nvidia Metal GPU upgrades
-  * Models: iMac11,x, iMac12,x with upgraded Nvidia Metal GPUs
+  * Reason: Patch AppleBacklight for iMacs with NVIDIA Metal GPU upgrades
+  * Models: iMac11,x, iMac12,x with upgraded NVIDIA Metal GPUs
 * AppleIntelPIIXATA
   * Reason: Fix IDE support on MacPro3,1
   * Models: MacPro3,1
 * AppleIntelMCEDisabler
   * Reason: Fix dual socket support in Catalina and newer
   * Models: Mac Pros and Xserves
-* NightShiftEnabler
-  * Reason: Enables NightShift support on unsupported models
-  * Models: 2011 and older, MacBookPro9,x included
 * SMC-Spoof
   * Reason: Spoofs SMC version to 9.9999
-  * Models: All models require
-:::
+  * Models: All models require when spoofing minimal or higher
+* AppleRAIDCard
+  * Adds AppleRaidCard Support for Xserves
+* AMDGPUWakeHandler
+  * Reason: Adds Software Based Demux for 2011 15/17 Macbook Pros
+* AppleIntelCPUPowerManagement and AppleIntelCPUPowerManagementClient
+  * Reason: Restores Ivy Bridge and older CPU Power Management
+* AppleUSBTopCase
+  * Reason: Restore USB Keyboard support on Mac OS Ventura
+* AppleUSBMultitouch and AppleUSBTrackpad
+  * Reason: Restore USB Trackpad support on Mac OS Ventura
+* ASPP-Override
+  * Reason: Forces ACPI_SMC_PlatformPlugin to outmatch X86PlatformPlugin and disable firmware throttling 
+* BacklightInjector
+  * Reason: Fixes Brightness in iMacs with upgraded GPUs
+* BigSurSDXC
+  * Reason: Restores SDXC Support in Pre Ivy-Bridge Macs
+* Bluetooth-spoof
+  * Reason: Spoofs legacy Bluetooth to work on Monterey and newer
+* Innie
+  * Reason: Makes all PCIe drives appear internal
+  * Models: MacPro3,1 and newer & Xserve3,1 and newer 
+* KDKlessWorkaround
+  * Reason: Helps with Mac os updates on KDKless patched systems
+* LegacyUSBVieoSupport
+  * Reason: Fixes Legacy USB iSight support
+* MonteAHCIPort
+  * Reason: Fixes SSD support for stock SSD found in MacBookAir6,x
+* NoAVXFSCompressionTypeZlib
+  * Reason: Prevents AVXFSCompressionTypeZlib crash on pre AVX1.0 systems in 12.4+
+* SimpleMSR 
+  * Reason: Disables BD PROCHOT to prevent firmware throttling on Nehalem+ MacBooks
+* LegacyKeyboardInjector
+  * Reason: Fixes function keys on MacBook5,2
 
 
+:::
+
 ## On-Disk Patches
 
 Unfortunately certain on-disk patches are required to achieve full functionality. Below is a breakdown of patches supported
 
-Note, GPU Acceleration Patches are not public yet, the below section is simply documentation for easier research with new aids.
-
-::: details Audio Patches
+::: details Audio Patches (11.0+)
 
 ### Extensions
 
 * AppleHDA
-  * Reason: Re-add High Sierra's AppleHDA to achieve audio support
-  * Models: 2011 and older Macs (excluding MacPro4,1+)
+  * Reason: Re-add El Capitan's AppleHDA to achieve audio support
+  * Models: iMac7,1 and iMac8,1
 
 :::
 
-::: details Acceleration Patches
+::: details Legacy Wireless Patches (12.0+)
+
+Applicable for BCM94328, BCM94322 and Atheros Wifi cards
+
+### CoreServices
+
+* WiFiAgent.app
+
+### /usr/libexec
+
+* airportd
+
+:::
+
+::: details NVIDIA Kepler Graphics Acceleration Patches (12.0+)
 
 ### Extensions
 
+* GeForce.kext
+* GeForceAIRPlugin.bundle
+* GeForceGLDriver.bundle
+* GeForceMTLDriver.bundle
+* GeForceVADriver.bundle
+* NVDAGF100Hal.kext
+* NVDAGK100Hal.kext
+* NVDAResman.kext
+* NVDAStartup.kext
+
+### Frameworks
+
+* OpenCL (libCLVMNVPTXPlugin.dylib, NVPTX.dylib)
+  * Reason: Re-add Kepler hardware acceleration support
+* Metal 
+  * Reason: 3802 based GPU's broken by 13.3, requiring a Metal downgrade to 13.2.1
+
+### PrivateFrameworks
+
+* MTLCompiler
+  * Reason: 3802 based GPU's broken by 13.3, requiring a MTLCompiler downgrade to 13.2.1
+* GPUCompiler
+  * Reason: 3802 based GPU's broken by 13.3, requiring a GPUCompiler downgrade to 13.2.1
+
+:::
+
+
+::: details Intel Ivy Bridge Graphics Acceleration Patches (12.0+)
+
+### Extensions
+
+* AppleIntelIVBVA.bundle
+* AppleIntelFramebufferCapri.kext
+* AppleIntelGraphicsShared.bundle
+* AppleIntelHD4000Graphics.kext
+* AppleIntelHD4000GraphicsGLDriver.bundle
+* AppleIntelHD4000GraphicsMTLDriver.bundle
+* AppleIntelHD4000GraphicsVADriver.bundle
+
+### PrivateFrameworks
+
+* AppleGVA/AppleGVACore
+  * Reason: Enable DRM support
+* MTLCompiler
+  * Reason: 3802 based GPU's broken by 13.3, requiring a MTLCompiler downgrade to 13.2.1
+* GPUCompiler
+  * Reason: 3802 based GPU's broken by 13.3, requiring a GPUCompiler downgrade to 13.2.1
+
+### Frameworks
+
+* OpenCL (libCLVMIGILPlugin.dylib)
+  * Reason: Re-add Ivy Bridge hardware acceleration support
+* WebKit (com.apple.WebProcess.sb)
+  * Reason: Re-add Ivy Bridge Safari rendering support
+* Metal 
+  * Reason:  3802 based GPU's broken by 13.3, requiring a Metal downgrade to 13.2.1
+:::
+
+::: details Intel Haswell Graphics Acceleration Patches (13.0+)
+
+### Extensions 
+
+* AppleIntelFramebufferAzul.kext
+* AppleIntelHD5000Graphics.kext
+* AppleIntelHD5000GraphicsGLDriver.bundle
+* AppleIntelHD5000GraphicsMTLDriver.bundle
+* AppleIntelHD5000GraphicsVADriver.bundle 
+* AppleIntelHSWVA.bundle
+* AppleIntelGraphicsShared.bundle
+
+### Frameworks 
+
+* Metal 
+  * Reason:  3802 based GPU's broken by 13.3, requiring a Metal downgrade to 13.2.1
+
+### PrivateFrameworks
+
+* MTLCompiler
+  * Reason: 3802 based GPU's broken by 13.3, requiring a MTLCompiler downgrade to 13.2.1
+* GPUCompiler
+  * Reason: 3802 based GPU's broken by 13.3, requiring a GPUCompiler downgrade to 13.2.1
+
+:::
+
+::: details Intel Broadwell Graphics Acceleration Patches (13.0+)
+
+### Extensions 
+
+* AppleIntelBDWGraphics.kext
+* AppleIntelBDWGraphicsFramebuffer.kext
+* AppleIntelBDWGraphicsGLDriver.bundle
+* AppleIntelBDWGraphicsMTLDriver.bundle
+* AppleIntelBDWGraphicsVADriver.bundle
+* AppleIntelBDWGraphicsVAME.bundle
+* AppleIntelGraphicsShared.bundle
+
+
+
+:::
+
+::: details Intel Skylake Graphics Acceleration Patches (13.0+)
+
+### Extensions 
+
+* AppleIntelSKLGraphics.kext
+* AppleIntelSKLGraphicsFramebuffer.kext
+* AppleIntelSKLGraphicsGLDriver.bundle
+* AppleIntelSKLGraphicsMTLDriver.bundle
+* AppleIntelSKLGraphicsVADriver.bundle
+* AppleIntelSKLGraphicsVAME.bundle
+* AppleIntelGraphicsShared.bundle
+
+
+:::
+
+::: details AMD Legacy Vega Graphics Acceleration Patches (13.0+)
+
+### Extensions
+
+* AMDRadeonX5000.kext
+* AMDRadeonVADriver2.bundle
+* AMDRadeonX5000GLDriver.bundle
+* AMDRadeonX5000MTLDriver.bundle
+* AMDRadeonX5000Shared.bundle
+* AMDShared.bundle
+
+:::
+
+::: details AMD Legacy Polaris Graphics Acceleration Patches (13.0+)
+
+### Extensions
+
+* AMDRadeonX4000.kext
+* AMDRadeonX4000HWServices.kext
+* AMDRadeonVADriver2.bundle
+* AMDRadeonX4000GLDriver.bundle
+* AMDMTLBronzeDriver.bundle
+* AMDShared.bundle
+
+:::
+
+::: details AMD Legacy GCN Graphics Acceleration Patches
+
+### Extensions
+
+* AMD7000Controller.kext
+* AMD8000Controller.kext
+* AMD9000Controller.kext
+* AMD9500Controller.kext
+* AMD10000Controller.kext
+* AMDRadeonX4000.kext
+* AMDRadeonX4000HWServices.kext
+* AMDFramebuffer.kext
+* AMDSupport.kext
+* AMDRadeonVADriver.bundle
+* AMDRadeonVADriver2.bundle
+* AMDRadeonX4000GLDriver.bundle
+* AMDMTLBronzeDriver.bundle
+* AMDShared.bundle
+
+
+
+
+::: details non-Metal Graphics Acceleration Patches (11.0+)
+
 #### General Patches
 
 * IOSurface.kext
@@ -222,17 +511,32 @@ Note, GPU Acceleration Patches are not public yet, the below section is simply d
 
 #### Dropped Acceleration Binaries
 
-* Nvidia Binaries
+* NVIDIA Binaries
   * GeForceGA.bundle
   * GeForceTesla.kext
     * Skip IOFree Panic - Mojave+
-	  * At Offset `0x5CF9A` replace following bytes with `0xEB`
+      * At Offset `0x5CF9A` replace following bytes with `0xEB`
     * Avoids `addMemoryRegion/removeMemoryRegion` calls
       * At Offset `0x5527` and `0x77993`, replace following bytes with `0x909090909090`
   * GeForceTeslaGLDriver.bundle
   * GeForceTeslaVADriver.bundle
   * NVDANV50HalTesla.kext
   * NVDAResmanTesla.kext
+    * 0x1ea59a - 0x1ea5b3: nop
+    * Replace VSLGestalt to IOLockLock or any other known symbol of the same length.
+
+* NVIDIA Web Drivers Binaries 
+  * GeForceWeb.kext
+  * NVDAGF100HalWeb.kext
+  * NVDAGK100HalWeb.kext
+  * NVDAGM100HalWeb.kext
+  * NVDAGP100HalWeb.kext
+  * NVDAResmanWeb.kext
+  * NVDAStartupWeb.kext
+  * GeForceTeslaWeb.kext
+  * NVDANV50HalTeslaWeb.kext
+  * NVDAResmanTeslaWeb.kext
+    * Reason: Allows for non-Metal Acceleration for NVIDIA Maxwell and Pascal GPUs
 
 * AMD/ATI Binaries
   * AMD2400Controller.kext
@@ -271,6 +575,8 @@ Note, GPU Acceleration Patches are not public yet, the below section is simply d
   * AppleIntelHD3000GraphicsGLDriver.bundle
   * AppleIntelHD3000GraphicsVADriver.bundle
   * AppleIntelSNBGraphicsFB.kext
+    * Board ID Patch
+      * Replace original Board ID with updated model
   * AppleIntelSNBVA.bundle
 
 ### Frameworks
@@ -288,10 +594,4 @@ Note, GPU Acceleration Patches are not public yet, the below section is simply d
 * SkyLight.framework
   * Logic: Copied from Mojave, heavy modifications/shims
 
-### LaunchDaemons
-
-* HiddHack.plist
-  * Reason: Fixes unresponsive input when patching Skylight
-  * Logic: Forces `hidd` to register events, as Skylight handles them by default in Big Sur
-
 :::

docs/POST-INSTALL.md

@@ -1,7 +1,8 @@
 # Post-Installation
 
 * [Booting without USB drive](#booting-without-usb-drive)
-* [Booting seamlessly without Verbose or OpenCore Picker](#booting-seamlessly-without-verbose-or-opencore-picker)
+* [Booting seamlessly without Boot Picker](#booting-seamlessly-without-boot-picker)
+* [SIP settings](#sip-settings)
 * [Applying Post Install Volume Patches](#applying-post-install-volume-patches)
 
 ## Booting without USB drive
@@ -14,35 +15,217 @@ Once you've installed macOS through OpenCore, you can boot up and go through the
 * Install OpenCore to internal drive
 * Reboot holding Option, and select the internal EFI
 
-And voila! No more USB drive required
+And voila! No more USB drive required.
 
-## Booting seamlessly without Verbose or OpenCore Picker
+If you're having issues with undetected internal disk, refer to [Internal disk missing when building OpenCore](https://dortania.github.io/OpenCore-Legacy-Patcher/TROUBLESHOOTING.html#internal-disk-missing-when-building-opencore) for troubleshooting.
 
-To do this, run the OpenCore Patcher and head to Patcher Settings:
+## Booting seamlessly without Boot Picker
 
-![](../images/settings.png)
+To do this, run the OpenCore Patcher and head to Patcher Settings, then uncheck "Show OpenCore Bootpicker" on the Build tab:
 
-Here you can change different patcher settings, however the main interest is:
 
-* Set ShowPicker Mode
+<div align="left">
+             <img src="./images/OCLP-GUI-Settings-ShowPicker.png" alt="GUI Settings ShowPicker" width="600" />
+</div>
 
-Once you've toggled them both off, build your OpenCore EFI once again and install to your desired drive. Now to show the OpenCore selector, you can simply hold down the "ESC" key while clicking on EFI boot, then you can release the "ESC" key when you see the cursor arrow at the top left.
+
+Once you've toggled it off, build your OpenCore EFI once again and install to your desired drive. Now to show the OpenCore selector, you can simply hold down the "ESC" key while clicking on EFI boot, and then you can release the "ESC" key when you see the cursor arrow at the top left.
+
+## SIP settings
+
+SIP, or System Integrity Protection, needs to be lowered on systems where root patching is required to patch data on disk. This will vary between OS versions and the model in question. 
+
+OCLP by default will determine the proper SIP options for the OS version and Mac model, in most cases the user has no need to touch these settings.
+
+:::warning
+
+If you're unsure whether you should change the SIP settings, leave them as-is. Systems where you have already ran the Post Install Root Patching cannot enable SIP without potentially breaking the current install.
+
+:::
+
+| SIP Enabled | SIP Lowered (OCLP default) | SIP Disabled |
+| :--- | :--- | :--- |
+| ![](./images/OCLP-GUI-Settings-SIP-Enabled.png) | ![](./images/OCLP-GUI-Settings-SIP-Root-Patch.png) | ![](./images/OCLP-GUI-Settings-SIP-Disabled.png) |
+
+
+The guide in the dropdown below explains how the SIP settings work in OCLP, where lowered SIP is needed and where full SIP could be enabled.
+
+::: details Configuring SIP manually (click to expand)
+
+SIP settings can be accessed from the Security tab shown in the images. To change SIP settings, make the changes here, return in main menu and rebuild OpenCore using the first option.
+
+In the cases where SIP can be enabled, manually enabling it is needed. 
+
+Easiest way to check whether you can fully enable SIP is the "Post Install Root Patch" section, if that section tells your system doesn't need patches (or you don't install the patches e.g. in case you don't need WiFi on a Mac Pro with upgraded GPU running Monterey) then it is safe to assume full SIP can be enabled.
+
+**Ventura and newer**
+
+All unsupported systems require lowered SIP.
+
+**Monterey**
+
+Majority of unsupported systems from 2013 onward can enable full SIP.
+
+Pre-2012 systems, also known as "non-Metal", as well as NVIDIA Kepler and Intel HD 4000 GPUs require lowered SIP. Mac Pros also require lowered SIP for stock WiFi cards and stock GPUs (due to root patching) but if you do not need WiFi (or you plan to upgrade it) and you're running on an upgraded GPU, there is no need for root patching and as such SIP can be fully enabled.
+
+**Big Sur**
+
+All Metal capable systems from 2012 onward (incl. NVIDIA Kepler and Intel HD 4000) as well as Mac Pros with upgraded GPU can run with full SIP enabled. 
+Non-Metal systems still require lowered SIP.
+
+:::
 
 ## Applying Post Install Volume Patches
 
-**Note**: For users who need Post-Install Volume patches for legacy video acceleration support, you **must** disable the following settings in "Patcher Settings" when building and installing your new OpenCore:
+Post Install Volume Patches, sometimes also called root patches, are patches that have to be installed to disk for some older Macs to gain back functionality.
 
-* SIP: Disabled
-* SecureBootModel: Disabled
+OCLP will automatically root patch your system during a first time install **if the USB install media was created within OCLP and the proper model was selected before installer creation.** Users will also be prompted to install these patches after macOS updates or whenever patches are not detected on the system. We recommend rebuilding OpenCore with the latest version of OCLP to take advantage of these new features.
 
-Once set, rebuild OpenCore, install to drive and reboot. Then, Post-Install Volume patches will run just fine
+Users can also see whether applicable patches have been installed, date and version the system was root patched with in the Post-Install Menu.
 
-To apply the Post-Install Volume patches [to test out the Beta Graphics Acceleration Patches system](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108), select option #3 as shown below:
+- **Note:** In some cases OCLP may require packages to be obtained from the internet, such as KDK or MetallibSupprtPkg if they do not already exist on the system. In these cases OCLP may only install the WiFi driver on first patch run to ensure you can connect to the internet, which means no graphics acceleration 
+  after reboot. Root patching has to be ran again manually to install the rest of the required patches after internet connection is established to obtain the required packages.
 
-![](../images/root-patch.png)
+   Check the affected systems and GPUs from the warnings below.
 
-And go ahead to option #1 and let the OCLP patcher apply the needed legacy video patches.
+:::warning
 
-![](../images/root-patcher-2.png)
+If you need to use Migration Assistant to bring over data to your new macOS install, it is **highly recommended** to avoid restoring from inside Setup Assistant and waiting to install root patches until after the transfer is complete. If root patches were automatically installed, you can use the options available in the OCLP app to remove them.
 
-Reboot your system and check out the now working graphics acceleration on your legacy system. This is still Beta software.
+Using Migration Assistant while patches are installed can lead to an unbootable system, requiring a reinstall of macOS.
+
+For more information on how to restore a Time Machine backup, [refer to the guide here.](https://dortania.github.io/OpenCore-Legacy-Patcher/TIMEMACHINE.html)
+
+:::
+
+| Automatic install prompt | Status |
+| :--- | :--- |
+| ![](./images/OCLP-GUI-root-patch-update.png) | ![](./images/OCLP-GUI-Root-Patch-Status.png)  |
+
+You can install and revert Root Patching manually from the app. 
+
+| Listing Patches | Patching Finished |
+| :--- | :--- |
+| ![](./images/OCLP-GUI-Root-Patch.png) | ![](./images/OCLP-GUI-Root-Patch-Finished.png) |
+
+
+
+:::warning
+
+With macOS Sequoia, MetallibSupportPkg is required to be downloaded for all 3802-based systems. OCLP will handle this as long as you're connected to the internet.
+
+3802 based GPUs:
+
+* NVIDIA
+    * Kepler (GTX 600 - 700 series)
+* Intel
+   * Ivy Bridge (HD 4000 series)
+   * Haswell (Iris/HD 4000-5000 series)
+
+:::
+
+:::warning
+
+With macOS Ventura and Macs with AMD Legacy GCN GPUs (ie. Metal), Root Patching requires a network connection to grab Apple's Kernel Debug Kit to start root patching. If your system is unable to connect to the internet, you can manually download a KDK from Apple's site:
+
+* [Apple's Developer Download Page](https://developer.apple.com/download/all/?q=Kernel%20Debug%20Kit)
+
+Grab the Kernel Debug Kit whose version is closest to the OS you installed, and install it to the machine running Ventura.
+
+Machines that require this are those with AMD Metal dGPUs:
+* 2008 - 2013 Mac Pros (MacPro3,1 - 6,1)
+* 2009 - 2016 iMacs (iMac10,1 - 17,1)
+* 2015 15" MacBook Pro with a dGPU (MacBookPro11,5)
+
+:::
+
+Below entries represent GPUs no longer natively supported, ie. requiring root volume patching with OpenCore Legacy Patcher:
+
+:::details GPUs requiring patching in different macOS versions
+
+AMD Navi (RX 5000 - 6000 series) GPUs are non-functional in Mac Pro 2008 to 2012 using Ventura and newer due to lack of AVX2 support.
+
+**Sequoia**
+
+* NVIDIA:
+  * Tesla (8000 - 300 series)
+  * Kepler (600 - 800 series)
+* AMD:
+  * TeraScale (2000 - 6000 series)
+  * GCN 1-3 (7000 - R9 series)
+  * Polaris (RX 4xx/5xx series, if CPU lacks AVX2)
+* Intel:
+  * Iron Lake
+  * Sandy Bridge (2000 - 3000 series)
+  * Ivy Bridge (4000 series)
+  * Haswell (4400, 4600, 5000 series)
+  * Broadwell (6000 series)
+  * Skylake (500 series)
+
+**Sonoma**
+
+* NVIDIA:
+  * Tesla (8000 - 300 series)
+  * Kepler (600 - 800 series)
+* AMD:
+  * TeraScale (2000 - 6000 series)
+  * GCN 1-3 (7000 - R9 series)
+  * Polaris (RX 4xx/5xx series, if CPU lacks AVX2)
+* Intel:
+  * Iron Lake
+  * Sandy Bridge (2000 - 3000 series)
+  * Ivy Bridge (4000 series)
+  * Haswell (4400, 4600, 5000 series)
+  * Broadwell (6000 series)
+  * Skylake (500 series)
+
+**Ventura**
+
+* NVIDIA:
+  * Tesla (8000 - 300 series)
+  * Kepler (600 - 800 series)
+* AMD:
+  * TeraScale (2000 - 6000 series)
+  * GCN 1-3 (7000 - R9 series)
+  * Polaris (RX 4xx/5xx series, if CPU lacks AVX2)
+* Intel:
+  * Iron Lake
+  * Sandy Bridge (2000 - 3000 series)
+  * Ivy Bridge (4000 series)
+  * Haswell (4400, 4600, 5000 series)
+  * Broadwell (6000 series)
+  * Skylake (500 series)
+
+**Monterey**
+
+* NVIDIA:
+  * Tesla (8000 - 300 series)
+  * Kepler (600 - 800 series)
+* AMD:
+  * TeraScale (2000 - 6000 series)
+* Intel:
+  * Iron Lake
+  * Sandy Bridge (2000 - 3000 series)
+  * Ivy Bridge (4000 series)
+
+
+**Big Sur**
+
+* NVIDIA:
+  * Tesla (8000 - 300 series)
+* AMD:
+  * TeraScale (2000 - 6000 series)
+* Intel:
+  * Iron Lake
+  * Sandy Bridge (2000 - 3000 series)
+
+:::
+
+:::details Wireless Cards requiring patching in macOS Monterey
+
+* Broadcom:
+  * BCM94328
+  * BCM94322
+* Atheros
+
+:::

docs/PROCESS.md

@@ -0,0 +1,19 @@
+# Background process
+
+OpenCore Legacy Patcher utilizes a background process to:
+- Check for mismatched configurations and warn the user (e.g. installed MacBookPro11,1 config on MacBookPro11,5)
+- Monitor the status of installed Root Patches and OpenCore
+- Ask you to install Root Patches in case they aren't detected (typically after an update)
+- Check whether OpenCore is being booted from USB drive or internal drive
+- Ask you to install OpenCore on the internal disk in case booted from USB
+- React to upcoming updates requiring a new KDK to be downloaded, starting KDK download automatically
+
+It is recommended to keep the background process enabled for smoothest functionality. e.g. to try and avoid failed patching when new KDK is not found.
+
+If you decide to disable the background process, the KDK installation for each update has to be done manually. OCLP is also unable to detect Root Patches on boot, meaning manually opening the app and root patching is required.
+
+::: warning  Note:
+
+In some cases macOS may report background process being added by "Mykola Grymalyuk", this happens due to a macOS bug where sometimes the developer name who sent the app for notarization is shown instead of the application name.
+Dortania cannot do anything about this.
+:::

docs/README.md

@@ -10,11 +10,17 @@ meta:
   content: Experience macOS just like before
 
 features:
-- title: Built with security in mind
-  details: Supporting System Integrity Protection(SIP), FileVault 2, .im4m Secure Boot and Vaulting. You're just as secure as a supported Mac
-- title: Native OTA updates
-  details: Install updates the moment they come out just like on a supported Mac, and no more 12GB+ updates.
+# - title: Built with security in mind
+#   details: Supporting System Integrity Protection(SIP), FileVault 2, .im4m Secure Boot and Vaulting. We make an effort to ensure your system is as secure as possible.
+- title: Near-native OTA updates.
+  details: Install updates from System Settings, with just couple more additional steps compared to native.
 - title: Zero firmware patching
-  details: No need to patch APFS ROM support, all protocol upgrades are done in memory and never permanent.
-footer: Copyright © Dortania 2020-2021
----
+  details: Using the capabilities of the OpenCore boot manager, our protocol upgrades are done in memory and are never permanent.
+- title: Supporting more hardware
+  details: New life is breathed into your decade-old graphics card, WiFi, and Bluetooth chipsets. Even your upgraded hardware receives benefits by unlocking exciting features like Hardware Acceleration, AirDrop, Apple Watch Unlock, Sidecar, and much more!
+- title: The newest features
+  details: Unlock Sidecar, AirPlay to Mac, Night Shift, and Universal Control, even on natively supported models!
+- title: A helpful community
+  details: Whether it's getting started or learning the specifics, you can always find answers with our amazing community of tinkerers, developers, and dreamers.
+footer: Copyright © Dortania 2020-2024
+---

docs/SEQUOIA-DROP.md

@@ -0,0 +1,109 @@
+# macOS Sequoia
+
+![](./images/macos-sequoia.png)
+
+Another year, another release.
+
+This time Apple dropped surprisingly few amount of Macs. With the release of OpenCore Legacy Patcher 2.0.0, early support for macOS Sequoia has been implemented.
+
+
+## Newly dropped hardware
+
+* MacBookAir8,1 :       MacBook Air (2018)
+* MacBookAir8,2 :       MacBook Air (2019)
+
+## Current status
+
+OpenCore Legacy Patcher 2.0.0 will support Sequoia for most models normally supported by the Patcher, however some challenges remain. You can find information about them below.
+
+Unfortunately due to T2 related problems, the recently dropped MacBookAir8,x models cannot be supported at this time.
+
+[More information here](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1136)
+
+## Non-functional features
+
+On majority of patched Macs, iPhone Mirroring and Apple Intelligence won't be functional.
+
+iPhone Mirroring requires T2 for attestation and Apple Intelligence requires an NPU only found in Apple Silicon, the patcher is unable to provide a fix for these as they're hardware requirements.
+
+## Issues
+
+* [Dual socket CPUs with Mac Pros and Xserve](#dual-socket-cpus-with-mac-pro-2008-and-xserve-2008)
+* [T2 Security chip](#t2-security-chip)
+* [USB 1.1 (OHCI/UHCI) Support](#usb-1-1-ohci-uhci-support)
+* [Graphics support and issues](#graphics-support-and-issues)
+
+
+### Dual socket CPUs with Mac Pro 2008 and Xserve 2008
+
+Booting Sequoia on Mac Pro 2008 (MacPro3,1) or Xserve 2008 (Xserve2,1) with more than 4 cores will cause Sequoia to panic. OpenCore Legacy Patcher will automatically disable additional cores.
+
+This is due to the dual socket nature of the machine, and likely some firmware/ACPI table incompatibility. 
+
+**If building OpenCore for older OS, this limitation can be disabled in Settings -> Build -> "MacPro3,1/Xserve2,1 Workaround".** 
+
+::: warning Note
+
+Dual booting Sequoia and older will not be possible with all cores enabled due to reasons described before. In these cases you will be limited to 4 cores.
+
+:::
+
+### T2 security chip
+
+The current biggest issue we face with supporting the MacBookAir8,x (2018/19) series is the T2 chip's lack of communication when booted through OpenCorePkg.
+
+What happens when one of these units boots through OpenCorePkg is that AppleKeyStore.kext panics due to timeouts with the T2 chip:
+
+```
+"AppleKeyStore":3212:0: sks timeout strike 18
+"AppleKeyStore":3212:0: sks timeout strike 19
+"AppleKeyStore":3212:0: sks timeout strike 20
+panic(cpu 0 caller 0xffffff801cd12509): "AppleSEPManager panic for "AppleKeyStore": sks request timeout" @AppleSEPManagerIntel.cpp:809
+```
+
+This affects not only macOS Sequoia, but macOS Ventura and Sonoma are confirmed to have the same issue. Thus an underlying problem with the MacBookAir8,x's firmware where it is not happy with OpenCorePkg.
+
+We currently do not have any leads on what exactly breaks the T2.
+* MacBookPro15,2, MacBookPro16,2 and Macmini8,1 do not exhibit these issues in local testing
+* MacPro7,1 does seem to surprisingly based on reports: [MacPro7,1 - OpenCorePkg](https://forums.macrumors.com/threads/manually-configured-opencore-on-the-mac-pro.2207814/post-29418464)
+  * Notes from this report were unsuccessful locally: [Cannot boot MacPro7,1 #1487](https://github.com/acidanthera/bugtracker/issues/1487)
+
+
+### USB 1.1 (OHCI/UHCI) Support
+
+For Penryn systems, pre-2013 Mac Pros and Xserve, USB 1.1 support was outright removed in macOS Ventura, therefore this applies all the way to Sequoia.
+While USB 1.1 may seem unimportant, it handles many important devices on your system. These include:
+
+* Keyboard and Trackpad for laptops
+* IR Receivers
+* Bluetooth
+
+Users will need to use a USB hub for installation and post-OS updates when patches are cleaned:
+
+However, the driver has recently been weakened starting from Sonoma, which means even some USB hubs may not work properly. 
+
+An alternative way is making sure to enable "Remote Login" in General -> Sharing before updating, which will enable SSH. 
+That means you can take control using Terminal in another system by typing `ssh username@lan-ip-address` and your password. 
+
+After that run Post Install Volume Patching by typing `/Applications/OpenCore-Patcher.app/Contents/MacOS/OpenCore-Patcher --patch_sys_vol` and finally `sudo reboot`.
+
+
+![](./images/usb11-chart.png)
+
+::: warning The following systems rely on USB 1.1
+
+* iMac10,x and older
+* Macmini4,1 and older
+* MacBook7,1 and older
+* MacBookAir3,1 and older
+* MacPro5,1 and older
+* Xserve 3,1 and older
+:::
+
+[More information here](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)
+
+### Graphics support and issues
+This build includes both Legacy Metal and non-Metal patches for macOS Sequoia. Refer to the following links for more information about Legacy Metal and non-Metal support and their respective issues.
+
+* [Legacy Metal](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008)
+* [Non-Metal](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)

docs/SONOMA-DROP.md

@@ -0,0 +1,95 @@
+# macOS Sonoma
+
+![](./images/sonoma.png)
+
+*Well here we are again, it's always such a pleasure~*
+
+Apple has yet again dropped a bunch of models, continuing their journey on discontinuing Intel Macs. With the release of OpenCore Legacy Patcher 1.0.0, early support for macOS Sonoma has been implemented.
+
+## Versioning
+
+With 1.0.0, we'll be switching to a proper major, minor and bug fix system ([Semantic Versioning](https://semver.org/)). This means the coming release will be version 1.0.0, and future releases plan to follow this scheme:
+
+- First digit: Major changes, including new OS support, API changes, and significant patch set changes, etc
+- Second digit: Minor changes, including incoming OS update fixes, minor patch set changes, etc
+- Third digit: Bug fixes, primarily hot fixes either due to a regression in prior release or resolving issues in already released OS updates
+
+
+## Newly dropped hardware
+
+* MacBook10,1:       MacBook (Retina, 12-inch, 2017)
+* MacBookPro14,1:    MacBook Pro (13-inch, 2017, Two Thunderbolt 3 ports)
+* MacBookPro14,2:    MacBook Pro (13-inch, 2017, Four Thunderbolt 3 Ports)
+* MacBookPro14,3:    MacBook Pro (15-inch, 2017)
+* iMac18,1:          iMac (21.5-inch, 2017)
+* iMac18,2:          iMac (Retina 4K, 21.5-inch, 2017)
+* iMac18,3:          iMac (Retina 5K, 27-inch, 2017)
+
+## Current status
+
+OpenCore Legacy Patcher 1.0.0 will support Sonoma for all models normally supported by the Patcher, however some challenges remain. You can find information about them below.
+
+## Issues
+
+* [Bluetooth](#bluetooth)
+* [T1 Security chip](#t1-security-chip)
+* [USB 1.1 (OHCI/UHCI) Support](#usb-1-1-ohci-uhci-support)
+* [Graphics support and issues](#graphics-support-and-issues)
+
+
+### Bluetooth
+
+Sometimes Bluetooth may not work after boot on pre-2012 models. Running NVRAM reset can alleviate it.
+
+Dual boots may also bring the issue back even after the reset.
+
+### T1 Security chip
+
+::: details Support for the T1 Security chip (Resolved in 1.1.0 and newer)
+
+Sonoma has removed support for T1 chips found in most 2016 and 2017 Macs. Therefore on these systems, the following will not function:
+
+* Enable or disable FileVault
+* Open the Password Settings window
+* Add fingerprints (if upgrading, existing fingerprints will be deleted)
+* Add cards to Apple Pay
+
+[More information here](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1103)
+
+:::
+
+::: warning
+Note that erasing the entire drive will remove the T1 firmware and it won't be reinstalled.
+:::
+
+### USB 1.1 (OHCI/UHCI) Support
+
+For Penryn systems, pre-2013 Mac Pros and Xserve, USB 1.1 support was outright removed in macOS Ventura and naturally this continues in Sonoma.
+While USB 1.1 may seem unimportant, it handles many important devices on your system. These include:
+
+* Keyboard and Trackpad for laptops
+* IR Receivers
+* Bluetooth
+
+With OpenCore Legacy Patcher v0.6.0+, basic support has been implemented via Root Volume patching. However due to this, users will need to use a USB hub for installation and post-OS updates when patches are cleaned:
+
+![](./images/usb11-chart.png)
+
+::: warning The following systems rely on USB 1.1
+
+* iMac10,x and older
+* Macmini4,1 and older
+* MacBook7,1 and older
+* MacBookAir3,1 and older
+* MacPro5,1 and older
+* Xserve 3,1 and older
+:::
+
+[More information here](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)
+
+### Graphics support and issues
+This build includes both Legacy Metal and non-Metal patches for macOS Sonoma. Refer to the following links for more information about Legacy Metal and non-Metal support and their respective issues.
+
+* [Legacy Metal](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1008)
+* [Non-Metal](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/108)
+

docs/START.md

@@ -1,31 +1,12 @@
 # What is OpenCore?
 
-This is a sophisticated boot loader used to inject and patch data in memory, instead of on disk. This means we're able to get near-native experience on many unsupported Macs with Metal GPUs. This includes many of the long desired features of other patchers such as:
+OpenCore is a sophisticated boot loader used to inject and patch data in memory, instead of on disk. This means that we're able to achieve a near-native experience on many unsupported Macs. 
 
-* System Integrity Protection, FileVault 2, .im4m Secure Boot and Vaulting
-* Native OTA OS DELTA updates on all Macs
-* Recovery OS, Safe Mode and Single-user Mode booting
-* WPA Wifi and Personal Hotspot support
-
-While many PC users from the Hackintosh community are familiar with OpenCore, OpenCore was designed as Mac and PC agnostic ensuring both platforms can use it easily. And with OpenCore Legacy Patcher, we help automate the process making running with OpenCore that much easier.
-
-For advanced troubleshooting, we highly recommend users check out the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN) as this is generally the quickest way to get a hold of us developers and get help from the community.
-
-For those who wish to support this patcher, please see the [Supporting the Patcher page](./DONATE.md)
-
-## Patcher Warnings
-
-Since this patcher tricks macOS into thinking you're running a newer Mac, certain functionality may be broken:
-
-* Boot Camp Assistant.app
-  * We recommend following our [guide on getting a UEFI Windows Install working](). Legacy MBR Based installs won't show up in OpenCore
+* We recommend viewing the [OpenCore Patcher Terminology Page](./TERMS.md) if you have questions.
+* For troubleshooting, join the [OpenCore Patcher Paradise Discord Server](https://discord.gg/rqdPgH8xSN) and see our [Troubleshooting Page](./TROUBLESHOOTING.md).
 
 ## How do I get started?
 
-1. The first step of ensuring whether your model is support is checking here:
-
-* [Supported Models](./MODELS.md)
-
-2. [Download and build macOS Installer](./INSTALLER.md)
-3. [Run the `OpenCore-Patcher.app`](./BUILD.md)
-4. [Reboot and boot OpenCore](./BOOT.md)
+1. Read the [FAQ](./FAQ.md) for application requirements and other information.
+2. Check that your model is supported from the [Supported Models](./MODELS.md) page.
+3. Once you've verified your model is supported, you can jump into the process in [Download and build macOS Installer](./INSTALLER.md)

docs/TERMS.md

@@ -6,7 +6,7 @@ With OpenCore Legacy Patcher, we use a lot of different terms to refer to hardwa
 
 Term | Description
 --- | ---
-**macOS**        | Apple's own UNIX based OS used for Mac machines and "What makes a Mac a Mac".
+**macOS**        | Apple's own UNIX based OS used for Mac machines and is "What makes a Mac a Mac".
 **Windows**      | Microsoft's proprietary OS that is used and supported on a wide range of devices
 **Linux**        | Family of open source Unix-like operating systems based on the Linux kernel, an operating system kernel first released on September 17, 1991, by Linus Torvalds. Linux is typically packaged in a Linux distribution. Note that while macOS and Linux may be UNIX-based, they're vastly different.
 **Bootloader**   | Piece of software that loads an OS, usually made by the OS creators. OpenCore is technically not a bootloader per se (see boot manager explanation down below). Apple's Boot.efi would be the actual boot loader in a Mac.
@@ -16,24 +16,24 @@ Term | Description
 --- | ---
 **OpenCore**   | The new hotness on the scene, made with security in mind by the [Acidanthera team](https://github.com/acidanthera), has faster booting and lighter weight than previous boot managers. Supports many native Mac features such as SIP, FileVault, Secure Boot, etc
 **ACPI**   | Tables defined in your firmware defining your hardware and different methods, tied directly to how IOKit/IOService handles device setup
-**NVRAM**   | Non-volitile storage, where many variables are stored including default boot options, Hibernation keys, Secure Boot information, etc
+**NVRAM**   | Non-volatile storage, where many variables are stored including default boot options, Hibernation keys, Secure Boot information, etc
 ---
 Term | Description
 --- | ---
 **XNU**    | Also known as **X** is **N**ot **U**nix, XNU is referred to as macOS's "kernel" and the heart of what makes macOS tick
 **Kexts**   | Also known as **K**ernel **Ext**ensions, are macOS's drivers. They're used to perform different tasks like device drivers or for a different purpose (in this patcher) like patching the OS, injecting information or running tasks.
 **KernelCollection**   | Also known as the ImmutableKernel and PrelinkedKernel, this is a bundle of the kernel(XNU) and kernel extensions(Kexts) that we use to boot macOS. This is also what OpenCore patches in memory to allow us to have a seamless experience <br/>- PrelinkedKernel: Default caching system since 10.7 <br/>- ImmutableKernel: Secure Boot based caching system since 10.13 <br/>- KernelCollection: Merge of both Prelinked and ImmutableKernel's since macOS 11, Big Sur
-**IOKit**   | Backbone of how Kernel Extentions (Kexts) probe and attach onto hardware, starts quickly after kernel initates
+**IOKit**   | Backbone of how Kernel Extensions (Kexts) probe and attach onto hardware, starts quickly after kernel initiates
 **WindowServer**   | Backbone of the GUI interface in macOS, one of the first userfacing userspace programs to kick-in
 **OTA**   | Short for **O**ver **T**he **A**ir, refers to native OS updates via System Preferences like a supported Mac
-**DELTA**   | Often used with OTA, refers to OS updates that much smaller than full installers (generally ~3GB), note Deltas require the root volume to be unmotified otherwise ~12GB updates will occur.
+**DELTA**   | Often used with OTA, refers to OS updates that much smaller than full installers (generally ~3GB), note Deltas require the root volume to be unmodified otherwise ~12GB updates will occur.
 ---
 Term | Description
 --- | ---
 **EFI**   | It can denote two things: <br/>- Mac's firmware, which is the same as UEFI, but pretty modified for Macs only, so not so "Universal" <br/>- The partition on your hard drive that stores software read by the UEFI to load OSes (like the Windows bootloader) or UEFI Applications (like OpenCore), it's FAT32 formatted and has an ID type of EF00 (in hex). It can be named ESP or SYSTEM, and it's usually from 100MB to 400MB in size but the size doesn't reflect upon anything.
-**HFS+**   | Also known as MacOS Journaled, this was the default macOS drive format up until macOS 10.13, format was designed around spinning disks
-**APFS**   | This was the default macOS drive from macOS 10.13 and onwards for SSDs, and standard for all drives in Mojave. Format was designed around SSDs primarily.
+**HFS+**   | Also known as Mac OS Extended (Journaled), this was the default macOS drive format up until macOS 10.13. It was designed around spinning disks.
+**APFS**   | This is the default macOS drive format from macOS 10.13 and onwards for SSDs, and standard for all drives in Mojave. This format was designed primarily around SSDs.
 **32 and 64-Bit CPU**   | The bit number of a CPU determines how much data a CPU can address. <br/>- 32-Bit CPUs were only supported up-to Mac OS X 10.6, Snow Leopard.
-**32-Bit Firmware**   | The bit number of a Firmware determines how much data the firmware can address. In some older Macs, it's common to have a 64-Bit CPU can have a 32-Bit firmware<br/>- 32-Bit Firmwares were only supported up-to Mac OS X 10.7, Lion.
+**32-Bit Firmware**   | The bit number of a Firmware determines how much data the firmware can address. In some older Macs, it's common to have a 64-Bit CPU with a 32-Bit firmware<br/>- 32-Bit Firmwares were only supported up-to Mac OS X 10.7, Lion.
 **SSE Instructions**   | Also known as **S**IMD **S**ingle-Precision Floating-Point **I**nstructions,  these are defined as instruction sets supported by your CPU. In macOS, there are a certain number of instruction sets required for normal operation: <br/>- SSE3: Required for all Intel CPUs since Mac OS X 10.4, Tiger <br/>- SSSE3: Required for all Intel 64-Bit CPUs since Mac OS X 10.6, Snow Leopard  <br/>- SSE4.1: Required for all Intel CPUs since macOS 10.12, Sierra
 ---

docs/TESTED.md

@@ -1,118 +0,0 @@
-# Tested Models on OpenCore Legacy Patcher
-
-To aid users in troubleshooting, we've compiled a list of users who've reported success with OpenCore Legacy patcher as well as the version used. This should aid users in verifying whether issues with the patcher are regression-related with newer versions.
-
-
-### MacBook
-
-| SMBIOS | Tested | Tester | Comment |
-| :--- | :--- | :--- | :--- |
-| MacBook4,1 | <span style="color:#30BCD5"> YES </span> | Mami | - Stock Model<br/>- Couldn't install due to broke USB support |
-| MacBook5,1 | ^^ | air.man | - Stock Model<br/>- Patcher version 0.0.19 |
-| MacBook5,2 | ^^ | Finder352 | ^^ |
-| MacBook6,1 | ^^ | Finder352 | ^^ |
-| MacBook7,1 | ^^ | MykolaG | ^^ |
-| ^^ | ^^ | Jazzzny | ^^ |
-| ^^ | ^^ | AlexSakha67 | - Stock Model<br/>- Patcher version 0.0.20 |
-
-### MacBook Air
-
-| SMBIOS | Year | Supported | Comment |
-| :--- | :--- | :--- | :--- |
-| MacBookAir2,1 | No reports | N/A | N/A |
-| MacBookAir3,1 | ^^ | ^^ | ^^ |
-| MacBookAir3,2 | ^^ | ^^ | ^^ |
-| MacBookAir4,1 | ^^ | ^^ | ^^ |
-| MacBookAir4,2 | ^^ | ^^ | ^^ |
-| MacBookAir5,1 | <span style="color:#30BCD5"> YES </span> | Ausdauersportler | - Stock Model<br/>- Patcher version 0.0.9 |
-| ^^ | ^^ | webg3 | Stock Model |
-| MacBookAir5,2 | ^^ | Bab-droid | - Stock Model<br/>- Patcher version 0.0.19 |
-| ^^ | ^^ | K-Hobert | - Stock model <br/>- Patcher version unknown |
-| ^^ | ^^ | cboukouv | - Stock model <br/>- Patcher version 0.0.21 |
-
-### MacBook Pro
-
-| SMBIOS | Tested | Tester | Comment |
-| :--- | :--- | :--- | :--- |
-| MacBookPro4,1 | <span style="color:#30BCD5"> YES </span> | cboukouv | - Stock model <br/>- Patcher version 0.0.19 |
-| MacBookPro5,1 | ^^ | GURU_Jasho#5736 | - Stock model <br/>- Patcher version 0.0.21 |
-| MacBookPro5,2 | ^^ | hvds | ^^ |
-| MacBookPro5,3 | ^^ | kommtzeitkonrad | - Stock model <br/>- Patcher version 0.0.22 |
-| MacBookPro5,4 | No reports | N/A | N/A |
-| MacBookPro5,5 | ^^ | ^^ | ^^ |
-| MacBookPro6,1 | ^^ | ^^ | ^^ |
-| MacBookPro6,2 | <span style="color:#30BCD5"> YES </span> | Jakeluke | - Stock model, dGPU broken <br/>- Patcher version unknown |
-| MacBookPro7,1 | ^^ | fussel132 | - Stock model <br/>-Patcher version v0.1.2 |
-| MacBookPro8,1 | ^^ | AvaQueen | - Stock model <br/>- Patcher version 0.0.19 |
-| MacBookPro8,2 | ^^ | air.man | - Stock model, dGPU disabled <br/>- Patcher version 0.0.22 |
-| ^^ | ^^ | cboukouv | - Stock model <br/>- Patcher version 0.0.19 |
-| MacBookPro8,3 | No reports | N/A | N/A |
-| MacBookPro9,1 | <span style="color:#30BCD5"> YES </span> | jbdamiano | - Stock model <br/>- Patcher version 0.0.19 |
-| ^^ | ^^ | dennes544 | ^^|
-| ^^ | ^^ | cgrazy | ^^ |
-| ^^ | ^^ | LIPA85 | ^^ |
-| MacBookPro9,2 | ^^ | alexx17xx | - Stock model <br/>- Patcher version 0.0.19 |
-| ^^ | ^^ | Arvxistanx | ^^ |
-| ^^ | ^^ | CyberDroid1 | - Stock model<br/>- Patcher version 0.0.16 |
-| ^^ | ^^ | woefi | - BCM94331CAX upgrade<br/>- Patcher version 0.0.13 |
-| ^^ | ^^ | whgmkeller | - Stock model<br/>- Patcher version 0.0.11 |
-| ^^ | ^^ | vinaypundith | - Patcher version 0.0.7 |
-| MacBookPro10,1 | ^^ | traviswparker | - Stock model <br/>- Patcher version 0.0.14 |
-| ^^ | ^^ | il-rollino | - Upgraded BCM94360CSAX <br/>- Patcher version 0.0.21 |
-| MacBookPro10,2 | No reports | N/A | N/A |
-
-### Mac mini
-
-| SMBIOS | Tested | Tester | Comment |
-| :--- | :--- | :--- | :--- |
-| Macmini3,1 | No reports | N/A | N/A |
-| Macmini4,1 | ^^ | ^^ | ^^ |
-| Macmini5,1 | ^^ | ^^ | ^^ |
-| Macmini5,2 | ^^ | ^^ | ^^ |
-| Macmini5,3 | ^^ | ^^ | ^^ |
-| Macmini6,1 | <span style="color:#30BCD5"> YES </span> | cicofz | - Stock model <br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | Stig124 | - Stock model <br/>- Patcher version 0.0.19 |
-| ^^ | ^^ | mwidjaya | - Stock model <br/>- Patcher version 0.0.18 |
-| Macmini6,2 | ^^ | Shelbs | - Stock model <br/>- Patcher version 0.0.16 |
-
-### iMac
-
-| SMBIOS | Tested | Tester | Comment |
-| :--- | :--- | :--- | :--- |
-| iMac7,1 | No reports | N/A | N/A |
-| iMac8,1 | <span style="color:#30BCD5"> YES </span> | EduCovas | - Stock Model<br/>- Patcher version 0.0.21 |
-| iMac9,1 | ^^ | Allanrfox | ^^ |
-| ^^ | ^^ | Jakeluke | ^^ |
-| iMac10,1 | ^^ | Ausdauersportler | - Upgraded with WX4150 |
-| iMac11,1 | ^^ | internetzel | - Upgraded with RX580 mobile |
-| iMac11,2 | ^^ | MykolaG | - Stock Model<br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | iMac-iPad | - Stock Model<br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | vinaypundith | - Patcher version 0.0.19 |
-| iMac11,3 | ^^ | Ausdauersportler | - Upgraded with Polaris GPU<br/>- Upgraded BCM943602CDP<br/>- Patcher version 0.0.21 |
-| iMac12,1 | ^^ | shnockdu | - Upgraded with Kepler GPU<br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | StephN999 | - Upgraded WX4150 GPU<br/>- Upgraded BCM94360CD<br/>- Patcher version 0.0.21 |
-| iMac12,2 | ^^ | Ausdauersportler | - Upgraded with Polaris GPU<br/>- Upgraded BCM943602CDP<br/>- Patcher version 0.0.21 |
-| iMac13,1 | ^^ | alexx17xx | - Stock Model<br/>- Patcher version 0.0.19 |
-| iMac13,2 | ^^ | Alain13 | ^^ |
-| ^^ | ^^ | algernonpule | - Stock Model<br/>- Patcher version 0.0.19 |
-| iMac13,3 | No reports | N/A | N/A |
-| iMac14,1 | <span style="color:#30BCD5"> YES </span> | woefi | - Upgraded NVMe<br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | mikeboss | - Stock Model<br/>- Patcher version 0.0.19 |
-| iMac14,2 | ^^ | OKonnel | - Stock Model<br/>- Patcher version 0.0.22 |
-| ^^ | ^^ | mibaxx | - Stock Model<br/>- Patcher version 0.0.21 |
-| iMac14,3 | No reports | N/A | N/A |
-
-### Mac Pro
-
-| SMBIOS | Tested | Tester | Comment |
-| :--- | :--- | :--- | :--- |
-| MacPro3,1 | <span style="color:#30BCD5"> YES </span> | christiann | - Upgraded with RX 560 and BCM94322<br/>- Stock Bluetooth card removed<br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | gw463 | - Upgraded GTX 680<br/>- Upgraded BCM94360<br/>- Patcher version 0.0.22 |
-| ^^ | ^^ | AlexSakha67 | - Upgraded R9 280<br/>- Patcher version 0.0.20 |
-| ^^ | ^^ | nekton1 | - Upgraded GTX 680<br/>- Patcher version 0.0.20 |
-| ^^ | ^^ | Pri-est | - Patcher version 0.0.9 |
-| ^^ | ^^ | vinaypundith | - Upgraded GTX 680<br/>- Upgraded BCM94360CD<br/>- Patcher version 0.0.6 |
-| MacPro4,1 | ^^ | ^^ | - Patcher version 0.0.9 |
-| MacPro5,1 | ^^ | woefi | - Upgraded with RX 580<br/>- Patcher version 0.0.21 |
-| ^^ | ^^ | Mabrouk Oscar | - Patcher version 0.0.21 |
-| ^^ | ^^ | astuffedtiger | - MacPro4,1 flashed to 5,1<br/>- Patcher version 0.0.18 |

docs/TIMEMACHINE.md

@@ -0,0 +1,25 @@
+# Restoring Time Machine backup
+
+OCLP automatically installs root patches when installing from the USB drive for the first time to ensure smooth operation of the first time settings. 
+
+However, as an unfortunate side effect, restoring via Time Machine breaks while root patches are installed and restoring a root patched machine requires a few tricks to avoid a kernel panic.
+
+To ensure a smooth Time Machine restore, follow the steps listed under:
+
+1. In first time settings (Setup Assistant), do not restore the backup. Instead do all settings like you would want to start fresh.
+2. Once you reach desktop, open the OCLP application and revert root patches in the Post Install Volume Patches section.
+3. Restart your machine.
+   * Note: Your Mac will feel slow due to lack of graphics drivers and resolution may be wrong. WiFi will also be unavailable in most cases, if your backup is on a network drive, use Ethernet.
+4. Login and start Migration Assistant.
+5. Go through the restoring process.
+6. Once finished, go into the OCLP app and reinstall the root patches.
+
+Now you should be fully restored with Time Machine and also running with all patches.
+
+
+::: warning Sequoia Note
+
+Time Machine restoring seems to be currently broken on Sequoia even after uninstalling root patches, leading to a loop with "Migration Finished" window. Currently the only way is to restore on older OS and then upgrade to Sequoia.
+
+:::
+

docs/TROUBLESHOOTING.md

@@ -1,71 +1,320 @@
-# Troubleshooting
-
-Here are some common errors users may experience while using this patcher:
-
-* [Stuck on `This version of Mac OS X is not supported on this platform`](#stuck-on-this-version-of-mac-os-x-is-not-supported-on-this-platform)
-* [Cannot boot macOS without the USB](#cannot-boot-macos-without-the-usb)
-* [Infinite Recovery OS Booting](#infinite-recovery-os-reboot)
-* [Reboot when entering Hibernation (`Sleep Wake Failure`)](#reboot-when-entering-hibernation-sleep-wake-failure)
-* [Booting with a non-flashed GPU](#booting-with-a-non-flashed-gpu)
-* [How to Boot Big Sur Recovery](#how-to-boot-big-sur-recovery)
-* [Stuck on "Your Mac needs a firmware update"](#stuck-on-your-mac-needs-a-firmware-update)
-* [No Brightness Control](#no-brightness-control)
-
-## Stuck on `This version of Mac OS X is not supported on this platform`
-
-This means macOS has detected a SMBIOS it does not support, to resolve this ensure you're booting OpenCore **before** the macOS installer in the boot picker. Reminder the option will be called `EFI Boot`
-
-Once you've booted OpenCore at least once, your hardware should now auto boot it until either NVRAM reset or you remove the drive with OpenCore installed.
-
-## Cannot boot macOS without the USB
-
-By default, the OpenCore Patcher won't install OpenCore onto the internal drive itself during installs. Instead, you'll need to either [manually transfer](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html) OpenCore to the internal drive's EFI or run this patcher's Option 2 again but select your internal drive.
-
-Reminder that once this is done, you'll need to select OpenCore in the boot picker again for your hardware to remember this entry and auto boot from then on.
-
-## Infinite Recovery OS Booting
-
-With OpenCore Legacy Patcher, we rely on Apple Secure Boot to ensure OS updates work correctly and reliably with Big Sur. However this installs NVRAM variables that will confuse your Mac if not running with OpenCore. To resolve, simply uninstall OpenCore and [reset NVRAM](https://support.apple.com/en-mide/HT201255).
-
-* Note: Machines with modded root volumes will also result in infinite recovery until integrity is restored
-
-## Reboot when entering Hibernation (`Sleep Wake Failure`)
-
-[Known issue on some models](https://github.com/dortania/Opencore-Legacy-Patcher/issues/72), temporary fix is to disable Hibernation:
-
-```
-sudo pmset -a hibernatemode 0
-```
-
-## Booting with a non-flashed GPU
-
-For Mac Pro, Xserve and iMac users with non-flashed GPUs, you can still easily boot OpenCore and view the entire boot process. To do so, make sure SIP is disabled(to allow NVRAM write access) and run the following:
-
-```sh
-sudo bless --verbose --file /Volumes/VOLNAME/EFI/OC/OpenCore.efi --folder /Volumes/VOLNAME/EFI/OC --setBoot
-```
-
-* Note you will need to replace `VOLNAME` with the Volume name of your USB or hard drive with OpenCore
-* Note 2: Once done, you can re-enable SIP
-* Note 3: The EFI partition OpenCore was installed on must be mounted, if it's unmounted simply rerun "Install OpenCore to drive"
-
-Once you boot OpenCore for the first time, LauncherOption will install itself as the top boot priority making OpenCore always launch. Combined with `RequestBootVar`, all boot options must go through OpenCore ensuring seamless usage even with OS installation and updates.
-
-## How to Boot Big Sur Recovery
-
-By default, the patcher will try to hide extra boot options such as recovery from the user. To make them appear, simply press the "Spacebar" inside OpenCore's Picker to list all boot options.
-
-## Stuck on "Your Mac needs a firmware update"
-
-Full error: "Your Mac needs a firmware update in order to install to this Volume. Please select a Mac OS Extended (Journaled) volume instead."
-
-
-This error occurs when macOS determines the firmware to not have full APFS support. To resolve is quite simple, when building OpenCore head to "Patcher Settings" and enable "Moderate SMBIOS Patching" or higher. This will ensure that the firmware reported will show as supporting full APFS capabilities.
-
-## No Brightness Control
-
-With OCLP v0.0.22, we've added support for brightness control on many models. However some users may have noticed that their brightness keys do not work.
-
-To work-around, we recommend user try out the below app:
-
-* [Brightness Slider](https://actproductions.net/free-apps/brightness-slider/)
+# General troubleshooting
+
+Here are some common errors that users may experience while using this patcher:
+
+* [OpenCore Legacy Patcher not launching](#opencore-legacy-patcher-not-launching)
+* ["You don't have permission to save..." error when creating USB installer](#you-don-t-have-permission-to-save-error-when-creating-usb-installer)
+* [Stuck on `This version of Mac OS X is not supported on this platform` or (🚫) Prohibited Symbol](#stuck-on-this-version-of-mac-os-x-is-not-supported-on-this-platform-or-🚫-prohibited-symbol)
+* [Stuck on hard disk selection with greyed out buttons in installer](#stuck-on-hard-disk-selection-with-greyed-out-buttons-in-installer)
+* [Cannot boot macOS without the USB](#cannot-boot-macos-without-the-usb)
+* [Infinite Recovery OS Booting](#infinite-recovery-os-reboot)
+* [Internal disk missing when building OpenCore](#internal-disk-missing-when-building-opencore)
+* [System version mismatch error when root patching](#system-version-mismatch-error-when-root-patching)
+* [Stuck on boot after root patching](#stuck-on-boot-after-root-patching)
+* ["Unable to resolve dependencies, error code 71" when root patching](#unable-to-resolve-dependencies-error-code-71-when-root-patching)
+* [Reboot when entering Hibernation (`Sleep Wake Failure`)](#reboot-when-entering-hibernation-sleep-wake-failure)
+* [How to Boot Recovery through OpenCore Legacy Patcher](#how-to-boot-recovery-through-opencore-legacy-patcher)
+* [Stuck on "Your Mac needs a firmware update"](#stuck-on-your-mac-needs-a-firmware-update)
+* [No Brightness Control](#no-brightness-control)
+* [Cannot connect Wi-Fi on Monterey with legacy cards](#cannot-connect-Wi-Fi-on-Monterey-with-legacy-cards)
+* [No Graphics Acceleration](#no-graphics-acceleration)
+* [Black Screen on MacBookPro11,3 in macOS Monterey](#black-screen-on-macbookpro113-in-macos-monterey)
+* [No DisplayPort Output on Mac Pros with NVIDIA Kepler](#no-displayport-output-on-mac-pros-with-NVIDIA-kepler)
+* [Volume Hash Mismatch Error in macOS Monterey](#volume-hash-mismatch-error-in-macos-monterey)
+* [Cannot Disable SIP in recoveryOS](#cannot-disable-sip-in-recoveryos)
+* [Stuck on "Less than a minute remaining..."](#stuck-on-less-than-a-minute-remaining)
+* [No acceleration after a Metal GPU swap on Mac Pro](#no-acceleration-after-a-metal-gpu-swap-on-mac-pro)
+* [Keyboard, Mouse and Trackpad not working in installer or after update](#keyboard-mouse-and-trackpad-not-working-in-installer-or-after-update)
+* [No T1 functionality after installing Sonoma or newer](#no-t1-functionality-after-installing-sonoma-or-newer)
+
+
+## OpenCore Legacy Patcher not launching
+
+If the application won't launch (e.g. icon will bounce in the Dock), try launching OCLP via Terminal by typing the following command, make sure you've moved the app to `/Applications` before this.
+
+```sh
+/Applications/OpenCore-Patcher.app/Contents/MacOS/OpenCore-Patcher
+```
+
+## "You don't have permission to save..." error when creating USB installer
+
+In some cases, a following error saying "The bless of the installer disk failed" stating the reason as "You don't have permission to save..." may appear. 
+
+
+<div align="left">
+             <img src="./images/Error-No-Permission-To-Save.png" alt="NoPermissionToSave" width="600" />
+</div>
+
+
+To resolve this, you may try adding Full Disk Access permission for OpenCore Legacy Patcher. To add it, first go to the settings
+
+* Ventura and Sonoma: Go to System Settings -> Privacy and Security -> Full Disk Access
+
+* Big Sur and Monterey: Go to System Preferences -> Security and Privacy -> Full Disk Access
+
+Enable OpenCore-Patcher in the list. If not found on the list, press the + sign to add a new entity and find OpenCore Legacy Patcher from Applications.
+
+Restart OpenCore Legacy Patcher and try creating your USB drive again.
+
+Optional: After you've created your USB drive, you can remove OpenCore Legacy Patcher from Full Disk Access again.
+
+
+## Stuck on `This version of Mac OS X is not supported on this platform` or (🚫) Prohibited Symbol
+
+This means macOS has detected an SMBIOS it does not support. To resolve this, ensure you're booting OpenCore **before** the macOS installer in the boot picker. Reminder that the option will be called `EFI Boot`.
+
+Once you've booted OpenCore at least once, your hardware should now auto-boot it until either an NVRAM reset occurs, or you remove the drive with OpenCore installed.
+
+However, if the 🚫 Symbol only appears after the boot process has already started (the bootscreen appears/verbose boot starts), it could mean that your USB drive has failed to pass macOS' integrity checks. To resolve this, create a new installer using a different USB drive (preferably of a different model.)
+
+## Stuck on hard disk selection with greyed out buttons in installer
+
+Switch installer language to English. If the language selector doesn't show up, [reset NVRAM](https://support.apple.com/en-mide/102603) and boot into the installer again.
+
+You can switch back to different language once macOS has installed.
+
+## Cannot boot macOS without the USB
+
+By default, the OpenCore Patcher won't install OpenCore onto the internal drive itself during installs.
+
+After installing macOS, OpenCore Legacy Patcher should automatically prompt you to install OpenCore onto the internal drive. However, if it doesn't show the prompt, you'll need to either [manually transfer](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html) OpenCore to the internal drive's EFI or Build and Install again and select your internal drive.
+
+Reminder that once this is done, you'll need to select OpenCore in the boot picker again for your hardware to remember this entry and auto boot from then on.
+
+## Infinite Recovery OS Booting
+
+With OpenCore Legacy Patcher, we rely on Apple Secure Boot to ensure OS updates work correctly and reliably with Big Sur. However this installs NVRAM variables that will confuse your Mac if not running with OpenCore. To resolve this, simply uninstall OpenCore and [reset NVRAM](https://support.apple.com/en-mide/HT201255).
+
+* Note: Machines with modified root volumes will also result in an infinite recovery loop until integrity is restored.
+
+## Internal disk missing when building OpenCore
+
+If you're using a brand new disk that has not been used before or was never formatted in any macOS type, you may face the following error in OCLP when trying to build on the internal disk.
+
+<div align="left">
+             <img src="./images/OCLP_Failed_to_find_applicable_disks.png" alt="Failed to find applicable disks" width="600" />
+</div>
+
+There are two ways to to try and resolve this.
+
+1. Create a new FAT32 partition using Disk Utility, sized at around 100MB, naming does not matter. OpenCore will detect it and you will be able to build your EFI there.
+
+2. When installing macOS, choose "View -> Show all devices" in Disk Utility and format the entire disk by choosing the topmost option in the sidebar.
+
+<div align="left">
+             <img src="./images/wipe-disk.png" alt="Wipe disk" width="800" />
+</div>
+
+
+## System version mismatch error when root patching
+
+Updates from now on modify the system volume already while downloading, which can lead to broken patches out of a sudden as well as a "version mismatch" error while root patching, since the operating system gets into a liminal state between two versions. The "version mismatch" error is a safeguard preventing OCLP from patching on a system that is in a weird liminal state, to avoid leading to a very likely boot failure.
+
+Currently there is a "PurgePendingUpdate" tool available [on the Discord server](https://discord.com/channels/417165963327176704/1037474131526029362/1255993208966742108) you can download and then run it in Terminal, to get rid of a pending update. This may be integrated into OCLP later on, however there is currently no ETA.
+
+Disabling automatic macOS updates is extremely recommended once recovered, to prevent it from happening again.
+
+**macOS Ventura and newer:**
+
+System Settings -> General -> Software Update -> (i) button next to Automatic Updates -> Disable "Download new updates when available".
+
+**macOS Big Sur and Monterey:**
+
+System Preferences -> Software Update -> Advanced -> Disable "Download new updates when available".
+
+## Stuck on boot after root patching
+
+Boot into recovery by pressing space when your disk is selected on the OCLP bootpicker (if you have it hidden, hold ESC while starting up)
+
+* **Note:** If your disk name is something else than "Macintosh HD", make sure to change the path accordingly. You can figure out your disk name by typing `ls /Volumes`.
+
+Go into terminal and first mount the disk by typing
+```sh
+mount -uw "/Volumes/Macintosh HD"
+```
+Then revert the snapshot
+```sh
+bless --mount "/Volumes/Macintosh HD" --bootefi --last-sealed-snapshot
+```
+Now we're going to clean the /Library/Extensions folder from offending kexts while keeping needed ones.
+
+Run the following and **make sure to type it carefully**
+
+::: warning
+If you have **FileVault 2 enabled**, you will need to mount the Data volume first. This can be done in Disk Utility by locating your macOS volume name, selecting its Data volume, and selecting the Mount option in the toolbar.
+:::
+
+```sh
+cd "/Volumes/Macintosh HD - Data/Library/Extensions" && ls | grep -v "HighPoint*\|SoftRAID*" | xargs rm -rf
+```
+
+Then restart and now your system should be restored to the unpatched snapshot and should be able to boot again.
+
+## "Unable to resolve dependencies, error code 71" when root patching
+
+If you're getting this error, it typically means you have some offending kernel extensions, to fix this you will have to clear them.
+
+Semi-automated way:
+
+1. Open Terminal
+2. Type `sudo zsh`
+3. Type `cd "/Volumes/Macintosh HD/Library/Extensions" && ls | grep -v "HighPoint*\|SoftRAID*" | xargs rm -rf`
+   * Make sure to rename "Macintosh HD" to what your drive name is
+4. Run OCLP root patcher again
+   
+Manual way:
+
+1. Navigate to /Library/Extensions
+2. Delete everything **except** HighPointIOP.kext, HighPointRR.kext and SoftRAID.kext
+3. Run OCLP root patcher again
+
+If there is no success, navigate to "/Library/Developer/KDKs" and delete everything.
+
+If still no success, type `sudo bless --mount "/Volumes/Macintosh HD/" --bootefi --last-sealed-snapshot` 
+* Make sure again to rename "Macintosh HD" to what your drive name is
+
+Run OCLP root patcher again.
+
+## Reboot when entering Hibernation (`Sleep Wake Failure`)
+
+[Known issue on some models](https://github.com/dortania/Opencore-Legacy-Patcher/issues/72), a temporary fix is to disable Hibernation by executing the following command in the terminal:
+
+```
+sudo pmset -a hibernatemode 0
+```
+
+## How to Boot Recovery through OpenCore Legacy Patcher
+
+By default, the patcher will try to hide extra boot options such as recovery from the user. To make them appear, simply press the `Spacebar` key while inside OpenCore's Picker to list all boot options.
+
+## Stuck on "Your Mac needs a firmware update"
+
+Full error: "Your Mac needs a firmware update in order to install to this Volume. Please select a Mac OS Extended (Journaled) volume instead."
+
+This error occurs when macOS determines that the current firmware does not have full APFS support. To resolve this, when installing OpenCore, head to "Patcher Settings" and enable "Moderate SMBIOS Patching" or higher. This will ensure that the firmware reported will show support for full APFS capabilities.
+
+## No Brightness Control
+
+With OCLP v0.0.22, we've added support for brightness control on many models. However, some users may have noticed that their brightness keys do not work.
+
+As a work-around, we recommend users try out the below app:
+
+* [Brightness Slider](https://actproductions.net/free-apps/brightness-slider/)
+
+## Cannot connect Wi-Fi on Monterey with legacy cards
+
+With OCLP v0.2.5, we've added support for legacy Wi-Fi on Monterey. However, some users may have noticed that they can't connect to wireless networks.
+
+To work-around this, we recommend that users manually connect using the "Other" option in the Wi-Fi menu bar or manually adding the network in the "Network" preference pane.
+
+## No Graphics Acceleration
+
+In macOS, GPU drivers are often dropped from the OS with each major release of it. With macOS Big Sur, currently, all non-Metal GPUs require additional patches to gain acceleration. In addition, macOS Monterey removed Graphics Drivers for both Intel Ivy Bridge and NVIDIA Kepler graphics processors.
+
+If you're using OCLP v0.4.4, you should have been prompted to install Root Volume patches after the first boot from installation of macOS. If you need to do this manually, you can do so within the patcher app. Once rebooted, acceleration will be re-enabled as well as brightness control for laptops.
+
+## Black Screen on MacBookPro11,3 in macOS Monterey
+
+Due to Apple dropping NVIDIA Kepler support in macOS Monterey, [MacBookPro11,3's GMUX has difficulties switching back to the iGPU to display macOS correctly.](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/522) To work-around this issue, boot the MacBookPro11,3 in Safe Mode and once macOS is installed, run OCLP's Post Install Root Patches to enable GPU Acceleration for the NVIDIA dGPU.
+
+* Safe Mode can be started by holding `Shift` + `Enter` when selecting macOS Monterey in OCLP's Boot Menu.
+
+## No DisplayPort Output on Mac Pros with NVIDIA Kepler
+
+If you're having trouble with DisplayPort output on Mac Pros, try enabling Minimal Spoofing in Settings -> SMBIOS Settings and rebuild/install OpenCore. This will trick macOS drivers into thinking you have a newer MacPro7,1 and resolve the issue.
+
+
+<div align="left">
+             <img src="./images/OCLP-GUI-SMBIOS-Minimal.png" alt="GUI SMBIOS minimal" width="800" />
+</div>        
+
+
+## Volume Hash Mismatch Error in macOS Monterey
+
+A semi-common popup some users face is the "Volume Hash Mismatch" error:
+
+<p align="left">
+<img src="./images/Hash-Mismatch.png">
+</p>
+
+What this error signifies is that the OS detects that the boot volume's hash does not match what the OS is expecting, this error is generally cosmetic and can be ignored. However if your system starts to crash spontaneously shortly after, you'll want to reinstall macOS fresh without importing any data at first.
+
+* Note that this bug affects native Macs as well and is not due to issues with unsupported Macs: [OSX Daily: “Volume Hash Mismatch” Error in MacOS Monterey](https://osxdaily.com/2021/11/10/volume-hash-mismatch-error-in-macos-monterey/)
+
+Additionally, it can help to disable FeatureUnlock in Settings -> Misc Settings as this tool can be strenuous on systems with weaker memory stability.
+
+## Cannot Disable SIP in recoveryOS
+
+With OCLP, the patcher will always overwrite the current SIP value on boot to ensure that users don't brick an installation after an NVRAM reset. However, for users wanting to disable SIP entirely, this can be done easily.
+
+Head into the GUI, go to Patcher Settings, and toggle the bits you need disabled from SIP:
+
+| SIP Enabled | SIP Lowered (Root Patching) | SIP Disabled |
+| :--- | :--- | :--- |
+| ![](./images/OCLP-GUI-Settings-SIP-Enabled.png) | ![](./images/OCLP-GUI-Settings-SIP-Root-Patch.png) | ![](./images/OCLP-GUI-Settings-SIP-Disabled.png) |
+
+## Intermediate issues with USB 1.1 and Bluetooth on MacPro3,1 - MacPro5,1
+
+For those experiencing issues with USB 1.1 devices (such as mice, keyboards and bluetooth chipsets), macOS Big Sur and newer have weakened OS-side reliability for the UHCI controller in older Mac Pros.
+
+* UHCI is a USB 1.1 controller that is hooked together with the USB 2.0 ports in your system. Whenever a USB 1.1 device is detected, the UHCI controller is given ownership of the device at a hardware/firmware level.
+  * EHCI is the USB 2.0 controller in older Mac Pros
+
+Because of this, we recommend placing a USB 2.0/3.0 hub between your devices and the port on the Mac Pro. UHCI and EHCI cannot both be used at once, so using a USB hub will always force the EHCI controller on.
+
+* Alternatively, you can try cold-starting the hardware and see if macOS recognizes the UHCI controller properly.
+
+## Stuck on "Less than a minute remaining..."
+
+A common area for systems to get "stuck", namely for units that are missing the `AES` CPU instruction/older mobile hardware. During this stage, a lot of heavy cryptography is performed, which can make systems appear to be stuck. In reality they are working quite hard to finish up the installation.
+
+Because this step can take a few hours or more depending on drive speeds, be patient at this stage and do not manually power off or reboot your machine as this will break the installation and require you to reinstall. If you think your system has stalled, press the Caps Lock key. If the light turns on, your system is busy and not actually frozen.
+
+## No acceleration after a Metal GPU swap on Mac Pro
+
+If you finished installing macOS with the original card installed (to see bootpicker for example) and swapped your GPU to a Metal supported one, you may notice that you're missing acceleration. To fix this, open OCLP and revert root patches to get your Metal-supported GPU work again. In macOS Ventura and newer, repatching is needed after reversion.
+
+Alternatively, you can remove "AutoPkg-Assets.pkg" from /Library/Packages on the USB drive before proceeding with the installation. To see the folder, enable hidden files with `Command` + `Shift` + `.`
+
+The reason for this is that the autopatcher will assume that you will be using the original graphics card and therefore does non-metal patching, which includes removing some drivers for other cards. This causes Metal cards to not accelerate after swapping.
+
+## Keyboard, Mouse and Trackpad not working in installer or after update
+
+For Macs using legacy USB 1.1 controllers, OpenCore Legacy Patcher can only restore support once it has performed root volume patches. Thus to install macOS, you need to hook up a USB hub between your Mac and Keyboard/Mouse.
+
+::: warning Note
+
+In macOS Sonoma, this seems to have been further weakened and some hubs may not be functional. 
+
+Alternative way is making sure to enable "Remote Login" in General -> Sharing before updating, which will enable SSH. That means you can take control using Terminal in another system by typing `ssh username@lan-ip-address` and your password. After that run Post Install Volume Patching by typing `/Applications/OpenCore-Patcher.app/Contents/MacOS/OpenCore-Patcher --patch_sys_vol` and finally `sudo reboot`.
+
+:::
+
+
+
+* For MacBook users, you'll need to find an external keyboard/mouse in addition to the USB hub
+
+More information can be found here:
+
+* [Legacy UHCI/OHCI support in Ventura #1021](https://github.com/dortania/OpenCore-Legacy-Patcher/issues/1021)
+
+Applicable models include:
+
+| Family      | Year                 | Model                         | Notes                                            |
+| :---------- | :--------------------| :---------------------------- | :----------------------------------------------- |
+| MacBook     | Mid 2010 and older   | MacBook5,1 - MacBook7,1       |                                                  |
+| MacBook Air | Late 2010 and older  | MacBookAir2,1 - MacBookAir3,x |                                                  |
+| MacBook Pro | Mid 2010 and older   | MacBookPro4,1 - MacBookPro7,x | Excludes Mid 2010 15" and 17" (MacBookPro6,x)    |
+| iMac        | Late 2009 and older  | iMac7,1 - iMac10,x            | Excludes Core i5/7 27" late 2009 iMac (iMac11,1) |
+| Mac mini    | Mid 2011 and older   | Macmini3,1 - Macmini5,x       |                                                  |
+| Mac Pro     | Mid 2010 and older   | MacPro3,1 - MacPro5,1         |                                                  |
+
+<div align="left">
+             <img src="./images/usb11-chart.png" alt="USB1.1 chart" width="800" />
+</div>
+
+## No T1 functionality after installing Sonoma or newer
+
+If you notice your Touchbar etc not working, this means loss of T1 functionality. 
+
+Wiping the entire disk using Disk Utility with Sonoma or newer causes the T1 firmware to be removed, which due to removed support, the macOS Sonoma+ installer will not restore. To restore T1 functionality, Ventura or older has to be reinstalled. This can be done in another volume or external disk as well, as long as the OS is booted once. After this you can wipe the old OS or unplug the external disk.

docs/UNINSTALL.md

@@ -1,12 +1,45 @@
-# Uninstalling OpenCore
+# Uninstall
 
-To remove OpenCore is actually quite simply:
+This guide tells you different ways to uninstall OCLP and/or patches.
+
+## Delete everything and revert back to native macOS
+
+Boot a native macOS installer, go to Disk Utility and choose View -> Show All Devices. Wipe the full disk by choosing the top option on the left sidebar and start macOS installation.
+
+[Reset NVRAM](https://support.apple.com/HT204063) afterwards.
+
+## Uninstalling the application
+
+### Version 1.5.0 and newer
+
+Version 1.5.0 and newer use a Privileged Helper Tool that requires more thorough uninstallation than previous versions. Download the uninstaller package from [the releases page.](https://github.com/dortania/OpenCore-Legacy-Patcher/releases)
+
+### Version 1.4.3 and older.
+
+Navigate to `/Library/Application Support/` and delete the Dortania folder.
+
+## Reverting root patches
+
+Open the OCLP application and go into the Post Install Root Patch menu, choose Revert Root Patches.
+
+If you're planning to revert back to native version, you don't have to do this. Root patches get wiped when you wipe the disk.
+
+## Uninstalling the bootloader
 
 1. Remove OpenCore either from the USB or internal drive
-  * You'll need to mount the drive's EFI partition, and delete the EFI/OC folder as well as the System folder
-    * Note **do not** delete the entire EFI folder, this will likely break any existing Windows and Linux installations
-  * [See here for example how to mount](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html)
-2. Reset NVRAM
-  * [Reset NVRAM or PRAM on your Mac](https://support.apple.com/HT204063)
 
-Know that if you are on Big Sur when you remove the EFI folder, your Mac will no longer boot and show the prohibited symbol. Be ready to install an older version of macOS before you uninstall OpenCore.
+  * You'll need to mount the drive's EFI partition, and delete the `EFI/OC` and `System` folders
+    * Note: **Do not** delete the entire EFI folder, this will likely break any existing Windows and Linux installations.
+    * [See here for an example on how to mount](https://dortania.github.io/OpenCore-Post-Install/universal/oc2hdd.html)
+    * For 5K iMac users, you will also need to delete `boot.efi` on the root of the EFI partition.
+
+2. [Reset NVRAM](https://support.apple.com/HT204063)
+
+:::warning
+
+Note that after you remove OpenCore, your Mac will no longer boot and show the "prohibited" symbol. Be prepared to have a bootable USB drive with either OpenCore or natively-supported version of macOS before you uninstall the bootloader.
+
+* This does not apply to native Macs just using OpenCore to achieve features like AirPlay to Mac and Sidecar, but it is still recommended to reinstall macOS after removing OpenCore, if using SMBIOS spoofing to enable Universal Control and other features.
+:::
+
+

docs/UNIVERSALCONTROL.md

@@ -0,0 +1,344 @@
+
+# Universal Control on unsupported Macs
+
+Introduced in macOS 12 Monterey, Universal Control is a feature that allows a Mac to control other Macs and/or iPads, share input devices, and share files across them simultaneously. With OpenCore and FeatureUnlock, Universal Control can be unlocked for most unsupported Macs, as long as they meet the technical requirements listed on this page.
+
+::: warning Note
+
+These features are not actively tested and may break at any time. The following page is primarily for tinkerers, no proper support is provided outside of Discord support (see bottom of page).
+
+:::
+
+## Enabling Universal Control
+
+If you meet all the requirements, in most cases you can go to Display Preferences and tick the Universal Control settings to enable it. If you're planning to use Universal Control with an iPad, make sure to enable Universal Control on the iPad as well.
+
+
+| Display Preferences | Universal Control settings |
+| :--- | :--- |
+| ![](./images/UC-enable-1.png) | ![OCLP GUI Build Finished](./images/UC-enable-2.png) |
+
+
+Most Mac models from 2011 and above should work out of the box. However, older Macs like the 2008-2011 MacBook Pros require upgrading the Wi-Fi/Bluetooth card to a newer model. More info in the [requirements section.](#requirements-for-universal-control)
+
+Some Monterey-native models are blacklisted, check the [blacklisted models section](#blacklisted-models) for more info.
+
+## Requirements for Universal Control
+
+Technical requirements:
+
+* Wi-Fi 4 (802.11n)
+* Bluetooth 4.0
+* macOS Monterey 12.4 or newer
+* iPadOS 15.4 or newer (if applicable)
+* OpenCore Legacy Patcher 0.4.3 or newer
+
+Check the [table of models](#table-of-models) below to see whether you need to upgrade hardware and exactly what hardware is required to be changed based on the offending Macs listed. For help on how to upgrade the Wi-Fi card in older 2008-2011 models, refer to the `#hardware` channel in the [Discord server](https://discord.gg/rqdPgH8xSN) if required.
+
+
+
+Other requirements:
+
+* All devices are signed into the same iCloud account.
+* Two Factor Authentication is enabled with your Apple ID.
+* Bluetooth and WiFi are enabled. Neither needs to be connected, leaving them enabled is sufficient.
+* Handoff turned on from iCloud settings.
+* The devices in question are in close proximity.
+
+
+### Table of models
+
+This table shows which models do and do not support Universal Control out of box (OOB) and what is required to gain support.
+Note: For AirPort upgrades, only the best/newest cards are listed.
+
+::: details MacBook
+
+|   SMBIOS   | WiFi/BT version | UC OOB  | Comment |
+|------------|-----------------|------------|---------|
+| MacBook5,1 | Wi-Fi 4 / BT 2.0 EDR |  <span style="color:red"> NO </span> | Use a Broadcom USB Bluetooth 4.0+ Dongle </span> |
+| MacBook5,2 | WiFi 4 / BT 2.1 EDR  | ^^ | Replace stock AirPort card with an mPCIE + USB Connector Adapter board with a BCM94360CS2 card  |
+| MacBook6,1 | ^^ | ^^ | Replace stock AirPort card with a BCM94331PCIEBT4CAX/BCM94331PCIEBT4 card |
+| MacBook7,1 | ^^ | ^^ | ^^ |
+| MacBook8,1 | WiFi 4 + BT 4.2 | <span style="color:#30BCD5"> YES </span> | Universal Control will work. |
+
+:::
+
+::: details MacBook Air
+
+| SMBIOS | WiFi/BT version | UC OOB  | Comment |
+|--------|-----------------|------------|---------|
+| MacBookAir2,1 | Wi-Fi 4 / BT 2.1 EDR | <span style="color:red"> NO </span> | Use a Broadcom USB Bluetooth 4.0+ Dongle |
+| MacBookAir3,1 | ^^ | ^^ | Replace stock AirPort card with a BCM94360CS2 card |
+| MacBookAir3,2 | ^^ | ^^ | ^^ |
+| MacBookAir4,1 | Wi-Fi 4 +  BT 4.0 | <span style="color:#30BCD5"> YES </span> | Universal Control will work. |
+| MacBookAir4,2 | ^^ | ^^ | ^^ |
+| MacBookAir5,1 | ^^ | ^^ | ^^ |
+| MacBookAir5,2 | ^^ | ^^ | ^^ |
+| MacBookAir6,1 | Wi-Fi 5 + BT 4.0 | ^^ | ^^ |
+| MacBookAir6,2 | ^^ | ^^ | ^^ |
+| MacBookAir7,1 | ^^ | <span style="color:red"> NO </span> | Hardware supports UC. <br> [**Spoofing required.**](#blacklisted-models)|
+| MacBookAir7,2 | ^^ | ^^ | ^^ |
+
+
+:::
+
+::: details MacBook Pro
+
+| SMBIOS | WiFi/BT version | UC OOB   | Comment |
+|--------|-----------------|-------------|---------|
+| MacBookPro4,1 | Wi-Fi 4   /   BT 2.1 EDR | <span style="color:red"> NO </span> | Replace stock AirPort card with an mPCIE + USB Connector Adapter board with a BCM94360CS2 card |
+| MacBookPro5,1 | ^^ | ^^ | Use a Broadcom USB Bluetooth 4.0+ Dongle |
+| MacBookPro5,2 | ^^ | ^^ | ^^ |
+| MacBookPro5,3 | ^^ | ^^ | ^^ |
+| MacBookPro5,4 | ^^ | ^^ | ^^ |
+| MacBookPro5,5 | ^^ | ^^ | ^^ |
+| MacBookPro6,1 | ^^ | ^^ | ^^ |
+| MacBookPro6,2 | ^^ | ^^ | Replace stock AirPort card with a BCM94331PCIEBT4CAX/BCM94331PCIEBT4 card |
+| MacBookPro7,1 | ^^ | ^^ | Use a Broadcom USB Bluetooth 4.0+ Dongle |
+| MacBookPro8,1 | Wi-Fi 4 + BT 2.1 EDR | ^^ | Replace stock AirPort card with a BCM94331PCIEBT4CAX/BCM94331PCIEBT4 card |
+| MacBookPro8,2 | ^^ | ^^ | ^^ |
+| MacBookPro9,1 | Wi-Fi 4 + BT 4.0 | <span style="color:#30BCD5"> YES </span> | Universal Control will work. |
+| MacBookPro9,2 | ^^ | ^^ | ^^ |
+| MacBookPro10,1 | ^^ | ^^ | ^^ |
+| MacBookPro10,2 | ^^ | ^^ | ^^ |
+| MacBookPro11,1 | Wi-Fi 5 + BT 4.0 | ^^ | ^^ |
+| MacBookPro11,2 | ^^ | ^^ | ^^ |
+| MacBookPro11,3 | ^^ | ^^ | ^^ |
+| MacBookPro11,4 | Wi-Fi 5 + BT 4.2 | <span style="color:red"> NO </span> | Hardware supports UC. <br> [**Spoofing required.**](#blacklisted-models) |
+| MacBookPro11,5 | ^^ | ^^ | ^^ |
+| MacBookPro12,1 | ^^ | ^^ | ^^ |
+:::
+
+:::details Mac mini
+
+| SMBIOS | WiFi/BT version | UC OOB | Comment |
+|--------|-----------------|------------|---------|
+| Macmini3,1 | Wi-Fi 4 + BT 2.1 EDR  |  <span style="color:red"> NO </span>  | Upgrade requires some heavy electrical and case modifications, so instead used a Broadcom USB Bluetooth 4.0+ Dongle. |
+| Macmini4,1 | ^^ |  ^^ | ^^ |
+| Macmini5,1 | Wi-Fi 4 + BT 4.0 | <span style="color:#30BCD5"> YES </span> | Universal Control will work. |
+| Macmini5,2 | ^^ | ^^ | ^^ |
+| Macmini5,3 | ^^ | ^^ | ^^ |
+| Macmini6,1 | ^^ | ^^ | ^^ |
+| Macmini6,2 | ^^ | ^^ | ^^ |
+| Macmini7,1 | Wi-Fi 5 + BT 4.0 | <span style="color:red"> NO </span> | Hardware supports UC. <br> [**Spoofing required.**](#blacklisted-models) |
+
+:::
+
+
+:::details iMac
+
+|  SMBIOS  | WiFi/BT version | UC OOB | Comment |
+|----------|-----------------|------------|---------|
+| iMac7,1  | Wi-Fi 4 + BT 2.0 EDR  | <span style="color:red"> NO </span> | Replace stock AirPort card with an mPCIE + USB Connector Adapter board with a BCM94360CD card
+| iMac8,1  | ^^ | ^^ | ^^ |
+| iMac9,1  | Wi-Fi 4 / BT 2.1 EDR  | ^^ | ^^ |
+| iMac10,1 | ^^ | ^^ | ^^ |
+| iMac11,1 | ^^ | ^^ | ^^ |
+| iMac11,2 | ^^ | ^^ | ^^ |
+| iMac11,3 | ^^ | ^^ | ^^ |
+| iMac12,1 | ^^ | ^^ | Replace stock AirPort card with an mPCIE + USB Connector Adapter board with a BCM943602CD card
+| iMac12,2 | ^^ | ^^ | ^^ |
+| iMac13,1 | Wi-Fi 4 + BT 4.0 | <span style="color:#30BCD5"> YES </span> | Universal Control will work. |
+| iMac13,2 | ^^ | ^^ | ^^ |
+| iMac13,3 | ^^ | ^^ | ^^ |
+| iMac14,1 | Wi-Fi 5 + BT 4.0 | ^^ | ^^ |
+| iMac14,2 | ^^ | ^^ | ^^ |
+| iMac14,3 | ^^ | ^^ | ^^ |
+| iMac14,4 | ^^ | ^^ | ^^ |
+| iMac15,1 | ^^ | ^^ | ^^ |
+| iMac16,1 | Wi-Fi 5 + BT 4.2 | <span style="color:red"> NO </span> | Hardware supports UC. <br> [**Spoofing required.**](#blacklisted-models) |
+| iMac16,2 | ^^ | ^^ | ^^ |
+
+:::
+
+:::details Mac Pro
+
+| SMBIOS    | WiFi/BT version | UC OOB  | Comment |
+|-----------|-----------------|---------|---------|
+| MacPro3,1 | Wi-Fi 4 + BT 2.0 EDR | <span style="color:red"> NO </span> | Replace stock AirPort card with an mPCIE Adapter board with a BCM943602CD card |
+| MacPro4,1 | Wi-Fi 4 + BT 2.1 EDR | ^^ | Replace stock AirPort card with an mPCIE + USB Connector Adapter board with a BCM943602CD card |
+| MacPro5,1 | ^^ | ^^ | ^^ |
+| MacPro6,1 | Wi-Fi 5 + BT 4.0 | ^^ | Hardware supports UC. <br> [**Spoofing required.**](#blacklisted-models) |
+
+* Note: Some older Mac Pro configurations may not have shipped with a WiFi card in the base model
+
+
+:::
+
+
+:::details Xserve ;p
+
+| SMBIOS    | WiFi/BT version | UC OOB  | Comment |
+|-----------|-----------------|---------|---------|
+| Xserve2,1 | N/A | <span style="color:red"> NO </span> | Install a PCIe BCM943602CD card |
+| Xserve3,1 | ^^ | ^^ | ^^ |
+
+:::
+
+## Blacklisted models
+
+The following models are blacklisted from using Universal Control by Apple:
+
+- MacBookAir7,x - MacBook Air Early 2015 11" / 13"
+- MacBookPro11,4 - MacBook Pro Mid 2015 15" (Intel Iris)
+- MacBookPro11,5 - MacBook Pro Mid 2015 15" (dGPU)
+- MacBookPro12,x - MacBook Pro Early 2015 13"
+- iMac16,x - iMac Late 2015 21"
+- Macmini7,x - Mac mini 2014
+- MacPro6,x - Mac Pro Late 2013
+
+The hardware in these models are capable of supporting Universal Control, but due to blacklisting, the only solution to use Universal Control on these models is to spoof their SMBIOS. SMBIOS spoofing essentially fools some aspects of macOS to think they are running on a different machine.
+
+With SMBIOS Spoofing, the Universal Control handshake recognizes a different SMBIOS and thus grants a blacklisted Mac to connect to other Macs and iPads with Universal Control.
+
+| Situation | Condition | Solution |
+|-----------|-----------|---------|
+| Mac <-> Mac connection | Monterey-unsupported | No spoofing needed |
+| Mac <-> iPad connection | Monterey-unsupported | No spoofing needed |
+| Mac <-> Mac connection | One or both are blacklisted |Spoofing required on blacklisted Macs |
+| Mac <-> iPad connection | Blacklisted Mac | Spoofing required on blacklisted Mac |
+
+:::warning
+
+Before we continue, please keep in mind that SMBIOS Spoofing is an advanced feature of OpenCore. Reckless usage of it could potentially break important functionality and leave your installation in a non-working state. Once you boot into a spoofed state, it is highly recommended that you stay spoofed, and avoid booting macOS without OpenCore.
+
+:::
+
+### How to spoof
+
+
+::: details macOS Sequoia
+
+Firstly run OpenCore Legacy Patcher.
+
+Then go to **Settings** and **SMBIOS** tab, set SMBIOS Spoof Level to **Moderate**. Set SMBIOS Spoof Model **one listed next to your native model in the table for spoofed models below.**
+
+Notice that "Allow native models" and "Allow Native Spoofs" **are NOT** enabled unlike on Monterey, this is on purpose. They are no longer relevant on Sonoma and enabling them will cause boot issues.
+
+| Main Settings view | SMBIOS settings |
+| :--- | :--- |
+| ![](./images/ventura_uc1.png) | ![](./images/ventura_uc2.png) |
+
+
+
+::: details Table for spoofed models (click to expand)
+
+Spoofing to any model with native Sequoia support should work, but these are the earliest Macs natively supported by Sequoia and thus chosen for the sake of simplicity.
+
+**Reminder:** Macs that are not listed on this table work without spoofing, including systems that do not natively support Sequoia as long as the other requirements are met, since they aren't blacklisted.
+
+
+| Mac by name | Native SMBIOS | Spoof SMBIOS |
+|-------------|---------------|--------------|
+| MacBook Air Early 2015 11" / 13" | MacBookAir7,x | MacBookAir9,1 |
+| MacBook Pro Early 2015 13" | MacBookPro12,x | MacBookPro15,2 |
+| MacBook Pro Mid 2015 15" | MacBookPro11,4 / 11,5 | MacBookPro15,2 |
+| iMac Late 2015 21" | iMac16,x | iMac19,2 |
+| Mac mini Late 2014  | Macmini7,x | MacMini8,1 |
+| Mac Pro Late 2013 | MacPro6,x | MacPro7,1 |
+
+:::
+
+::: details macOS Sonoma
+
+Firstly run OpenCore Legacy Patcher.
+
+Then go to **Settings** and **SMBIOS** tab, set SMBIOS Spoof Level to **Moderate**. Set SMBIOS Spoof Model **one listed next to your native model in the table for spoofed models below.**
+
+Notice that "Allow native models" and "Allow Native Spoofs" **are NOT** enabled unlike on Monterey, this is on purpose. They are no longer relevant on Sonoma and enabling them will cause boot issues.
+
+| Main Settings view | SMBIOS settings |
+| :--- | :--- |
+| ![](./images/ventura_uc1.png) | ![](./images/ventura_uc2.png) |
+
+
+
+::: details Table for spoofed models (click to expand)
+
+Spoofing to any model with native Sonoma support should work, but these are the earliest Macs natively supported by Sonoma and thus chosen for the sake of simplicity.
+
+**Reminder:** Macs that are not listed on this table work without spoofing, including systems that do not natively support Sonoma as long as the other requirements are met, since they aren't blacklisted.
+
+
+| Mac by name | Native SMBIOS | Spoof SMBIOS |
+|-------------|---------------|--------------|
+| MacBook Air Early 2015 11" / 13" | MacBookAir7,x | MacBookAir8,1 |
+| MacBook Pro Early 2015 13" | MacBookPro12,x | MacBookPro15,2 |
+| MacBook Pro Mid 2015 15" | MacBookPro11,4 / 11,5 | MacBookPro15,2 |
+| iMac Late 2015 21" | iMac16,x | iMac19,2 |
+| Mac mini Late 2014  | Macmini7,x | MacMini8,1 |
+| Mac Pro Late 2013 | MacPro6,x | MacPro7,1 |
+
+:::
+
+::: details macOS Ventura
+
+Firstly run OpenCore Legacy Patcher.
+
+Then go to **Settings** and **SMBIOS** tab, set SMBIOS Spoof Level to **Moderate**. Set SMBIOS Spoof Model **one listed next to your native model in the table for spoofed models below.**
+
+Notice that "Allow native models" and "Allow Native Spoofs" **are NOT** enabled unlike on Monterey, this is on purpose. They are no longer relevant on Ventura and enabling them will cause boot issues.
+
+| Main Settings view | SMBIOS settings |
+| :--- | :--- |
+| ![](./images/ventura_uc1.png) | ![](./images/ventura_uc2.png) |
+
+
+
+::: details Table for spoofed models (click to expand)
+
+Spoofing to any model with native Ventura support should work, but these are the earliest Macs natively supported by Ventura and thus chosen for the sake of simplicity.
+
+**Reminder:** Macs that are not listed on this table work without spoofing, including systems that do not natively support Ventura as long as the other requirements are met, since they aren't blacklisted.
+
+
+| Mac by name | Native SMBIOS | Spoof SMBIOS |
+|-------------|---------------|--------------|
+| MacBook Air Early 2015 11" / 13" | MacBookAir7,x | MacBookAir8,1 |
+| MacBook Pro Early 2015 13" | MacBookPro12,x | MacBookPro14,1 |
+| MacBook Pro Mid 2015 15" | MacBookPro11,4 / 11,5 | MacBookPro14,3 |
+| iMac Late 2015 21" | iMac16,x | iMac18,2 |
+| Mac mini Late 2014  | Macmini7,x | MacMini8,1 |
+| Mac Pro Late 2013 | MacPro6,x | MacPro7,1 |
+
+:::
+
+::: details macOS Monterey
+
+Firstly, run OpenCore Legacy Patcher. Secondly, go to **Settings** then the **App** tab and tick **Allow native models**.
+
+[](./images/OCLP-App-Allow-Native-Models.png)
+
+Then, go to **SMBIOS** tab, tick **Allow spoofing native Macs**, set SMBIOS Spoof Level to **Moderate**. Set SMBIOS Spoof Model to **one listed next to your native model in the table for spoofed models below.**
+
+
+| Main Settings view | SMBIOS settings |
+| :--- | :--- |
+| ![](./images/OCLP-SMBIOS-Allow-Native-Spoof.png) | ![](./images/OCLP-smbios-settings.png) |
+
+
+::: details Table for spoofed models (click to expand)
+
+Any model after the list of officially blacklisted Macs should be supported, but these are the earliest Macs with Universal Control support, and thus chosen for the sake of simplicity.
+
+**Reminder:** Macs that are not listed on this table work without spoofing, including systems that do not natively support Monterey, as long as the other requirements are met, since they aren't blacklisted.
+
+
+| Mac by name | Native SMBIOS | Spoof SMBIOS |
+|-------------|---------------|--------------|
+| MacBook Air Early 2015 11" / 13" | MacBookAir7,x | MacBookAir8,1 |
+| MacBook Pro Early 2015 13" | MacBookPro12,x | MacBookPro13,1 |
+| MacBook Pro Mid 2015 15" | MacBookPro11,4 / 11,5 | MacBookPro13,3 |
+| iMac Late 2015 21" | iMac16,x | iMac18,2 |
+| Mac mini Late 2014  | Macmini7,x | MacMini8,1 |
+| Mac Pro Late 2013 | MacPro6,x | MacPro7,1 |
+
+:::
+
+**Note:** Unless you are building OpenCore on a different machine than it's targeted for, **do not** change the model in the main settings view. It is important to understand that OCLP targets this model regardless of what you may have spoofed to, as your Mac is still what the Native SMBIOS shows.
+
+Lastly, Build and install OpenCore again, and reboot back to the OS. Enable Universal Control as explained in the [Enabling Universal Control section.](#enabling-universal-control)
+
+
+
+You should now be prompted to log back into iCloud by your Mac. If you get this prompt, you have successfully configured SMBIOS spoofing. Otherwise, verify that you have correctly followed the steps listed above, or ask on the Discord server for further assistance in [#misc-help](https://discord.gg/rqdPgH8xSN).

docs/UPDATE.md

@@ -1,22 +1,45 @@
-# Updating OpenCore and Co.
-
-With OpenCore Legacy Patcher, generally there's very little reason for users to update the OpenCore installed on their machine unless you feel there's a benefit with new versions for your setup.
-
-For those who do wish to update, it's actually quite easy. Simply [download the latest release](https://github.com/dortania/OpenCore-Legacy-Patcher/releases) and rerun the patcher:
-
-![](../images/first-run.png)
-
-Then simply rebuild your OpenCore build and install again. Then voila, OpenCore is updated!
-
-To check what version of OpenCore and Patcher version you're currently running, you can run the following in terminal:
-
-```bash
-# OpenCore Version
-nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:opencore-version
-# Patcher Version
-nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:OCLP-Version
-```
-
-![](../images/oclp-version.png)
-
-From this, we can see we're running a RELEASE version of OpenCore 0.6.8 built on March 27th, 2021 with Patcher Version 0.0.20!
+# Updating OpenCore and Patches
+
+This guide explains how to get fully up to date application, bootloader and patches.
+
+## Updating the application
+
+Latest versions of OCLP can download updates by themselves, you will get notified of a new update with the changelog.
+
+[You can also manually download the latest release here.](https://github.com/dortania/OpenCore-Legacy-Patcher/releases)
+
+
+<div align="left">
+             <img src="./images/OCLP_Update_Available.png" alt="Update Avaialble" />
+</div>
+
+
+## Updating patches
+
+After the update, the application asks if you want to update OpenCore and root patches. 
+
+If you do not need to change any settings, you can click "Yes" and follow the procedure. If you want to change settings, select "No" from here and do your settings, then manually build and install OpenCore to update to the latest version of the bootloader.
+
+Finally install new root patches to ensure you're running on the latest fixes for on-disk patches. 
+
+
+<div align="left">
+             <img src="./images/OCLP_Update_Successful.png" alt="Update Successful" />
+</div>
+
+## Checking OCLP and OpenCore versions
+
+To check what version of OpenCore bootloader and the Patcher you're currently running, you can run the following in the terminal:
+
+```bash
+# OpenCore Version
+nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:opencore-version
+# Patcher Version
+nvram 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102:OCLP-Version
+```
+
+<div align="left">
+             <img src="./images/oclp-version.png" alt="OCLP version" width="600" />
+</div>
+
+From this, we can see that we're running a RELEASE version of OpenCore 0.9.0 built on January 1st, 2023 with Patcher Version 0.6.0!

docs/VENTURA-DROP.md

@@ -0,0 +1,140 @@
+# macOS Ventura
+
+![](./images/ventura.png)
+
+With the release of OpenCore Legacy Patcher v0.5.0 and newer, early support for macOS Ventura has been implemented for most Metal-capable Macs. This page will be used to inform users regarding current issues and will be updated as new patch sets are developed and added to our patcher.
+
+## Newly dropped hardware
+
+Ventura's release dropped a large amount of Intel hardware, thus requiring the usage of OpenCore Legacy Patcher on the following models (in addition to previously removed models):
+
+* iMac16,1 (21.5-inch, Late 2015)
+* iMac16,2 (21.5-inch and 21.5-inch 4K, Late 2015)
+* iMac17,1 (27-inch 5K, Late 2015)
+* MacBook9,1 (12-inch, Early 2016)
+* MacBookAir7,1 (11-inch, Early 2015)
+* MacBookAir7,2 (13-inch, Early 2015)
+* MacBookPro11,4 (15-inch, Mid 2015, iGPU)
+* MacBookPro11,5 (15-inch, Mid 2015, dGPU)
+* MacBookPro12,1 (13-inch, Early 2015)
+* MacBookPro13,1 (13-inch, Late 2016)
+* MacBookPro13,2 (13-inch, Late 2016)
+* MacBookPro13,3 (15-inch, Late 2016)
+* Macmini7,1 (Late 2014)
+* MacPro6,1 (Late 2013)
+
+
+## Current status
+
+<img width="625" alt="" src="./images/OCLP-060-Initial-Support.png">
+
+For older hardware, see below sections:
+
+* [Currently Unsupported/Broken Hardware in Ventura](#currently-unsupportedbroken-hardware-in-ventura)
+  * [AMD Polaris, Vega and Navi support on pre-2019 Mac Pros and pre-2012 iMacs](#amd-polaris-vega-and-navi-support-on-pre-2019-mac-pros-and-pre-2012-imacs)
+  * [USB 1.1 (OHCI/UHCI) Support](#usb-11-ohciuhci-support)
+  * [Ethernet issue with Early 2008 Mac Pro](#ethernet-issue-with-early-2008-mac-pro)
+
+The team is doing their best to investigate and fix the aforementioned issues, however no estimated time can be provided.
+
+## Currently Unsupported/Broken Hardware in Ventura
+
+### AMD Polaris, Vega and Navi support on pre-2019 Mac Pros and pre-2012 iMacs
+
+For users with 2008 to 2013 Mac Pros (MacPro3,1-6,1) and 2009 to 2011 iMacs (iMac9,1-12,2), keep in mind that macOS Ventura now requires [AVX2.0 support in the CPU](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#Advanced_Vector_Extensions_2) for native graphics acceleration. Thus while your GPU may be natively supported, you cannot run Ventura officially with these GPUs.
+
+* CPUs supporting AVX2.0 are Haswell or newer, which no pre-2019 Mac Pros can be upgraded with.
+
+Currently at this time, OpenCore Legacy Patcher only supports patching the AMD Polaris and Vega Graphics stack to no longer require AVX2.0. We're recently received an AMD RX 6600 donation, so hopefully in the future the project can support AMD Navi with pre-Haswell Macs. However, no time estimates can be given.
+
+Following GPUs are applicable:
+
+| GPU Architecture | Model Families | Supported |
+| :--- | :--- | :--- |
+| AMD Polaris | RX 4xx/5xx (10/20 series) | <span style="color:#30BCD5"> Supported with patching </span> |
+| AMD Vega    | Vega 56/64/VII (10/20 series) | ^^ |
+| AMD Navi    | RX 5xxx/6xxx (10/20 series) | <span style="color:red"> Unsupported </span> |
+
+
+### USB 1.1 (OHCI/UHCI) Support
+
+For Penryn systems and pre-2013 Mac Pros, USB 1.1 support was outright removed in macOS Ventura. While USB 1.1 may seem unimportant, it handles many important devices on your system. These include:
+
+* Keyboard and Trackpad for laptops
+* IR Receivers
+* Bluetooth
+
+With OpenCore Legacy Patcher v0.6.0, basic support has been implemented via Root Volume patching. However due to this, users will need to use a USB hub for installation and post-OS updates when patches are cleaned:
+
+![](./images/usb11-chart.png)
+
+::: warning The following systems rely on USB 1.1
+
+* iMac10,x and older
+* Macmini3,1 and older
+* MacBook7,1 and older
+* MacBookAir3,1 and older
+* MacBookPro7,1 and older
+  * MacBookPro6,x is exempt
+* MacPro5,1 and older
+
+:::
+
+::: details Legacy Wireless Support (Resolved in v0.6.0 and newer)
+
+
+### Legacy Wireless Support
+
+For systems that required Root Patches in macOS Monterey to achieve Wireless support, unfortunately macOS Ventura has broken the patch set. Currently the following Wifi cards are unsupported:
+
+* Atheros: All models
+* Broadcom: BCM94328 and BCM94322
+
+The following machines shipped stock with these cards:
+
+* iMac12,x and older
+* Macmini3,1 and older
+* MacBook5,x and older
+* MacBookAir2,1 and older
+* MacBookPro7,1 and older
+  * MacBookPro6,x is exempt
+* MacPro5,1 and older
+
+
+Currently BCM943224, BCM94331, BCM94360 and BCM943602 are still fully supported by OpenCore Legacy Patcher. Consider upgrading to these cards if possible.
+
+:::
+
+
+::: details Non-Metal Graphics Acceleration (Resolved in v0.6.0 and newer)
+
+
+### Non-Metal Graphics Acceleration
+
+Regarding non-Metal, the team is hard at work to get non-Metal working, however this is our greatest challenge since Big Sur.
+
+Apple has made significant changes to the graphics stack in order to facilitate fancy effects, and in particularly, Stage Manager. We will update you as we work on development, however, now is not the best time to ask about ETAs.
+
+The following GPUs are applicable:
+
+* NVIDIA:
+  * Tesla (8000 - 300 series)
+* AMD:
+  * TeraScale (2000 - 6000 series)
+* Intel:
+  * Iron Lake
+  * Sandy Bridge (2000 - 3000 series)
+
+
+The following machines shipped stock with an unsupported GPU:
+
+* iMac7,1 - iMac12,x
+* MacBook5,1 - MacBook7,1
+* MacBookAir2,1 - MacBookAir4,x
+* MacBookPro4,1 - MacBookPro8,x
+* Macmini3,1 - Macmini5,x
+* MacPro3,1 - MacPro5,1
+* Xserve2,1 - Xserve3,1
+
+
+:::

docs/WINDOWS.md

@@ -1,88 +1,242 @@
-# Installing UEFI Windows 10
+# Installing Windows in UEFI Mode
 
-* Guide based off of [cdf's Mac Pro Thread](https://forums.macrumors.com/threads/opencore-on-the-mac-pro.2207814/)
+Modern versions of Windows officially support two types of firmware: UEFI and BIOS. Users may want to boot Windows through the OCLP Bootpicker, but only UEFI Installations of Windows will show up in the OCLP Bootpicker.
+Many older Macs do not "officially" support UEFI Windows installations, leading to installation failures and strange behaviour, but OCLP can be used to prevent almost all of these issues.
 
-To install UEFI is actually super simple! All it requires is to boot Windows' Installer through OpenCore to force a UEFI setup. Here we'll be going a bit more step by step in the process including partitioning and such.
+::: warning
 
-* Note: UEFI Windows is generally quite usable for Arrendale and newer models, however machines with Penryn CPUs may experience issues
-* Recommended Models:
-  * MacBookAir4,x and newer
-  * MacBookPro8,x and newer
-  * Macmini5,x and newer
-  * iMac11,x and newer
-  * MacPro4,1 and newer
-  * Xserve3,1 and newer
+When booting Windows with OpenCore, it's highly recommended to create a new 200MB **MS-DOS (FAT)** partition in Disk Utility to install OpenCore in. This will prevent Windows from overwriting OpenCore with its own bootloader in the EFI partition and causing boot issues.
 
-Once you know your model is supported, you're good to go with the rest of this guide
+::::
 
-## Disk Formatting
 
-To start off, we'll need the following:
+## Minimum Requirements
 
-* An 8GB USB drive for the Windows Installer
-* Minimum of 30GB of free space on whatever drive you want to install Windows too
+This guide will focus on the installation of modern Windows (10/11) without using Boot Camp Assistant.
 
-First, lets format out drives as follows:
+* Due to hardware and firmware limitations, UEFI Windows installations are only recommended on the following machines:
 
-### USB Drive Formatting
+  * 2015 MacBook or newer (`MacBook8,x`+)
+  * 2011 MacBook Air or newer (`MacBookAir4,x`+)
+  * 2011 MacBook Pro or newer (`MacBookPro8,x`+)
+  * 2011 Mac mini or newer (`Macmini5,x`+)
+  * 2009* Mac Pro or newer (`MacPro4,1`+), upgraded GPU is preferred
+  * 2010 iMac or newer (`iMac11,x`+), upgraded GPU is preferred
+  * 2009* Xserve (`Xserve3,1`), upgraded GPU is preferred
 
-Open Disk Utility in macOS and format the USB Drive as ExFat with MBR Scheme:
 
-![](../images/windows-mbr-format.png)
+*`MacPro4,1`, `MacPro5,1`, and `Xserve3,1` systems experience issues with the Windows installer, follow the DISM installation section for instructions.
 
-### Disk Formatting
+If your machine is not listed, UEFI Windows will likely still install, but you may face stability/driver issues.
 
-Next, grab the drive you wish to install Windows on and partition it as ExFat (If formatting entire drive, ensure it's GUID Partition Table):
+## Disk Partitioning and Formatting
 
-![](../images/windows-partition-1.png)
+The following is required for installation:
+* 8GB+ USB Drive for the Windows installer
+* 30GB+ Free Space on an existing drive / empty drive for the Windows installation
+
+### Formatting the USB Drive
+
+Open Disk Utility in macOS and format the USB Drive as ExFat with the Master Boot Record scheme:
+
+![](./images/windows-mbr-format.png)
+
+### Formatting the Target Drive
+
+Next, select the drive you wish to install Windows in Disk Utility on and partition it as ExFat (If formatting the entire drive, ensure it's using the GUID Partition Table scheme):
+
+![](./images/windows-partition-1.png)
+
+
+:::warning
+
+Incorrectly erasing your drive can lead to data loss! Please verify that you are erasing the correct drive/partition.
+
+:::
 
 If you plan to use the same hard drive for macOS and Windows, we recommend creating a dedicated partition just for OpenCore. This lets Windows have the ESP to itself and OpenCore can stay within it's own bubble.
 
 Recommended size is 200MB and the partition format **must** be FAT32 for OpenCore to operate correctly. You will next want to install OpenCore onto the new partition, either moving from the ESP with [MountEFI](https://github.com/corpnewt/MountEFI) or rerunning the OpenCore-Patcher.app
 
-* Note: For machines with dedicated drives for Windows, having different partitions for OpenCore is not required
-* Note 2: We recommend uninstalling OpenCore from the ESP/EFI Partition when you create this new OpenCore partition to avoid confusion when selecting OpenCore builds in the Mac's boot picker
+* Note 1: For machines with dedicated drives for Windows, having different partitions for OpenCore is not required.
+* Note 2: Having different partitions for OpenCore is not required if the Windows boot files detected by the stock Bootpicker are removed. See "Removing the Windows option from the stock bootpicker" for further information.
+* Note 3: We recommend uninstalling OpenCore from the ESP/EFI Partition when you create this new OpenCore partition to avoid confusion when selecting OpenCore builds in the Mac's boot picker.
 
-![](../images/windows-partition-2.png)
+![](./images/windows-partition-2.png)
 
-## Creating the Installer
+## Creating the Windows Installer
 
-First up, lets grab Windows's Installer at the below link:
+The latest Windows installation images can be downloaded from Microsoft using the following links:
 
 * [Download Windows 10 Disc Image (ISO File)](https://www.microsoft.com/en-ca/software-download/windows10ISO)
 
-Next, mount the Windows 10 ISO:
+* [Download Windows 11 Disc Image (ISO File)](https://www.microsoft.com/en-ca/software-download/windows11)
 
-![](../images/windows-iso.png)
+Once the file is downloaded, mount the .iso image:
 
-The open terminal and run `rsync` on the USB drive (replace CCCOMA_X64 with the mounted ISO's name, as well as replacing W10USB with your USB drive's name):
+![](./images/windows-iso.png)
+
+Then open terminal and use the `rsync` command with the disk image set as the source and your USB drive set as the target. (Replace "CCCOMA_X64" with the mounted image's partition name, and replace "InstallWin10" with your USB Drive's name).
 
 ```
-rsync -r -P /Volumes/CCCOMA_X64/ /Volumes/W10USB
+rsync -r -P /Volumes/CCCOMA_X64/ /Volumes/InstallWin10
 ```
 
-![](../images/rsync-progess.png)
+![](./images/rsync-progess.png)
 
-Command will take some time, so sit back and get some coffee. Once finished, the root of the USB drive should look as follows:
+The `rsync` command will take some time, so get some coffee and sit back. Once finished, the root of the USB drive should look as follows:
 
-* Ensure that these folders and files are on the root, otherwise the USB will not boot
+![](./images/windows-rsync-done.png)
 
-![](../images/windows-rsync-done.png)
+* Ensure that these folders and files are in the root of the USB drive, otherwise the USB will not boot.
 
-Once done, lets reboot into OpenCore's Menu and you'll see a new Windows' entry:
 
-* Note: Do not boot the installer outside of OpenCore as this will default back to the old MBR BIOS setup. Booting through OpenCore ensures Windows uses UEFI
+## Installation Process
 
-![](../images/oc-windows.png)
+Once you reboot your machine, you should see a new boot option in the OCLP Bootpicker labelled as "EFI Boot" or "Windows". It may or may not have the Boot Camp icon.
 
-From there, install Windows as normal and you'll get a new BootCamp entry in OpenCore's picker when done! 
+:::warning
 
-* Don't forget to run BootCamp's utilities installer as well to ensure Wifi and such are functioning correctly. This can be downloaded from the BootCamp Assistant app in macOS
+If you aren't booted into OCLP, you may see **two** boot options labelled "Windows" and "EFI Boot". Do not choose either of the options and boot into OCLP to continue.
 
-![](../images/oc-windows-done.png)
+:::
+
+
+
+### Installation: Microsoft Method
+
+Once booted into the Windows installer, proceed as you normally would on any Windows computer. If you see an error message containing “Windows could not prepare the computer to boot into the next phase of installation”, please follow the next portion of this guide (DISM Installation).
+
+::: details Installing Windows 11
+
+If you are installing Windows 11, you will need to [modify the Windows Setup](https://www.bleepingcomputer.com/news/microsoft/how-to-bypass-the-windows-11-tpm-20-requirement/) to allow installation on unsupported machines.
+
+:::
+
+### Installation: DISM Deployment Method
+
+Once booted into the Windows installer, proceed as you normally would until you reach the "Where do you want to install Windows" disk formatting section.
+
+When you are prompted to select a drive, select your desired partition and delete it using "Delete". If you want to install Windows to an empty drive, erase every partition currently on the desired drive.
+After your drive/partition is erased, press "New" to create the Windows system partitions.
+
+![](./images/DISM-1.png)
+
+You will be prompted to confirm the creation of the system partitions, press "OK".
+
+![](./images/DISM-2.png)
+
+Once the partitions are created, select the main (largest) partition and press "Format". This will format the partition using the NFTS file system.
+
+![](./images/DISM-3.png)
+
+After the installer formats the partition, open up the Command Prompt by pressing SHIFT + F10. Then run the `diskpart` command, and `list vol`. This will produce a list of volumes in your system, make sure to keep track of the drive letters of the main Windows partition (largest, NTFS), the EFI partition (100MB, FAT32), and the Windows installer (Usually Drive D). Run `exit` to close diskpart
+
+![](./images/DISM-4.png)
+
+Now, get a list of available Windows editions by running `dism /Get-WimInfo /WimFile:D:\Sources\install.wim` (substituting D with the Installer Drive Letter). This guide will use Option 6 for Windows 10 Pro.
+
+![](./images/DISM-5.png)
+
+You can now start the deployment process. Run `dism /Apply-Image /ImageFile:D:\Sources\install.wim /index:6 /ApplyDir:E:`, replacing "D" with the Installer Drive Letter, "6" with the Windows edition option, and "E" with the Windows Partition Drive Letter.
+
+![](./images/DISM-6.png)
+
+Once `dism` finishes its thing, run `bcdboot E:\Windows`, substituting "E" for the drive letter of the main Windows partition to create the boot files.
+
+![](./images/DISM-7.png)
+
+Windows is now installed. It should be recognized as "EFI Boot" or "Windows" with a Boot Camp icon in the OCLP Bootpicker.
+
+:::warning
+
+After the boot files are created, **DO NOT** reboot if you are using a MacPro4,1, MacPro5,1, or Xserve3,1 system! A bug in the Windows bootloader exists that will completely brick the system if it is loaded through the stock bootpicker. See the "Installation: Removing the Windows option from the stock bootpicker" section for a workaround.
+
+:::
+
+### Installation: Removing the Windows option from the stock bootpicker
+
+Removing the Windows boot option from the stock bootpicker is **HIGHLY RECOMMENDED** on MacPro4,1, MacPro5,1, and Xserve3,1 systems in order to prevent Secure Boot NVRAM corruption and bricking.
+
+Start up a command prompt window in the Windows Setup environment by running `cmd`.
+
+Next, enter the EFI Folder by running `C:`, substituting "C" for the EFI Partition Drive Letter. Then run `cd EFI` to enter the EFI Partition. Then, run `rmdir Boot /S /Q` to remove the boot files that can be detected by the stock Bootpicker. The OCLP Picker will still be able to detect and boot Windows.
+
+![](./images/DISM-8.png)
+
+You can verify that the `Boot` folder is removed by running the `dir` command:
+
+![](./images/DISM-9.png)
+
+If, for whatever reason, you are not able to remove the boot files from the Windows setup, shut down your system, boot into macOS, mount your EFI partition with [MountEFI](https://github.com/corpnewt/MountEFI), and remove the `Boot` folder (it should have a recent file modification date, and contain `Bootx64.efi`).
+
+
+## Post-Installation
+
+### Installing Boot Camp Software
+
+To get started, download the Brigadier utility from the following link:
+
+* [Download Brigadier](https://github.com/timsutton/brigadier/releases/download/0.2.4/brigadier.exe)
+
+Once Brigadier is downloaded, move it to your desktop for easy access.
+
+Open up a command prompt window as a standard user and run `cd desktop`.
+
+![](./images/BOOTCAMP-1.png)
+
+Then run `.\brigadier.exe --model=MODEL1,1`, replacing "MODEL1,1" with your machine's SMBIOS model.
+
+![](./images/BOOTCAMP-2.png)
+
+Once the Boot Camp software is downloaded, you can install it by executing `Setup.exe` or `\Drivers\Apple\BootCamp.msi` (`BootCamp64.msi` if present).
+
+### Installing Boot Camp 6 softare on unsupported machines
+
+To get started, download the Brigadier utility from the following link:
+
+* [Download Brigadier](https://github.com/timsutton/brigadier/releases/download/0.2.4/brigadier.exe)
+
+Once Brigadier is downloaded, move it to your desktop for easy access.
+
+Open up a command prompt window as a standard user and run `cd desktop`.
+
+![](./images/BOOTCAMP-1.png)
+
+Then run `.\brigadier.exe --model=MacPro7,1`. This will download the latest BootCamp 6 package.
+
+![](./images/BOOTCAMP-2.png)
+
+Once the Boot Camp software is downloaded, you can install Boot Camp 6 by executing `\Drivers\Apple\BootCamp.msi` in an administrator command prompt window.
 
 ## Troubleshooting
 
+### "This version of Boot Camp is not intended for this computer model."
+
+If you built OpenCore with Moderate or higher SMBIOS spoofing, you'll get an error when trying to install Boot Camp drivers. You can solve this by either rebuilding OpenCore with a lower spoof level, or running the installer from `Drivers/Apple/BootCamp.msi`.
+
+| Setup.exe | BootCamp.msi |
+| :--- | :--- |
+| ![](./images/windows-bootcamp-error.png) | ![](./images/windows-bootcamp-msi.png) |
+
+::: details BootCamp.msi quirks
+
+If needed, you can run it from the command line as administrator:
+
+```
+set __COMPAT_LAYER=WIN7RTM && start \path\to\BootCamp\Drivers\Apple\Bootcamp.msi'
+```
+
+Make sure to substitute `\path\to` with the location of the Boot Camp folder.
+
+You can also open `Properties` on the file to change the compatibility to `Previous version of Windows` in case you have Boot Camp 4.0 drivers (the above command does this already.)
+
+:::
+
 ### iMac12,x Bluescreen after driver installation
 
-Currently Intel's iGPU drivers for the HD 3000 series do not support UEFI booting in Windows. Recommended solution is to simply disable: [iMac 12,1 Windows 10 Boot Loop – Fix Intel Graphics issue](https://zzq.org/?p=39)
+Intel's iGPU drivers for the HD 3000 series do not support UEFI booting in Windows. The recommended solution is to simply disable the iGPU: [iMac 12,1 Windows 10 Boot Loop – Fix Intel Graphics issue](https://zzq.org/?p=39)
+
+### NVIDIA Tesla Black Screen after driver installation
+
+The NVIDIA Tesla GPUs found in 2008-2010 Macs do not support UEFI booting in Windows. You cannot use UEFI Windows without low-level patching on these machines.