DotNet3dsToolkit

From Pikmin Technical Knowledge Base
Jump to navigation Jump to search
Tested environments
For the purposes of editing Pikmin game files, the following environments have been tested.
Version 1.4.6, Windows 7 Works with errors that can be ignored
Version 1.4.6, Ubuntu 16 under Wine Works with errors that can be ignored

DotNet3dsToolkit is a set of tools that can extract and rebuild 3DS games in various formats. It can be used to extract Hey! Pikmin's files and rebuild the game, allowing it to be played on Citra.

Download

  • GitHub
    • Note: From the time of writing this (September 2017), the latest versions on the Releases page do not have a built binary. You can either compile the latest versions from scratch, or you can obtain the latest available binary, the one from version 1.4.6.

Use

The toolkit can be used as a library, but it's easier to use the console application, ToolkitConsole.exe. You can run the application without arguments and it will explain the usage format, or you can read the following sections for specific instructions.

Extracting a .3ds file

Open a command line, navigate to the DotNet3dsToolkit's folder, and run ToolkitConsole.exe <path to the 3DS file> <path to the folder where the files will be dumped>. For example, if your .3ds file is in C:\Users\A\heypikmin.3ds, and you want to dump the files into C:\Users\A\Hey! Pikmin files, write ToolkitConsole.exe C:\Users\A\heypikmin.3ds "C:\Users\A\Hey! Pikmin files". This will start the extraction process. Simply wait for it to finish, and then go check your dumped files folder, and open the RomFS folder, since that contains the actual files of the game's content.

Rebuilding a .3ds file

The command you run is similar to the extraction one, except the two arguments are in reverse order – folder with the contents first, final .3ds file second. You may want to save the game into a different 3DS file from the original you had, though. An example on the command you have to run, following the same logic as before: ToolkitConsole.exe "C:\Users\A\Hey! Pikmin files" C:\Users\A\modded_heypikmin.3ds. This will create a 3DS file with your changes.

During the rebuild process, some errors might pop up, like [3dstool] ERROR: open file <game data folder>\HeaderNCCH2.bin failed [3dstool] ERROR: create file failed. So far, the .3ds file was always generated successfully anyway, so these errors can be safely ignored.