Skip to content

sermuns/ironfoil

Repository files navigation

ironfoil logo

A tool to transfer to many title installers.

Exists both as a GUI and CLI app.

gui screenshot1 gui screenshot2 Screenshots from ironfoil-gui


cli demo Demo of ironfoil, the core CLI application


Which title installers are supported?

Using the TinFoil USB protocol, I have tested:

and also:

  • Sphaira, with its own protocol (make sure you enable Sphaira support when transferring!)

Installation

Important

Make sure to download the right variant for you. The graphical ironfoil-gui, might be what you're looking for...

Installing the GUI (ironfoil-gui)

...

Installing the CLI (ironfoil)

Alternatives:

  1. Manually download latest release and extract the tool to a location that is in your $PATH.

  2. Use cargo-binstall:

    cargo binstall ironfoil
  3. Install latest release using cargo (compile from source)

    cargo install ironfoil

Usage for the CLI

ironfoil --help

Transfer to NS title installers from the command-line

Usage: ironfoil <COMMAND>

Commands:
  usb      Transfer over USB
  network  Transfer over network
  rcm      Inject RCM payload
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

ironfoil usb --help

Transfer over USB

Usage: ironfoil usb [OPTIONS] <GAME_BACKUP_PATH>

Arguments:
  <GAME_BACKUP_PATH>  Path to a game backup file or directory containing game backup files

Options:
  -r, --recurse  Whether to recursively look for files (only for directories)
      --sphaira  If transferring to Sphaira homebrew menu
  -h, --help     Print help

ironfoil network --help

Transfer over network

Usage: ironfoil network [OPTIONS] <GAME_BACKUP_PATH> <TARGET_IP>

Arguments:
  <GAME_BACKUP_PATH>  Path to a game backup file or directory containing game backup files
  <TARGET_IP>         The IP address of the Nintendo Switch

Options:
  -r, --recurse  Whether to recursively look for files (only for directories)
  -h, --help     Print help

ironfoil rcm --help

Inject RCM payload

Usage: ironfoil rcm <PAYLOAD_PATH>

Arguments:
  <PAYLOAD_PATH>  Path to the RCM payload file

Options:
  -h, --help  Print help

License

Dual-licensed under Apache 2.0 or MIT.

About

Transfer to many Nintendo Switch title installers

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages