Update README.md
This commit is contained in:
Dominator
151
README.md
151
README.md
@@ -1,58 +1,131 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
|
<!-- 🌌 Banner / Title -->
|
||||||
|
<h1 align="center">
|
||||||
|
<img src="assets/logo.png" alt="logo" width="120"/><br>
|
||||||
|
<span style="font-size: 2.5rem; background: linear-gradient(90deg, #E60012, #5865F2, #0078D4); -webkit-background-clip: text; -webkit-text-fill-color: transparent;">
|
||||||
|
Horizon OC
|
||||||
|
</span>
|
||||||
|
</h1>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<i>Advanced Open Source Overclocking Tool for Nintendo Switch (Atmosphere CFW)</i>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
  [](https://discord.com/invite/S3eX47dHsB)   []()
|
<!-- 🏷️ Badges -->
|
||||||
|
|
||||||
|
|
||||||
|
[](https://discord.com/invite/S3eX47dHsB)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
### DISCLAIMER: THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION
|
## ⚠️ Disclaimer
|
||||||
* Due to the design of Horizon OS, overclocking RAM can cause **NAND DAMAGE**. Ensure to have a NAND Backup<br>
|
|
||||||
|
|
||||||
A open source overclocking tool for Nintendo Switch consoles running Atmosphere custom firmware<br>
|
> **THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION.**
|
||||||
|
> Overclocking RAM can cause **NAND DAMAGE** due to Horizon OS design.
|
||||||
|
> Always ensure you have a **full NAND backup** before proceeding.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Features:
|
## 🌀 About
|
||||||
CPU overclock up to 2397MHz on Mariko units, 2091MHz on Erista units<br>
|
|
||||||
GPU up to 1305MHz on Mariko units, 998MHz on Erista units<br>
|
|
||||||
RAM up to 3200MHz on Mariko units, 2360MHz on Erista units<br>
|
|
||||||
Over/undervolting<br>
|
|
||||||
Configurator<br>
|
|
||||||
Works with most homebrew<br>
|
|
||||||
|
|
||||||
*Higher (potentially dangerous) frequencies are unlockable*<br>
|
**Horizon OC** is an **open-source overclocking suite** for Nintendo Switch consoles running **Atmosphere** custom firmware.
|
||||||
*The exact maximum overclock varies per console*<br>
|
It provides safe and flexible control over CPU, GPU, and RAM frequencies, with a modern configuration utility.
|
||||||
## Installation
|
|
||||||
Ensure you have the latest version of [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere) and [Ultrahand](https://github.com/ppkantorski/Ultrahand-Overlay) installed before continuing<br>
|
|
||||||
Grab latest hoc.kip from releases tab<br>
|
|
||||||
If using hekate, edit hekate_ipl.ini to include "kip1=atmosphere/kips/*". No need for editing if using fusee<br>
|
|
||||||
Download latest Horizon OC sysmodule from releases tab<br>
|
|
||||||
Extract sysmodule into root of SD card<br>
|
|
||||||
|
|
||||||
Alternatively, you can download the configurator and click the two install buttons<br>
|
---
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
|
||||||
## Configuration
|
✅ CPU up to **2397MHz** (Mariko) / **2091MHz** (Erista)
|
||||||
Download the latest configurator on your computer<br>
|
✅ GPU up to **1305MHz** (Mariko) / **998MHz** (Erista)
|
||||||
Run the file<br>
|
✅ RAM up to **3200MHz** (Mariko) / **2360MHz** (Erista)
|
||||||
Select the drive your SD card or UMS device is mounted as<br>
|
✅ Overclock & undervolt support
|
||||||
Configure the kip to your liking, and in the end, save it<br>
|
✅ Built-in configuration tool
|
||||||
|
✅ Compatible with most homebrew
|
||||||
|
|
||||||
## Building
|
> ⚡ *Higher (potentially dangerous) frequencies are unlockable.*
|
||||||
Set up a development enviorment ready to compile Atmosphere<br>
|
> ⚙️ *Exact maximums vary per console.*
|
||||||
Git clone Atmosphere, and move the cloned folder into build/<br>
|
|
||||||
Insert Source/stratosphere folder into build/<br>
|
|
||||||
Run build.sh
|
|
||||||
|
|
||||||
To build the configurator, cd into Source/Configurator<br>
|
---
|
||||||
Run build.bat or run "python -m PyInstaller --onefile --add-data "assets;assets" --icon=assets/icon.ico --noconsole src/main.py"<br>
|
|
||||||
|
|
||||||
|
## 🧩 Installation
|
||||||
|
|
||||||
## Credits
|
1. Install the latest versions of:
|
||||||
Lightos for RAM timings<br>
|
- [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere)
|
||||||
KazushiMe and meha for Switch-Oc-Suite<br>
|
- [Ultrahand Overlay](https://github.com/ppkantorski/Ultrahand-Overlay)
|
||||||
sys-clk team for sys-clk<br>
|
|
||||||
b0rd2death for Ultrahand sys-clk fork<br>
|
2. Download the latest `hoc.kip` from the [Releases](../../releases) tab.
|
||||||
Lightos and Sammybigio2011 for early testing<br>
|
3. If using **Hekate**, edit `hekate_ipl.ini`:
|
||||||
|
```ini
|
||||||
|
kip1=atmosphere/kips/*
|
||||||
|
````
|
||||||
|
|
||||||
|
*(No edits needed if using fusee.)*
|
||||||
|
|
||||||
|
4. Download and extract the **Horizon OC sysmodule** to your SD card root.
|
||||||
|
5. Optionally, use the **Configurator** to install automatically via GUI.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚙️ Configuration
|
||||||
|
|
||||||
|
1. Download the **Configurator** on your PC.
|
||||||
|
2. Run the executable.
|
||||||
|
3. Select your SD card or UMS device.
|
||||||
|
4. Adjust frequency settings.
|
||||||
|
5. Click **Save** to apply your configuration.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧱 Building from Source
|
||||||
|
|
||||||
|
1. Set up a build environment for **Atmosphere**.
|
||||||
|
2. Clone the repo:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/Atmosphere-NX/Atmosphere.git
|
||||||
|
```
|
||||||
|
3. Move it into the `build/` folder.
|
||||||
|
4. Copy your `Source/stratosphere` folder into `build/`.
|
||||||
|
5. Build with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
**Build the Configurator:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd Source/Configurator
|
||||||
|
build.bat
|
||||||
|
# or
|
||||||
|
python -m PyInstaller --onefile --add-data "assets;assets" --icon=assets/icon.ico --noconsole src/main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 💎 Credits
|
||||||
|
|
||||||
|
| Contributor | Contribution |
|
||||||
|
| ------------------------------- | ---------------------- |
|
||||||
|
| **Lightos**, **Dominatorul** | RAM timings |
|
||||||
|
| **KazushiMe**, **meha** | Switch-OC-Suite |
|
||||||
|
| **sys-clk team** | sys-clk base |
|
||||||
|
| **b0rd2death** | Ultrahand sys-clk fork |
|
||||||
|
| **Lightos**, **Sammybigio2011** | Early testing |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
💻 *Built with ❤️ by the Horizon OC community* <br>
|
||||||
|
⭐ Star this repo if you find it useful!
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|||||||
Reference in New Issue
Block a user