mirror of
https://github.com/CTCaer/hekate.git
synced 2024-11-05 11:27:09 +00:00
Update Readme
This commit is contained in:
parent
a0c3323b7c
commit
4d1b59c05b
31
README.md
31
README.md
@ -53,14 +53,23 @@ You can find a template [Here](./res/hekate_ipl_template.ini)
|
|||||||
| autoboot=0 | 0: Disable, #: Boot entry number to auto boot. |
|
| autoboot=0 | 0: Disable, #: Boot entry number to auto boot. |
|
||||||
| autoboot_list=0 | 0: Read `autoboot` boot entry from hekate_ipl.ini, 1: Read from ini folder (ini files are ASCII ordered). |
|
| autoboot_list=0 | 0: Read `autoboot` boot entry from hekate_ipl.ini, 1: Read from ini folder (ini files are ASCII ordered). |
|
||||||
| bootwait=3 | 0: Disable (It also disables bootlogo. Having **VOL-** pressed since injection goes to menu.), #: Time to wait for **VOL-** to enter menu. |
|
| bootwait=3 | 0: Disable (It also disables bootlogo. Having **VOL-** pressed since injection goes to menu.), #: Time to wait for **VOL-** to enter menu. |
|
||||||
| verification=2 | 0: Disable Backup/Restore verification, 1: Sparse (block based, fast and not 100% reliable), 2: Full (sha256 based, slow and 100% reliable). |
|
|
||||||
| autohosoff=1 | 0: Disable, 1: If woke up from HOS via an RTC alarm, shows logo, then powers off completely, 2: No logo, immediately powers off.|
|
| autohosoff=1 | 0: Disable, 1: If woke up from HOS via an RTC alarm, shows logo, then powers off completely, 2: No logo, immediately powers off.|
|
||||||
| autonogc=1 | 0: Disable, 1: Automatically applies nogc patch if unburnt fuses found and a >= 4.0.0 HOS is booted. |
|
| autonogc=1 | 0: Disable, 1: Automatically applies nogc patch if unburnt fuses found and a >= 4.0.0 HOS is booted. |
|
||||||
| updater2p=0 | 0: Disable, 1: Force updates (if needed) the reboot2payload binary to be hekate. |
|
| updater2p=0 | 0: Disable, 1: Force updates (if needed) the reboot2payload binary to be hekate. |
|
||||||
| backlight=100 | Screen backlight level. 0-255. |
|
| backlight=100 | Screen backlight level. 0-255. |
|
||||||
|
|
||||||
|
|
||||||
### Possible boot entry key/value combinations:
|
### Nyx Global Configuration keys/values for (nyx.ini):
|
||||||
|
|
||||||
|
| Config option | Description |
|
||||||
|
| ------------------ | ---------------------------------------------------------- |
|
||||||
|
| themecolor=167 | Sets Nyx color of text highlights. |
|
||||||
|
| timeoff=100 | Sets time offset in HEX. Must be in HOS epoch format |
|
||||||
|
| homescreen=0 | Sets home screen. 0: Home menu, 1: All configs (merges Launch and More configs), 2: Launch, 3: More Configs. |
|
||||||
|
| verification=1 | 0: Disable Backup/Restore verification, 1: Sparse (block based, fast and mostly reliable), 2: Full (sha256 based, slow and 100% reliable). |
|
||||||
|
|
||||||
|
|
||||||
|
### Boot entry key/value combinations:
|
||||||
|
|
||||||
| Config option | Description |
|
| Config option | Description |
|
||||||
| ---------------------- | ---------------------------------------------------------- |
|
| ---------------------- | ---------------------------------------------------------- |
|
||||||
@ -76,15 +85,25 @@ You can find a template [Here](./res/hekate_ipl_template.ini)
|
|||||||
| debugmode=1 | Enables Debug mode. Obsolete when used with exosphere as secmon. |
|
| debugmode=1 | Enables Debug mode. Obsolete when used with exosphere as secmon. |
|
||||||
| atmosphere=1 | Enables Atmosphère patching. |
|
| atmosphere=1 | Enables Atmosphère patching. |
|
||||||
| emupath={SD folder} | Forces emuMMC to use the selected one. (=emuMMC/RAW1, =emuMMC/SD00, etc). emuMMC must be created by hekate because it uses the raw_based/file_based files. |
|
| emupath={SD folder} | Forces emuMMC to use the selected one. (=emuMMC/RAW1, =emuMMC/SD00, etc). emuMMC must be created by hekate because it uses the raw_based/file_based files. |
|
||||||
| nouserexceptions=1 | Disables usermode exception handlers when paired with Exosphère. |
|
| emummcforce=1 | Forces the use of emuMMC. If emummc.ini is disabled or not found, then it causes an error. |
|
||||||
| userpmu=1 | Allows user access to PMU when paired with Exosphère. |
|
| emummc_force_disable=1 | Disables emuMMC if it's enabled. |
|
||||||
| emummc_force_disable=1 | Disabled emuMMC if it's enabled. |
|
| stock=1 | Disables unneeded kernel patching when running stock or semi-stock. `If emuMMC is enabled, emummc_force_disabled=1` is required. emuMMC is not supported on stock. If additional KIPs are needed other than OFW's, you can define them with `kip1` key. No kip should be used that relies on Atmosphère patching, because it will hang. If `NOGC` is needed, use `kip1patch=nogc`. |
|
||||||
| stock=1 | Disables unneeded kernel patching when running stock or semi-stock. `If emuMMC is enabled, emummc_force_disabled=1` is required to run completely stock. |
|
|
||||||
| id=idname | Identifies boot entry for forced boot via id. Max 7 chars. |
|
| id=idname | Identifies boot entry for forced boot via id. Max 7 chars. |
|
||||||
| payload={SD path} | Payload launching. Tools, Linux, CFW bootloaders, etc. |
|
| payload={SD path} | Payload launching. Tools, Linux, CFW bootloaders, etc. |
|
||||||
| logopath={SD path} | If no logopath, `bootloader/bootlogo.bmp` will be used if exists. If logopath exists, it will load the specified bitmap. |
|
| logopath={SD path} | If no logopath, `bootloader/bootlogo.bmp` will be used if exists. If logopath exists, it will load the specified bitmap. |
|
||||||
| icon={SD path} | Force Nyx to use the icon defined here. If this is not found, it will check for a bmp named as the boot entry ([Test 2] -> `bootloader/res/Test 2.bmp`). Otherwise default will be used. |
|
| icon={SD path} | Force Nyx to use the icon defined here. If this is not found, it will check for a bmp named as the boot entry ([Test 2] -> `bootloader/res/Test 2.bmp`). Otherwise default will be used. |
|
||||||
|
|
||||||
|
|
||||||
|
### Boot entry key/value Exosphère combinations:
|
||||||
|
|
||||||
|
| Config option | Description |
|
||||||
|
| ---------------------- | ---------------------------------------------------------- |
|
||||||
|
| nouserexceptions=1 | Disables usermode exception handlers when paired with Exosphère. |
|
||||||
|
| userpmu=1 | Enables user access to PMU when paired with Exosphère. |
|
||||||
|
| cal0blank=1 | Overrides Exosphère config `blank_prodinfo_{sys/emu}mmc`. If that key doesn't exist, `exosphere.ini` will be used. |
|
||||||
|
| cal0writesys=1 | Overrides Exosphère config `allow_writing_to_cal_sysmmc`. If that key doesn't exist, `exosphere.ini` will be used. |
|
||||||
|
|
||||||
|
|
||||||
**Note1**: When using the wildcard (`/*`) with `kip1` you can still use the normal `kip1` after that to load extra single kips.
|
**Note1**: When using the wildcard (`/*`) with `kip1` you can still use the normal `kip1` after that to load extra single kips.
|
||||||
|
|
||||||
**Note2**: When using FSS0 it parses exosphere, warmboot and all core kips. You can override the first 2 by using `secmon`/`warmboot` after defining `fss0`.
|
**Note2**: When using FSS0 it parses exosphere, warmboot and all core kips. You can override the first 2 by using `secmon`/`warmboot` after defining `fss0`.
|
||||||
|
@ -383,7 +383,6 @@ void ipl_main()
|
|||||||
heap_init(IPL_HEAP_START);
|
heap_init(IPL_HEAP_START);
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
b_cfg = (boot_cfg_t *)(nyx_str->hekate + 0x94);
|
b_cfg = (boot_cfg_t *)(nyx_str->hekate + 0x94);
|
||||||
|
|
||||||
// Important: Preserve version header!
|
// Important: Preserve version header!
|
||||||
|
Loading…
Reference in New Issue
Block a user