Skip to content

leo60228/libgm9

 
 

Repository files navigation

GodMode9

A full access file browser for the 3DS console :godmode:

GodMode9 is a full access file browser for the Nintendo 3DS console, giving you access to your SD card, to the FAT partitons inside your SysNAND and EmuNAND and to basically anything else. Among other functionality (see below), you can copy, delete, rename files and create folders.

Warning

This is powerful stuff, it provides you with the means to do basically any thinkable modification to any system data available on the 3DS console. However, precautions are taken so you don't accidentially damage the data of your console. The write permissions system protects you by providing warnings and forces you to enter an unlock sequence for enabling write permissions. It is not possible to overwrite or modify any important stuff without such unlock sequences and it is not possible to accidentially unlock something.

As always, be smart, keep backups, just to be safe.

Quick start guide

These short instructions apply to all users who have ARM9loaderhax and Luma3DS installed (Luma3DS set up with standard paths), which will be the majority of all GodMode9 users. Here's how to set it up quickly:

  • Rename GodMode9.bin(from the release archive) to X_GodMode9.bin(change Xto the button of your choice) and put it into sd:/luma/payloads/
  • Get good versions of aeskeydb.bin, seeddb.bin and encTitlekeys.bin from somewhere (don't ask me!) and put these three files into sd:/ or sd:/files9 (optional but recommended for full functionality).
  • Possibly helpful info: If you wonder how to backup your NAND, press the HOME button and enter the menu titled More.... You may also backup your NAND via just copying the nand.bin / nand_min.bin file in S:/.

You may now run GodMode9 via the X Button (or any other button you chose). See below for a list of stuff you can do with it.

How to run this / entry points

GodMode9 can be built to run from a number of entry points, descriptions are below. Note that you need to be on or below 3DS firmware version v11.2 (v9.2 if not using SafeHax/FastHax) or have ARM9loaderhax installed for any of these to work. All entrypoint files are included in the release archive.

  • A9LH, Brahma & SafeHax: Copy GodMode9.bin to somewhere on your SD card and run it via either arm9loaderhax, Brahma or FastHax/SafeHax. Brahma derivatives / loaders (such as BrahmaLoader) and A9LH chainloaders (such as Luma3DS and BootCTR9) will work with this as well. Build this with make binary.
  • Homebrew Launcher: Copy GodMode9.3dsx & GodMode9.smdh into /3DS/GodMode9 on your SD card. Run this via Smealums Homebrew Launcher, Mashers Grid Launcher or any other compatible software. Build this with make brahma.
  • CakeHax Browser: Copy GodMode9.dat to the root of your SD card. You can then run it via http://dukesrg.github.io/?GodMode9.dat from your 3DS browser. Build this via make cakehax.
  • CakeHax MSET: Copy GodMode9.dat to the root of your SD card and GodMode9.nds to anywhere on the SD card. You can then run it either via MSET and GodMode9.nds. Build this via make cakerop.
  • Gateway Browser Exploit: Copy Launcher.dat to your SD card root and run this via http://go.gateway-3ds.com/ from your 3DS browser. Build this with make gateway. Please note: this entrypoint is deprecated. While it may still work at the present time with little to no problems, bugs will no more be fixed and it may be completely removed at a later time. Use CakeHax instead.

If you are a developer and you are building this, you may also just run make release to build all files at once. To build SafeMode9 (a bricksafe variant of GodMode9, with limited write permissions) instead of GodMode9, compile with make MODE=safe. For additional customization, you may also choose the internal font via make FONT=6X10, make FONT=ACORN, make FONT=GB and make FONT=ORIG.

Write permissions system

GodMode9 provides a write permissions system, which will protect you from accidentually damaging you system, losing data and/or modifying important system data. To unlock a write permission, an unlock sequence must be entered. This is not possible by accident. The write permission system is based on colors and the top bar on the top screen will change color according to the current write permission level. No permission above the yellow level can be unlocked on SafeMode9.

  • Green: Modification to system files is not possible on this permission level. You can't edit or delete savegames and installed data. However, keep in mind that any non-system related or custom stuff on your SD card is not protected.
  • Yellow: You can modify system files on this permission level. Data that is unique to your console and cannot be gotten from anywhere else is still not modifyable. Any damages you introduce can be fixed in software, but loss of savegames and installed data is possible if you are not careful. A NAND backup is highly recommended starting at this level.
  • Orange: This is similar to the yellow permission level, but, in addition, allows edits to console unique data. Any damages you introduce are still fixable in software, but if you play around with this, having a NAND backup is an absolute requirement.
  • Red: The highest regular permission level. There are no limits to system file edits, and if you are not careful enough, you can brick your console and/or remove your A9LH installation. Bricks on this level may only be fixable in hardware. If you don't have a NAND backup at this point, you seem to have a deathwish for your console.
  • Blue: This permission level is reserved for edits to system memory. While, most likely, nothing bad at all will happen, consequences of edits can be unforeseen. There is even a (albeit very small) chance of bricking your console, maybe even permanently. Tread with caution on this level.

Support files

For certain functionality, GodMode9 may need 'support files'. Support files can be placed into either 0:/(the SD root folder), 0:/files9/ or 1:/rw/files9/ (all locations will work). Support files contain additional information that is required in decryption operations. A list of support files, and what they do, is found below. Please don't ask for support files - find them yourself.

  • aeskeydb.bin: This should contain 0x25keyX, 0x18keyX and 0x1BkeyX to enable decryption of 7x / Secure3 / Secure4 encrypted NCCH files and 0x11key95 / 0x11key96 for FIRM decrypt support. It can be created from your existing legacy slot0x??key?.binfiles in Decrypt9 via the 'Build Key Database' feature. As an alternative (not recommended), legacy slot0x??key?.bin files are also supported in GodMode9.
  • seeddb.bin: This file is required to decrypt and mount seed encrypted NCCHs and CIAs if the seed in question is not installed to your NAND. Note that your seeddb.bin must also contain the seed for the specific game you need to decrypt.
  • otp.bin: This file is console-unique and is required - on entrypoints other than A9LH - for decryption of the 'secret' sector 0x96 on N3DS (and O3DS with a9lh installed). Refer to this guide for instructions on how to get your own otp.bin file.
  • sector0x96.bin / secret_sector.bin : A copy of the decrypted, untouched (non-a9lh) secret sector. This is required for decryption of the encrypted ARM9 section of N3DS FIRMs. It is not required for anything else. As an alternative you can also provide the required keys inside your aeskeydb.bin.
  • encTitleKeys.bin / decTitleKeys.bin: These files are optional and provide titlekeys, which are required to create updatable CIAs from NCCH / NCSD files. CIAs created without these files will still work, but won't be updatable from eShop.

Drives in GodMode9

GodMode9 provides access to system data via drives, a listing of what each drive contains and additional info follows below. Some of these drives are removable (such as drive 7:), some will only turn up if they are available (drive 8: and everything associated with EmuNAND, f.e.). Information on the 3DS console file system is also found on 3Dbrew.org.

  • 0: SDCARD: The SD card currently inserted into the SD card slot. The 0:/Nintendo 3DSfolder contains software installs and extdata and is specially protected via the write permission system. The SD card can be unmounted from the root directory via the R+B buttons, otherwise the SD card is always available.
  • 1: SYSNAND CTRNAND: The CTRNAND partition on SysNAND. This contains your 3DS console's operating system and system software installs. Data in here is protected by the write permissions system.
  • 2: SYSNAND TWLN: The TWLN partition on SysNAND. This contains your 3DS console's TWL mode operating system and system software installs. Data in here is protected by the write permissions system.
  • 3: SYSNAND TWLP: The TWLP partition on SysNAND. This contains photos taken while in TWL mode
  • A: SYSNAND SD: This drive is used for special access to data on your SD card. It actually links to a subfolder inside 0:/Nintendo 3DS and contains software and extdata installed to SD from SysNAND. Crypto in this folder is handled only when accessed via the A: drive (not from 0:). This is protected by the write permissions system.
  • S: SYSNAND VIRTUAL: This drive provides access to all partitions of the SysNAND, some of them critical for base system functionality. This is protected by the write permissions system, but, when unlocked, modifications can brick the system.
  • 4: EMUNAND CTRNAND: Same as 1:, but handles the CTRNAND on EmuNAND. For multi EmuNAND setups, the currently active EmuNAND partition can be switched via the HOME menu.
  • 5: EMUNAND TWLN: Same as 2, but handles TWLN on EmuNAND. No write protection here, cause this partition is never used on EmuNAND.
  • 6: EMUNAND TWLP: Same as 3, but handles TWLP on EmuNAND.
  • B: EMUNAND SD: Same as A:, but handles the 0:/Nintendo 3DS subfolder associated with EmuNAND. In case of linked NANDs, this is identical with A:. This is also protected by the write permissions system.
  • E: EMUNAND VIRTUAL: Same as S:, but handles system partitions on EmuNAND. No bricking risk here as EmuNAND is never critical to system functionality.
  • 7: FAT IMAGE / IMGNAND CTRNAND: This provides access to mounted FAT images. When a NAND image is mounted, it provides access to the mounted NAND image's CTRNAND.
  • 8: BONUS DRIVE / IMGNAND TWLN: This provides access to the bonus drive on SysNAND. The bonus drive can be setup via the HOME menu on 3DS consoles that provide the space for it. When a NAND image is mounted, this provides access to the mounted NAND image's TWLN.
  • 9: RAM DRIVE / IMGNAND TWLP: This provides access to the RAM drive. All data stored inside the RAM drive is temporary and will be wiped after a reboot. When a NAND image is mounted, this provides access to the mounted NAND image's TWLP.
  • I: IMGNAND VIRTUAL: When a NAND image is mounted, this provides access to the partitions inside the NAND image.
  • C: GAMECART: This is read-only and provides access to the game cartridge currently inserted into the cart slot. This can be used for dumps of CTR and TWL mode cartridges. Flash cards are supported only to a limited extent.
  • G: GAME IMAGE: CIA/NCSD/NCCH/EXEFS/ROMFS/FIRM images can be accessed via this drive when mounted. This is read-only.
  • T: TICKET.DB IMAGE: Ticket database files can be mounted and accessed via this drive. This provides easy and quick access to all tickets inside the ticket.db. This is read-only.
  • M: MEMORY VIRTUAL: This provides access to various memory regions. This is protected by a special write permission, and caution is advised when doing modifications inside this drive.
  • X: NAND XORPADS: This drive contains XORpads for all NAND partitions. XORpads can be used to decrypt NAND partitions outside of the 3DS console with the help of additional software. This is read-only.
  • Z: LAST SEARCH: After a search operation, search results are found inside this drive. The drive can be accessed at a later point to return to the former search results.

What you can do with GodMode9

With the possibilites GodMode9 provides, not everything may be obvious at first glance. In short, GodMode9 includes improved versions of basically everything that Decrypt9 has, and more. Any kind of dumps and injections are handled via standard copy operations and more specific operations are found inside the A button menu. The A button menu also works for batch operations when multiple files are selected. For your convenience a (incomplete!) list of what GodMode9 can do follows below.

  • Manage files on all your data storages: You wouldn't have expected this, right? Included are all standard file operations such as copy, delete, rename files and create folders. Use the L button to mark multiple files and apply file operations to multiple files at once.
  • Actually use that extra NAND space: You can setup a bonus drive via the home menu, which will be available via drive letter 8:.
  • Make screenshots: Press R+L anywhere. Screenshots are in BMP format.
  • Use multiple panes: Press R+left|right. This enables you to stay in one location in the first pane and open another in the second pane.
  • Search drives and folders: Just press R+A on the drive / folder you want to search.
  • Format your SD card / setup a RedNAND: Press the HOME button, select SD format menu. This also allows to setup a RedNAND on your SD card. You will get a warning prompt and an unlock sequence before any operation starts.
  • Handle multiple EmuNANDs / RedNAND: Press the HOME button, select Switch EmuNAND to switch between EmuNANDs / RedNANDs.
  • Run it without an SD card / unmount the SD card: If no SD card is found, you will be offered to run without the SD card. You can also unmount and remount your SD card from the file system root at any point.
  • Direct access to SD installed contents: Just take a look inside the A:/B: drives. On-the-fly-crypto is taken care for, you can access this the same as any other content.
  • Build CIAs from NCCH / NCSD (.3DS) / TMD (installed contents): Press A on the file you want converted, the option will be shown. Installed contents are found (among others) in 1:/titles/(SysNAND) and A:/titles/(SD installed). Where applicable, you will also be able to generate legit CIAs. Note: this works also from a file search.
  • Decrypt, encrypt and verify NCCH / NCSD / CIA / BOSS / FIRM images: Options are found inside the A button menu. You will be able to decrypt/encrypt to the standard output directory or (where applicable) in place.
  • Decrypt content downloaded from CDN / NUS: Press A on the file you want decrypted. For this to work, you need at least a TMD file (encTitlekeys.bin / decTitlekeys.bin also required, see Support files below) or a CETK file. Either keep the names provided by CDN / NUS, or rename the downloaded content to (anything).nus or (anything).cdn and the CETK to (anything).cetk.
  • Batch mode for the above operations: Just select multiple files of the same type via the L button, then press the A button on one of the selected files.
  • Access any file inside NCCH / NCSD / CIA / FIRM images: Just mount the file via the A button menu and browse to the file you want. For CIAs and CDN / NUS content, prior decryption may be advisable for full access.
  • Mount ticket.db files and dump tickets: Mount the file via the A button menu. Tickets are sorted into eshop (stuff from eshop, probably legit), system (system tickets, probably legit) and unknown(everything else, never legit) categories.
  • Inject any NCCH CXI file into Health & Safety: The option is found inside the A button menu for any NCCH CXI file. NCCH CXIs are found, f.e. inside of CIAs. Keep in mind there is a (system internal) size restriction on H&S injectable apps.
  • Inject and dump GBA VC saves: Look for a file called gbavc.sav inside the S: drive. Keep in mind that you need to start the specific GBA game on your console before dumping / injecting the save.
  • Dump 3DS / NDS / DSi type retail game cartridges: Insert the cartridge and take a look inside the C: drive. You may also dump private headers from 3DS game cartridges.
  • Generate XORpads from ncchinfo.bin files: Start this via the appropriate entry inside the A button menu.
  • Generate XORpads for any NAND partition: Take a look inside the X: drive. You can use these XORpads for decryption of encrypted NAND images on PC. Additional tools such as 3dsFAT16Tool are required on PC.
  • Check and fix CMACs (for any file that has them): The option will turn up in the A button menu if it is available for a given file (f.e. system savegames, ticket.db, etc...). This can also be done for multiple files at once if they are marked.
  • Directly mount and access NAND dumps or standard FAT images: Just press the A button on these files to get the option. You can only mount NAND dumps from the same console.
  • Restore NAND dumps while keeping your A9LH / sighax installation intact: Select Restore SysNAND (safe) from inside the A button menu.
  • Restore / dump NAND partitions or even full NANDs: Just take a look into the S: (or E:/ I:) drive. This is done the same as any other file operation.
  • Transfer CTRNAND images between systems: Transfer the file located at S:/ctrnand_full.bin (or E:/ I:). On the receiving system, press A, select CTRNAND Options..., then Transfer to NAND.
  • Embed an essential backup right into a NAND dump: This is available in the A button menu for NAND dumps. Essential backups contain NAND header, movable.sed, LocalFriendCodeSeed_B and SecureInfo_A.
  • Compare and verify files: Press the A button on the first file, select Calculate SHA-256. Do the same for the second file. If the two files are identical, you will get a message about them being identical. On the SDCARD drive (0:) you can also write a SHA file, so you can check for any modifications at a later point.
  • Hexview and hexedit any file: Press the A button on a file and select Show in Hexeditor. A button again enables edit mode, hold the A button and press arrow buttons to edit bytes. You will get an additional confirmation prompt to take over changes. Take note that for certain files, write permissions can't be enabled.
  • Inject a file to another file: Put exactly one file (the file to be injected from) into the clipboard (via the Y button). Press A on the file to be injected to. There will be an option to inject the first file into it.

License

You may use this under the terms of the GNU General Public License GPL v2 or under the terms of any later revisions of the GPL. Refer to the provided LICENSE.txt file for further information.

Credits

This tool would not have been possible without the help of numerous people. Thanks go to...

  • Archshift, for providing the base project infrastructure
  • Normmatt, for sdmmc.c / sdmmc.h and gamecart code
  • Cha(N), Kane49, and all other FatFS contributors for FatFS
  • SciresM for helping me figure out RomFS
  • b1l1s for helping me figure out A9LH compatibility
  • Gelex and AuroraWright for helping me figure out various things
  • dark_samus for the new 6x10 font and help on various things
  • Wolfvak for the ARM9 binary launcher and other improvements
  • WinterMute and YodaDaCoda for help testing DSi cart dumping
  • Al3x_10m, Supster131, imanoob, Kasher_CS and all other fearless testers
  • Shadowhand for being awesome and hosting my nightlies
  • Plailect for putting his trust in my tools and recommending this in The Guide
  • Amazingmax fonts for the Amazdoom font
  • The fine folks on freenode #Cakey
  • All 3dbrew.org editors
  • Everyone I possibly forgot, if you think you deserve to be mentioned, just contact me!

About

GodMode9 made into a library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C 94.5%
  • C++ 3.7%
  • Other 1.8%