Update README.md

This commit is contained in:
Dominator
2025-10-10 23:16:11 +03:00
committed by GitHub
parent 1e56f1b016
commit 3dce26b03d

104
README.md
View File

@@ -1,25 +1,15 @@
<div align="center"> <div align="center">
<!-- 🌌 Banner / Title --> <img src="assets/logo.png" alt="logo" width="160"/>
<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>
--- ---
<!-- 🏷️ Badges -->
![License: GPL-2.0](https://img.shields.io/badge/GPL--2.0-red?style=for-the-badge) ![License: GPL-2.0](https://img.shields.io/badge/GPL--2.0-red?style=for-the-badge)
![Nintendo Switch](https://img.shields.io/badge/Nintendo_Switch-E60012?style=for-the-badge&logo=nintendo-switch&logoColor=white) ![Nintendo Switch](https://img.shields.io/badge/Nintendo_Switch-E60012?style=for-the-badge\&logo=nintendo-switch\&logoColor=white)
[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/S3eX47dHsB) [![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge\&logo=discord\&logoColor=white)](https://discord.com/invite/S3eX47dHsB)
![VSCode](https://img.shields.io/badge/VSCode-0078D4?style=for-the-badge&logo=visual%20studio%20code&logoColor=white) ![VSCode](https://img.shields.io/badge/VSCode-0078D4?style=for-the-badge\&logo=visual%20studio%20code\&logoColor=white)
![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge&logo=c%2B%2B&logoColor=white) ![C++](https://img.shields.io/badge/C%2B%2B-00599C?style=for-the-badge\&logo=c%2B%2B\&logoColor=white)
![Downloads](https://img.shields.io/github/downloads/souldbminersmwc/Horizon-OC/total.svg?style=for-the-badge) ![Downloads](https://img.shields.io/github/downloads/souldbminersmwc/Horizon-OC/total.svg?style=for-the-badge)
--- ---
@@ -29,78 +19,78 @@
## ⚠️ Disclaimer ## ⚠️ Disclaimer
> **THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION.** > **THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION.**
> Overclocking RAM can cause **NAND DAMAGE** due to Horizon OS design. > Due to the design of Horizon OS, **overclocking RAM can cause NAND DAMAGE.**
> Always ensure you have a **full NAND backup** before proceeding. > Ensure you have a **full NAND backup** before proceeding.
--- ---
## 🌀 About ## 🌀 About
**Horizon OC** is an **open-source overclocking suite** for Nintendo Switch consoles running **Atmosphere** custom firmware. **Horizon OC** is an open-source overclocking tool for Nintendo Switch consoles running **Atmosphere custom firmware**.
It provides safe and flexible control over CPU, GPU, and RAM frequencies, with a modern configuration utility. It enables advanced CPU, GPU, and RAM tuning with user-friendly configuration tools.
--- ---
## 🚀 Features ## 🚀 Features
✅ CPU up to **2397MHz** (Mariko) / **2091MHz** (Erista) * **CPU:** Up to `2397MHz` (Mariko) / `2091MHz` (Erista)
✅ GPU up to **1305MHz** (Mariko) / **998MHz** (Erista) * **GPU:** Up to `1305MHz` (Mariko) / `998MHz` (Erista)
✅ RAM up to **3200MHz** (Mariko) / **2360MHz** (Erista) * **RAM:** Up to `3200MHz` (Mariko) / `2360MHz` (Erista)
Overclock & undervolt support * Over/undervolting support
Built-in configuration tool * Built-in configurator
Compatible with most homebrew * Compatible with most homebrew
> ⚡ *Higher (potentially dangerous) frequencies are unlockable.* > ⚡ *Higher (potentially dangerous) frequencies are unlockable.*
> ⚙️ *Exact maximums vary per console.* > ⚙️ *Exact maximum values vary per console.*
--- ---
## 🧩 Installation ## 🧩 Installation
1. Install the latest versions of: 1. Ensure you have the latest versions of
- [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere)
- [Ultrahand Overlay](https://github.com/ppkantorski/Ultrahand-Overlay)
2. Download the latest `hoc.kip` from the [Releases](../../releases) tab. * [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere)
3. If using **Hekate**, edit `hekate_ipl.ini`: * [Ultrahand Overlay](https://github.com/ppkantorski/Ultrahand-Overlay)
```ini 2. Download the latest **hoc.kip** file from the [Releases](../../releases) tab.
3. If using **Hekate**, edit `hekate_ipl.ini` to include:
```
kip1=atmosphere/kips/* kip1=atmosphere/kips/*
```` ```
*(No edits needed if using fusee.)* *(No changes needed if using fusee.)*
4. Download and extract the **Horizon OC sysmodule** to the root of your SD card.
4. Download and extract the **Horizon OC sysmodule** to your SD card root. 5. Alternatively, use the **Configurator** and click the **Install** buttons for automatic setup.
5. Optionally, use the **Configurator** to install automatically via GUI.
--- ---
## ⚙️ Configuration ## ⚙️ Configuration
1. Download the **Configurator** on your PC. 1. Download the latest **Configurator** on your computer.
2. Run the executable. 2. Run the executable.
3. Select your SD card or UMS device. 3. Select your SD card or UMS drive.
4. Adjust frequency settings. 4. Adjust overclocking settings as desired.
5. Click **Save** to apply your configuration. 5. Click **Save** to apply your configuration.
--- ---
## 🧱 Building from Source ## 🧱 Building from Source
1. Set up a build environment for **Atmosphere**. 1. Set up a development environment for compiling **Atmosphere**.
2. Clone the repo: 2. Clone Atmosphere:
```bash ```bash
git clone https://github.com/Atmosphere-NX/Atmosphere.git git clone https://github.com/Atmosphere-NX/Atmosphere.git
``` ```
3. Move it into the `build/` folder. 3. Move the cloned folder into `build/`.
4. Copy your `Source/stratosphere` folder into `build/`. 4. Insert your `Source/stratosphere` folder into `build/`.
5. Build with: 5. Run:
```bash ```bash
./build.sh ./build.sh
``` ```
**Build the Configurator:** To build the Configurator:
```bash ```bash
cd Source/Configurator cd Source/Configurator
@@ -113,19 +103,9 @@ python -m PyInstaller --onefile --add-data "assets;assets" --icon=assets/icon.ic
## 💎 Credits ## 💎 Credits
| Contributor | Contribution | * **Lightos** & **Dominatorul** RAM timings
| ------------------------------- | ---------------------- | * **KazushiMe** & **meha** Switch-OC-Suite
| **Lightos**, **Dominatorul** | RAM timings | * **sys-clk team** sys-clk
| **KazushiMe**, **meha** | Switch-OC-Suite | * **b0rd2death** Ultrahand sys-clk fork
| **sys-clk team** | sys-clk base | * **Lightos** & **Sammybigio2011** Early testing
| **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>