From f22616894cd308967e3f82daaed95bcbfa387a77 Mon Sep 17 00:00:00 2001 From: Kostas Missos Date: Sun, 1 Jul 2018 20:21:25 +0300 Subject: [PATCH] Update README and README_BOOTLOGO --- README.md | 17 ++++++++++++++++- README_BOOTLOGO.md | 14 ++++++++++++++ res/bootlogo/README_BOOTLOGO.md | 7 ------- 3 files changed, 30 insertions(+), 8 deletions(-) create mode 100644 README_BOOTLOGO.md delete mode 100644 res/bootlogo/README_BOOTLOGO.md diff --git a/README.md b/README.md index dcd6f32..6fe32f7 100644 --- a/README.md +++ b/README.md @@ -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. -### 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 | | ------------------ | ---------------------------------------------------------- | +| 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 | | secmon={SD path} | Replaces the security monitor binary | | kernel={SD path} | Replaces the kernel binary | diff --git a/README_BOOTLOGO.md b/README_BOOTLOGO.md new file mode 100644 index 0000000..57636ee --- /dev/null +++ b/README_BOOTLOGO.md @@ -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. \ No newline at end of file diff --git a/res/bootlogo/README_BOOTLOGO.md b/res/bootlogo/README_BOOTLOGO.md deleted file mode 100644 index 355dc47..0000000 --- a/res/bootlogo/README_BOOTLOGO.md +++ /dev/null @@ -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. \ No newline at end of file