From: chaoskagami Date: Fri, 8 Jul 2016 00:19:41 +0000 (-0400) Subject: Update README to more accurately reflect current status X-Git-Tag: v0.2.0~31 X-Git-Url: https://chaos.moe/g/?a=commitdiff_plain;h=ad961f9daaa6cb2f5b630f800ac12311befbb93d;p=corbenik%2Fcorbenik.git Update README to more accurately reflect current status --- diff --git a/README.md b/README.md index 8afbcab..712ab76 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,15 @@ Not every feature has been implemented/tested yet, but at the moment it offers a Corbenik is licensed under the terms of the GPLv3. Please obey it. You should have received a copy either as part of the git repository, or as part of the tarball/zipfile you downloaded. If not, get a copy here: `http://www.gnu.org/licenses/gpl-3.0.txt` -Upgrading +Usage ------------------------- -Skip to `Installing` if you are installing this for the first time. +If you are using a nightly build off of https://github.com/chaoskagami/corbenik - treat all paths starting in `/corbenik` as `/skeith` instead for these instructions. + +Skip to `Installing` if you are installing this for the first time, otherwise follow `Updating` and then `Installing`. + +Updating +------------------------- When updating Corbenik, usually you should (at minimum) perform the following steps to SAFELY update: @@ -84,14 +89,15 @@ Setup ------------------------- Unless otherwise noted, menu controls are always shown at the top, but for reference: - * A -> enter/select/enable/increase - * X -> Decrease - * B -> back/exit/boot - * Up -> Up one - * Down -> Down one - * Left -> Up five - * Right -> Down five - * Select -> Help + * A -> Enter/Select/Enable/Increase + * X -> Decrease + * B -> Back/Exit/Boot + * Up -> Up one + * Down -> Down one + * Left -> Up five + * Right -> Down five + * Select -> Help (on any selectable option) + * L+R+Start -> Screenshot (Menu ONLY.) For starters, you'll want to go into options and enable `Loader Replacement` to get loader to run patches as well. Even if you don't plan to run any loader patches, this will at very least kill ASLR and anti-OoThax/anti-Ninjhax features in the official Nintendo loader. @@ -117,8 +123,7 @@ You'll also want these patches, which are done by loader and therefore require i If you're using the reboot hook, you might want these: * AGB Signature fix * AGB Bootscreen - * Will stop games with corrupted Nintendo logos from running. Disable for - ROMhacks if this occurs. + * Will stop games with corrupted Nintendo logos from running. Disable for ROM hacks if this occurs. * TWL Patches If you're on 11.0, you also want these: @@ -132,16 +137,25 @@ If you region changed your console and replaced SecureInfo_A, you want: * SecureInfo_A Signature Fix Optional, but recommended patches are: - * MSET Version + * Settings Version String * ErrDisp devmode And these YOU SHOULD NOT ENABLE unless you have specialized needs: * Developer UNITINFO (Pretends to be a developer console/Panda) - * ARM11 XN Disable (Grants +X maps by default) - * Force TestMenu (Boots into TestMenu rather than HOME - requires TestMenu to be installed.) + * ARM11 XN Disable (Grants +X maps by default to kernel) + * Force TestMenu (Boots into TestMenu rather than HOME - requires TestMenu to be installed) Before booting, you should select 'Save Configuration' from the menu. +Customization +------------------------- + +Extra patches may be supplied in the `/corbenik/contrib` folder. Copy any of these patches to `patch` if you wish to use them. + +You can copy some 90° rotated BGR8 pixel data sized to the screen (essentially, a menuhax splash) and it will be used as backgrounds for menus. Put them at: + * Top: `/corbenik/bits/top.bin` + * Bottom: `/corbenik/bits/bottom.bin` + Reporting issues ------------------------- @@ -202,6 +216,8 @@ Temptress Cerise (GBATemp) Crystal the Glaceon (GBATemp) * A LOT of testing which was really helpful. +Everyone on #Cakey for being generally cool people. + CyberConnect2 * Because the name originates from .hack, which you should go play.