Skip to content

Commit

Permalink
Update some dox and rem screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Coopydood committed Sep 16, 2024
1 parent 00606a2 commit b459625
Show file tree
Hide file tree
Showing 28 changed files with 49 additions and 25 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ ovmf/OVMF_VARS.fd
ovmf/user_store/OVMF_VARS.fd
boot/opencore-image-ng.sh
boot/mnt
docs/screenshots/ventura
docs/screenshots/sonoma
docs/.screenshots
BaseSystem.dmg
.gitignore
boot.xml
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a href="https://coopydood.github.io/ultimate-macOS-KVM"><img src="https://github.com/Coopydood/ultimate-macOS-KVM/blob/492731ef1d95d2da534c660b001550f4d76a6c68/resources/images/bannerAlphaBasic.png?raw=true" alt="ultimate-macOS-KVM" width="500"/></a>

### v0.12.3
### v0.12.4

Helping you build the ultimate macOS virtual machine, powered by KVM.

Expand Down
9 changes: 9 additions & 0 deletions docs/Extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
This page will go over some of the features in the Extras menu, without too much detail.

***

## 1. Create and import XML file

This option allows you to automatically convert a QEMU config script previously generated by AutoPilot into an XML file compatible with **virt-manager** (Virtual Machine Manager), which is a GUI frontend that makes management of your VMs easier and nicer to work with.
Expand Down Expand Up @@ -44,13 +45,21 @@ For users who use GRUB to boot their host's Linux install, setting the right ker
Created by @Hyperchromiac.

***

## 5. Generate SMBIOS / Serial Number

ULTMOS now has built-in support for CorpNewt's [GenSMBIOS](https://github.com/corpnewt/GenSMBIOS) script, allowing you to automatically change your OpenCore's SMBIOS model and serial number - so you can customise the virtual Mac model and log into iServices, etc.

***

## R. Restore tools...

This opens a seperate menu providing options to restore various parts of the repository to defaults.

Great for troubleshooting common issues and covering up your mess.

***

## I. Report an issue...

Opens a new issue page on the GitHub repo in your default browser.
Expand Down
27 changes: 13 additions & 14 deletions docs/SupportedHosts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ There are many, *many* distros of Linux to choose from. While theoretically univ
#### Recommended

<img align="left" width="80" height="80" src="https://github.com/Coopydood/Coopydood/assets/39441479/b54b7098-bc82-4110-8a3e-2c4ed729b1b0">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=28l5 width=2 />
<img align="left" width="80" height="80" src="https://github.com/user-attachments/assets/c1b2a299-7dd4-4a4d-a49c-36a89dd6fca7">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=285 width=2 />

<h3>Arch Linux<br><sub>Arch Linux Contributors&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/Coopydood/ultimate-macOS-KVM">Open Website... ⎋</a></sub></h3>
<h3>Arch Linux<br><sub>Arch Linux Contributors&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://archlinux.org/">Open Website... ⎋</a></sub></h3>

This is an advanced distro that is known for its no-nonsense approach to Linux. It does not come with a graphical desktop environment by default, making it a good choice for those who want a minimal system to run KVM on. ULTMOS was developed on this distro, and so compatibility with it is fully guaranteed.

Expand All @@ -19,33 +19,33 @@ This is an advanced distro that is known for its no-nonsense approach to Linux.
<br>
<br>
<img align="left" width="80" height="80" src="https://github.com/Coopydood/Coopydood/assets/39441479/b54b7098-bc82-4110-8a3e-2c4ed729b1b0">
<img align="left" width="80" height="80" src="https://github.com/user-attachments/assets/94a0e55a-8ad2-4514-a0a5-8fe870fb9ba0">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=135 width=2 />

<h3>EndeavourOS<br><sub>EndeavourOS Team&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/Coopydood/ultimate-macOS-KVM">Open Website... ⎋</a></sub></h3>
<h3>EndeavourOS<br><sub>EndeavourOS Team&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://endeavouros.com/">Open Website... ⎋</a></sub></h3>

A more user-friendly approach to an Arch-based system. ULTMOS was developed primarily on Arch Linux, so for almost-guaranteed compatibility - an Arch-based distro is recommended.<br><br>

<img align="left" width="80" height="80" src="https://github.com/Coopydood/ultimate-macOS-KVM/blob/main/resources/images/ULTMOS.png?raw=true">
<img align="left" width="80" height="80" src="https://github.com/user-attachments/assets/8c508afc-985c-4b33-ae1a-4509d75e0e1f">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=135 width=2 />

<h3>Linux Mint<br><sub>Linux Mint Team&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/Coopydood/ultimate-macOS-KVM">Open Website... ⎋</a></sub></h3>

The recommended option for new users; especially those who are accustomed to Windows. Linux Mint is built on an Ubuntu / Debian foundation. ULTMOS has been tested on Linux Mint.<br><br>

<img align="left" width="80" height="80" src="https://github.com/Coopydood/Coopydood/assets/39441479/f37fd9ea-4de9-447c-9cd9-36dd61027a52">
<img align="left" width="80" height="70" src="https://github.com/user-attachments/assets/ceeb84ae-b171-428e-8556-726d38ccdce2">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=135 width=2 />

<h3>ZorinOS<br><sub>ZorinOS Team&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/Coopydood/ultimate-macOS-KVM">Open Website... ⎋</a></sub></h3>
<h3>Zorin OS<br><sub>Zorin OS Team&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://zorin.com/os/">Open Website... ⎋</a></sub></h3>

This is another very user-friendly distro based on Ubuntu. Similar to Linux Mint, it is aimed at users of Windows by providing a simple but stylish design, that can be customised to look similar to other OSes.
<br>
<br>

<img align="left" width="80" height="80" src="https://github.com/Coopydood/Coopydood/assets/39441479/f37fd9ea-4de9-447c-9cd9-36dd61027a52">
<img align="left" width="80" height="80" src="https://github.com/user-attachments/assets/c6461af6-12bf-45ae-b224-2923950b9000">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=295 width=2 />

<h3>Ubuntu<br><sub>Canonical&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/Coopydood/ultimate-macOS-KVM">Open Website... ⎋</a></sub></h3>
<h3>Ubuntu<br><sub>Canonical&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://ubuntu.com/">Open Website... ⎋</a></sub></h3>

The most well-known Linux distro, popular for its application support and ease of use. Also forms the base framework for many other distros, such as Linux Mint.

Expand All @@ -54,11 +54,10 @@ The most well-known Linux distro, popular for its application support and ease o
<br>
<br>
<img align="left" width="80" height="80" src="https://github.com/Coopydood/Coopydood/assets/39441479/f37fd9ea-4de9-447c-9cd9-36dd61027a52">
<img align="left" width="80" height="80" src="https://github.com/user-attachments/assets/a41c89e7-2d91-4673-aaab-35f6c6872d94">
<img align="left" src="https://github.com/Coopydood/ultimate-macOS-KVM/assets/39441479/8f69f9b9-cf23-4e8b-adf3-95862a23e2ba" height=135 width=2 />

<h3>Fedora<br><sub>The Fedora Project&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://github.com/Coopydood/ultimate-macOS-KVM">Open Website... ⎋</a></sub></h3>

Boot your machine in style with a fluent, modern, and clean GRUB theme. Choose from a growing list of theme variants to show off your *NIX distro!
<h3>Fedora<br><sub>The Fedora Project&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://fedoraproject.org/">Open Website... ⎋</a></sub></h3>

A popular Linux distro developed by The Fedora Project. Several users have reported success using ULTMOS on Fedora.
<br>
18 changes: 18 additions & 0 deletions docs/changelogs/v0-12-4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## v0.12.4

### Minor update • --/09/2024

This update includes the following features / fixes / changes:

- Added warning about Resizeable BAR to VFIO passthrough assistant
- Added and updated documentation
- Removed screenshots folder
- *need more drinks? introducing the resizeable bar!*

To see individual code changes, visit the project's commits page at <https://github.com/Coopydood/ultimate-macOS-KVM/commits/main>

> [!NOTE]
> This release has multiple authors. Attributions for contributor changes are included in relevant lines above.
> [!NOTE]
> Remember, commits by Coopydood will always be signed as **4CD28348A3DD016F** or GitHub's public key.
Binary file removed docs/screenshots/ap_changing_values.png
Binary file not shown.
Binary file removed docs/screenshots/ap_in_progress.png
Binary file not shown.
Binary file removed docs/screenshots/ap_mac_address.png
Binary file not shown.
Binary file removed docs/screenshots/ap_success.png
Binary file not shown.
Binary file removed docs/screenshots/ap_summary.png
Binary file not shown.
Binary file removed docs/screenshots/baseConfig.png
Binary file not shown.
Binary file removed docs/screenshots/bootargs_changed.png
Binary file not shown.
Binary file removed docs/screenshots/gpu_checker.png
Binary file not shown.
Binary file removed docs/screenshots/kvm_checker.png
Binary file not shown.
Binary file removed docs/screenshots/mac_pro_example.png
Binary file not shown.
Binary file removed docs/screenshots/macos_recovery.png
Binary file not shown.
Binary file removed docs/screenshots/opencore.png
Binary file not shown.
Binary file removed docs/screenshots/passthrough_checker.png
Binary file not shown.
Binary file removed docs/screenshots/sequoia_passthrough_AtM.png
Binary file not shown.
Binary file removed docs/screenshots/sequoia_passthrough_GPU.png
Binary file not shown.
Binary file removed docs/screenshots/sequoia_passthrough_about.png
Binary file not shown.
Binary file removed docs/screenshots/sequoia_passthrough_desktop.png
Binary file not shown.
Binary file removed docs/screenshots/sequoia_passthrough_rx5700xt.png
Binary file not shown.
Binary file removed docs/screenshots/sequoia_passthrough_safari.png
Binary file not shown.
Binary file removed docs/screenshots/sussymac.png
Binary file not shown.
Binary file removed docs/screenshots/updater.png
Binary file not shown.
5 changes: 3 additions & 2 deletions resources/.upgrade
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
0.11.4
0.12.0
0.12.1
0.12.2
0.12.3
0.12.2
0.12.3
0.12.4
10 changes: 4 additions & 6 deletions scripts/extras/vfio-passthrough.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ def cpydLog(logStatus,logMsg,*args):
cpydLog("info",(" "))
cpydLog("info",("Logging to ./logs/VPTA_RUN_"+logTime+".log"))



# Declare method of clearing the screen the Coopydoopydoo way.
def clear():
os.system("clear")
Expand Down Expand Up @@ -127,7 +125,7 @@ def pause():
def usbOffer():
time.sleep(3)
clear()
print("\n\n "+color.BOLD+color.YELLOW+"VIRTUAL INPUT DEVICES REMOVED"+color.END,"")
print("\n\n "+color.BOLD+color.YELLOW+"VIRTUAL INPUT DEVICES REMOVED"+color.END,"")
print(" Virtual monitor was removed\n")
print(" The assistant has detected that you "+color.BOLD+"passed through a GPU."+color.END+"\n To accommodate this, the virtual guest monitor had to be\n removed. This also means you can't use the virtual input\n devices that utilise the monitor.\n\n To send input to the guest, you may want to passthrough\n USB input devices attached to your host. This project\n can do this for you. You don't need this if you also\n passed through a host USB controller.\n")
#print(color.YELLOW+color.BOLD+"\n ⚠ "+color.END+color.BOLD+"WARNING"+color.END+"\n This action requires superuser permissions.\n"+color.END)
Expand Down Expand Up @@ -184,7 +182,7 @@ def preliminary():
if (len(vfio_ids) == 0 or len(vfio_names) == 0 or len(pci_ids) == 0):
# TODO: LOGGING SHIT GOING SOUTH
clear()
print(f" \033[91m\033[1m✖ NO VFIO-PCI DEVICES FOUND\033[0m\n")
print(f" \033[91m\033[1mNO VFIO-PCI DEVICES FOUND\033[0m\n")
print(f" The script couldn't find any stubbed PCI devices")
print(f" to use with VFIO. Check your boot arguments!!!\n")
cpydLog("fatal", "User's machine does not have any stubbed VFIO-PCI devices.")
Expand Down Expand Up @@ -357,7 +355,7 @@ def phase3():
print(f" {color.BOLD}{color.BLUE}❖ GPU DETECTED{color.END}")
print(f" VBIOS ROM file selection{color.END}\n")
print(f" {color.BOLD}{vfio_names[pci_ids.index(selected_vfio_ids[i])]}{color.END}\n")
print(f" Some GPUs need a romfile to function in a VM, others do not.\n Please specify the direct path to a VBIOS romfile below,\n or type \"skip\" if you don't need one.")
print(f" Some GPUs need a romfile to function in a VM, others do not.\n Please specify the direct path to a VBIOS romfile below,\n or type \"skip\" if you don't need one.\n\n "+color.BOLD+color.YELLOW+"WARNING\n "+color.END+color.BOLD+"You may need to disable ReSizeable BAR (ReBAR) in your\n host's BIOS utility. This feature is known to cause\n major issues with GPU passthrough.")
cpydLog("wait", f"Awaiting for user input on GPU romfile for {selected_vfio_ids[i]}")
user_input: str = input(f"{color.BOLD}\nAbsolute Path of VBIOS>{color.END} ")
if (user_input == "" or user_input == None):
Expand All @@ -375,7 +373,7 @@ def phase3():
qemu_flags.append(f"-device vfio-pci,host=\"{selected_vfio_ids[i]}\",bus=pcie.0")
if naviDetected == 1:
clear()
print("\n\n "+color.BOLD+color.YELLOW+"BOOT PATCH AVAILABLE"+color.END,"")
print("\n\n "+color.BOLD+color.YELLOW+"BOOT PATCH AVAILABLE"+color.END,"")
print(" You may need to apply a fix to boot macOS\n")
print(" The assistant has detected that you may have a"+color.BOLD+" Navi-based"+color.END+" GPU. \n A patch is available to fix the macOS boot process. I can add\n this patch for you automatically just now, or you can do it\n later using the macOS Boot Argument Assistant.")
print(color.YELLOW+color.BOLD+"\n ⚠ "+color.END+color.BOLD+"WARNING"+color.END+"\n This action requires superuser permissions.\n"+color.END)
Expand Down

0 comments on commit b459625

Please sign in to comment.