0.17.0-1 2026-04-10

Release Notes

This release is a hotfix for 0.17.0, which fixes conversions from the old pending
deployment log format to the new one.

Fixed

• Fixed a crash on program bootup, related to path traversal when converting
  old pending logs to new ones when the old logs contain an empty path

Install ukmm 0.17.0-1

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/NiceneNerd/ukmm/releases/download/v0.17.0-1/ukmm-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -ExecutionPolicy Bypass -c "irm https://github.com/NiceneNerd/ukmm/releases/download/v0.17.0-1/ukmm-installer.ps1 | iex"

Download ukmm 0.17.0-1

File	Platform	Checksum
ukmm-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
ukmm-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
ukmm-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
ukmm-x86_64-pc-windows-msvc.msi	x64 Windows	checksum
ukmm-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum

0.17.0 - 2026-04-09

Release Notes

This release includes multiple breaking changes to the UKMM mod format. This means
that you will need to reinstall and/or repackage all existing UKMM mods that edit
map files or AnimSeq ("animation sequence," or bas) files, to avoid errors.

Added

• MainField Static merger. Fixes various issues with installing bnps that edit
  the file, including the disappearance of safe zones around the game world
  • This is a breaking change. Any mod that edits Map/MainField/Static.smubin
    will need to be reinstalled from a loose file or bnp package.
• New AnimSeq merger. Runs on highest-priority-wins rules, to avoid as many issues
  as possible. Compatibility patches should be made for animation-changing mods.
  Also contains several checks for AnimSeq files to ensure they are not missing data
  or crash due to cyclic or index-out-of-bounds errors.
  • This is a breaking change. Any mod that edits any Actor/AS/<some_name>.bas file
    will need to be reinstalled from a loose file or bnp package.
• Support for mods packaged as rar files
• Thanks @Clonephaze for 2 new features:
  • Russian, Japanese, Korean, Arabic, Viet localization. All of these were done
    with AI, so if you don't like the translations, feel free to open a PR
    • Note: Localization is the only thing AI will ever be used for in this project
  • UI breadcrumbs, for pointing the user toward the settings tab, if they somehow
    miss the intro dialog popup

Changed

• Changed cemu settings importer to populate the emulator executable path with
  a path that will boot directly into BotW, skipping the game list, if the dump
  is in the unpacked format. Otherwise, it will populate it with a path that will
  open cemu to the game list
• Added quotes to the executable command on Windows or when the path has spaces in
  it, to ensure that Powershell doesn't vomit all over a completely valid path
• Rewrote the file subsystem. Files will now only be searched for once, in the
  exact location they're supposed to be located at
• Logs have been cleaned up considerably. Only one log file will be used, and it
  will only store info from the current or most recent session. Various changes have
  been made to reduce the amount of unnecessary log spam
• Added context to unwraps during merging, in case they fail
• Added context to various bnp map rebuild operations, in case they fail
• Set top-level error message to tell the user to expand the details, so that people
  stop thinking that all errors are the same error just because the top-level message
  is the same
• Better support for detecting meta information for 7z and rar packaged mods
• Better support for detecting mod root directories for zip, 7z, and rar mods
• Made missing loc keys pull from English instead of displaying the loc key, itself.
  • This will become more important as I try to replace further messages, like error
    messages, with localized strings. ETA on that is TBD.
• Changed intro dialog window write-up, for more clarity on first usage or when
  settings have not yet been set
  • Thanks @Clonephaze
• Gracefully handle IPC socket claim errors. Allows multiple instances of UKMM to
  run at the same time, though I'm not sure why you'd ever want to do that

Fixed

• Fixed profile validation when dual-booting multiple operating systems, where
  both systems are reading from the same effective storage folder. For example,
  if Windows reads from %LocalAppData%/ukmm, and another operating system has
  a symbolic link to read from that same folder, then UKMM will reconstruct mod
  paths on boot, to ensure that you can properly merge from both systems
• Fixed the program displaying at the wrong DPI when using Wayland, e.g. on steamOS
• Reordered bnp map conversions, so modifications apply to the right map instances
• Made sure DeleteSets actually deleted the things marked for deletion. Whoops!
  Fixes various merge errors in BoneControl, ActorLink, and other files
• Fixed copy mode trying to copy folders using code for copying files
• Fixed hard link mode trying to hard link folders
• Fixed how partial deployment determines if a file is changed, so that only files
  that were actually changed are updated
• Fixes a rare error where some files with no header in their format would be
  recognized as byml files instead of binary
• Fixed various deployment errors, reimplemented partial deployment
• Fixed egui assertion failures in debug mode caused by invalid widget sizes
  (NaN or negative values). All size values passed to egui are now validated
  to ensure they are finite and non-negative

Install ukmm 0.17.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/NiceneNerd/ukmm/releases/download/v0.17.0/ukmm-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -ExecutionPolicy Bypass -c "irm https://github.com/NiceneNerd/ukmm/releases/download/v0.17.0/ukmm-installer.ps1 | iex"

Download ukmm 0.17.0

File	Platform	Checksum
ukmm-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
ukmm-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
ukmm-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
ukmm-x86_64-pc-windows-msvc.msi	x64 Windows	checksum
ukmm-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum

0.15.0 - 2024-08-29

Temporary notice: UKMM download moved until v0.17.0

Due to repo collaborator status timing, v0.16.0 was released on this fork. Plans are underway to move the
downloads back to this repo as the official location again for v0.17.0 and
beyond. When that happens, the automatic updater included in both that repo
and this one will point back to this repo for further updates.

Release Notes

This release is fairly significant and includes multiple breaking changes to
the UKMM mod format. This means there is a high likehood that you will need to
reinstall and/or repackage existing UKMM mods to avoid errors. Ideally, this
should be the last breaking release before stabilizaiton.

Added

• Added support for new Cemu config paths
• Experimental support for arm64 macOS
• Added support for complex emulator command lines

Changed

• Switched to symlink deployment by default for Cemu
• Minor performance improvements

Fixed

• Fixed settings refresh after BCML migration
• Fixed broken symlink on switching profiles
• Fixed issues with language differences in text merging
• Fixed issues with StatusEffectList and LevelSensor mergers. This is a
  breaking change which requires reinstalling mods which modify StatusEffectList
  or LevelSensor.
• Reverted msyt version to fix BNP compatibility. This is a reversion of an
  unintentional breaking change in the last release. It will require
  reinstalling mods which modify game texts.

Removed

• Removed merging for actor recipes (.brecipe). Diffs will be stored whole and
  merging will simply overwrite with the highest priority. This is a breaking
  change which requires reinstalling all mods which modify recipe files.

Install ukmm 0.15.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/NiceneNerd/ukmm/releases/download/v0.15.0/ukmm-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -c "irm https://github.com/NiceneNerd/ukmm/releases/download/v0.15.0/ukmm-installer.ps1 | iex"

Download ukmm 0.15.0

File	Platform	Checksum
ukmm-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
ukmm-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
ukmm-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
ukmm-x86_64-pc-windows-msvc.msi	x64 Windows	checksum
ukmm-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum

0.13.0 - 2024-07-28

Release Notes

This release adds GameBanana 1-click support. It can be registered to open BCML links. Just click Register 1-Click Handler in the settings page.

Added

• Added full GameBanana 1-click and "open mod with UKMM" support
• Added Refresh button to file picker
• Added specific error about mods made with old roead versions

Fixed

• Fixed crash when reopening tabs closed by their buttons
• Fixed rare race condition with mod packaging

Removed

• Removed everything related to the mod editor tool, which will probably never
  be finished

Install ukmm 0.13.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/NiceneNerd/ukmm/releases/download/v0.13.0/ukmm-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -c "irm https://github.com/NiceneNerd/ukmm/releases/download/v0.13.0/ukmm-installer.ps1 | iex"

Download ukmm 0.13.0

File	Platform	Checksum
ukmm-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
ukmm-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
ukmm-x86_64-pc-windows-msvc.msi	x64 Windows	checksum
ukmm-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum

0.12.1

Release Notes

Added

• Added cargo dist integration to provide simpler install and update methods

Fixed

• Restored missing Package button to Window menu
• Fixed option descriptions not showing on multiple choice
• Fixed misidentification of Switch BNPs with a rules.txt as Wii U mods

Install ukmm 0.12.1

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/NiceneNerd/ukmm/releases/download/v0.12.1/ukmm-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -c "irm https://github.com/NiceneNerd/ukmm/releases/download/v0.12.1/ukmm-installer.ps1 | iex"

Download ukmm 0.12.1

File	Platform	Checksum
ukmm-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
ukmm-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
ukmm-x86_64-pc-windows-msvc.msi	x64 Windows	checksum
ukmm-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum

Forgiveness and mercy

This release should make it easier to use mods with various minor errors. UKMM will warn you and let it pass more than it used to.

Added

• Added experimental "binary override," as-is storage of technically invalid
  resources for mods which work despite minor "errors"

Changed

• Completely reworked logger using egui_logger, hopefully more performant and
  maintainable
• Switched some Arcs to Rcs where possible

Why am I making it easier to use BNPs? Because I'm too nice, or so I've been told.

Changed

• Stopped caching open directory contents so the file picker is accurate after
  the app restarts

Fixed

• Fixed serious issues with reinflating BNPs with options
• Fixed parsing numeric strings in BCML 2.x deepmerge.yml files

Full Changelog: v0.11.0...v0.11.1

After most of a school year

Added

• Added update mod button for developers
• Added GUI error message for startup panics

Changed

• Switched back from a custom fork of egui to the latest official version.
  This brings some minor unwanted UI changes, but nothing, I think, that
  affects anything functionally.

Fixed

• Fixed possible errors with missing game languages

Full Changelog: v0.10.1...v0.11.0

Beta v0.10.1

Added

• Added open folder buttons to tool menu
• Added button to open emulator per-deployment config

Changed

• Use dictionary for ZSTD compression

Fixed

• Fixed missing AocMainField.pack in some map mods
• Minor patches to gamedata handling

Beta v0.10.0

Added

• Added button to extract mods back into full files (graphic pack/RomFS)
• Added mod API versioning to better handle format changes across versions

Changed

• Breaking change: Updated to the newest version of roead, which supports
  BYML versions 5-7. This means all mods that edit BYML files may need to be
  reinstalled, which is perhaps a majority of mods. (The good news is this will
  make TOTK support easier to add in the future.)
• Updated to work on the stable Rust compiler, nightly no longer required.

Fixed

• Fixed "no base or DLC content folder" on some Switch mods
• Fixed panic parsing map logs with deletions in BNPs
• Fixed weird gamedata flag issue on some BNPs
• Updated RSTB library to fix mystery panics