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:
-------------------------
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.
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:
* 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
-------------------------
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.