coopydood / opencore-writeup-template

Easily share your Hackintosh OpenCore setup files with others, while providing easy-to-understand details.

🚧 THIS IS A TEMPLATE!

This repo is intended to be used as a template for those wanting to share their OpenCore EFI files with others on GitHub, also providing helpful setup information.

Things to replace:

• CPU_MODEL (e.g. Intel® Core™ i9-10900K)

• CPU_GENERATION (e.g. Comet Lake)

• CHIPSET_MODEL (e.g. Z490)

• GPU_MODEL (e.g. AMD RX 5700 XT)

• GPU_INTEGRATED_MODEL (e.g. Intel UHD 630)

• MOTHERBOARD_MODEL (e.g. ASUS ROG STRIX Z490-E GAMING)

• HOST_RAM (e.g. 64 GB DDR4 3200MHz)

• STORAGE_MODEL (e.g. 500 GB WD Blue NVMe)

• ETHERNET_MODEL (e.g. Intel I225-V 2.5Gb)

• DISABLED_GPU_MODEL (e.g. NVIDIA RTX 3090)

• SECURE_BOOT_MODEL (e.g. j185f)

• BOOT_ARGS (e.g. -v keepsyms=1)

• MAC_MODEL (e.g. iMac20,2)

• VERSION_NAME (e.g. macOS Sonoma)

• VERSION_NUMBER (e.g. 14.4.1)

• OPENCORE_VERSION (e.g. 0.9.7)

Other things to change:

• Problem list, including any fixes
• Your SSDT tables in the ACPI section
• Any added DeviceProperties sections
• Any additional kexts you use in Kernel
• Any patches you may have added in Kernel
• Any other NVRAM contents
• Your chosen SMBIOS Mac model, and why you chose it
• The drivers you use in UEFI
• A gallery of your working setup in Gallery
• Your disclaimers in Disclaimer

You can see a completed example of my setup here: OpenCore-Z490E-CometLake

REMEMBER TO DELETE THIS SECTION BEFORE FINISHING!

---

OpenCore CHIPSET_MODEL (CPU_GENERATION)

OpenCore Hackintosh configuration example for the MOTHERBOARD_MODEL motherboard with a CPU_MODEL.

YOUR IMAGE HERE.

---

OpenCore

OpenCore
_{OPENCORE_VERSION}

This is the version of OpenCore used, including bundled files. The included config.plist targets this version.

macOS

VERSION_NAME
_{VERSION_NUMBER}

This is the version of macOS that this OpenCore configuration currently targets. Other versions of macOS that are compatible with it are listed below.

Supported

macOS Sonoma

macOS Ventura

macOS Monterey

macOS Big Sur

macOS Catalina

macOS Mojave

macOS High Sierra

macOS Sierra

---

What works?

macOS

• VERSION_NAME

Hardware

• Dedicated GPU (GPU_MODEL)
• iGPU (GPU_INTEGRATED_MODEL)
• NVMe drives
• SATA drives
• USB 3.1 (XHCI)
• Ethernet
• Wi-Fi
• Bluetooth
• Camera
• Sound

Software

• AirDrop
• iMessage
• FaceTime
• Unlock with Apple Watch
• QE/CI graphics acceleration
• Metal support
• Temperature sensors
• Sleep / Wake
• RTC (protection)
• Hyperthreading
• Virtualisation
• Memory bank configuration

---

Problems

• YOUR PROBLEM HERE
DESCRIBE YOUR PROBLEM HERE

• ANOTHER PROBLEM HERE
DESCRIBE YOUR PROBLEM HERE





• FIXED PROBLEM EXAMPLE ‏‏‎ ‏‏‎ ‎‎‏‏‎ ‎ 🎉 FIXED!
THE ART OF FIXING A PROBLEM AS DESCRIBED HERE

Tip

Describe to viewers how you managed to fix the issue here.

---

System

The specs of the main system that the OpenCore configuration targets.

Motherboard	MOTHERBOARD_MODEL
CPU	CPU_MODEL
Chipset	CHIPSET_MODEL
Generation	CPU_GENERATION
Memory	HOST_RAM
Storage	STORAGE_MODEL
GPU	GPU_MODEL DISABLED_GPU_MODEL *
NIC	ETHERNET_MODEL

Note

The system contains a DISABLED_GPU_MODEL graphics card, but it has been intentionally disabled through a custom YOUR_METHOD.

---

ACPI

SSDTs used:

• SSDT-1
• SSDT-2
• SSDT-3

---

DeviceProperties

The following tables display the added PCI devices and their child keys.

PciRoot(0x0)/Pci(0x2,0x0)

EXAMPLE

Key	Type	Value
AAPL,ig-platform-id	Data	0000923E
device-id	Data	923E7000
framebuffer-fbmem	Data	00009000
framebuffer-patch-enable	Data	01000000
framebuffer-stolenmem	Data	00003001
framebuffer-unifiedmem	Data	00000080
hda-gfx	String	onboard-1

PciRoot(0x0)/Pci(0x1b,0x0)

Apple ALC

Key	Type	Value
AAPL,ig-platform-id	Data	0300220D
layout-id	Data	01000000

---

Kernel

The following shows the kernel configuration.

Kexts

Kexts used:

• Lilu
• WhateverGreen
• ...

Patches

EXAMPLE

Key	Type	Value
Arch	String	Any
Base	String	__Z18e1000_set_mac_typeP8e1000_hw
Comment	String	I225-V patch
Count	Number	1
Enabled	Boolean	True
Find	Data	F2150000
Identifier	String	com.apple.driver.AppleIntelI210Ethernet
Limit	Number	0
Mask	Data
MaxKernel	String	20.4.0
MinKernel	String	19.0.0
Replace	Data	F3150000
ReplaceMask	Data
Skip	Number	0

---

Security

SecureBootModel 》 SECURE_BOOT_MODEL

Vault 》 Optional

---

NVRAM

Contents stored in NVRAM.

4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14

Key	Type	Value
DefaultBackgroundColor	Data	00000000

4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102

Key	Type	Value
rtc-blacklist	Data

7C436110-AB2A-4BBB-A880-FE41995C9F82

Key	Type	Value
boot-args	String	BOOT_ARGS

---

SMBIOS

MAC_MODEL

DESCRIPTION ON WHY YOU PICKED THIS SMBIOS MODEL...?

---

UEFI

Drivers in use:

• HFSPlus
• OpenRuntime
• ...

---

Gallery

ADD SOME IMAGES TO SHOW OFF YOUR WORK!

---

Disclaimer

ADD A DISCLAIMER HERE!