Getting Started

Megaton is a build tool and library for linking and patching NX modules at runtime.

Credits:

• exlaunch for the hooking and patching framework megaton is based on.

Prerequisites

Make sure you have these installed:

• git
• Rust toolchain (cargo)

These are just for installing the tool. The tool itself requires other tools to function, which you can install later.

Install

1. First, clone the repository to where you want to install the tool

   git clone https://github.com/Pistonite/megaton path/to/install
   cd path/to/install
   

2. Build the tool

   cargo run --release --bin megaton-buildtool -- install
   

3. Add the bin directory to your PATH. For example, add the following to your shell profile:

   export PATH=$PATH:path/to/install/bin
   

4. Finish the installation

   megaton install
   

Update

To update the tool in the future, you can run install with -u/--update flag:

megaton install -u

This will git pull the repository and rebuild the tool.

Check Environment

To check that you have the necessary tools installed, run

megaton checkenv

This will check for additional tools required to build projects