An hmod is either a folder ending in ".hmod" or a gzip-compressed tar archive with the ".hmod" file extension.
All folders and files in the hmod with the exception of any readme, install, or uninstall script will be copied to
$rootfs unless the install script for the hmod returns a non-zero exit code.
If this script returns a non-zero exit code, the hmod files will not be copied to
This script will be run during hmod uninstall, and a list of files copied to
$rootfs will automatically be appended to the uninstall script for removal.
If you do not wish to have an uninstall script generated, you can make a file with the contents of
During hmod install, a variable of
$transferpath will be available and will contain the path containing the data for the hmod currently being installed.
As an example, the
advanced_music_hack.hmod is structured as follows:
advanced_music_hack.hmod │ readme.md │ ├───etc │ └───preinit.d │ bb223_advanced_music_hack │ pb223_advanced_music_hack │ └───usr └───share └───advanced_music_hack bgm_boot.wav
In this example, the hmod's structure matches that of the SNES Mini's file structure and, as there is no
install script, the structure will be directly replicated on
In other cases, an
install script can be used to copy files to other folders, such as those where the path is region-specific and a custom variable needs to be defined.