docs: README and install process for debug.ini and backup
All checks were successful
Build / Build (push) Successful in 17s
All checks were successful
Build / Build (push) Successful in 17s
- Link DEBUG_INI.md; describe clean install backup (dbi.config, prod.keys) - Update INSTALLATION_PROCESS backup/restore steps Made-with: Cursor
This commit is contained in:
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
This document provides a detailed, step-by-step breakdown of everything that is checked and done during the OmniNX installation/update process.
|
This document provides a detailed, step-by-step breakdown of everything that is checked and done during the OmniNX installation/update process.
|
||||||
|
|
||||||
|
For **optional debug step skips** (`sd:/config/omninx/debug.ini`), see **[DEBUG_INI.md](DEBUG_INI.md)**.
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The OmniNX Installer Payload operates in two modes:
|
The OmniNX Installer Payload operates in two modes:
|
||||||
@@ -305,17 +307,12 @@ channel_pack={variant} # Same as current_pack
|
|||||||
#### 32. Create Backup Directory
|
#### 32. Create Backup Directory
|
||||||
- Creates `sd:/temp_backup/` directory
|
- Creates `sd:/temp_backup/` directory
|
||||||
|
|
||||||
#### 33. Backup DBI
|
#### 33. Backup DBI settings
|
||||||
- **Source**: `sd:/switch/DBI/`
|
- **Source**: `sd:/switch/DBI/dbi.config` (file only, not the whole `DBI` tree)
|
||||||
- **Destination**: `sd:/temp_backup/DBI/`
|
- **Destination**: `sd:/temp_backup/dbi.config`
|
||||||
- Only if source exists
|
- Only if the source file exists
|
||||||
|
|
||||||
#### 34. Backup Tinfoil
|
#### 34. Backup prod.keys
|
||||||
- **Source**: `sd:/switch/tinfoil/`
|
|
||||||
- **Destination**: `sd:/temp_backup/tinfoil/`
|
|
||||||
- Only if source exists
|
|
||||||
|
|
||||||
#### 35. Backup prod.keys
|
|
||||||
- **Source**: `sd:/switch/prod.keys`
|
- **Source**: `sd:/switch/prod.keys`
|
||||||
- **Destination**: `sd:/temp_backup/prod.keys`
|
- **Destination**: `sd:/temp_backup/prod.keys`
|
||||||
- Only if source exists
|
- Only if source exists
|
||||||
@@ -325,22 +322,22 @@ channel_pack={variant} # Same as current_pack
|
|||||||
### Step 2: Wipe Directories
|
### Step 2: Wipe Directories
|
||||||
**Location**: `install.c:543-602`
|
**Location**: `install.c:543-602`
|
||||||
|
|
||||||
#### 36. Delete Entire Directories
|
#### 35. Delete Entire Directories
|
||||||
Recursively deletes (if they exist):
|
Recursively deletes (if they exist):
|
||||||
- `sd:/atmosphere/` (entire directory tree)
|
- `sd:/atmosphere/` (entire directory tree)
|
||||||
- `sd:/bootloader/` (entire directory tree)
|
- `sd:/bootloader/` (entire directory tree)
|
||||||
- `sd:/config/` (entire directory tree)
|
- `sd:/config/` (entire directory tree)
|
||||||
- `sd:/switch/` (entire directory tree)
|
- `sd:/switch/` (entire directory tree)
|
||||||
|
|
||||||
#### 37. Delete Root Files
|
#### 36. Delete Root Files
|
||||||
- Uses same deletion list as update mode (Step 19)
|
- Uses same deletion list as update mode (Step 19)
|
||||||
- Deletes `boot.dat`, `boot.ini`, `exosphere.ini`, etc.
|
- Deletes `boot.dat`, `boot.ini`, `exosphere.ini`, etc.
|
||||||
|
|
||||||
#### 38. Delete Miscellaneous Items
|
#### 37. Delete Miscellaneous Items
|
||||||
- Uses same deletion lists as update mode (Steps 20-21)
|
- Uses same deletion lists as update mode (Steps 20-21)
|
||||||
- Deletes `argon/`, `games/`, `SaltySD/`, etc.
|
- Deletes `argon/`, `games/`, `SaltySD/`, etc.
|
||||||
|
|
||||||
#### 39. Recreate Switch Directory
|
#### 38. Recreate Switch Directory
|
||||||
- Creates empty `sd:/switch/` directory for restoration
|
- Creates empty `sd:/switch/` directory for restoration
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -348,27 +345,17 @@ Recursively deletes (if they exist):
|
|||||||
### Step 3: Restore User Data
|
### Step 3: Restore User Data
|
||||||
**Location**: `backup.c:55-95`
|
**Location**: `backup.c:55-95`
|
||||||
|
|
||||||
#### 40. Restore DBI
|
#### 39. Restore DBI settings
|
||||||
- **Source**: `sd:/temp_backup/DBI/`
|
- **Source**: `sd:/temp_backup/dbi.config`
|
||||||
- **Destination**: `sd:/switch/DBI/`
|
- **Destination**: `sd:/switch/DBI/dbi.config` (creates `sd:/switch/DBI/` if needed)
|
||||||
- **Cleanup**: After restoration, deletes old DBI NRO files:
|
- No longer copies the full `DBI` folder; old `.nro` cleanup is unnecessary
|
||||||
- `sd:/switch/DBI/DBI_810_EN.nro`
|
|
||||||
- `sd:/switch/DBI/DBI_810_DE.nro`
|
|
||||||
- `sd:/switch/DBI/DBI_845_EN.nro`
|
|
||||||
- `sd:/switch/DBI/DBI_845_DE.nro`
|
|
||||||
- `sd:/switch/DBI/DBI.nro`
|
|
||||||
|
|
||||||
#### 41. Restore Tinfoil
|
#### 40. Restore prod.keys
|
||||||
- **Source**: `sd:/temp_backup/tinfoil/`
|
|
||||||
- **Destination**: `sd:/switch/tinfoil/`
|
|
||||||
- **Cleanup**: After restoration, deletes `sd:/switch/tinfoil/tinfoil.nro`
|
|
||||||
|
|
||||||
#### 42. Restore prod.keys
|
|
||||||
- **Source**: `sd:/temp_backup/prod.keys`
|
- **Source**: `sd:/temp_backup/prod.keys`
|
||||||
- **Destination**: `sd:/switch/prod.keys`
|
- **Destination**: `sd:/switch/prod.keys`
|
||||||
|
|
||||||
#### 43. Cleanup Backup Directory
|
#### 41. Cleanup Backup Directory
|
||||||
**Location**: `backup.c:98-103`
|
**Location**: `backup.c` (`cleanup_backup`)
|
||||||
- Deletes `sd:/temp_backup/` directory after restoration
|
- Deletes `sd:/temp_backup/` directory after restoration
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ Based on [HATS-Installer-Payload](https://github.com/sthetix/HATS-Installer-Payl
|
|||||||
- **Automatic Variant Detection**: Detects which OmniNX pack variant is present (Standard/Light/OC)
|
- **Automatic Variant Detection**: Detects which OmniNX pack variant is present (Standard/Light/OC)
|
||||||
- **Smart Installation Modes**:
|
- **Smart Installation Modes**:
|
||||||
- **Update Mode**: Selective deletion when OmniNX is already installed
|
- **Update Mode**: Selective deletion when OmniNX is already installed
|
||||||
- **Clean Install**: Full wipe with backup/restore of user data (DBI, Tinfoil, prod.keys)
|
- **Clean Install**: Full wipe with backup/restore of user data (DBI `dbi.config`, prod.keys)
|
||||||
- **Version Detection**: Detects installed OmniNX version via marker files (`1.0.0s`, `1.0.0l`, `1.0.0oc`)
|
- **Version Detection**: Detects installed OmniNX version via marker files (`1.0.0s`, `1.0.0l`, `1.0.0oc`)
|
||||||
- **Progress Display**: Visual status messages during installation
|
- **Progress Display**: Visual status messages during installation
|
||||||
- **Error Handling**: Detailed error reporting on screen
|
- **Error Handling**: Detailed error reporting on screen
|
||||||
@@ -22,6 +22,7 @@ Based on [HATS-Installer-Payload](https://github.com/sthetix/HATS-Installer-Payl
|
|||||||
|
|
||||||
For detailed information about the installation process, see:
|
For detailed information about the installation process, see:
|
||||||
- **[INSTALLATION_PROCESS.md](INSTALLATION_PROCESS.md)** - Complete step-by-step breakdown of everything checked and done during installation/update
|
- **[INSTALLATION_PROCESS.md](INSTALLATION_PROCESS.md)** - Complete step-by-step breakdown of everything checked and done during installation/update
|
||||||
|
- **[DEBUG_INI.md](DEBUG_INI.md)** - Optional `sd:/config/omninx/debug.ini` parameters to skip install steps (for testing)
|
||||||
|
|
||||||
## Installation Modes
|
## Installation Modes
|
||||||
|
|
||||||
@@ -35,8 +36,7 @@ For detailed information about the installation process, see:
|
|||||||
- Detected when no version marker files are found
|
- Detected when no version marker files are found
|
||||||
- Performs full wipe of `/atmosphere`, `/bootloader`, `/config`, and `/switch`
|
- Performs full wipe of `/atmosphere`, `/bootloader`, `/config`, and `/switch`
|
||||||
- **Backs up and restores**:
|
- **Backs up and restores**:
|
||||||
- `sd:/switch/DBI` → preserved
|
- `sd:/switch/DBI/dbi.config` → preserved (not the whole `DBI` folder)
|
||||||
- `sd:/switch/tinfoil` → preserved
|
|
||||||
- `sd:/switch/prod.keys` → preserved
|
- `sd:/switch/prod.keys` → preserved
|
||||||
- Fresh installation of all CFW components
|
- Fresh installation of all CFW components
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user