OpenCore

https://dortania.github.io/OpenCore-Install-Guide/
Admin
OpenCore is a bootloader that prepares X86-based PCs for macOS installation by injecting system data...
Tokens:144,198
Snippets:1,824
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Dependencies and Run Development Server

Source: https://dortania.github.io/OpenCore-Install-Guide/CONTRIBUTING.html

Install project dependencies and start a local webserver to preview changes. This is essential for testing your contributions.

```bash
npm install
npm run dev
```

--------------------------------

### OpenCore NVRAM Add Section Example

Source: https://dortania.github.io/OpenCore-Install-Guide/AMD/zen.html

Example of the NVRAM Add section in OpenCore's config.plist, showing common GUIDs and their associated keys for boot arguments, SIP, and language settings.

```plist
<key>NVRAM</key>
<dict>
	<key>Add</key>
	<dict>
		<key>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14</key>
		<dict>
			<key>DefaultBackgroundColor</key>
			<data>AAAAAAAAAA==</data>
		</dict>
		<key>4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102</key>
		<dict>
			<key>rtc-blacklist</key>
			<data></data>
		</dict>
		<key>7C436110-AB2A-4BBB-A880-FE41995C9F82</key>
		<dict>
			<key>boot-args</key>
			<string>-v debug=0x100 keepsyms=1 npci=0x3000 alcid=1</string>
			<key>csr-active-config</key>
			<data>AAAAAA==</data>
			<key>run-efi-updater</key>
			<string>No</string>
			<key>prev-lang:kbd</key>
			<data></data>
		</dict>
	</dict>
	<key>Delete</key>
	<dict/>
	<key>LegacyEnable</key>
	<false/>
	<key>LegacyOverwrite</key>
	<false/>
	<key>LegacySchema</key>
	<dict/>
	<key>WriteFlash</key>
	<true/>
</dict>
```

--------------------------------

### OpenCore NVRAM prev-lang:kbd Example (String)

Source: https://dortania.github.io/OpenCore-Install-Guide/AMD/zen.html

Example of setting the 'prev-lang:kbd' NVRAM variable as a String for non-Latin keyboards. This example sets it to US English.

```text
en-US:0
```

--------------------------------

### Nehalem SMBIOS Info Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config-HEDT/nehalem.html

This is an example output from GenSMBIOS for a MacPro5,1 SMBIOS. It provides the necessary details for configuring PlatformInfo in OpenCore.

```text
  #######################################################
 #               MacPro5,1 SMBIOS Info                 #
#######################################################

Type:         MacPro5,1
Serial:       C02YX0TZHX87
Board Serial: C029269024NJG36CB
SmUUID:       DEA17B2D-2F9F-4955-B266-A74C47678AD3

```

--------------------------------

### Haswell SMBIOS Info Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config-laptop.plist/haswell.html

This is an example output from GenSMBIOS for a MacBookPro11,1 SMBIOS. It provides the necessary details for configuring PlatformInfo in OpenCore.

```text
  #######################################################
 #               MacBookPro11,1 SMBIOS Info            #
#######################################################

Type:         MacBookPro11,1
Serial:       C02M9SYJFY10
Board Serial: C02408101J9G2Y7A8
SmUUID:       7B227BEC-660D-405F-8E60-411B3E4EF055


```

--------------------------------

### OpenCore NVRAM prev-lang:kbd Example (HEX)

Source: https://dortania.github.io/OpenCore-Install-Guide/AMD/zen.html

Example of setting the 'prev-lang:kbd' NVRAM variable in HEX format. This example represents 'en-US:0'.

```text
656e2d55533a30
```

--------------------------------

### Example MacPro6,1 SMBIOS Info

Source: https://dortania.github.io/OpenCore-Install-Guide/config-HEDT/ivy-bridge-e.html

This is an example output from GenSMBIOS for MacPro6,1 SMBIOS. It provides the necessary details for configuring PlatformInfo in OpenCore.

```text
  #######################################################
 #               MacPro6,1 SMBIOS Info                 #
#######################################################

Type:         MacPro6,1
Serial:       C02YX0TZHX87
Board Serial: C029269024NJG36CB
SmUUID:       DEA17B2D-2F9F-4955-B266-A74C47678AD3

```

--------------------------------

### Create macOS Installer

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/mac-install.html

Use this command to create a bootable macOS installer on a USB drive named 'MyVolume'. Ensure the installer application is in the default Applications directory.

```bash
sudo /Applications/Install\ macOS\ Big\ Sur.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume
```

--------------------------------

### Example SMBIOS Info Output

Source: https://dortania.github.io/OpenCore-Install-Guide/config.plist/penryn.html

This is an example output from GenSMBIOS for iMac10,1 SMBIOS. It provides the necessary details for configuring OpenCore's PlatformInfo.

```text
  #######################################################
 #               iMac10,1 SMBIOS Info                  #
#######################################################

Type:         iMac10,1
Serial:       C02KCYZLDNCW
Board Serial: C02309301QXF2FRJC
SmUUID:       A154B586-874B-4E57-A1FF-9D6E503E4580

```

--------------------------------

### OpenCore NVRAM boot-args Example

Source: https://dortania.github.io/OpenCore-Install-Guide/AMD/zen.html

Example of common boot arguments for OpenCore, used for debugging, disabling watchdogs, and enabling specific hardware features.

```text
-v debug=0x100 keepsyms=1 npci=0x3000 alcid=1
```

--------------------------------

### iMac17,1 SMBIOS Info Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config.plist/skylake.html

This is an example output from GenSMBIOS for an iMac17,1 SMBIOS. It provides the necessary serial numbers and UUIDs to configure your OpenCore installation.

```text
  #######################################################
 #               iMac17,1 SMBIOS Info                  #
#######################################################

Type:         iMac17,1
Serial:       C02S3HYWGG7L
Board Serial: C02629102GUGPF7AD
SmUUID:       3508AD44-B67D-4AD7-A109-7955130A1033

```

--------------------------------

### Kernel Extension Load Order Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config-HEDT/ivy-bridge-e.html

This example illustrates the importance of kext load order, emphasizing that plugins like Lilu must load before their dependencies such as VirtualSMC, AppleALC, and WhateverGreen. This is crucial for proper system initialization.

```plist
<key>Kernel</key>
	<dict>
		<key>Add</key>
			<array>
				<dict>
					<key>BundlePath</key>
					<string>Lilu.kext</string>
					<key>Enabled</key>
					<true/>
					<key>Arch</key>
					<string>Any</string>
				</dict>
				<dict>
					<key>BundlePath</key>
					<string>VirtualSMC.kext</string>
					<key>Enabled</key>
					<true/>
					<key>Arch</key>
					<string>Any</string>
					<key>PlistPath</key>
					<string>Contents/Info.plist</string>
				</dict>
			</array>
			<key>Emulate</key>
				<dict>
					<key>Cpuid1Data</key>
					<data></data>
					<key>Cpuid1Mask</key>
					<data></data>
				</dict>
				<key>Force</key>
					<array>
					</array>
				</dict>
			</dict>
```

--------------------------------

### Rename bootx64 or bootia32 to boot

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/windows-install.html

Rename the bootx64 (64-bit) or bootia32 (32-bit) file to 'boot' for DuetPkg compatibility during legacy install setup.

```bash
Grab either the **bootx64**(64 Bit CPUs) or **bootia32**(32 Bit CPUs) file from `Utilities/LegacyBoot/` and place it on the root of your drive. **Rename this file to boot** to ensure DuetPkg can properly
```

--------------------------------

### OpenCore NVRAM GPU-Specific boot-args Example

Source: https://dortania.github.io/OpenCore-Install-Guide/AMD/zen.html

Example of GPU-specific boot arguments for OpenCore, used for AMD Navi GPUs, enabling hardware video encoding, and power-gating adjustments.

```text
agdpmod=pikera -radcodec radpg=15 unfairgva=1
```

--------------------------------

### Partitioning USB with gdisk (Method 1)

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/linux-install.html

Use this command to partition your USB drive with GPT and create a single Microsoft basic data partition. Ensure you replace `<your USB block>` with the correct device identifier.

```bash
sudo gdisk /dev/<your USB block>
```

--------------------------------

### Restore PBR using boot1f32 file

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/windows-install.html

Restore the Partition Boot Record (PBR) using the boot1f32 file from OpenCorePkg's LegacyBoot utilities. This is part of the legacy install setup.

```bash
Restore PBR | Restore boot1f32 file
```

--------------------------------

### Restore MBR using boot0 file

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/windows-install.html

Restore the Master Boot Record (MBR) using the boot0 file from OpenCorePkg's LegacyBoot utilities. This is part of the legacy install setup.

```bash
Restore MBR | Restore boot0 file
```

--------------------------------

### Correct EFI Folder Structure

Source: https://dortania.github.io/OpenCore-Install-Guide/troubleshooting/extended/opencore-issues.html

An example of the correct EFI folder structure required for OpenCore to boot. Ensure all necessary OpenCore files are within an EFI folder on your ESP.

```text
Example of folder structure
```

--------------------------------

### List and Download Full macOS Installers

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/mac-install.html

Use this command to list available full macOS installers and then fetch a specific version. Ensure you have sufficient disk space.

```bash
softwareupdate --list-full-installers; echo; echo "Please enter version number you wish to download:"; read REPLY; [ -n "$REPLY" ] && softwareupdate --fetch-full-installer --full-installer-version "$REPLY"
```

--------------------------------

### Install xattr Module for InstallInstallMacOS

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/mac-install.html

If encountering issues with Munki's InstallInstallMacOS utility on macOS Monterey 12.3+, install the 'xattr' module using pip3 after installing Xcode Command Line Tools.

```bash
This tool requires the Python xattr module. Perhaps run 'pip install xattr' to install it.
```

--------------------------------

### Example SMBIOS Output

Source: https://dortania.github.io/OpenCore-Install-Guide/AMD/zen.html

This is an example output from GenSMBIOS, showing the structure of SMBIOS information that will be used for OpenCore configuration.

```text
  #######################################################
 #               MacPro7,1 SMBIOS Info                 #
#######################################################

Type:         MacPro7,1
Serial:       F5KZV0JVP7QM
Board Serial: F5K9518024NK3F7JC
SmUUID:       535B897C-55F7-4D65-A8F4-40F4B96ED394
Apple ROM:    001D4F0D5E22

```

--------------------------------

### Install DuetPkg with LegacyBoot Tool

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/mac-install.html

This command installs DuetPkg to a desired drive for legacy systems not supporting UEFI boot. Replace 'X64' with 'IA32' for 32-bit CPUs. The tool will prompt for disk selection and MBR writing.

```bash
# Replace X64 with IA32 if you have a 32-Bit CPU
sudo ~/Downloads/OpenCore/Utilities/legacyBoot/BootInstall_X64.tool
```

--------------------------------

### Add WhateverGreen Fixes Boot Argument

Source: https://dortania.github.io/OpenCore-Install-Guide/troubleshooting/extended/kernel-issues.html

Use the '-igfxmlr' boot argument with WhateverGreen to fix potential 'Divide by Zero' errors or display initialization issues.

```config
-igfxmlr boot argument
```

--------------------------------

### GenSMBIOS Output Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config.plist/coffee-lake.html

This is an example output from GenSMBIOS for iMac19,1 SMBIOS. It provides the necessary serial numbers and UUIDs to be configured in OpenCore.

```text
  #######################################################
 #               iMac19,1 SMBIOS Info                  #
#######################################################

Type:         iMac19,1
Serial:       C02XG0FDH7JY
Board Serial: C02839303QXH69FJA
SmUUID:       DBB364D6-44B2-4A02-B922-AB4396F16DA8


```

--------------------------------

### Framebuffer BusID Example for 00001659

Source: https://dortania.github.io/OpenCore-Install-Guide/config-laptop.plist/kaby-lake.html

Example of BusID information for framebuffer 00001659, showing port configurations for LVDS, DP, and HDMI.

```text
[0] busId: 0x00, pipe: 8, type: 0x00000002, flags: 0x00000098 - ConnectorLVDS
[1] busId: 0x05, pipe: 9, type: 0x00000400, flags: 0x00000187 - ConnectorDP
[2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI
00000800 02000000 98000000
01050900 00040000 87010000
02040A00 00080000 87010000
```

--------------------------------

### Formatting USB to FAT32 (Method 1)

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/linux-install.html

Format the created partition as FAT32 with the label 'OPENCORE'. Replace `<your USB partition block>` with the specific partition identifier.

```bash
sudo mkfs.vfat -F 32 -n "OPENCORE" /dev/<your USB partition block>
```

--------------------------------

### Framebuffer BusID Example for 00001B59

Source: https://dortania.github.io/OpenCore-Install-Guide/config-laptop.plist/kaby-lake.html

Example of BusID information for framebuffer 00001B59, showing port configurations for LVDS, HDMI, and DP.

```text
[0] busId: 0x00, pipe: 8, type: 0x00000002, flags: 0x00000098 - ConnectorLVDS
[2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI
[3] busId: 0x06, pipe: 10, type: 0x00000400, flags: 0x00000187 - ConnectorDP
00000800 02000000 98000000
02040A00 00080000 87010000
03060A00 00040000 87010000
```

--------------------------------

### Kernel Kext Loading Order and Configuration

Source: https://dortania.github.io/OpenCore-Install-Guide/config.plist/coffee-lake.html

Specify kexts to load, their order, and supported architectures. Ensure dependencies like Lilu are loaded before plugins like VirtualSMC.

```plist
<key>Kernel</key>
<dict>
    <key>Add</key>
    <array>
        <dict>
            <key>Arch</key>
            <string>Any</string>
            <key>BundlePath</key>
            <string>Lilu.kext</string>
            <key>Comment</key>
            <string>Patching is irrelevant</string>
            <key>Enabled</key>
            <true/>
            <key>ExecutablePath</key>
            <string>Contents/MacOS/Lilu</string>
            <key>MaxKernel</key>
            <string>99999999</string>
            <key>MinKernel</key>
            <string>0</string>
            <key>PlistPath</key>
            <string>Contents/Info.plist</string>
        </dict>
        <dict>
            <key>Arch</key>
            <string>Any</string>
            <key>BundlePath</key>
            <string>VirtualSMC.kext</string>
            <key>Comment</key>
            <string>SMC emulator</string>
            <key>Enabled</key>
            <true/>
            <key>ExecutablePath</key>
            <string>Contents/MacOS/VirtualSMC</string>
            <key>MaxKernel</key>
            <string>99999999</string>
            <key>MinKernel</key>
            <string>0</string>
            <key>PlistPath</key>
            <string>Contents/Info.plist</string>
        </dict>
    </array>
    <key>Delete</key>
    <array/>
    <key>Emulate</key>
    <dict>
        <key>Cpuid1Data</key>
        <data></data>
        <key>Cpuid1Mask</key>
        <data></data>
        <key>DummyPowerState</key>
        <false/>
        <key>MaxKernel</key>
        <string>99999999</string>
        <key>MinKernel</key>
        <string>0</string>
    </dict>
    <key>Patch</key>
    <array/>
    <key>Quirks</key>
    <dict>
        <key>AppleCpuPmCfgLock</key>
        <false/>
        <key>AppleXcpmCfgLock</key>
        <false/>
        <key>DisableIoMapper</key>
        <true/>
        <key>PanicNoKextDump</key>
        <true/>
        <key>PowerTimeoutKernelPanic</key>
        <true/>
        <key>ThirdPartyDrives</key>
        <false/>
        <key>XhciPortLimit</key>
        <false/>
    </dict>
</dict>
```

--------------------------------

### SMBIOS Info Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config-laptop.plist/sandy-bridge.html

This is an example output from GenSMBIOS, showing the SMBIOS details for a MacBookPro8,2. These values are used to populate the Generic section of the OpenCore config.plist.

```text
  #######################################################
 #                MacBookPro8,2 SMBIOS Info            #
#######################################################

Type:         MacBookPro8,2
Serial:       C02KCYZLDNCW
Board Serial: C02309301QXF2FRJC
SmUUID:       A154B586-874B-4E57-A1FF-9D6E503E4580


```

--------------------------------

### Legacy createinstallmedia Commands for macOS Versions

Source: https://dortania.github.io/OpenCore-Install-Guide/installer-guide/mac-install.html

A collection of commands for creating bootable installers for various macOS versions, including Ventura, Monterey, Big Sur, Catalina, Mojave, High Sierra, Sierra, El Capitan, Yosemite, and Mavericks. Some commands include specific application path or no interaction flags.

```bash
# Ventura
sudo /Applications/Install\ macOS\ Ventura.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume

# Monterey
sudo /Applications/Install\ macOS\ Monterey.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume

# Big Sur
sudo /Applications/Install\ macOS\ Big\ Sur.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume

# Catalina
sudo /Applications/Install\ macOS\ Catalina.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume

# Mojave
sudo /Applications/Install\ macOS\ Mojave.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume

# High Sierra
sudo /Applications/Install\ macOS\ High\ Sierra.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume

# Sierra
sudo /Applications/Install\ macOS\ Sierra.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume --applicationpath /Applications/Install\ macOS\ Sierra.app

# El Capitan
sudo /Applications/Install\ OS\ X\ El\ Capitan.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume --applicationpath /Applications/Install\ OS\ X\ El\ Capitan.app

# Yosemite
sudo /Applications/Install\ OS\ X\ Yosemite.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume --applicationpath /Applications/Install\ OS\ X\ Yosemite.app

# Mavericks
sudo /Applications/Install\ OS\ X\ Mavericks.app/Contents/Resources/createinstallmedia --volume /Volumes/MyVolume --applicationpath /Applications/Install\ OS\ X\ Mavericks.app --nointeraction
```

--------------------------------

### GenSMBIOS Output Example

Source: https://dortania.github.io/OpenCore-Install-Guide/config-laptop.plist/coffee-lake.html

This is an example of the output generated by GenSMBIOS for a MacBookPro15,1 SMBIOS. It provides the necessary details for configuring OpenCore's PlatformInfo.

```text
  #######################################################
 #               MacBookPro15,1 SMBIOS Info            #
#######################################################

Type:         MacBookPro15,1
Serial:       C02XG0FDH7JY
Board Serial: C02839303QXH69FJA
SmUUID:       DBB364D6-44B2-4A02-B922-AB4396F16DA8

```
Tokens:
Raw