Goldleaf - A Nintendo Switch multipurpose homebrew tool




Goldleaf is multipurpose homebrew tool for Nintendo Switch.​


Features

Goldleaf has a very similar concept to FBI, which is a similar tool for Nintendo 3DS homebrew.

These are its main features:

  • SD card browser: A simple but fully equiped file browser for the SD card, supporting several file formats (such as NSP, NRO, NACP, NXTheme, JPEG, tickets...), and with support for copying, pasting, renaming, deleting and creating files and directories.

  • Console memory browser: Same browser but to be used with NAND partitions, which also warns when writing or deleting content as it can be dangerous.

  • Remote PC browser: Via this feature, one can browse a PC's drives like any other filesystem, connected by a USB-C cable.

  • Content manager: Browse any kind of content in your SD card, console memory or game cartridge. You can browse all the NCAs, and as title options, you can remove the content, or export it as a NSP. NAND SYSTEM contents (system titles or contents) aren't allowed to be deleted. Invidual contents such as updates or DLC can be removed individually.

  • Ticket manager: Browse all tickets, both common and personalized. You can remove them, but an extra warning will be displayed when attempting to remove tickets being used by some content.

  • Web browser (web applets): Using the console's web applets, Goldleaf allows to search and navigate through web pages. If Goldleaf is launched through hbmenu as a NRO, WifiWebAuth applet will be used, which tends to fail sometimes, along with fewer features, such as lack of video support.

  • User account manager: Select a user account, and easily change things as the user's nickname or even delete it. Via the file browsers you can replace a user's icon with a JPEG image, but it can be a risky action. The icon needs to be a valid JPEG, with 256x256 dimensions. Goldleaf checks if the icon is valid to replace the other one.

  • Console information: Simple menu to see current firmware string, and the total free and occupied size on SD card and console memory.
Among all this features, Goldleaf is a very intuitive tool, with a fancy UI, and fully translated into 5 different languages: English, Spanish, German, French and Italian.

Common controls
  • (L-stick / D-pad) Move through the current menu

  • (R-stick) Move slightly faster through the current menu

  • (ZL / ZR) Show a dialog to shut down or reboot the console.
NRO version
  • (+ / -) Exit the application in order to return to hbmenu.
Disclaimer

NSP installs

Always keep in mind that installing NSPs can be a very easy way to get banned. If you use airplane mode and special DNSs like 90DNS, there is a smaller chance to get banned.

NEVER install untrusted NSPs. Goldleaf can identify (according to the NSP's application ID) whether the NSP is a homebrew NSP (IDs starting with "05", usually for forwarders), or a regular title (official ID range just allows IDs starting with "01")

Tickets

Tickets represent a game purchase, but technically speaking, you can't boot a title if the ticket isn't present (in case the title requires the ticket).

NSPs which don't have (nor require) a ticket are "standard crypto" NSPs. Standard-crypto titles aren't offical (usually reconverted content to avoid importing tickets).

Goldleaf will display whether a ticket is present or not, and if so, it's titlekey. Titlekeys are required to decrypt and access titles' content which require a ticket. Otherwise, they are undecryptable, hence unlaunchable by the system.

TL;DR: Always try to avoid untrusted NSPs, and if you go ahead and install CDN NSPs with tickets, avoid going online, or use special tools such as 90DNS, or you'll be banned for sure.

Forwarding

Goldleaf is released along with a NSP, in order to launch Goldleaf as an installed title, and take advantage of extra RAM and features such as web browsing.

The NSP is a forwarder since 0.6, what means that, instead of having Goldleaf's source inside the NSP, it simply loads the NRO from the SD card, meaning that only the NRO should be updated instead of having to reinstall the NSP.

Goldleaf's forwarding code tries to locate Goldleaf (Goldleaf.nro) in sd:/switch/ and sd:/switch/Goldleaf/. If it isn't found, an error message is displayed.

Settings

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

Sample

This is an example JSON for Goldleaf settings:

Code:
{
   "general": {
       "customLanguage": "es",
       "keysPath": "/switch/prod.keys",
       "externalRomfs": "/switch/Goldleaf/theme/rom"
   },
   "ui": {
       "background": "#aabbccdd",
       "base": "#aabbccdd",
       "baseFocus": "#aabbccdd",
       "text": "#aabbccdd",
       "menuItemSize": 80
   },
   "installs": {
       "ignoreRequiredFwVersion": true
   }
}

If a certain attribute isn't present Goldleaf will use default values. For colors, Goldleaf will initially load default light/dark themes according to the console's theme color, and later, colors present in the JSON will be used instead of default theme ones.

Notes

Via RomFs replacement, when Goldleaf tries to locate, for instance, romfs:/FileSystem/FileDataFont.ttf resource font, if romfsReplace is true and romfsReplacePath is, for instance, /switch/Goldleaf/testromfs, Goldleaf will look if sd:/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 which will be added in future updates.

Known bugs
  • On Atmosphère and SX OS, exiting Goldleaf via HOME menu (as a NRO) seems to crash the system on 7.x firmwares.

  • Remote PC browsing in general seems to have several bugs, most of them related to the UI system.
Contributing

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.

Translations

Read this before making any new translations:

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

  • UI (Plutonium) lacks special UTF16 characters, so some languages like Russian or Korean will not work, at least on the UI's current state.
Credits and support

Credits

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 from Icons8.

  • 2767mr, for all the support given in Goldtree.

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

  • shchmue and blawar for the system to get titlekeys without breaking processes, found in Lockpick.

  • Translators: unbranched and exelix for Italian, tiliarou and FuryBaguette for French, and LoOkYe and C4Phoenix for German.

  • All the testers, for reporting bugs and helping a lot with the project's development.
Discord server and beta testing

If you would like to be more informed about my projects' status and support, you should check my Discord server. It's a simple server for Nintendo hacking and homebrew, mainly focused on my projects. If you would like to be a beta-tester, then this is what you're looking for.

Enjoy this amazing homebrew!
 
Last edited by XorTroll, , Reason: 0.6 README changes

crissal

Well-Known Member
Member
Joined
Dec 3, 2017
Messages
137
Trophies
0
XP
585
Country
Italy
When launched as nro it didn't delete files nor folders, but as nsp works really well. BTW nice job!
EDIT: some random crashes even with nsp version, especially when entering some menus (config, about, ...) and then entering sd browser
 
Last edited by crissal,

Cyan

GBATemp's lurking knight
Former Staff
Joined
Oct 27, 2002
Messages
23,616
Trophies
2
Age
44
Location
Engine room, learning
XP
15,070
Country
France
Nice too see more features, like the theme installers or file browser :)
though, it might be dangerous to allow deleting files from partitions. Do you have proper warning and confirmation? maybe disable it by default, and force users to enable an option to allow deletion.
I wouldn't want to have to see lot of users requesting help because of bad usage of this feature.


more questions:
Did you implement a safety check for title installation?
permission check, or TitleID mask?

Does it work with split nsp files?
Is xci support planned?


general question:
anyone had issue with Zadig and libusbk on win7 x64?
I fear it would mess my current drivers or break Windows.
 
Last edited by Cyan,

XorTroll

Switching between my 2DS and my Switch
OP
Developer
Joined
Dec 28, 2017
Messages
636
Trophies
1
Location
Nowhere
Website
github.com
XP
4,105
Country
Spain
Nice too see more features, like the theme installers or file browser :)
though, it might be dangerous to allow deleting files from partitions. Do you have proper warning and confirmation? maybe disable it by default, and force users to enable an option to allow deletion.
I wouldn't want to have to see lot of users requesting help because of bad usage of this feature.


more questions:
Did you implement a safety check for title installation?
permission check, or TitleID mask?

Does it work with split nsp files?
Is xci support planned?


general question:
anyone had issue with Zadig and libusbk on win7 x64?
I fear it would mess my current drivers or break Windows.
There is no safety for title installing for the moment, but it does warn when the user attempts to delete or paste contents in NAND partitions
 

Gee19

Active Member
Newcomer
Joined
Dec 30, 2018
Messages
37
Trophies
0
Website
github.com
XP
203
Country
Canada
Been having a ton of trouble with USB installs lately. It would be sweet to investigate using a transaction to install NSPs so it could be resumed if any parts failed.

EDIT: Reinstalling libusbK via zadig seemed to help

I'd be willing to contribute on the C# side of things, anyway keep up the good work man.
 
Last edited by Gee19,

blawar

Developer
Developer
Joined
Nov 21, 2016
Messages
1,706
Trophies
1
Age
38
XP
4,271
Country
United States
Congrats on the release. Feels especially rewarding after a certain person claimed you picked up projects and dropped them without spending much time on them.

Looks real nice.

I noticed you didn't harp this project about lack of included licenses :) I thought you were the MIT / ISC license enforcer?

Nice release XorTroll, it looks well done. Do I have a license to copy everything?

--------------------- MERGED ---------------------------

This is the official replacement for Tinfoil, right? Great stuff.

There is no official replacement for Tinfoil, as noone uses tinfoil code (unless you ask @iriez )
 

hippy dave

BBMB
Member
Joined
Apr 30, 2012
Messages
7,807
Trophies
1
XP
11,540
Country
United Kingdom
Great work on the release!

It's a common issue for some NSPs, although they are completely valid ones, being detected as wrong NSPs. Although they can be really wrong NSPs, it is usually caused by firmware mismatch. For instance, in case you are trying to install a title which requires at least 5.1.0 version (which uses key generation 4) on a lower firmware version, it won't be recognised as a valid NSP for cryptographical reasons. (the console cannot decrypt the NSP because it is encrypted with unknown keys which are within 5.1.0 update)
Couldn't you detect this (read the required key generation from the nsp and compare to current firmware), and give a more specific error?

I second the request for a dark theme, and you know I'm gonna keep bugging you about mac support for goldtree! Keep up the good work.
 
  • Like
Reactions: wicksand420

blawar

Developer
Developer
Joined
Nov 21, 2016
Messages
1,706
Trophies
1
Age
38
XP
4,271
Country
United States
Great work on the release!


Couldn't you detect this (read the required key generation from the nsp and compare to current firmware), and give a more specific error?

I second the request for a dark theme, and you know I'm gonna keep bugging you about mac support for goldtree! Keep up the good work.

Horizon does not expose the NCA header when mounting like he is doing, so there is no way for him to read the master key level. If the user provides keys.txt / prod.keys, he could go well out of his way to decrypt the header and try to figure out what is wrong, but that is a lot of work for very little gain.

He could try to make an assumption that the master key level for the nca's is the same as the ticket or rights id, but this is not always the case.
 
General chit-chat
Help Users
    KenniesNewName @ KenniesNewName: https://www.pcgamer.com/it-admin-gets-7-years-for-wiping-his-companys-servers-to-prove-a-point/?f...