Merge pull request #8 from dominatorul/patch-1
Better Readme Formatting
This commit is contained in:
Souldbminer
131
README.md
131
README.md
@@ -1,58 +1,111 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
<img src="assets/logo.png" alt="logo" width="160"/>
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
[](https://discord.com/invite/S3eX47dHsB)
|
||||
|
||||
|
||||
|
||||
|
||||
  [](https://discord.com/invite/S3eX47dHsB)   []()
|
||||
---
|
||||
|
||||
</div>
|
||||
|
||||
### DISCLAIMER: THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION
|
||||
* Due to the design of Horizon OS, overclocking RAM can cause **NAND DAMAGE**. Ensure to have a NAND Backup<br>
|
||||
## ⚠️ Disclaimer
|
||||
|
||||
A open source overclocking tool for Nintendo Switch consoles running Atmosphere custom firmware<br>
|
||||
> **THIS TOOL CAN BE DANGEROUS IF MISUSED. PROCEED WITH CAUTION.**
|
||||
> Due to the design of Horizon OS, **overclocking RAM can cause NAND DAMAGE.**
|
||||
> Ensure you have a **full NAND backup** before proceeding.
|
||||
|
||||
---
|
||||
|
||||
## Features:
|
||||
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>
|
||||
## 🌀 About
|
||||
|
||||
*Higher (potentially dangerous) frequencies are unlockable*<br>
|
||||
*The exact maximum overclock varies per console*<br>
|
||||
## 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>
|
||||
**Horizon OC** is an open-source overclocking tool for Nintendo Switch consoles running **Atmosphere custom firmware**.
|
||||
It enables advanced CPU, GPU, and RAM tuning with user-friendly configuration tools.
|
||||
|
||||
Alternatively, you can download the configurator and click the two install buttons<br>
|
||||
---
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
## Configuration
|
||||
Download the latest configurator on your computer<br>
|
||||
Run the file<br>
|
||||
Select the drive your SD card or UMS device is mounted as<br>
|
||||
Configure the kip to your liking, and in the end, save it<br>
|
||||
* **CPU:** Up to `2397MHz` (Mariko) / `2091MHz` (Erista)
|
||||
* **GPU:** Up to `1305MHz` (Mariko) / `998MHz` (Erista)
|
||||
* **RAM:** Up to `3200MHz` (Mariko) / `2360MHz` (Erista)
|
||||
* Over/undervolting support
|
||||
* Built-in configurator
|
||||
* Compatible with most homebrew
|
||||
|
||||
## Building
|
||||
Set up a development enviorment ready to compile Atmosphere<br>
|
||||
Git clone Atmosphere, and move the cloned folder into build/<br>
|
||||
Insert Source/stratosphere folder into build/<br>
|
||||
Run build.sh
|
||||
> ⚡ *Higher (potentially dangerous) frequencies are unlockable.*
|
||||
> ⚙️ *Exact maximum values vary per console.*
|
||||
|
||||
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
|
||||
|
||||
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** file from the [Releases](../../releases) tab.
|
||||
3. If using **Hekate**, edit `hekate_ipl.ini` to include:
|
||||
|
||||
```
|
||||
kip1=atmosphere/kips/*
|
||||
```
|
||||
|
||||
*(No changes needed if using fusee.)*
|
||||
4. Download and extract the **Horizon OC sysmodule** to the root of your SD card.
|
||||
5. Alternatively, use the **Configurator** and click the **Install** buttons for automatic setup.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
1. Download the latest **Configurator** on your computer.
|
||||
2. Run the executable.
|
||||
3. Select your SD card or UMS drive.
|
||||
4. Adjust overclocking settings as desired.
|
||||
5. Click **Save** to apply your configuration.
|
||||
|
||||
---
|
||||
|
||||
## 🧱 Building from Source
|
||||
|
||||
1. Set up a development environment for compiling **Atmosphere**.
|
||||
2. Clone Atmosphere:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Atmosphere-NX/Atmosphere.git
|
||||
```
|
||||
3. Move the cloned folder into `build/`.
|
||||
4. Insert your `Source/stratosphere` folder into `build/`.
|
||||
5. Run:
|
||||
|
||||
```bash
|
||||
./build.sh
|
||||
```
|
||||
|
||||
To 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
|
||||
|
||||
* **Lightos** & **Dominatorul** – RAM timings
|
||||
* **KazushiMe** & **meha** – Switch-OC-Suite
|
||||
* **sys-clk team** – sys-clk
|
||||
* **b0rd2death** – Ultrahand sys-clk fork
|
||||
* **Lightos** & **Sammybigio2011** – Early testing
|
||||
|
||||
## Credits
|
||||
Lightos for RAM timings<br>
|
||||
KazushiMe and meha for Switch-Oc-Suite<br>
|
||||
sys-clk team for sys-clk<br>
|
||||
b0rd2death for Ultrahand sys-clk fork<br>
|
||||
Lightos and Sammybigio2011 for early testing<br>
|
||||
|
||||
Reference in New Issue
Block a user