Repository files navigation

• Features
  • Controls
• Frequently asked questions
  • NSP installing
• Disclaimer
  • NSP installing
  • Tickets
• Quark and remote browsing
  • Windows
  • Linux
  • Mac
• Known bugs
• Building
• Contributing
  • Translations
• Credits
• Quark and remote browsing
  • Windows
  • Linux
  • Mac
• Settings & themeing
  • Sample
  • Notes
• Screenshots
• Known bugs
• Building
• Contributing
  • Translations
• Credits

Goldleaf's concept is very similar toFBI's, a well-known Nintendo 3DS homebrew tool.

• Explorer: An easy-to-use but fully featured filesystem browser.

  • Supported locations/devices:

    • SD card

    • Console memory (SAVE, SYSTEM, USER and PRODINFOF partitions)

    • Remote PC (via tools like Quark)

    • USB drives (thanks tolibusbhsfs)

    • Game savedata (read-only, check below how to mount it)

    • NRO homebrew RomFs (read-only)

    Note: all of them are automatically unmounted when Goldleaf is exited

  • Features:

    • File operations: create, delete, copy, rename, view as hex/text, get size, etc.

    • Directory operations: create, delete, copy, rename, (un)set archive bit, get full size, install all NSPs inside, etc.

    • Install NSPs of games, updates, DLC, etc. (use this carefully, and make sure you know what you're doing!)

    • Launch other NRO homebrews and mount their RomFs (as mentioned above)

    • Execute .bin files as RCM payloads (reboot with them)

    • Set JPG/JPEG files as user icons (use this very carefully, and make sure you know what you're doing!)

    • Preview of NACP files (the ones automatically exported by Goldleaf, and so on)

• Game/update/DLC browser: an easy-to-use but fully featured content manager:

  • Per title:

    • View general information (occupied size, play stats, launch flags and so on)

    • Mount savedata to navigate it (check theContent explorer above)

  • Content operations (for each title content: base game, update or DLCs):

    • View information (ID, contents, version, ticket...)

    • Uninstall/completely remove the content (won't remove savedata)

    • Export content to NSP

    • Remove ticket, if present (use this carefully, and make sure you know what you're doing!)

    • Reset launch version (useful to be able to play a base game after an update has been removed)

    Note: some of these are only (obviously) available for games with contents

• Ticket browser Check tickets, and optionally remove unused ones (use this carefully, and make sure you know what you're doing!)

• Web browser: makes use of the console's web applet:

  • Browse user-submitted URLs

  • Create and save bookmarks

  Note: the web browser is only usable when launched as application (due to system memory limitations).

• Account manager: select a user (or just use the pre-selected one if present), and:

  • Change nickname

  • View its icon

  • Delete user (of course, only if there is more than one in the system!)

  Note: to change the user's icon, select the desired JPG/JPEG icon file by browsing in theContent explorer.

• Amiibo dump: create a virtual amiibo (for emuiibo) from a real amiibo figurine.

• Settings: check both system and Goldleaf settings:

  • Firmware and updates:

    • Check current firmware information (version, hash, key generation)

    • Check for pending updates, and (if desired) remove them if present

    • Export current firmware or pending update data

  • Memory: check free and total space on different locations

  • Goldleaf settings: check settings present insettings.json

• About: check Goldleaf's version and how it was launched (as an applet or an application), and check for latest Goldleaf updates + update to a new release if it exists

• Goldleaf has been translated to11 different languages so far:English,Spanish,German,French,Italian,Dutch,Japanese,Portuguese,Korean,traditional Chinese andsimplified Chinese.

Thanks to all the various contributors to the different translations! 💛

• Common:

  • (LR-stick / R-stick / D-pad) Move through the current menu

  • (ZL / ZR) Show a dialog to shut down or reboot the console. To avoid unwanted shut-downs/reboots, Goldleaf will ask for confirmation.

  • (Minus / -) Show a dialog with this control information.

  • (Plus / +) Exit the application in order to return to hbmenu.

• Explore menu:

  • (X) Unmount the selected location (only when a manually-mounted location is selected)

  • (Y) Refresh mounted contents

• File browser:

  • (Y) Select folder (might take a bit of time with folders with many sub-items)

Make sure you check these before making an issue!

• I keep getting 'invalid NCA'/'missing patches' or weird FS/ETicket errors...

  • Do you actually have all the required patches?

• Goldleaf freezes and Quark doesn't respond/complains when I launch it...

  • Do you have USB set-up correctly? Check how to do sohere.

    • If you do have USB corrently set-up, Quark shouldn't complain. If it does, try doing the setup again to ensure it is done fine.

  • Also, make sure you're launching Quarkafter having launched Goldleaf. Goldleaf needs to be opened first.

  • Are you using the latest version of both Goldleaf and Quark? Double-check it just in case, since this is a very common mistake.

• I can't launch Quark / Quark is giving me errors on Linux...

  • Quark is a little bit fucky on Linux. Make sure to checkthe setup for some more information about the matter.

Always keep in mind that installing NSPs can be a very easy way to get banned.

NEVER install untrusted NSPs. Goldleaf doesn't do any special verification, so please be very careful about installing untrusted packages.

Tickets represent a game purchase - technically speaking, you can't launch a title if the ticket isn't present and the title requires it (official titles require them). NSPs which don't have/require a ticket are standard-crypto.

Goldleaf will display whether a ticket is present or not, and if so, it's title-key. Title-keys are required to decrypt and access a title's content. Otherwise, they are undecryptable, hence unlaunchable by the system.

Quark Goldleaf's desktop Java tool, working as the desktop client for the remote PC option. It supports Windows, Linux and Mac.

Quark needs Java 9 or greater to run. See below the recommended installation for each supported system.

You also need to install libusbK drivers for USB to work fine.

The best way to install Java 9 in Windows (or a very simple one) is to installAdoptOpenJDK 11 or higher.

Note: make sure that the JDK/JRE you choose contains JavaFX! You can always install it manually otherwise

After installing it, double-clicking the JAR should be enough to start it.

Otherwise, runjava -jar Quark.jar in the command prompt.

For the USB to get recognized, follow the following steps:

• DownloadZadig

• Boot your console with CFW, connect it to the PC via USB

• Open Goldleaf

• With Zadig, select the device named "Goldleaf" (if it doesn't appear, ensure Goldleaf has a USB icon on the top of the screen, and select "List all devices" under "Options" in Zadig)

• InstalllibusbK to that device (any other driver won't work fine)

Install OpenJDK 11 (or higher) in the terminal:

• Runsudo add-apt-repository ppa:openjdk-r/ppa

• Runsudo apt-get update

• Finally, runsudo apt-get install openjdk-11-jdk (if you just want the JRE, installopenjdk-11-jre instead)

• Create the file/etc/udev/rules.d/99-switch.rules with the following contents:SUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", GROUP="plugdev"

• Reload udev rules with:sudo udevadm control --reload-rules && sudo udevadm trigger

Now you can run Quark usingjava -jar Quark.jar.

Install OpenJDK 11 (or higher) in the terminal:

• Install brew/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

• Runbrew tap AdoptOpenJDK/openjdk

• Runbrew install adoptopenjdk11 --cask

• Finally, runjava -version to check the JDK version

Now you can run Quark usingjava -jar Quark.jar.

Having done all this, the USB connection should work fine.

• Exiting Goldleaf via HOME menu (as a NRO) seems to crash the system on 7.x firmwares due to a weird USB bug present on those specific versions. Any non-7.x firmware doesn't seem to have this issue.

In order to build Goldleaf, you will need the following:

• devkitA64

• JDK 9 or higher (needed for Quark)

• Maven (needed for Quark)

You will also need to install the following packages with devkitPro's pacman:

• switch-sdl2 switch-freetype switch-glad switch-libdrm_nouveau switch-sdl2_gfx switch-sdl2_image switch-sdl2_ttf switch-sdl2_mixer

Remember to clone this repository recursively (git clone <this-repo-url> --recurse-submodules) since Goldleaf makes use of submodules.

In order to build Goldleaf, runmake setup (only for the first time), then just runmake and wait for it to finish building.

In order to build Quark, just execute thebuild.sh script in its directory.

If you would like to contribute with new features, you are free to fork Goldleaf and open pull requests showcasing your additions.

If you just would like to suggest new ideas, but without actual code implementations, you're free to open an issue. Please try not to duplicate those, if the idea or problem is already reported in another issue.

You can always contact me on my Discord server (invite link below) as an easier way to suggest ideas or directly report issues.

Goldleaf's aim is to, mainly, support languages supported by the console itself, so those not yet supported by Goldleaf and which aren't supported by consoles should have less priority and won't be probably accepted.

Note that some languages may contain untranslated (English) content. I prioritize dropping relevant releases/updates over waiting for correct and fully up-to-date translations, thus releases may not contain complete translations.

Anyone with enough knowledge of a certain language is absolutely welcome to make a PR with translation suggestions and/or fixes, and will be credited for such a contribution.

The main concepts of Goldleaf are and have been developed by me (XorTroll), but without the effort and support of many others, this project wouldn't have been a thing:

• Adubbz and all the (old)Tinfoil contributors, for their huge work with title installing.

• C4Phoenix, for his awesome work doing this project's logo, and the GIF displayed when launching the installed forwarder.

• All the graphics except Goldleaf's logo (see credit above) were grabbed fromIcons8.

• 2767mr, for all the support given in Goldtree (former Quark tool).

• developer.su forNS-USBloader, which helped a lot on the development of Quark, mainly on the usage of usb4java and the base of a multi-platform JavaFX Java project.

Quark Goldleaf's desktop Java tool, working as the desktop client for the remote PC option. It supports Windows, Linux and Mac.

Quark needs Java 9 or greater to run. See below the recommended installation for each supported system.

You also need to install libusbK drivers for USB to work fine.

The best way to install Java 9 in Windows (or a very simple one) is to installAdoptOpenJDK 11 or higher.

Note: make sure that the JDK/JRE you choose contains JavaFX! You can always install it manually otherwise

After installing it, double-clicking the JAR should be enough to start it.

Otherwise, runjava -jar Quark.jar in the command prompt.

For the USB to get recognized, follow the following steps:

• DownloadZadig

• Boot your console with CFW, connect it to the PC via USB

• Open Goldleaf

• With Zadig, select the device named "Goldleaf" (if it doesn't appear, ensure Goldleaf has a USB icon on the top of the screen, and select "List all devices" under "Options" in Zadig)

• InstalllibusbK to that device (any other driver won't work fine)

Install OpenJDK 11 (or higher) in the terminal:

• Runsudo add-apt-repository ppa:openjdk-r/ppa

• Runsudo apt-get update

• Finally, runsudo apt-get install openjdk-11-jdk (if you just want the JRE, installopenjdk-11-jre instead)

• Create the file/etc/udev/rules.d/99-switch.rules with the following contents:SUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", GROUP="plugdev"

• Reload udev rules with:sudo udevadm control --reload-rules && sudo udevadm trigger

Now you can run Quark usingjava -jar Quark.jar.

Install OpenJDK 11 (or higher) in the terminal:

• Install brew/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

• Runbrew tap AdoptOpenJDK/openjdk

• Runbrew install adoptopenjdk11 --cask

• Finally, runjava -version to check the JDK version

Now you can run Quark usingjava -jar Quark.jar.

Having done all this, the USB connection should work fine.

Goldleaf supports the customization of colors, assets and other options via a JSON file located at Goldleaf's folder:sd:/switch/Goldleaf/settings.json.

This is an example JSON for Goldleaf settings:

{"general": {"language":"es","external_romfs_path":"sdmc:/switch/Goldleaf/custom-romfs","use_12h_time":true,"ignore_hidden_files":true,    },"ui": {"light_color_scheme": {"bg":"#aabbccdd","menu_base":"#aabbccdd","menu_base_focus":"#aabbccdd","text":"#aabbccdd","version_text":"#aabbccdd","scroll_bar":"#aabbccdd","progress_bar":"#aabbccdd","progress_bar_bg":"#aabbccdd","dialog_title":"#aabbccdd","dialog_opt":"#aabbccdd","dialog":"#aabbccdd","dialog_over":"#aabbccdd"        },"dark_color_scheme": {"bg":"#aabbccdd","menu_base":"#aabbccdd","menu_base_focus":"#aabbccdd","text":"#aabbccdd","version_text":"#aabbccdd","scroll_bar":"#aabbccdd","progress_bar":"#aabbccdd","progress_bar_bg":"#aabbccdd","dialog_title":"#aabbccdd","dialog_opt":"#aabbccdd","dialog":"#aabbccdd","dialog_over":"#aabbccdd"        },"menu_item_size":80    },"fs": {"compute_directory_sizes":false    },"installs": {"ignore_required_fw_version":false,"show_deletion_prompt_after_install":false,"copy_buffer_max_size":10485760    },"exports": {"decrypt_buffer_max_size":10485760    },"web": {"bookmarks": [            {"name":"Google","url":"https://www.google.com"            },            {"name":"GitHub","url":"https://www.github.com"            }        ]    }}

If a certain attribute isn't present Goldleaf will use default values (none of these fields are mandatory).

Colors follow#RRGGBBAA hex format. Not all color schemes/color scheme fields have to be implemented, otherwise default light/dark scheme ones will be used (for those not implemented).

Possible language values:auto (uses the system language) and all language codes listedhere.

Via RomFs replacement, when Goldleaf tries to locate, for instance,romfs:/FileSystem/FileDataFont.ttf resource font, ifromfsReplace is true andromfsReplacePath is, for instance,/switch/Goldleaf/testromfs, Goldleaf will look ifsd:/switch/Goldleaf/testromfs/FileSystem/FileDataFont.ttf exists and use it if so, otherwise will use RomFs's one.

So, via this configurations, UI's images, resources, element sizes and even translations (using custom JSON translations) can be used, plus some more assets that might be added in future updates.

• Exiting Goldleaf via HOME menu (as a NRO) seems to crash the system on 7.x firmwares due to a weird USB bug present on those specific versions. Any non-7.x firmware doesn't seem to have this issue.

In order to build Goldleaf, you will need the following:

• devkitA64

• JDK 9 or higher (needed for Quark)

• Maven (needed for Quark)

You will also need to install the following packages with devkitPro's pacman:

• switch-sdl2 switch-freetype switch-glad switch-libdrm_nouveau switch-sdl2_gfx switch-sdl2_image switch-sdl2_ttf switch-sdl2_mixer

Remember to clone this repository recursively (git clone <this-repo-url> --recurse-submodules) since Goldleaf makes use of submodules.

In order to build Goldleaf, runmake setup (only for the first time), then just runmake (ormake dev for a dev version) and wait for it to finish building.

In order to build Quark, just execute thebuild.sh script in its directory.

If you would like to contribute with new features, you are free to fork Goldleaf and open pull requests showcasing your additions.

If you just would like to suggest new ideas, but without actual code implementations, you're free to open an issue. Please try not to duplicate those, if the idea or problem is already reported in another issue.

You can always contact me on my Discord server (invite link below) as an easier way to suggest ideas or directly report issues.

Goldleaf's aim is to, mainly, support languages supported by the console itself, so those not yet supported by Goldleaf and which aren't supported by consoles should have less priority and won't be probably accepted.

Note that some languages may contain untranslated (English) content. I prioritize relevant releases/updates over correct and fully up-to-date translations, thus releases may not contain complete translations.

Anyone with enough knowledge of a certain language is absolutely welcome to make a PR with translation suggestions and/or fixes.

The main concepts of Goldleaf are and have been developed by me (XorTroll), but without the effort and support of many others, this project wouldn't have been a thing:

• Adubbz and all the (old)Tinfoil contributors, for their huge work with title installing.

• C4Phoenix, for his awesome work doing this project's logo.

• All the graphics except Goldleaf's logo (see credit above) were grabbed fromfreepik andflaticon.

• 2767mr, for all the support given in Goldtree (former Quark tool).

• developer.su forNS-USBloader, which helped a lot on the development of Quark, mainly on the usage of usb4java and the base of a multi-platform JavaFX Java project.

• Simon for his libusbK implementation for C#, which made the former Goldtree client possible.

• shchmue for the system to get tickets from system save data without breaking anything, which was part of Lockpick.

• WerWolv for the help with custom exception handling, avoiding those frustrating fatals.

• Translators:unbranched andexelix for Italian,tiliarou,FuryBaguette and GOffrier#9688 for French, andLoOkYe and C4Phoenix for German.

• All the testers, for reporting bugs and helping a lot with the project's development 💙