forked from Mirrors/OmniNX
updated readme
This commit is contained in:
niklascfw
parent
580412fac9
commit
6ffb0a4f92
1 changed files with 18 additions and 58 deletions
76
README.md
76
README.md
|
|
@ -12,7 +12,7 @@ OmniNX ist ein vollständiges Custom-Firmware-Setup für die Nintendo Switch, ve
|
|||
* **Ultrahand Reload** – Overlay-Menü und Package-System (Alchemist, RAM Patcher, OmniNX Downloader)
|
||||
* **Vorkonfigurierte Payloads** – Lockpick RCM (Pro), TegraExplorer, Modchip-Toolboxen
|
||||
* **Sicherheit und Patches** – sys-patch, DNS-MitM, USB 3.0 Force
|
||||
* **Modulare Struktur** – Build-Skripte und Git LFS für überschaubare Repo-Größe
|
||||
* **Modulare Struktur** – Build-Skripte für einfaches Erstellen der Packs
|
||||
* **RAM-Patcher-Packages** – Optionale Speicher-Konfigurationen (Default, RAM Patch, 4GB Kip, etc.)
|
||||
|
||||
## Varianten
|
||||
|
|
@ -32,7 +32,7 @@ OmniNX ist ein vollständiges Custom-Firmware-Setup für die Nintendo Switch, ve
|
|||
4. **[Ultrahand Reload](https://github.com/ppkantorski/Ultrahand-Overlay)** – Overlay-Menü und Package-System
|
||||
|
||||
### **2. Payloads**
|
||||
* **[Lockpick RCM](https://github.com/saneki/Lockpick_RCM)** / **Lockpick RCM** – Konsolen-Key-Extraktion
|
||||
* **[Lockpick RCM](https://github.com/saneki/Lockpick_RCM)** – Konsolen-Key-Extraktion
|
||||
* **[TegraExplorer](https://github.com/suchmememanyskill/TegraExplorer)** – Low-Level-Dateimanager
|
||||
* **[hwfly_toolbox](https://github.com/hwfly-nx/hwfly-toolbox)** – hwfly-Modchip-Toolbox
|
||||
* **[Instinct_toolbox](https://github.com/Xnopyt/HWFLY-Instinct)** – Instinct-Modchip-Toolbox
|
||||
|
|
@ -87,81 +87,43 @@ OmniNX ist ein vollständiges Custom-Firmware-Setup für die Nintendo Switch, ve
|
|||
```
|
||||
OmniNX/
|
||||
├── staging/ # Gemeinsame Install-Stage-Dateien (Bootloader, Payloads, Nyx, etc.)
|
||||
├── standard/ # Standard-Variante (voll)
|
||||
├── light/ # Light-Variante (minimal)
|
||||
├── oc/ # OC-Variante (Overclocking + SaltySD)
|
||||
└── scripts/ # Build-Skripte (build-pack.sh, build-all.sh)
|
||||
├── variants/ # Varianten-Inhalt
|
||||
│ ├── light/ # Light-Variante (minimal)
|
||||
│ ├── standard/ # Standard-Variante (voll)
|
||||
│ └── oc/ # OC-Variante (Overclocking + SaltySD)
|
||||
├── scripts/ # Build-Skripte
|
||||
│ └── build-all.sh
|
||||
├── VERSION # Version (wird in die Packs eingetragen)
|
||||
└── output/ # Erstellte ZIP-Archive (wird beim Build erstellt)
|
||||
```
|
||||
|
||||
## Repository-Setup (Git LFS)
|
||||
|
||||
Dieses Repository nutzt **Git LFS** für Binärdateien. Ohne LFS wäre das Repo sehr groß und würde mit jedem Update wachsen.
|
||||
|
||||
### Ersteinrichtung
|
||||
|
||||
```bash
|
||||
# Git LFS installieren (z. B. macOS)
|
||||
brew install git-lfs
|
||||
|
||||
# Im Repo initialisieren
|
||||
git lfs install
|
||||
```
|
||||
|
||||
### Klonen
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd OmniNX
|
||||
```
|
||||
|
||||
Falls das Repo bereits ohne LFS geklont wurde:
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs pull
|
||||
```
|
||||
|
||||
Siehe `.gitattributes` für LFS-Track-Muster. Zu GitHub-Quota und Bandbreiten-Limits siehe Projekt-Docs oder SETUP.md.
|
||||
|
||||
## Packs bauen
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Bash, `zip`, Git LFS
|
||||
|
||||
### Einzelne Variante bauen
|
||||
|
||||
```bash
|
||||
./scripts/build-pack.sh [standard|light|oc] [version]
|
||||
```
|
||||
|
||||
Beispiel: `./scripts/build-pack.sh standard 1.0.0`
|
||||
- Bash, `zip`
|
||||
|
||||
### Alle Varianten bauen
|
||||
|
||||
```bash
|
||||
./scripts/build-all.sh [version]
|
||||
./scripts/build-all.sh
|
||||
```
|
||||
|
||||
Die Skripte kopieren Staging- und Varianten-Inhalt, aktualisieren `manifest.ini` mit der Version und erstellen ZIP-Archive.
|
||||
|
||||
Die Version steht in `{variant}/config/omninx/manifest.ini`.
|
||||
Die Version wird aus der Datei `VERSION` gelesen und in `manifest.ini` sowie die ZIP-Dateinamen übernommen. Die fertigen Packs liegen in `output/`.
|
||||
|
||||
## Installation
|
||||
|
||||
1. **SD-Karte vorbereiten** – Als FAT32 formatieren
|
||||
2. **Dateien kopieren** – Gewünschtes Varianten-ZIP auf die SD-Root entpacken (oder OmniNX Installer nutzen)
|
||||
3. **Booten** – Hekate oder Fusee per RCM laden
|
||||
4. **Optional** – Einstellungen in `config/` anpassen (Sphaira, Ultrahand, etc.)
|
||||
2. **Dateien kopieren** – Gewünschtes Varianten-ZIP auf die SD-Root entpacken
|
||||
3. **Installation** – Beim start vom Hekate OmniNX Installer Payload auswählen und Anweisungen befolgen
|
||||
|
||||
## Verwendung
|
||||
|
||||
### Boot-Optionen (Hekate)
|
||||
### Boot-Optionen (Hekate-Launch)
|
||||
- **CFW-EmuMMC** – Custom Firmware mit EmuMMC
|
||||
- **OFW** – Original-Firmware
|
||||
- **TegraExplorer** – Dateisystem-Explorer
|
||||
- **Lockpick RCM** – Key-Extraktion
|
||||
- **Modchip-Toolboxen** – hwfly, Instinct, PicoFly (variantenabhängig)
|
||||
|
||||
### Overlay-Menü
|
||||
- **L + R + PLUS** – Ultrahand-Reload-Overlay öffnen
|
||||
|
|
@ -189,14 +151,12 @@ Die verwendeten Projekte unterliegen ihren jeweiligen Lizenzen. Das OmniNX-Pack
|
|||
## Support
|
||||
|
||||
* **Discord:** [NiklasCFW Modding Community](https://discord.gg/niklascfw)
|
||||
* **GitHub:** [Woody-NX](https://github.com/Woody-NX) · **[NiklasCFW](https://github.com/Niklas080208)**
|
||||
* **Releases:** [OmniNX](https://github.com/Woody-NX/OmniNX/releases)
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/OmniNX/OmniNX/releases)
|
||||
[](https://github.com/OmniNX/OmniNX)
|
||||
[](https://git.niklascfw.de/OmniNX/OmniNX/releases)
|
||||
[](https://git.niklascfw.de/OmniNX/OmniNX)
|
||||
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in a new issue