Skip to content

Commit

Permalink
I know it sucks but I will improve it in the next update
Browse files Browse the repository at this point in the history
  • Loading branch information
gorouflex authored Jul 17, 2024
1 parent 715c873 commit 7c19594
Showing 1 changed file with 34 additions and 29 deletions.
63 changes: 34 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,51 @@
<picture><img align="left" src="/Img/Logo.png" width="20%"/></picture>
<h1>UXTU4Unix (WIP)</h1>
<h3>Based on RyzenAdj and Python</h3>
<h1>UXTU4Unix (Work-in-Progress)</h1>
<h3>Powered by RyzenAdj and Python</h3>

![GitHub Downloads (all assets, latest release)](https://img.shields.io/github/downloads/AppleOSX/UXTU4Mac/total)

---

> [!CAUTION]
> **The development and updates of this repository will be temporarily suspended until after July 29**
> - **Do not** use `UXTU4Unix` with [SMCAMDProcessor](https://github.com/trulyspinach/SMCAMDProcessor) as they may conflict with each other.
> - This is not an **alternative solution** to [SMCAMDProcessor](https://github.com/trulyspinach/SMCAMDProcessor), [NootedRed](https://github.com/ChefKissInc/NootedRed) and [AMDPlatformPlugin](https://github.com/ChefKissInc/AMDPlatformPlugin/) for their CPU/APU power management itself.
> **Development and updates for this repository will be temporarily suspended until after July 29.**
> - **Caution:** Avoid using `UXTU4Unix` in conjunction with [SMCAMDProcessor](https://github.com/trulyspinach/SMCAMDProcessor) due to potential conflicts.
> - This project does not serve as an alternative to [SMCAMDProcessor](https://github.com/trulyspinach/SMCAMDProcessor), [NootedRed](https://github.com/ChefKissInc/NootedRed), or [AMDPlatformPlugin](https://github.com/ChefKissInc/AMDPlatformPlugin/) for CPU/APU power management.
## Supported APU & OS
## Supported APU & Operating Systems

> [!NOTE]
> - AMD Ryzen APUs processors that are supported by either [NootedRed](https://github.com/ChefKissInc/NootedRed) or the **Premade Preset** section in [UXTU](https://github.com/JamesCJ60/Universal-x86-Tuning-Utility) (or simply supported by RyzenAdj)
> - Support ranges from macOS 10.4 to the latest version (14).
> - Linux is supported (tested on Debian-based distros, Fedora).
> - Compatible with AMD Ryzen APUs supported by either [NootedRed](https://github.com/ChefKissInc/NootedRed) or the **Premade Preset** section in [UXTU](https://github.com/JamesCJ60/Universal-x86-Tuning-Utility) (or generally supported by RyzenAdj).
> - Operating Systems: macOS 10.9 through 15, and Linux (tested on Debian-based distributions and Fedora).
## Usage
- Disable `Secure Boot`
- Download the official build from [Releases](https://github.com/AppleOSX/UXTU4Unix/releases)
- Run `UXTU4Unix.command` (only for macOS) or run `UXTU4Unix.py` by using `python3` command ( `python3 /path/to/UXTU4Unix.py` )
- Follow the instructions.
- [macOS only] Disable `Core Performance Boost` in BIOS using [Smokeless_UMAF](https://github.com/DavidS95/Smokeless_UMAF) to achieve better temperature and better control with `UXTU4Unix` but sacrifice a lot of CPU performance
## Usage Instructions

## Fix Python Certificates in macOS
- Disable `Secure Boot` in the BIOS. (Unknown: Applying the Secure Boot certificate to UEFI may enable compatibility.)
- Download the official build from the [Releases](https://github.com/AppleOSX/UXTU4Unix/releases).
- Run `UXTU4Unix.command` (macOS only) or run `UXTU4Unix.py` using the command: `python3 /path/to/UXTU4Unix.py` or `python /path/to/UXTU4Unix.py`.
- Follow the on-screen instructions.
- [macOS only] For enhanced temperature management and control with `UXTU4Unix`, disable `Core Performance Boost` in the BIOS using [Smokeless_UMAF](https://github.com/DavidS95/Smokeless_UMAF). Note that this may significantly reduce CPU performance, as the `Core Performance Boost` feature on macOS is not optimal.

## Fixing Python Certificates on macOS

<p align="left">
<img src="/Img/cert1.png">
<img src="/Img/cert2.png">
</p>

## FAQ
### 1. Why do we have to disable SIP in macOS?
- Honestly, the binary file (ryzenAdj and DirectHW) is recognized in macOS as untrusted kexts. So, in order to get it working, we have to disable SIP including the flag `ALLOW_UNTRUSTED_KEXTS` (0x1).
### 2. Why does `UXTU4Unix` lack CPU support?
- When I ported a bunch of AMD APU presets from `UXTU` to `UXTU4Unix`, some commands were not compatible with ryzenAdj (because `UXTU` uses lots of methods to change CPU/APU settings besides ryzenAdj), especially the CPU presets. So, I could only keep some commands as a `work-around`.
### 3. GUI wen eta?
- `idk` - NotchApple1703 said to me, but we will release it soon.
## Frequently Asked Questions

### 1. Why is SIP disabled in macOS?
- The binaries (ryzenAdj and DirectHW) are flagged as untrusted kexts in macOS. To ensure functionality, it is necessary to disable SIP and include the `ALLOW_UNTRUSTED_KEXTS` flag (0x1).

### 2. Why does `UXTU4Unix` lack comprehensive CPU support?
- During the transition of AMD APU presets from `UXTU` to `UXTU4Unix`, some commands were incompatible with ryzenAdj. `UXTU` employs various methods to modify CPU/APU settings beyond those supported by ryzenAdj, particularly concerning CPU presets. Consequently, only select commands were retained as workarounds.

### 3. What is the timeline for the GUI?
- The release of the GUI is forthcoming, as communicated by NotchApple1703.

## Advanced Users
For more detailed configurations, please refer to [Custom.md](Custom.md).

## For advanced users, please visit [Custom.md](Custom.md).
# Preview

<p align="left">
Expand All @@ -51,8 +56,8 @@
<img src="/Img/settings.png">
</p>

### Special thanks to
- [b00t0x](https://github.com/b00t0x) for the guide to build ryzenAdj based on DirectHW and pciutils-osx
- [JamesCJ60](https://github.com/JamesCJ60) for [UXTU](https://github.com/JamesCJ60/Universal-x86-Tuning-Utility)
- [corpnewt](https://github.com/corpnewt) for command file
- [NotchApple1703](https://github.com/NotchApple1703) for the GUI (starting from version `0.3.x` or `0.4.x`)
### Acknowledgments
- Special thanks to [b00t0x](https://github.com/b00t0x) for guidance on building ryzenAdj based on DirectHW and pciutils-osx.
- [JamesCJ60](https://github.com/JamesCJ60) for contributions to [UXTU](https://github.com/JamesCJ60/Universal-x86-Tuning-Utility).
- [corpnewt](https://github.com/corpnewt) for the command file on macOS.
- [NotchApple1703](https://github.com/NotchApple1703) for the GUI (starting from `0.4.x`).

0 comments on commit 7c19594

Please sign in to comment.