Installation

Prerequisites

  • Megaton requires DevKitA64 from DevKitPro. (Select the switch-dev group)

    Todo

    TODO Add info about how megaton searches for DKP installation

  • For Rust support (building mods written in Rust), a Rust toolchain for the host system (i.e. the system used to build the mod) and git are required to clone and build the Rust compiler for the aarch64-unknown-hermit target.

Install Megaton

The megaton CLI is a single binary, which can be installed in 3 ways:

Todo

TODO These don’t work yet

  1. (Recommended) Install from prebuilt binary with cargo-binstall 
    cargo binstall megaton-cmd --git https://github.com/Pistonite/megaton
  2. Install from source with cargo 
    cargo install megaton-cmd --git https://github.com/Pistonite/megaton
  3. Download the binary from the latest release on GitHub

Install Megaton Rust Toolchain

Megaton implements the Hermit ABI to bind Rust Standard Library to NNSDK. This requires a custom Rust toolchain. Megaton will install this toolchain at ~/.cache/megaton/rust-toolchain.

This toolchain is locked at a commit for every Megaton version. This will be bumped approximately in line with Rust’s stable release. If you need Rust feature in a higher version of Rust than what is included with Megaton, please open an issue on GitHub.

Run the following command to install the toolchain, or upgrade the toolchain in the future

megaton toolchain install

Note

This compiles LLVM and bootstraps the Rust compiler, which will take a while. To keep the build artifact, use the -k/--keep flag: megaton toolchain install -k. This will make it faster to rebuild the toolchain in the future when upgrading. However, this will consume 10-20GB of disk spaces.

You can check if the toolchain is installed with

megaton toolchain check

Or directly with rustc (megaton is the name of the toolchain)

rustc +megaton -vV

Upgrading

To upgrade megaton, simply reinstall the latest version with cargo/cargo-binstall, or replace the binary with the latest release on GitHub if you installed it manually.

To upgrade the custom Rust toolchain, run megaton toolchain install after upgrading megaton.