hacks-guide/finalize
1
0
Fork 0
mirror of https://github.com/hacks-guide/finalize.git synced 2024-11-26 18:40:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
fc4d9a1b2d
finalize/README.md
Lily 86c0974bb1 docs/readme: update links & info 
readme: use new file paths
readme: separate between automatic builds and manual file placement
readme: minor grammar/word fixes
docs: update behaviour from #1
docs: fix a wrong word
2024-03-15 00:32:18 +01:00

3.1 KiB
Raw Blame History

finalize

Scripts relating to Finalizing Setup on https://3ds.hacks.guide/finalizing-setup.

  • /romfs/finalize/: Files that are packed into finalize.romfs
    • /romfs/finalize/img: Images used for visual troubleshooting
    • /romfs/finalize/finalize.gm9: Script run after finalize_helper.gm9 that:
      • Installs base homebrew applications to SYSNAND SD (see below for list)
      • Copies GodMode9 to CTRNAND (/rw/luma/payloads)
      • Backs up essential.exefs to /gm9/backups
      • Deletes CFW installation files that are no longer necessary
      • Backs up minsize NAND backup to /gm9/backups
    • /romfs/finalize/donor.db: Empty title database used for consoles that do not have title database (i.e. no eShop software)
  • finalize_helper.gm9: Script that is compiled as GM9 scriptrunner (finalize_helper.firm); extracts finalize.romfs
  • docs.md: Full error information / script documentation

Bundled software

The following repositories have their compiled builds in this software package:

Releases

Releases are tagged for reference (based on usage in the guide). Releases in this repository are not intended to be for general use. If you want to use them, you have two options:

Automatically built binaries

Binaries are automatically built by GitHub Actions. Place finalize_helper.firm in /luma/payloads/ and finalize.romfs on root of SD.

Manual file placement

  • Clone this repository (latest commit, or a tagged release if you are looking for a specific version)
  • Copy the contents of finalize (inside of the romfs folder) to the root of your console's SD card
  • Copy finalize.gm9 from the finalize folder to /gm9/scripts/
  • Copy GodMode9.firm from the finalize folder to /luma/payloads/
    • Create any folders that do not exist
    • Luma's boot.firm needs to be on root of SD for this to work

Building

You need the following tools installed on your computer:

  • 3dstool
  • devkitARM
    • devkitARM is only required if you are building the FIRM, which you are going to want to do anyway
    • Install the 3DS related packages

Clone the repository via the following commands:

git clone https://github.com/hacks-guide/finalize --recurse-submodules
cd finalize

And build:

make

The romfs and FIRM will be present in the builds directory.

License

TBD