Goldleaf

<p align="center"> <img alt="Goldleaf" src="Goldleaf/romfs/Logo.png"> </p <p align="center"> <b>💙 thanks for 2M downloads 💙</b> </p> <p align="center"> <a title="Discord" href="https://discord.gg/3KpFyaH"> <img alt="Discord" src="https://img.shields.io/discord/789833418631675954?label=Discord&logo=Discord&logoColor=fff&style=for-the-badge"> </a> <a title="Downloads" href="https://github.com/XorTroll/Goldleaf/releases/latest"> <img alt="Downloads" src="https://img.shields.io/github/downloads/XorTroll/Goldleaf/total?longCache=true&style=for-the-badge&label=Downloads&logoColor=fff&logo=GitHub"> </a> <a title="License" href="https://github.com/XorTroll/Goldleaf/blob/master/LICENSE"> <img alt="License" src="https://img.shields.io/github/license/XorTroll/Goldleaf?style=for-the-badge"> </a> </p> <p align="center"> <a title="Patreon" href="https://www.patreon.com/xortroll"> <img alt="Patreon" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3DXorTroll%26type%3Dpatrons&style=for-the-badge"/> </a> <a title="GitHub sponsors" href="https://github.com/sponsors/XorTroll"> <img alt="GitHub sponsors" src="https://img.shields.io/github/sponsors/XorTroll?label=Sponsor&logo=GitHub&style=for-the-badge"/> </a> <a title="PayPal" href="https://www.paypal.com/donate/?hosted_button_id=PHQKFTY9AHPUU"> <img alt="PayPal" src="https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge"/> </a> </p> <p align="center"> <a title="Ko-fi" href='https://ko-fi.com/xortroll' target='_blank'> <img alt="Ko-fi" height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0'/> </a> </p> <img src="screenshots/light1.jpg" alt="drawing" width="auto"/> <img src="screenshots/dark1.jpg" alt="drawing" width="auto"/>

If the last Goldleaf release is currently broken, please hop in my Discord server, where I periodically share dev builds of changes being tested, prior to commits or releases!

<h3> Table of contents </h3>

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

Features

Goldleaf's concept is very similar to FBI'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 to libusbhsfs)

    • 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 the Content 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 the Content 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 in settings.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 to 11 different languages so far: English, Spanish, German, French, Italian, Dutch, Japanese, Portuguese, Korean, traditional Chinese and simplified Chinese.

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

Controls

• 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)

Frequently asked questions

Make sure you check these before making an issue!

NSP installing

• 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 so here.

    • 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 Quark after 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 check the setup for some more information about the matter.

Disclaimer

NSP installing

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

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.

FAQ

Goldleaf crashes, what can I do?

Check Goldleaf logs (sd:/switch/Goldleaf/goldleaf.log) and any crash report mentioned by the Switch (typically it will mention title ID 010000000000100D, so the latest crash report inside sd:/atmosphere/crash_reports/ containing that ID will be the corresponding one).

Submit an issue here with any of these files (better if the two are included) or ask for support in Discord with the files as well.

Quark and remote browsing

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.

Windows

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

Note: make sure that the JDK/JRE you choose contains JavaFX! You can alway