From b0c35ef639d5d0fb0bf044d2d98421e70534d470 Mon Sep 17 00:00:00 2001 From: niklascfw Date: Wed, 3 Jun 2026 22:01:07 +0200 Subject: [PATCH] docs: Restructure README variant tables like NiklasCFW Docs. Split availability into separate tables for homebrew, Ultrahand packages, overlays, and OC/system; add basis section for shared CFW components. --- README.md | 207 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 107 insertions(+), 100 deletions(-) diff --git a/README.md b/README.md index 0438bfe..5445e94 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,116 @@ # OmniNX CFW Pack -[![Aktuelle Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgit.niklascfw.de%2FOmniNX%2FOmniNX%2Fraw%2Fbranch%2Fmain%2F.github%2Fbadges%2Fdata.json&query=%24.omninx_pack_version&label=OmniNX%20Version&color=blue)](https://git.niklascfw.de/OmniNX/OmniNX/releases/latest) -[![Firmware](https://img.shields.io/github/v/release/THZoria/NX_Firmware?display_name=release&filter=*22.1.0&label=Kompatibel%20mit%20FW&color=189c11&logo=nintendoswitch)](https://github.com/THZoria/NX_Firmware/releases/tag/22.1.0) -[![OmniNX Pack Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgit.niklascfw.de%2FOmniNX%2FOmniNX%2Fraw%2Fbranch%2Fmain%2F.github%2Fbadges%2Fdata.json&query=%24.release_zip_downloads_total&label=OmniNX%20Downloads&color=6f42c1)](https://git.niklascfw.de/OmniNX/OmniNX/releases) +[Aktuelle Version](https://git.niklascfw.de/OmniNX/OmniNX/releases/latest) +[Firmware](https://github.com/THZoria/NX_Firmware/releases/tag/22.1.0) +[OmniNX Pack Downloads](https://git.niklascfw.de/OmniNX/OmniNX/releases) OmniNX ist ein vollständiges Custom-Firmware-Setup für die Nintendo Switch, verfügbar in drei Varianten mit Fokus auf Flexibilität und Modularität. Vollständige Schritt-für-Schritt-Anleitungen: **[OmniNX Setup](https://docs.niklascfw.de/switch/omninx/einfuehrung/)** ## Vorschau -![](.pics/preview.gif) + + ## Features von OmniNX -* **Drei Varianten** – Light (minimal), Standard (voll) und OC (Alles aus Light/Standard + Extra Overclocking Tools) -* **Vollständiges CFW-Setup** – Sofort einsatzbereit mit Atmosphere, Hekate und wichtigen Tools -* **Ultrahand** – Overlay-Menü und Package-System (OmniNX Downloader, Alchemist, RAM Patcher und weitere...) -* **Vorkonfigurierte Payloads** – u. a. APL (Recovery), Lockpick RCM & Pro, TegraExplorer, **[modchip_toolbox](https://github.com/DefenderOfHyrule/modchip-toolbox)**, OmniNX Installer -* **Sicherheit und Patches** – sys-patch, DNS-MitM, USB 3.0 Force -* **Modulare Struktur** – Build-Skripte für einfaches Erstellen der Packs -* **RAM-Patcher-Packages** – Optionale Speicher-Konfigurationen (Default, RAM Patch, 4GB Kip, etc.) -* **sys-ticon (Standard, damit auch OC)** – Home-Menü: eigene Icons, Titel, Herausgeber und Versionsanzeige ([sys-ticon](https://github.com/masagrator/sys-ticon)) +- **Drei Varianten** – Light (minimal), Standard (voll) und OC (Alles aus Light/Standard + Extra Overclocking Tools) +- **Vollständiges CFW-Setup** – Sofort einsatzbereit mit Atmosphere, Hekate und wichtigen Tools +- **Ultrahand** – Overlay-Menü und Package-System (OmniNX Downloader, Alchemist, RAM Patcher und weitere...) +- **Vorinstallierte Payloads** – u. a. APL (Recovery), Lockpick RCM- & Pro, TegraExplorer, **[modchip_toolbox](https://github.com/DefenderOfHyrule/modchip-toolbox)**, OmniNX Installer +- **Sicherheit und Patches** – sys-patch, DNS-MitM +- **Modulare Struktur** – Build-Skripte für einfaches Erstellen der Packs +- **sys-ticon (Standard, damit auch OC)** – Home-Menü: eigene Icons, Titel, Herausgeber und Versionsanzeige ([sys-ticon](https://github.com/masagrator/sys-ticon)) ## Varianten +**Light** ist die Basis, **Standard** baut auf Light auf, **OC** baut auf Standard auf – jede Variante enthält alles von der vorherigen plus die zusätzlichen Einträge. + | Variante | Beschreibung | -|----------|---------------| -| **Light** | Minimales Pack: nur Kern-Apps und Overlays (Daybreak, DBI, JKSV, Sphaira, Ultrahand, etc.) | -| **Standard** | Volles Pack: alle Homebrew-Apps, Overlays, Themes und Packages | -| **OC** | Volles Pack plus Overclocking: [Horizon OC](https://github.com/Horizon-OC/Horizon-OC), SaltySD-Integration | +| -------- | ------------ | +| **Light** | Minimal: Kern-Apps, Overlays und Packages für den Alltag. | +| **Standard** | Wie Light, plus weitere Homebrew-Apps, Themes, Mod-Tools und Cheat-Overlay. | +| **OC** | Wie Standard, plus Overclocking: [Horizon OC](https://github.com/Horizon-OC/Horizon-OC), SaltyNX/SaltySD, FPSLocker. | + +Schritt-für-Schritt-Anleitungen: **[NiklasCFW Docs – OmniNX Setup](https://docs.niklascfw.de/switch/omninx/einfuehrung/)** ## Inhalt von OmniNX -### **1. Kern-CFW-Komponenten** -1. **[Atmosphere](https://github.com/Atmosphere-NX/Atmosphere)** – Custom Firmware für Nintendo Switch -2. **[Hekate](https://github.com/CTCaer/hekate)** – Bootloader mit grafischer Oberfläche (Nyx) -3. **[sys-patch](https://github.com/borntohonk/sys-patch)** – System-Patches für unsigned Software -4. **[Ultrahand](https://github.com/ppkantorski/Ultrahand-Overlay)** – Overlay-Menü und Package-System +**Legende:** ✓ = enthalten · — = nicht enthalten · *(offload)* = in `.offload/`, per **Package Manager** aktivierbar -### **2. Payloads** -* **[AllgemeinerProblemLoeser (APL)](https://git.niklascfw.de/OmniNX/AllgemeinerProblemLoeser)** – Recovery & Problembehebung ohne PC *(Fork von Common Problem Resolver; u. a. Sysmodule/Themes, Archiv-Bit, Mac-Ordner, Mariko-Warmboot/Sleep)* -* **[Lockpick RCM](https://gbatemp.net/download/lockpick_rcm-zoria-decscot.39752/)** – Konsolen-Key-Extraktion -* **[Lockpick RCM Pro](https://github.com/sthetix/Lockpick_RCM_Pro)** – Konsolen-Key-Extraktion *(u. a. PRODINFO-Backup)* -* **[TegraExplorer](https://github.com/suchmememanyskill/TegraExplorer)** – Low-Level-Dateimanager -* **[modchip_toolbox](https://github.com/DefenderOfHyrule/modchip-toolbox)** – Modchip-Toolbox *(All-in-one für HWFLY & PicoFly)* -* **[OmniNX Installer](https://github.com/OmniNX/OmniNX-Installer-Payload)** – Pack-Installer-Payload (Staging / Updates) +### Was ist in welcher Variante? -### **3. Homebrew-Apps** +Orientierung an den [NiklasCFW Docs](https://docs.niklascfw.de/switch/omninx/einfuehrung/). -> **Hinweis:** **Light** enthält nur eine **Teilmenge**; Einträge mit **(Standard)** liegen erst ab der **Standard**-Variante im Pack. Übersichtstabelle: **[NiklasCFW Docs](https://docs.niklascfw.de/switch/omninx/einfuehrung/)** +#### Homebrew-Apps -* **[Sphaira](https://github.com/ITotalJustice/sphaira)** – Modernes Homebrew-Menü (Standard-Launcher) -* **[DBI](https://github.com/rashevskyv/DBI)** – Dateimanager, Save-Manager, Installer -* **[Daybreak](https://github.com/Atmosphere-NX/Atmosphere)** – HOS-Update-Tool -* **[JKSV](https://github.com/J-D-K/JKSV)** – Save-Manager -* **[Linkalho](https://github.com/impeeza/linkalho)** – Account-Verknüpfung -* **[SimpleModDownloader](https://github.com/PoloNX/SimpleModDownloader)** – Mod-Downloader (Standard) -* **[SimpleModAlchemist](https://github.com/ppkantorski/Alchemist)** – Mod-Manager (Standard) -* **[NXThemesInstaller](https://github.com/exelix11/SwitchThemeInjector)** – Theme-Installer (Standard) -* **[ThemezerNX](https://github.com/suchmememanyskill/themezer-nx)** – Themezer-Client (Standard) -* **[NXGallery](https://github.com/iUltimateLP/NXGallery)** – Medien-Galerie (Standard) -* **[Breeze](https://github.com/tomvita/Breeze-Beta)** – Cheat-Manager (Standard) -* **[DNS_mitm Tester](https://github.com/meganukebmp/Switch_90DNS_tester)** – DNS-Test-Tool -* **[CyberFoil](https://github.com/luketanti/CyberFoil)** – Installer für NSP, NSZ, XCI, XCZ (Standard) -* **[cheats-updater](https://github.com/HamletDuFromage/switch-cheats-updater)** – Cheat-Pakete aktualisieren (Standard) +| App | Light | Standard | OC | +| --- | ----- | -------- | -- | +| Sphaira (HB-Menü) | ✓ | ✓ | ✓ | +| DBI | ✓ | ✓ | ✓ | +| Daybreak | ✓ | ✓ | ✓ | +| JKSV | ✓ | ✓ | ✓ | +| Linkalho | ✓ | ✓ | ✓ | +| DNS_mitm Tester | ✓ | ✓ | ✓ | +| Ultrahand Reload | ✓ | ✓ | ✓ | +| NXGallery | — | ✓ | ✓ | +| Switch Theme Installer | — | ✓ | ✓ | +| ThemezerNX | — | ✓ | ✓ | +| SimpleModDownloader | — | ✓ | ✓ | +| SimpleModAlchemist | — | ✓ | ✓ | +| Breeze (Cheat-Manager) | — | ✓ | ✓ | +| CyberFoil | — | ✓ | ✓ | +| Cheats-Updater | — | ✓ | ✓ | +| Furmark-NX | — | — | ✓ | +| swr-ini-tool | — | — | ✓ | -### **4. Overlays und Packages** -* **nx-ovlloader** – Overlay-Loader für Tesla-artiges Menü -* **Ultrahand Reload** – Overlay-System und Packages: - - **[Status Monitor (HOC)](https://github.com/Horizon-OC/Horizon-OC)** – Echtzeit-Systemüberwachung - - **sys-patch Overlay** – Patch-Verwaltung - - **EdiZon Overlay** – Cheats - - **sysmodules** – Modul-Verwaltung - - **DNS-MitM Manager** – DNS-Konfiguration - - **QuickNTP** – Zeitsynchronisation -* **RAM Patcher** – Speicher-Konfiguration (Default, RAM Patch, RAM Patch Kip, 4GB Kip) -* **Memory Kit / Memory Config** – Mesosphere- und Speicher-Optionen -* **Alchemist** – pchtxt- und Contents-Verwaltung -* **OmniNX Downloader** – Apps, Overlays, Sysmodules, OS, Updater -* **[MasterVolume](https://github.com/averne/MasterVolume)** – Tesla-Overlay zur Regelung der Master-Lautstärke (gilt für alle Audio-Ausgänge); benötigt den mitgelieferten Patch `atmosphere/exefs_patches/audio_mastervolume` -* **[sys-ticon](https://github.com/masagrator/sys-ticon)** (Standard; OC-Pack enthält Standard-Inhalt) – Sysmodule für qlaunch: Icons, Titel, Publisher und `display_version` pro Titel-ID (`atmosphere/contents//`, `config.ini`, optional `icon.jpg` / `icon174.jpg`) +#### Ultrahand-Packages -### **5. OC: SaltyNX, SaltySD und OmniNX-Tools** +| Package | Light | Standard | OC | +| ------- | ----- | -------- | -- | +| OmniNX Downloader | ✓ | ✓ | ✓ | +| RebootNX | ✓ | ✓ | ✓ | +| Alchemist | ✓ | ✓ | ✓ | +| Cool Curves | ✓ | ✓ | ✓ | +| Package Manager | ✓ | ✓ | ✓ | +| RAM Patcher *(offload)* | ✓ | ✓ | ✓ | +| Memory Kit / Memory Config *(offload)* | ✓ | ✓ | ✓ | +| Installer Configurator *(offload)* | ✓ | ✓ | ✓ | -Zusätzlich zum **Standard**-Inhalt liefert die **OC**-Variante u. a.: +#### Overlays -* **[Horizon OC](https://github.com/Horizon-OC/Horizon-OC)** – Open-Source-Overclocking für Atmosphere (KIP, Overlay, Konfiguration) -* **[FPSLocker](https://github.com/masagrator/FPSLocker)** (Overlay) – FPS-Ziele und Spiel-Patches (mit SaltyNX / NX-FPS) -* **[ReverseNX-RT](https://github.com/masagrator/ReverseNX-RT)** (Overlay) – Docked-/Handheld-Verhalten steuern -* **[SaltyNX](https://github.com/masagrator/SaltyNX)** – Sysmodule für Plugins und Laufzeit-Anpassungen (Grundlage u. a. für FPSLocker) -* **SaltySD** – SD-Pfad für Patches und Plug-ins (z. B. FPSLocker; im Pack u. a. `SaltySD/exceptions.txt`) -* **[PatchExtractor](https://git.niklascfw.de/OmniNX/PatchExtractor)** – entpackt `sd:/SaltySD/plugins/FPSLocker/patches.zip` (Hilfs-Homebrew, siehe Projekt-README) -* **[swr-ini-tool](https://git.niklascfw.de/OmniNX/swr-ini-tool)** – INI-/Konfig-Werkzeug aus dem OmniNX-Projekt -* **[sys-clk](https://github.com/retronx-team/sys-clk)** – **Sys-Clk Manager** (`.nro` im OC-Pack) zur Profil-Verwaltung; unabhängig von den **[Horizon-OC](https://github.com/Horizon-OC/Horizon-OC)**-Tweaks +| Overlay | Light | Standard | OC | +| ------- | ----- | -------- | -- | +| HOC Monitor | ✓ | ✓ | ✓ | +| QuickNTP | ✓ | ✓ | ✓ | +| Sysmodules (ovlSysmodules) | ✓ | ✓ | ✓ | +| Ultrahand-Menü (ovlmenu) | ✓ | ✓ | ✓ | +| sys-patch Overlay *(offload)* | ✓ | ✓ | ✓ | +| DNS-MitM Manager *(offload)* | ✓ | ✓ | ✓ | +| MasterVolume *(offload)* | ✓ | ✓ | ✓ | +| EdiZon (Cheats) | — | ✓ | ✓ | +| sys-ticon | — | ✓ | ✓ | +| Horizon OC Overlay | — | — | ✓ | +| FPSLocker | — | — | ✓ | +| ReverseNX-RT | — | — | ✓ | -### **6. Konfiguration und Themes** -* **OmniNX-Theme** – Sphaira-Theme (`/config/sphaira/themes/omninx.ini`) in allen Varianten -* **Boot-Logos** – Einheitliches CFW-Boot-Logo (`bootlogo_cfw.bmp`) -* **HorizonOS-Boot-Logo** – IPS-Patch für das Nintendo-Startlogo (`variants/light/atmosphere/exefs_patches/logo` → auf der SD `atmosphere/exefs_patches/logo`); Erstellung eigener Logos: **[switch-logo-patcher](https://github.com/friedkeenan/switch-logo-patcher)** -* **Audio-Master-Volume** – IPS-Patches für **[MasterVolume](https://github.com/averne/MasterVolume)** (`atmosphere/exefs_patches/audio_mastervolume`) -* **Hekate** – Vorkonfigurierte Boot-Einträge (CFW-EmuMMC, OFW, Payloads) -* **Nyx** – Theming und UI (z. B. `themecolor=197`) +#### OC / System (nur OC-Variante) -### **7. Sicherheit und System** -* **DNS-MitM** – DNS-Weiterleitung und Blocking -* **sys-patch** – Automatische System-Patches -* **USB 3.0 Force** – USB-3.0-Superspeed für Homebrew (u. a. `exosphere.ini`, Hekate, `system_settings.ini`) -* **exosphere.ini** – Optionale Exosphere-Konfiguration pro Variante +| Komponente | Light | Standard | OC | +| -------- | ----- | -------- | -- | +| [Horizon OC](https://github.com/Horizon-OC/Horizon-OC) (KIP, hoc-clk) | — | — | ✓ | +| SaltyNX | — | — | ✓ | +| SaltySD | — | — | ✓ | +| Gepatchtes `exosphere.bin` | — | — | ✓ | +| FPSLocker-Patch-Entpackung (`boot_package.ini`) | — | — | ✓ | + +### Basis in allen Varianten (nicht in der Docs-Tabelle) + +* **[Atmosphere](https://github.com/Atmosphere-NX/Atmosphere)**, **[Hekate](https://github.com/CTCaer/hekate)** / Nyx, **[sys-patch](https://github.com/borntohonk/sys-patch)**, **[Ultrahand](https://github.com/ppkantorski/Ultrahand-Overlay)** +* Payloads: **[APL](https://git.niklascfw.de/OmniNX/AllgemeinerProblemLoeser)**, Lockpick RCM, **[Lockpick RCM Pro](https://github.com/sthetix/Lockpick_RCM_Pro)**, TegraExplorer, **[modchip_toolbox](https://github.com/DefenderOfHyrule/modchip-toolbox)**, **[OmniNX Installer](https://git.niklascfw.de/OmniNX/OmniNX-Installer-Payload)** +* DNS-MitM (Hosts), USB 3.0 Force, OmniNX Sphaira-Theme, Boot-Logos, HorizonOS-Logo-Patch, **[MasterVolume](https://github.com/averne/MasterVolume)**-IPS-Patch, `exosphere.ini` (optional) + +> **sys-clk** / Sys-Clk Manager: nicht fest im Pack; optional über **OmniNX Downloader** (in den Docs teils noch als OC-Eintrag geführt). ## Repository-Struktur @@ -162,20 +166,23 @@ Die Version wird aus der Datei `VERSION` gelesen und in `manifest.ini` sowie die ## Verwendung ### Hekate: Boot-Einträge und Payloads + - **CFW-EmuMMC** – Custom Firmware mit EmuMMC - **OFW** – Original-Firmware - **OmniNX Installer** – Pack-Installation / Staging (siehe Installation) - **TegraExplorer** – Dateisystem-Explorer (RCM-Payload) - **Lockpick RCM** / **Lockpick RCM Pro** – Key-Extraktion (Pro: u. a. PRODINFO) - **AllgemeinerProblemLoeser (APL)** – Recovery ohne PC -- **modchip_toolbox** – HWFLY & PicoFly (siehe Abschnitt 2) +- **modchip_toolbox** – HWFLY & PicoFly (siehe **Basis in allen Varianten**) -Vollständige Payload-Liste: Abschnitt **„2. Payloads“** oben. +Vollständige Payload-Liste: Abschnitt **„Basis in allen Varianten“** oben. ### Packages und Overlays + - **L + R + PLUS** – Ultrahand-Overlay öffnen ### Homebrew-Menü + - **Album** – Sphaira starten (OmniNX-Theme) ## Lizenz @@ -183,28 +190,28 @@ Vollständige Payload-Liste: Abschnitt **„2. Payloads“** oben. Die verwendeten Projekte unterliegen ihren jeweiligen Lizenzen; maßgeblich sind die Lizenzdateien der jeweiligen Upstream-Repositories. Das OmniNX-Pack selbst steht unter der MIT-Lizenz. **[GPL 2.0](https://github.com/Atmosphere-NX/Atmosphere/blob/master/LICENSE):** -* [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere) + +- [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere) ## Credits -* **Atmosphere Team** – Custom Firmware -* **CTCaer** – Hekate Bootloader -* **ppkantorski** – Ultrahand Overlay -* **ITotalJustice** – Sphaira, DNS_mitm Tester und mehr -* **DefenderOfHyrule** – [modchip_toolbox](https://github.com/DefenderOfHyrule/modchip-toolbox) -* **WerWolv** – Tesla-Menü & EdiZon -* **Sthetix** – Lockpick RCM Pro -* **MasaGratoR (masagrator)** – [sys-ticon](https://github.com/masagrator/sys-ticon), [SaltyNX](https://github.com/masagrator/SaltyNX), [FPSLocker](https://github.com/masagrator/FPSLocker), [Status Monitor](https://github.com/masagrator/Status-Monitor-Overlay), [ReverseNX-RT](https://github.com/masagrator/ReverseNX-RT) -* **Horizon-OC** – [Horizon OC](https://github.com/Horizon-OC/Horizon-OC) (Overclocking, KIP, OC-Overlay) -* **luketanti** – [CyberFoil](https://github.com/luketanti/CyberFoil) -* **averne** – [MasterVolume](https://github.com/averne/MasterVolume) -* **NiklasCFW** & **Woody-NX** – OmniNX-Pack; [PatchExtractor](https://git.niklascfw.de/OmniNX/PatchExtractor), [swr-ini-tool](https://git.niklascfw.de/OmniNX/swr-ini-tool); Vorgänger NiklasCFW Pack +- **Atmosphere Team** – Custom Firmware +- **CTCaer** – Hekate Bootloader +- **ppkantorski** – Ultrahand Overlay +- **ITotalJustice** – Sphaira, DNS_mitm Tester und mehr +- **DefenderOfHyrule** – [modchip_toolbox](https://github.com/DefenderOfHyrule/modchip-toolbox) +- **WerWolv** – Tesla-Menü & EdiZon +- **Sthetix** – Lockpick RCM Pro +- **MasaGratoR (masagrator)** – [sys-ticon](https://github.com/masagrator/sys-ticon), [SaltyNX](https://github.com/masagrator/SaltyNX), [FPSLocker](https://github.com/masagrator/FPSLocker), [Status Monitor](https://github.com/masagrator/Status-Monitor-Overlay), [ReverseNX-RT](https://github.com/masagrator/ReverseNX-RT) +- **Horizon-OC** – [Horizon OC](https://github.com/Horizon-OC/Horizon-OC) (Overclocking, KIP, OC-Overlay) +- **luketanti** – [CyberFoil](https://github.com/luketanti/CyberFoil) +- **averne** – [MasterVolume](https://github.com/averne/MasterVolume) +- **NiklasCFW** & **Woody-NX** – OmniNX-Pack; [PatchExtractor](https://git.niklascfw.de/OmniNX/PatchExtractor), [swr-ini-tool](https://git.niklascfw.de/OmniNX/swr-ini-tool); Vorgänger NiklasCFW Pack + -
### Socials/Support -[![Discord](https://img.shields.io/discord/733728731432091648?logo=discord&logoColor=white&label=NiklasCFW%20Modding%20Community&color=5865F2)](https://discord.gg/5rMJ4fWQT3) -[![YouTube Channel](https://img.shields.io/youtube/channel/subscribers/UCdEkFmAShnlE15CCimAwnYg?logo=youtube&label=NiklasCFW&color=ff0000)](https://www.youtube.com/@NiklasCFW) +[Discord](https://discord.gg/5rMJ4fWQT3) +[YouTube Channel](https://www.youtube.com/@NiklasCFW) -