nold/hekate
1
0
Fork 0
mirror of https://github.com/CTCaer/hekate synced 2024-11-16 08:59:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README and README_BOOTLOGO

Browse source
This commit is contained in:
Kostas Missos 2018-07-01 20:21:25 +03:00
parent 7b97015df6
commit f22616894c
3 changed files with 30 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -10,10 +10,25 @@ Custom Nintendo Switch bootloader, firmware patcher, and more.
The ipl can be configured via 'hekate_ipl.ini' (if it is present on the SD card). Each ini section represents a boot entry, except for the special section 'config' that controls the global configuration. The ipl can be configured via 'hekate_ipl.ini' (if it is present on the SD card). Each ini section represents a boot entry, except for the special section 'config' that controls the global configuration.
### Possible key/value combinations:
There are four possible type of entries. "**[ ]**": Boot entry, "**{ }**": Caption, "**#**": Comment, "*newline*": .ini cosmetic newline.
### Configuration keys/values when boot entry is **config**:
| Config option | Description | | Config option | Description |
| ------------------ | ---------------------------------------------------------- | | ------------------ | ---------------------------------------------------------- |
| autoboot=0 | 0: Disable, #: Boot entry number to auto boot. |
| bootwait=3 | 0: Disable (Having VOL- pressed since injection goes to menu. It also disables bootlogo.), #: Time to wait for **VOL-** to enter menu. |
| customlogo=0 | 0: Use default hekate bootlogo, 1: Use bootlogo.bmp. |
| verification=2 | 0: Disable Backup/Restore verification, 1: Sparse (block based, fast and not 100% reliable), 2: Full (sha256 based, slow and 100% reliable). |
### Possible boot entry key/value combinations:
| Config option | Description |
| ------------------ | ---------------------------------------------------------- |
| logopath={SD path} | If global customlogo is 1 and logopath empty, bootlogo.bmp will be used. If logopath exists, it will load the specified bitmap. |
| warmboot={SD path} | Replaces the warmboot binary | | warmboot={SD path} | Replaces the warmboot binary |
| secmon={SD path} | Replaces the security monitor binary | | secmon={SD path} | Replaces the security monitor binary |
| kernel={SD path} | Replaces the kernel binary | | kernel={SD path} | Replaces the kernel binary |

14
README_BOOTLOGO.md Normal file
View file

@ -0,0 +1,14 @@
# hekate - Bootlogo
The bootlogo can be any size with a maximum of 720 x 1280. It is automatically centered when it's smaller than 720 x 1280.
When saving a landscape bootlogo, it should be rotated 90o counterclockwise.
Lastly, the supported format is 32-bit BMP. Classic 24-bit BMPs are not supported for performance reasons.
## How to configure
If the custom logo option is enabled, it will try to load /bootlogo.bmp. If this is not found, the default hekate's logo will be used.
If a boot entry specifies a custom logo path, this is one will be loaded. Again if this is not found, bootlogo.bmp will be loaded and if that fails, hekate's built-in will be used.

7
res/bootlogo/README_BOOTLOGO.md
View file

@ -1,7 +0,0 @@
# hekate - Bootlogo
The bootlogo can be any size with a maximum of 720 x 1280. It is automatically centered when it's smaller than 720 x 1280.
When saving a landscape bootlogo, it should be rotated 90o counterclockwise.
Lastly, the supported format is 32-bit BMP. Classic 24-bit BMPs are not supported for performance reasons.