diff --git a/Assets/DarwinKVMLogo.png b/Assets/DarwinKVMLogo.png new file mode 100644 index 0000000..89ef729 Binary files /dev/null and b/Assets/DarwinKVMLogo.png differ diff --git a/Assets/DarwinKVMLogo.psd b/Assets/DarwinKVMLogo.psd new file mode 100644 index 0000000..65bbc2b Binary files /dev/null and b/Assets/DarwinKVMLogo.psd differ diff --git a/Assets/Header.psd b/Assets/Header.psd index 4247806..6de6b3b 100644 Binary files a/Assets/Header.psd and b/Assets/Header.psd differ diff --git a/Assets/HeaderAboutThisProject.png b/Assets/HeaderAboutThisProject.png new file mode 100644 index 0000000..409845c Binary files /dev/null and b/Assets/HeaderAboutThisProject.png differ diff --git a/Assets/HeaderBridgeNetworkingTextOnly.png b/Assets/HeaderBridgeNetworkingTextOnly.png new file mode 100644 index 0000000..c6e6cf2 Binary files /dev/null and b/Assets/HeaderBridgeNetworkingTextOnly.png differ diff --git a/Assets/HeaderDiskProvision.png b/Assets/HeaderDiskProvision.png new file mode 100644 index 0000000..3a16127 Binary files /dev/null and b/Assets/HeaderDiskProvision.png differ diff --git a/Assets/HeaderTextOnly.png b/Assets/HeaderTextOnly.png new file mode 100644 index 0000000..11ed836 Binary files /dev/null and b/Assets/HeaderTextOnly.png differ diff --git a/BridgeNetworking/README.md b/BridgeNetworking/README.md index 712b70e..97c769c 100644 --- a/BridgeNetworking/README.md +++ b/BridgeNetworking/README.md @@ -1,5 +1,5 @@

- +

DKVM Bridge Networking Submodule

diff --git a/OpenCore/README.md b/DiskProvision/README.md similarity index 97% rename from OpenCore/README.md rename to DiskProvision/README.md index 4fc3c4c..3518e00 100644 --- a/OpenCore/README.md +++ b/DiskProvision/README.md @@ -1,8 +1,8 @@

- +

-

DKVM OpenCore Submodule

+

DKVM DiskProvision Submodule

Allows the creation, management, and updating of the OpenCore EFI partition for your DKVM.

## About diff --git a/OpenCore/init.sh b/DiskProvision/init.sh similarity index 100% rename from OpenCore/init.sh rename to DiskProvision/init.sh diff --git a/OpenCore/mount.sh b/DiskProvision/mount.sh similarity index 100% rename from OpenCore/mount.sh rename to DiskProvision/mount.sh diff --git a/OpenCore/unmount.sh b/DiskProvision/unmount.sh similarity index 100% rename from OpenCore/unmount.sh rename to DiskProvision/unmount.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..766d868 --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2023, RoyalGraphX + +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. \ No newline at end of file diff --git a/README.md b/README.md index dfadb6e..854b609 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -

This is Pre-Release information! It is still WIP.

+

+ +

- +

An Advanced Template for running macOS within QEMU/KVM

@@ -347,14 +349,14 @@ Skip this if you did set up the br0 interface.

Part 0: Image Creation

Creation of the OpenCore .img for your DKVM.

-

This section has been derived from the OpenCore Submodule.

+

This section has been derived from the DiskProvision Submodule.


``` This tool automates the process of creating and setting up an OpenCore.img disk image for use with QEMU. It also comes with mount.sh and unmount.sh to easily modify the contents. ``` -Don't skip this section. To continue in this guide you will need an image file that will act as our OpenCore USB, holding all its contents. The fastest way to do this is by changing the directory into the OpenCore folder in this repository. You can quickly generate and mount a 1GB ``.img`` file to add to your Virtual Machine later. If you need any help understanding this section, please refer to the [README.md](https://github.com/royalgraphx/DarwinKVM/tree/main/OpenCore) for better context. You can now go ahead and transfer the EFI folder from [DarwinOCPkg](https://github.com/royalgraphx/DarwinOCPkg) to the root of the image. The rest of the steps will outline adding the necessary files to build your EFI for your Virtual Machine. +Don't skip this section. To continue in this guide you will need an image file that will act as our OpenCore USB, holding all its contents. The fastest way to do this is by changing the directory into the OpenCore folder in this repository. You can quickly generate and mount a 1GB ``.img`` file to add to your Virtual Machine later. If you need any help understanding this section, please refer to the [README.md](https://github.com/royalgraphx/DarwinKVM/tree/main/DiskProvision) for better context. You can now go ahead and transfer the EFI folder from [DarwinOCPkg](https://github.com/royalgraphx/DarwinOCPkg) to the root of the image. The rest of the steps will outline adding the necessary files to build your EFI for your Virtual Machine.

Part 1: ACPI Tables

diff --git a/docs/_config.yml b/docs/_config.yml index 11bfbd7..af90171 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -2,6 +2,18 @@ title: DarwinKVM Docs description: An Advanced Template for running macOS within QEMU/KVM. Run the latest macOS on QEMU/KVM with libvirtd/Virt-Manager, includes Single GPU Passthrough. theme: just-the-docs # Color scheme supports "light" (default) and "dark" -color_scheme: dark +color_scheme: custom +favicon_ico: "/assets/favicon.ico" -url: https://royalgraphx.github.io/DarwinKVM/docs \ No newline at end of file +url: https://royalgraphx.github.io/DarwinKVM/docs + +include: + - docs + +# Aux links for the upper right navigation +aux_links: + "View on Github": + - "//github.com/royalgraphx/DarwinKVM/tree/main" + +# Makes Aux links open in a new tab. Default is false +aux_links_new_tab: false \ No newline at end of file diff --git a/docs/_includes/footer_custom.html b/docs/_includes/footer_custom.html new file mode 100644 index 0000000..64be8b9 --- /dev/null +++ b/docs/_includes/footer_custom.html @@ -0,0 +1 @@ +Copyright © 2023 RoyalGraphX. Distributed by a BSD 3-Clause License. diff --git a/docs/_sass/color_schemes/custom.scss b/docs/_sass/color_schemes/custom.scss new file mode 100644 index 0000000..5b7edb8 --- /dev/null +++ b/docs/_sass/color_schemes/custom.scss @@ -0,0 +1,3 @@ +@import "./color_schemes/dark"; + +$link-color: $purple-000; \ No newline at end of file diff --git a/docs/android-chrome-192x192.png b/docs/android-chrome-192x192.png new file mode 100644 index 0000000..ef13ad5 Binary files /dev/null and b/docs/android-chrome-192x192.png differ diff --git a/docs/android-chrome-512x512.png b/docs/android-chrome-512x512.png new file mode 100644 index 0000000..be70411 Binary files /dev/null and b/docs/android-chrome-512x512.png differ diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png new file mode 100644 index 0000000..564243c Binary files /dev/null and b/docs/apple-touch-icon.png differ diff --git a/docs/assets/BootingRecovery.png b/docs/assets/BootingRecovery.png new file mode 100644 index 0000000..ba96a80 Binary files /dev/null and b/docs/assets/BootingRecovery.png differ diff --git a/docs/assets/BridgeNetworkingHypervisorSSH.png b/docs/assets/BridgeNetworkingHypervisorSSH.png new file mode 100644 index 0000000..5b9734b Binary files /dev/null and b/docs/assets/BridgeNetworkingHypervisorSSH.png differ diff --git a/docs/assets/BridgeNetworkingLocalTerminal.png b/docs/assets/BridgeNetworkingLocalTerminal.png new file mode 100644 index 0000000..e8ba6e6 Binary files /dev/null and b/docs/assets/BridgeNetworkingLocalTerminal.png differ diff --git a/docs/assets/BridgeNetworkingRPI.png b/docs/assets/BridgeNetworkingRPI.png new file mode 100644 index 0000000..6c97029 Binary files /dev/null and b/docs/assets/BridgeNetworkingRPI.png differ diff --git a/docs/assets/BridgeNetworkingRouterDash.png b/docs/assets/BridgeNetworkingRouterDash.png new file mode 100644 index 0000000..48e5893 Binary files /dev/null and b/docs/assets/BridgeNetworkingRouterDash.png differ diff --git a/docs/assets/DarwinKVMLogo copy.png b/docs/assets/DarwinKVMLogo copy.png new file mode 100644 index 0000000..89ef729 Binary files /dev/null and b/docs/assets/DarwinKVMLogo copy.png differ diff --git a/docs/assets/DarwinKVMLogo.png b/docs/assets/DarwinKVMLogo.png new file mode 100644 index 0000000..89ef729 Binary files /dev/null and b/docs/assets/DarwinKVMLogo.png differ diff --git a/docs/assets/DarwinKVMLogo.psd b/docs/assets/DarwinKVMLogo.psd new file mode 100644 index 0000000..65bbc2b Binary files /dev/null and b/docs/assets/DarwinKVMLogo.psd differ diff --git a/docs/assets/Header.png b/docs/assets/Header.png new file mode 100644 index 0000000..debb7e5 Binary files /dev/null and b/docs/assets/Header.png differ diff --git a/docs/assets/Header.psd b/docs/assets/Header.psd new file mode 100644 index 0000000..4247806 Binary files /dev/null and b/docs/assets/Header.psd differ diff --git a/docs/assets/HeaderAboutThisProject.png b/docs/assets/HeaderAboutThisProject.png new file mode 100644 index 0000000..409845c Binary files /dev/null and b/docs/assets/HeaderAboutThisProject.png differ diff --git a/docs/assets/HeaderBaseSystem.png b/docs/assets/HeaderBaseSystem.png new file mode 100644 index 0000000..bab9eed Binary files /dev/null and b/docs/assets/HeaderBaseSystem.png differ diff --git a/docs/assets/HeaderBridgeNetworking.png b/docs/assets/HeaderBridgeNetworking.png new file mode 100644 index 0000000..ba0faed Binary files /dev/null and b/docs/assets/HeaderBridgeNetworking.png differ diff --git a/docs/assets/HeaderBridgeNetworkingTextOnly.png b/docs/assets/HeaderBridgeNetworkingTextOnly.png new file mode 100644 index 0000000..c6e6cf2 Binary files /dev/null and b/docs/assets/HeaderBridgeNetworkingTextOnly.png differ diff --git a/docs/assets/HeaderCascadeLake.png b/docs/assets/HeaderCascadeLake.png new file mode 100644 index 0000000..8b1bcf1 Binary files /dev/null and b/docs/assets/HeaderCascadeLake.png differ diff --git a/docs/assets/HeaderConfigs.png b/docs/assets/HeaderConfigs.png new file mode 100644 index 0000000..f098400 Binary files /dev/null and b/docs/assets/HeaderConfigs.png differ diff --git a/docs/assets/HeaderCongrats.png b/docs/assets/HeaderCongrats.png new file mode 100644 index 0000000..a7a869f Binary files /dev/null and b/docs/assets/HeaderCongrats.png differ diff --git a/docs/assets/HeaderDGPU.png b/docs/assets/HeaderDGPU.png new file mode 100644 index 0000000..4a98624 Binary files /dev/null and b/docs/assets/HeaderDGPU.png differ diff --git a/docs/assets/HeaderDiskProvision.png b/docs/assets/HeaderDiskProvision.png new file mode 100644 index 0000000..3a16127 Binary files /dev/null and b/docs/assets/HeaderDiskProvision.png differ diff --git a/docs/assets/HeaderDisplayOverrides.png b/docs/assets/HeaderDisplayOverrides.png new file mode 100644 index 0000000..67483b8 Binary files /dev/null and b/docs/assets/HeaderDisplayOverrides.png differ diff --git a/docs/assets/HeaderGatheringFiles.png b/docs/assets/HeaderGatheringFiles.png new file mode 100644 index 0000000..cfc6858 Binary files /dev/null and b/docs/assets/HeaderGatheringFiles.png differ diff --git a/docs/assets/HeaderHostPreparations.png b/docs/assets/HeaderHostPreparations.png new file mode 100644 index 0000000..4be4ae6 Binary files /dev/null and b/docs/assets/HeaderHostPreparations.png differ diff --git a/docs/assets/HeaderInstallingmacOS.png b/docs/assets/HeaderInstallingmacOS.png new file mode 100644 index 0000000..c458667 Binary files /dev/null and b/docs/assets/HeaderInstallingmacOS.png differ diff --git a/docs/assets/HeaderOpenCore.png b/docs/assets/HeaderOpenCore.png new file mode 100644 index 0000000..42cefba Binary files /dev/null and b/docs/assets/HeaderOpenCore.png differ diff --git a/docs/assets/HeaderOpenCoreAlt.png b/docs/assets/HeaderOpenCoreAlt.png new file mode 100644 index 0000000..a115c39 Binary files /dev/null and b/docs/assets/HeaderOpenCoreAlt.png differ diff --git a/docs/assets/HeaderSGPU.png b/docs/assets/HeaderSGPU.png new file mode 100644 index 0000000..bd01e1c Binary files /dev/null and b/docs/assets/HeaderSGPU.png differ diff --git a/docs/assets/HeaderTextOnly.png b/docs/assets/HeaderTextOnly.png new file mode 100644 index 0000000..11ed836 Binary files /dev/null and b/docs/assets/HeaderTextOnly.png differ diff --git a/docs/assets/HeaderVirtualMachine.png b/docs/assets/HeaderVirtualMachine.png new file mode 100644 index 0000000..4f88a64 Binary files /dev/null and b/docs/assets/HeaderVirtualMachine.png differ diff --git a/docs/assets/IOMMUGroupChecker.png b/docs/assets/IOMMUGroupChecker.png new file mode 100644 index 0000000..6de8134 Binary files /dev/null and b/docs/assets/IOMMUGroupChecker.png differ diff --git a/docs/assets/OpenCoreACPIAdd.png b/docs/assets/OpenCoreACPIAdd.png new file mode 100644 index 0000000..a236a84 Binary files /dev/null and b/docs/assets/OpenCoreACPIAdd.png differ diff --git a/docs/assets/OpenCoreBooterQuirks.png b/docs/assets/OpenCoreBooterQuirks.png new file mode 100644 index 0000000..b3843c0 Binary files /dev/null and b/docs/assets/OpenCoreBooterQuirks.png differ diff --git a/docs/assets/OpenCoreDeviceProperties.png b/docs/assets/OpenCoreDeviceProperties.png new file mode 100644 index 0000000..a1c28b3 Binary files /dev/null and b/docs/assets/OpenCoreDeviceProperties.png differ diff --git a/docs/assets/OpenCoreEFIComplete.png b/docs/assets/OpenCoreEFIComplete.png new file mode 100644 index 0000000..0710c52 Binary files /dev/null and b/docs/assets/OpenCoreEFIComplete.png differ diff --git a/docs/assets/OpenCoreKernel.png b/docs/assets/OpenCoreKernel.png new file mode 100644 index 0000000..7ca5d8a Binary files /dev/null and b/docs/assets/OpenCoreKernel.png differ diff --git a/docs/assets/OpenCoreLocalCreation.png b/docs/assets/OpenCoreLocalCreation.png new file mode 100644 index 0000000..20b872c Binary files /dev/null and b/docs/assets/OpenCoreLocalCreation.png differ diff --git a/docs/assets/OpenCoreMisc.png b/docs/assets/OpenCoreMisc.png new file mode 100644 index 0000000..e091790 Binary files /dev/null and b/docs/assets/OpenCoreMisc.png differ diff --git a/docs/assets/OpenCoreNVRAM.png b/docs/assets/OpenCoreNVRAM.png new file mode 100644 index 0000000..d684106 Binary files /dev/null and b/docs/assets/OpenCoreNVRAM.png differ diff --git a/docs/assets/OpenCorePkgBase.png b/docs/assets/OpenCorePkgBase.png new file mode 100644 index 0000000..579ed24 Binary files /dev/null and b/docs/assets/OpenCorePkgBase.png differ diff --git a/docs/assets/OpenCorePlatformInfo.png b/docs/assets/OpenCorePlatformInfo.png new file mode 100644 index 0000000..9b79e16 Binary files /dev/null and b/docs/assets/OpenCorePlatformInfo.png differ diff --git a/docs/assets/OpenCoreProperTree.png b/docs/assets/OpenCoreProperTree.png new file mode 100644 index 0000000..8fc5118 Binary files /dev/null and b/docs/assets/OpenCoreProperTree.png differ diff --git a/docs/assets/OpenCoreRGXExample.png b/docs/assets/OpenCoreRGXExample.png new file mode 100644 index 0000000..2cf2151 Binary files /dev/null and b/docs/assets/OpenCoreRGXExample.png differ diff --git a/docs/assets/OpenCoreSonomaInstallationComplete.png b/docs/assets/OpenCoreSonomaInstallationComplete.png new file mode 100644 index 0000000..53fafb9 Binary files /dev/null and b/docs/assets/OpenCoreSonomaInstallationComplete.png differ diff --git a/docs/assets/OpenCoreSonomaRecoveryBoot.png b/docs/assets/OpenCoreSonomaRecoveryBoot.png new file mode 100644 index 0000000..02e5c37 Binary files /dev/null and b/docs/assets/OpenCoreSonomaRecoveryBoot.png differ diff --git a/docs/assets/OpenCoreSonomaRecoveryInstallation1.png b/docs/assets/OpenCoreSonomaRecoveryInstallation1.png new file mode 100644 index 0000000..4b1526f Binary files /dev/null and b/docs/assets/OpenCoreSonomaRecoveryInstallation1.png differ diff --git a/docs/assets/OpenCoreSonomaRecoveryInstallation2.png b/docs/assets/OpenCoreSonomaRecoveryInstallation2.png new file mode 100644 index 0000000..83708de Binary files /dev/null and b/docs/assets/OpenCoreSonomaRecoveryInstallation2.png differ diff --git a/docs/assets/OpenCoreSonomaSecondBootPhase.png b/docs/assets/OpenCoreSonomaSecondBootPhase.png new file mode 100644 index 0000000..2d36277 Binary files /dev/null and b/docs/assets/OpenCoreSonomaSecondBootPhase.png differ diff --git a/docs/assets/OpenCoreSonomaThirdBootPhase.png b/docs/assets/OpenCoreSonomaThirdBootPhase.png new file mode 100644 index 0000000..b5dde3e Binary files /dev/null and b/docs/assets/OpenCoreSonomaThirdBootPhase.png differ diff --git a/docs/assets/OpenCoreUEFI.png b/docs/assets/OpenCoreUEFI.png new file mode 100644 index 0000000..4f3b071 Binary files /dev/null and b/docs/assets/OpenCoreUEFI.png differ diff --git a/docs/assets/OpenCoreUnmount.png b/docs/assets/OpenCoreUnmount.png new file mode 100644 index 0000000..96c80e9 Binary files /dev/null and b/docs/assets/OpenCoreUnmount.png differ diff --git a/docs/assets/OpenCoreVMBootRecovery.png b/docs/assets/OpenCoreVMBootRecovery.png new file mode 100644 index 0000000..f01ff33 Binary files /dev/null and b/docs/assets/OpenCoreVMBootRecovery.png differ diff --git a/docs/assets/QEMUHookModification.png b/docs/assets/QEMUHookModification.png new file mode 100644 index 0000000..be62b89 Binary files /dev/null and b/docs/assets/QEMUHookModification.png differ diff --git a/docs/assets/Template-README.md b/docs/assets/Template-README.md new file mode 100644 index 0000000..68930a1 --- /dev/null +++ b/docs/assets/Template-README.md @@ -0,0 +1,28 @@ +

+ +

+ +

DKVM --- ---

+

Allows --- for your DKVM.

+ +## About + +This tool --- for use with ---. It performs the following actions: + +- +- +- +- +- +- + +## Requirements + +* --- : + * --- + * --- + * --- + * --- + +## Usage + diff --git a/docs/assets/VManAddBridgeNIC.png b/docs/assets/VManAddBridgeNIC.png new file mode 100644 index 0000000..c34b9f2 Binary files /dev/null and b/docs/assets/VManAddBridgeNIC.png differ diff --git a/docs/assets/VManAddOpenCore1.png b/docs/assets/VManAddOpenCore1.png new file mode 100644 index 0000000..4bec320 Binary files /dev/null and b/docs/assets/VManAddOpenCore1.png differ diff --git a/docs/assets/VManAddOpenCore2.png b/docs/assets/VManAddOpenCore2.png new file mode 100644 index 0000000..8e738f6 Binary files /dev/null and b/docs/assets/VManAddOpenCore2.png differ diff --git a/docs/assets/VManAddRecoveryDisplay1.png b/docs/assets/VManAddRecoveryDisplay1.png new file mode 100644 index 0000000..1c00e89 Binary files /dev/null and b/docs/assets/VManAddRecoveryDisplay1.png differ diff --git a/docs/assets/VManAddRecoveryDisplay2.png b/docs/assets/VManAddRecoveryDisplay2.png new file mode 100644 index 0000000..3bbd7ea Binary files /dev/null and b/docs/assets/VManAddRecoveryDisplay2.png differ diff --git a/docs/assets/VManAddVirtIOInstallation.png b/docs/assets/VManAddVirtIOInstallation.png new file mode 100644 index 0000000..ff002b4 Binary files /dev/null and b/docs/assets/VManAddVirtIOInstallation.png differ diff --git a/docs/assets/VManAddVirtIOInstallation2.png b/docs/assets/VManAddVirtIOInstallation2.png new file mode 100644 index 0000000..a802734 Binary files /dev/null and b/docs/assets/VManAddVirtIOInstallation2.png differ diff --git a/docs/assets/VManExampleReadyToInstall.png b/docs/assets/VManExampleReadyToInstall.png new file mode 100644 index 0000000..9e27d3b Binary files /dev/null and b/docs/assets/VManExampleReadyToInstall.png differ diff --git a/docs/assets/VManGPUPassthroughAddGPU.png b/docs/assets/VManGPUPassthroughAddGPU.png new file mode 100644 index 0000000..fe079ca Binary files /dev/null and b/docs/assets/VManGPUPassthroughAddGPU.png differ diff --git a/docs/assets/VManGPUPassthroughAddGPUAudio.png b/docs/assets/VManGPUPassthroughAddGPUAudio.png new file mode 100644 index 0000000..f24648e Binary files /dev/null and b/docs/assets/VManGPUPassthroughAddGPUAudio.png differ diff --git a/docs/assets/VManGPUPassthroughAddMultithreading.png b/docs/assets/VManGPUPassthroughAddMultithreading.png new file mode 100644 index 0000000..9c246fa Binary files /dev/null and b/docs/assets/VManGPUPassthroughAddMultithreading.png differ diff --git a/docs/assets/VManGPUPassthroughAddNVME.png b/docs/assets/VManGPUPassthroughAddNVME.png new file mode 100644 index 0000000..fcd2142 Binary files /dev/null and b/docs/assets/VManGPUPassthroughAddNVME.png differ diff --git a/docs/assets/VManGPUPassthroughAddUSBController1.png b/docs/assets/VManGPUPassthroughAddUSBController1.png new file mode 100644 index 0000000..9487a21 Binary files /dev/null and b/docs/assets/VManGPUPassthroughAddUSBController1.png differ diff --git a/docs/assets/VManGPUPassthroughAddUSBController2.png b/docs/assets/VManGPUPassthroughAddUSBController2.png new file mode 100644 index 0000000..0edcf71 Binary files /dev/null and b/docs/assets/VManGPUPassthroughAddUSBController2.png differ diff --git a/docs/assets/VManGPUPassthroughCompletedExample.png b/docs/assets/VManGPUPassthroughCompletedExample.png new file mode 100644 index 0000000..e70c764 Binary files /dev/null and b/docs/assets/VManGPUPassthroughCompletedExample.png differ diff --git a/docs/assets/VManGPUPassthroughCorrectAudioBusAfter.png b/docs/assets/VManGPUPassthroughCorrectAudioBusAfter.png new file mode 100644 index 0000000..771297c Binary files /dev/null and b/docs/assets/VManGPUPassthroughCorrectAudioBusAfter.png differ diff --git a/docs/assets/VManGPUPassthroughCorrectAudioBusBefore.png b/docs/assets/VManGPUPassthroughCorrectAudioBusBefore.png new file mode 100644 index 0000000..1a81ed2 Binary files /dev/null and b/docs/assets/VManGPUPassthroughCorrectAudioBusBefore.png differ diff --git a/docs/assets/VManGPUPassthroughCorrectedGPUMultifunction.png b/docs/assets/VManGPUPassthroughCorrectedGPUMultifunction.png new file mode 100644 index 0000000..09fd793 Binary files /dev/null and b/docs/assets/VManGPUPassthroughCorrectedGPUMultifunction.png differ diff --git a/docs/assets/VManGPUPassthroughFindGPUBus.png b/docs/assets/VManGPUPassthroughFindGPUBus.png new file mode 100644 index 0000000..2140a90 Binary files /dev/null and b/docs/assets/VManGPUPassthroughFindGPUBus.png differ diff --git a/docs/assets/VManGPUPassthroughRemoveRecoveryKBM.png b/docs/assets/VManGPUPassthroughRemoveRecoveryKBM.png new file mode 100644 index 0000000..4cdeb60 Binary files /dev/null and b/docs/assets/VManGPUPassthroughRemoveRecoveryKBM.png differ diff --git a/docs/assets/VManGPUPassthroughRemoveVirtIODisplay.png b/docs/assets/VManGPUPassthroughRemoveVirtIODisplay.png new file mode 100644 index 0000000..ac8a225 Binary files /dev/null and b/docs/assets/VManGPUPassthroughRemoveVirtIODisplay.png differ diff --git a/docs/assets/VManRemoveRecoveryKBM.png b/docs/assets/VManRemoveRecoveryKBM.png new file mode 100644 index 0000000..4b905d6 Binary files /dev/null and b/docs/assets/VManRemoveRecoveryKBM.png differ diff --git a/docs/assets/VManTemplateImport.png b/docs/assets/VManTemplateImport.png new file mode 100644 index 0000000..f0b7278 Binary files /dev/null and b/docs/assets/VManTemplateImport.png differ diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico new file mode 100644 index 0000000..1322fba Binary files /dev/null and b/docs/assets/favicon.ico differ diff --git a/docs/assets/macOSRecoveryDiskUtility.png b/docs/assets/macOSRecoveryDiskUtility.png new file mode 100644 index 0000000..8d068d0 Binary files /dev/null and b/docs/assets/macOSRecoveryDiskUtility.png differ diff --git a/docs/assets/macOSRecoveryFormatInstallTarget.png b/docs/assets/macOSRecoveryFormatInstallTarget.png new file mode 100644 index 0000000..7e77f4d Binary files /dev/null and b/docs/assets/macOSRecoveryFormatInstallTarget.png differ diff --git a/docs/assets/macOSRecoveryFormatInstallTarget2.png b/docs/assets/macOSRecoveryFormatInstallTarget2.png new file mode 100644 index 0000000..41cfebc Binary files /dev/null and b/docs/assets/macOSRecoveryFormatInstallTarget2.png differ diff --git a/docs/assets/macOSRecoveryFormatInstallTarget3.png b/docs/assets/macOSRecoveryFormatInstallTarget3.png new file mode 100644 index 0000000..638e283 Binary files /dev/null and b/docs/assets/macOSRecoveryFormatInstallTarget3.png differ diff --git a/docs/assets/macOSSonomaDesktop.png b/docs/assets/macOSSonomaDesktop.png new file mode 100644 index 0000000..eab8b39 Binary files /dev/null and b/docs/assets/macOSSonomaDesktop.png differ diff --git a/docs/assets/macOSSonomaGPUAccel.png b/docs/assets/macOSSonomaGPUAccel.png new file mode 100755 index 0000000..7dbd5ce Binary files /dev/null and b/docs/assets/macOSSonomaGPUAccel.png differ diff --git a/docs/assets/macOSSonomaNoMountEFIneeded.png b/docs/assets/macOSSonomaNoMountEFIneeded.png new file mode 100644 index 0000000..eacc30f Binary files /dev/null and b/docs/assets/macOSSonomaNoMountEFIneeded.png differ diff --git a/docs/assets/macrecovery.png b/docs/assets/macrecovery.png new file mode 100644 index 0000000..99b3762 Binary files /dev/null and b/docs/assets/macrecovery.png differ diff --git a/docs/docs/01-About.md b/docs/docs/01-About.md new file mode 100644 index 0000000..4ef14b5 --- /dev/null +++ b/docs/docs/01-About.md @@ -0,0 +1,19 @@ +--- +layout: default +title: About This Project +nav_order: 2 +--- + +

+ +

+ +

What is this for?

+ +This repository and its contents are to be a continuation of my work on [LegacyOSXKVM](https://github.com/royalgraphx/LegacyOSXKVM). The goal of that project was to allow anyone to quickly revisit some of their favorite versions of Mac OS X as it was known to many for years with its various releases. Snow Leopard was the main focus of that project, and as such had the most effort put into it. Nowadays we need to be on modern versions of macOS to enjoy the latest and greatest offered from Apple. The focus has now shifted to providing an Up-to-Date, Out of Box (OOB), Clean Template for creating Virtual Machines of the latest versions offered by Apple. As of writing this, you can create a powerful VM of macOS Ventura, Monterey, and even Sonoma works. The guides in this repository will help you continuously work on your virtual machine to make it the perfect experience. Things will not work right away, you will slowly keep fixing them as you discover what must be fixed. + +

Who is this for?

+ +This is for experienced users. You should already be familiar with 3 core concepts: [Virtualization](https://libvirt.org/)/[QEMU](https://www.qemu.org/docs/master/), [OpenCore](https://dortania.github.io/OpenCore-Install-Guide/), and [macOS](https://en.wikipedia.org/wiki/MacOS). If you feel as though you are not up to speed on any of these concepts, please take the time to first gain adequate knowledge as it will vastly improve your chances of having a working system you can daily drive. This guide is written completely from my perspective as I've learned throughout my time in the Hackintosh community. What you would typically do if you wanted to run macOS on your system you would have to use the OpenCore bootloader to provide macOS with the necessary information it needs. A Virtual Machine is no different. In theory, what we are simply doing is creating an OpenCore disk image that acts as if it were the equivalent of a USB or an EFI partition post-installation. While there exist many projects that utilize QEMU/KVM, for daily driving you must have a compatible GPU. What this means for the user of any projects that are seen as the equivalent to "Prebuilt EFI's" is that there is no learning involved. This causes the user to not understand why certain things are broken on their system and possibly may never fix those issues, potentially leaving them in the background. This guide is for those who are looking to properly create a macOS Virtual Machine from the ground up. PLEASE READ CAREFULLY. Try not to ask for support before rereading, many times you will misread something on accident or are simply not paying enough attention to what it's instructing you to do. + +

You can now proceed to the Host Preparations section!

\ No newline at end of file diff --git a/docs/docs/02-HostPreparations/01-BIOS.md b/docs/docs/02-HostPreparations/01-BIOS.md new file mode 100644 index 0000000..d189529 --- /dev/null +++ b/docs/docs/02-HostPreparations/01-BIOS.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 1. BIOS Settings +parent: Host Preparations +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/docs/02-HostPreparations/02-GRUB.md b/docs/docs/02-HostPreparations/02-GRUB.md new file mode 100644 index 0000000..c17381a --- /dev/null +++ b/docs/docs/02-HostPreparations/02-GRUB.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 2. GRUB Configuration +parent: Host Preparations +nav_order: 2 +--- \ No newline at end of file diff --git a/docs/docs/02-HostPreparations/03-Bridge.md b/docs/docs/02-HostPreparations/03-Bridge.md new file mode 100644 index 0000000..ebc22e0 --- /dev/null +++ b/docs/docs/02-HostPreparations/03-Bridge.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 3. Bridge Networking +parent: Host Preparations +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/docs/02-HostPreparations/04-PackageInstall.md b/docs/docs/02-HostPreparations/04-PackageInstall.md new file mode 100644 index 0000000..c5ad49d --- /dev/null +++ b/docs/docs/02-HostPreparations/04-PackageInstall.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 4. Package Installation +parent: Host Preparations +nav_order: 4 +--- \ No newline at end of file diff --git a/docs/docs/02-HostPreparations/05-Libvirtd.md b/docs/docs/02-HostPreparations/05-Libvirtd.md new file mode 100644 index 0000000..22b3814 --- /dev/null +++ b/docs/docs/02-HostPreparations/05-Libvirtd.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 5. Libvirtd Configuration +parent: Host Preparations +nav_order: 5 +--- \ No newline at end of file diff --git a/docs/docs/02-HostPreparations/index.md b/docs/docs/02-HostPreparations/index.md new file mode 100644 index 0000000..43cab43 --- /dev/null +++ b/docs/docs/02-HostPreparations/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Host Preparations +nav_order: 3 +has_children: true +--- + +

+ +

+ diff --git a/docs/docs/03-GatheringFiles/00-ImageCreation.md b/docs/docs/03-GatheringFiles/00-ImageCreation.md new file mode 100644 index 0000000..d2c3382 --- /dev/null +++ b/docs/docs/03-GatheringFiles/00-ImageCreation.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 0 - Image Creation +parent: Gathering Files +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/docs/03-GatheringFiles/01-ACPITables.md b/docs/docs/03-GatheringFiles/01-ACPITables.md new file mode 100644 index 0000000..fe479d9 --- /dev/null +++ b/docs/docs/03-GatheringFiles/01-ACPITables.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 1 - ACPI Tables +parent: Gathering Files +nav_order: 2 +--- \ No newline at end of file diff --git a/docs/docs/03-GatheringFiles/02-Drivers.md b/docs/docs/03-GatheringFiles/02-Drivers.md new file mode 100644 index 0000000..808ed0c --- /dev/null +++ b/docs/docs/03-GatheringFiles/02-Drivers.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 2 - Drivers +parent: Gathering Files +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/docs/03-GatheringFiles/03-Kexts.md b/docs/docs/03-GatheringFiles/03-Kexts.md new file mode 100644 index 0000000..8de74c5 --- /dev/null +++ b/docs/docs/03-GatheringFiles/03-Kexts.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 3 - Kexts +parent: Gathering Files +nav_order: 4 +--- \ No newline at end of file diff --git a/docs/docs/03-GatheringFiles/04-Tools.md b/docs/docs/03-GatheringFiles/04-Tools.md new file mode 100644 index 0000000..1decf1f --- /dev/null +++ b/docs/docs/03-GatheringFiles/04-Tools.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 4 - Tools +parent: Gathering Files +nav_order: 5 +--- \ No newline at end of file diff --git a/docs/docs/03-GatheringFiles/index.md b/docs/docs/03-GatheringFiles/index.md new file mode 100644 index 0000000..f32e8ea --- /dev/null +++ b/docs/docs/03-GatheringFiles/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Gathering Files +nav_order: 4 +has_children: true +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/00-Introduction.md b/docs/docs/04-Configs/01-VMCascadeLake/00-Introduction.md new file mode 100644 index 0000000..55d9338 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/00-Introduction.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Part 0 - Introduction +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 1 +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/01-ACPI.md b/docs/docs/04-Configs/01-VMCascadeLake/01-ACPI.md new file mode 100644 index 0000000..f0d7c68 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/01-ACPI.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 1 - ACPI +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 2 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/02-Booter.md b/docs/docs/04-Configs/01-VMCascadeLake/02-Booter.md new file mode 100644 index 0000000..0136a1d --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/02-Booter.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 2 - Booter +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/03-DeviceProperties.md b/docs/docs/04-Configs/01-VMCascadeLake/03-DeviceProperties.md new file mode 100644 index 0000000..2ff3a1f --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/03-DeviceProperties.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 3 - Device Properties +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 4 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/04-Kernel.md b/docs/docs/04-Configs/01-VMCascadeLake/04-Kernel.md new file mode 100644 index 0000000..b0373d6 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/04-Kernel.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 4 - Kernel +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 5 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/05-Misc.md b/docs/docs/04-Configs/01-VMCascadeLake/05-Misc.md new file mode 100644 index 0000000..3272a10 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/05-Misc.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 5 - Misc +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 6 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/06-NVRAM.md b/docs/docs/04-Configs/01-VMCascadeLake/06-NVRAM.md new file mode 100644 index 0000000..11e7147 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/06-NVRAM.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 6 - NVRAM +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 7 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/07-PlatformInfo.md b/docs/docs/04-Configs/01-VMCascadeLake/07-PlatformInfo.md new file mode 100644 index 0000000..9d052cc --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/07-PlatformInfo.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 7 - PlatformInfo +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 8 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/08-UEFI.md b/docs/docs/04-Configs/01-VMCascadeLake/08-UEFI.md new file mode 100644 index 0000000..151e543 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/08-UEFI.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Part 8 - UEFI +parent: Virtual Machine Cascade Lake +grand_parent: Configs +nav_order: 9 +--- \ No newline at end of file diff --git a/docs/docs/04-Configs/01-VMCascadeLake/index.md b/docs/docs/04-Configs/01-VMCascadeLake/index.md new file mode 100644 index 0000000..e296d91 --- /dev/null +++ b/docs/docs/04-Configs/01-VMCascadeLake/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Virtual Machine Cascade Lake +parent: Configs +has_children: true +nav_order: 1 +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/04-Configs/index.md b/docs/docs/04-Configs/index.md new file mode 100644 index 0000000..46c8aa6 --- /dev/null +++ b/docs/docs/04-Configs/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Configs +nav_order: 5 +has_children: true +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/05-FetchingBaseSystem/00-Introduction.md b/docs/docs/05-FetchingBaseSystem/00-Introduction.md new file mode 100644 index 0000000..e516c0a --- /dev/null +++ b/docs/docs/05-FetchingBaseSystem/00-Introduction.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 0 - Introduction +parent: Fetching BaseSystem +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/docs/05-FetchingBaseSystem/01-macrecovery.md b/docs/docs/05-FetchingBaseSystem/01-macrecovery.md new file mode 100644 index 0000000..abfa0c2 --- /dev/null +++ b/docs/docs/05-FetchingBaseSystem/01-macrecovery.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 1 - macrecovery +parent: Fetching BaseSystem +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/docs/05-FetchingBaseSystem/index.md b/docs/docs/05-FetchingBaseSystem/index.md new file mode 100644 index 0000000..a54d282 --- /dev/null +++ b/docs/docs/05-FetchingBaseSystem/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Fetching BaseSystem +nav_order: 6 +has_children: true +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/00-ImportingXML.md b/docs/docs/06-InstallingmacOS/00-ImportingXML.md new file mode 100644 index 0000000..34023ae --- /dev/null +++ b/docs/docs/06-InstallingmacOS/00-ImportingXML.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 0 - Importing XML +parent: Installing macOS +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/01-ConfigDisplay.md b/docs/docs/06-InstallingmacOS/01-ConfigDisplay.md new file mode 100644 index 0000000..18bbd86 --- /dev/null +++ b/docs/docs/06-InstallingmacOS/01-ConfigDisplay.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 1 - Configure Display for recoveryOS +parent: Installing macOS +nav_order: 2 +--- \ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/02-ConfigDrives.md b/docs/docs/06-InstallingmacOS/02-ConfigDrives.md new file mode 100644 index 0000000..67114b6 --- /dev/null +++ b/docs/docs/06-InstallingmacOS/02-ConfigDrives.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 2 - Configure Storage Drives +parent: Installing macOS +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/03-ConfigNIC.md b/docs/docs/06-InstallingmacOS/03-ConfigNIC.md new file mode 100644 index 0000000..9438105 --- /dev/null +++ b/docs/docs/06-InstallingmacOS/03-ConfigNIC.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 3 - Configure NIC for Virtual Machine +parent: Installing macOS +nav_order: 4 +--- \ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/04-Review.md b/docs/docs/06-InstallingmacOS/04-Review.md new file mode 100644 index 0000000..f0a1183 --- /dev/null +++ b/docs/docs/06-InstallingmacOS/04-Review.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 4 - Finished Example +parent: Installing macOS +nav_order: 5 +--- \ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/05-Installation.md b/docs/docs/06-InstallingmacOS/05-Installation.md new file mode 100644 index 0000000..726cb51 --- /dev/null +++ b/docs/docs/06-InstallingmacOS/05-Installation.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 5 - Installing via recoveryOS +parent: Installing macOS +nav_order: 6 +--- \ No newline at end of file diff --git a/docs/docs/06-InstallingmacOS/index.md b/docs/docs/06-InstallingmacOS/index.md new file mode 100644 index 0000000..89020af --- /dev/null +++ b/docs/docs/06-InstallingmacOS/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Installing macOS +nav_order: 7 +has_children: true +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/07-SingleGPUPassthrough/01-Installation.md b/docs/docs/07-SingleGPUPassthrough/01-Installation.md new file mode 100644 index 0000000..3e39310 --- /dev/null +++ b/docs/docs/07-SingleGPUPassthrough/01-Installation.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 1 - Script Installation +parent: Single GPU Passthrough +nav_order: 1 +--- \ No newline at end of file diff --git a/docs/docs/07-SingleGPUPassthrough/02-HookModification.md b/docs/docs/07-SingleGPUPassthrough/02-HookModification.md new file mode 100644 index 0000000..d62f5ce --- /dev/null +++ b/docs/docs/07-SingleGPUPassthrough/02-HookModification.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 2 - Hook Modification +parent: Single GPU Passthrough +nav_order: 2 +--- \ No newline at end of file diff --git a/docs/docs/07-SingleGPUPassthrough/03-VManUpdate.md b/docs/docs/07-SingleGPUPassthrough/03-VManUpdate.md new file mode 100644 index 0000000..bc8cc04 --- /dev/null +++ b/docs/docs/07-SingleGPUPassthrough/03-VManUpdate.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Part 3 - Virt-Manager Configuration +parent: Single GPU Passthrough +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/docs/07-SingleGPUPassthrough/index.md b/docs/docs/07-SingleGPUPassthrough/index.md new file mode 100644 index 0000000..eb5e423 --- /dev/null +++ b/docs/docs/07-SingleGPUPassthrough/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Single GPU Passthrough +nav_order: 8 +has_children: true +--- + +

+ +

\ No newline at end of file diff --git a/docs/docs/08-DualGPUPassthrough/index.md b/docs/docs/08-DualGPUPassthrough/index.md new file mode 100644 index 0000000..7d57c79 --- /dev/null +++ b/docs/docs/08-DualGPUPassthrough/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: Dual GPU Passthrough +nav_order: 9 +has_children: true +has_toc: false +--- + +

+ +

+ +Support for this section is in development. \ No newline at end of file diff --git a/docs/docs/09-Finish.md b/docs/docs/09-Finish.md new file mode 100644 index 0000000..c177544 --- /dev/null +++ b/docs/docs/09-Finish.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Finish! +nav_order: 10 +--- + +

+ +

+ +

Thanks for reading!

+

For further customization please refer to Submodules

+

Enjoy a screenshot of Sonoma with GPU Accel. Don't forget to add the bootflag!

+ +

+ +

\ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 8a81958..d6f0418 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,32 +1,123 @@ --- -title: Home -layout: home +layout: default +title: Welcome +nav_order: 1 +description: "Landing page for DarwinKVM Documentation!" +permalink: / --- -This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details. + -More specifically, the created site: +

+ +

-- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem -- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages +

+ +

-Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins. +

Features: Clean EFI Template for maximum customizability before boot, Compatibility with RisingPrism's Single GPU Passthrough, DisplayOverrides for repairing incompatible monitors, Custom Memory Mapping, Custom USB Mapping, Fake Core Count for incompatible CPU Topology, Host CPU Overclocking, Host Network Bridge for VM visibility, AMD GPU Zero-RPM Disable and custom sPPT Fan Curve! as well as many more advanced tutorials ready to further perfect your experience!

-[Browse our documentation][Just the Docs] to learn more about how to use this theme. +

Requirements

-To get started with creating a site, just click "[use this template]"! +* A compatible graphics card. This is a must, don't bother if you're not getting GPU Accel. please reference this [list](https://dortania.github.io/GPU-Buyers-Guide/) to verify. + * There are some exceptions, if you're crazy and want to use a legacy NVIDIA GPU, please reference this [list](https://elitemacx86.com/threads/nvidia-gpu-compatibility-list-for-macos.614/) to check macOS/OCLP compatibility. If it's supported, there is a section down for Legacy NVIDIA Patching. -If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README. +* A modern Linux distribution. E.g. Arch Based for the latest packages, my personally tested and working are: + * EndeavourOS + * ArcoLinuxB Plasma + * Pure Arch ----- +* A CPU with Intel VT-x or AMD SVM support is required (`grep -e vmx -e svm /proc/cpuinfo`) -[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). +* A CPU with SSE4.1 support is required for >= macOS Sierra -[Just the Docs]: https://just-the-docs.github.io/just-the-docs/ -[GitHub Pages]: https://docs.github.com/en/pages -[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md -[Jekyll]: https://jekyllrb.com -[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ -[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate +* A CPU with AVX2 support is required for >= macOS Ventura; but you can bypass the limitation with CryptexFixup as of now. + +* Previous experience creating an EFI for your bare metal system and/or reading/understanding the [Dortania OpenCore Guide](https://dortania.github.io/OpenCore-Install-Guide/) + +* Various Software/Packages, some optional, some not: + * qemu + * libvirtd/virtmanager + * Python 3 installed with the tkinter package + * dmg2img + * qemu-img + * [RisingPrism's Single GPU Passthrough Scripts](https://gitlab.com/risingprismtv/single-gpu-passthrough) + * [ProperTree](https://github.com/corpnewt/ProperTree) + * [GenSMBios](https://github.com/corpnewt/GenSMBIOS) + * [Hackintool](https://github.com/benbaker76/Hackintool) + * [SSDTTime](https://github.com/corpnewt/SSDTTime) + +
+ +* PATIENCE! This is NOT a Pre-Built EFI! You are responsible for completing it! + +

Table of Contents

+ + +- What is this for? + +- Who is this for? + +- Host Preparations + - Part 1 - BIOS Settings + - Part 2 - GRUB Configuration + - Part 3 - Bridge Networking + - A. Goal Examples + - B. Prerequisites to the script + - Part 4 - Package Installation + - Part 5 - Libvirtd Configuration + - A. Modifying Files + - B. Libvirt Services + +- OpenCore Configuration + - Part 0 - Image Creation + - Part 1 - ACPI Tables + - Part 2 - Drivers + - Part 3 - Kexts + - Part 4 - Tools + +- Config.plist Configuration + - Part 0 - Required Tools / Brief Overview + - Part 1 - ACPI + - Part 2 - Booter + - Part 3 - Device Properties + - Part 4 - Kernel + - Part 5 - Misc + - Part 6 - NVRAM + - Part 7 - Platform Info + - Part 8 - UEFI + +- Congratulations! EFI Complete + +- Fetching BaseSystem.dmg + - Part 0 - Required Tools / Brief Overview + - Part 1 - Usage + +- Installing macOS + - Part 0 - Importing the XML to Virt-Manager + - Part 1 - Configure VirtIO Display + - Part 2 - Configure OpenCore VirtIO Drive + - Part 3 - Configure VirtIO NIC + - Part 4 - Review! + - Part 5 - Installation + +- Single GPU Passthrough + - Part 1 - Installation + - Part 2 - Hook Modification + - Part 3 - Virt-Manager Modifications + +- Thanks for reading! + +

You can now proceed to the About section!

\ No newline at end of file