Skip to content

TOTK_ROMFS_EDITOR_V6.0.2_ENGLISH

Choose a tag to compare

@Renaf2 Renaf2 released this 22 Jun 17:56

====================================================================
๐Ÿ—ก๏ธ TOTK ROMFS EDITOR โ€“ Final Version
Tool for modifying Zelda games (TotK, BotW, LA)

Windows x64 French Download the .Zip file ; English Version Coming soon

๐Ÿ“Œ WHAT IS THIS TOOL FOR?

This tool allows you to modify the internal files of Zelda
games on Switch (Tears of the Kingdom, Breath of the Wild,
Link's Awakening). It is designed to be simple and intuitive,
even for beginners.

With it, you can:
โ€ข Modify weapon, armor and item statistics
(damage, durability, price, etc.)
โ€ข Change in-game names, descriptions and dialogues
โ€ข Activate or deactivate mods with one click
โ€ข Apply modifications in batch across multiple files
โ€ข Navigate through .sarc, .zs and .pack archives
โ€ข Visually edit BYML files (without writing code)

๐ŸŽฎ COMPATIBLE GAMES

โ€ข Tears of the Kingdom (TotK) โ€“ default
โ€ข Breath of the Wild (BotW) โ€“ selectable in the interface
โ€ข Link's Awakening (LA_NS) โ€“ selectable in the interface

โš™๏ธ HOW TO USE THE APPLICATION?

  1. Launch TOTK_Romfs_Editor.exe
  2. Choose your game from the toolbar (at the top)
  3. Click on "๐Ÿ“‚ Browse" to open your ROMFS folder
  4. In the file tree, double-click on:
    โ€ข An archive (.sarc, .zs) โ†’ to view its content
    โ€ข A file (.byml, .msbt) โ†’ to edit it
  5. Modify the values, then click "๐Ÿ’พ Save"
  6. Changes are immediately applied to the ROMFS

โš ๏ธ BEFORE DUMPING YOUR ROMFS

โ— WARNING: For your modifications to work,
you MUST enable Updates and DLC
in your emulator's mod manager (Citron, Ryujinx)
BEFORE dumping the ROMFS.

Without this, modified files may be incompatible
with your game version.

๐Ÿ“ OBTAINING A ROMFS

โ€ข From Citron / Ryujinx:
Right-click on the game โ†’ "Dump ROMFS"
(Make sure Updates and DLC are checked)

โ€ข From a modded Switch:
Use a tool like NX-DumpTool or hactool

๐Ÿ”ง DETAILED FEATURES

๐Ÿ  Home
โ†’ Visual guide to get started

๐Ÿ“ฆ Mod Manager
โ†’ Activate/deactivate your mods with one click
โ†’ Automatic conflict detection between mods

โšก Batch Patch
โ†’ Modify values in bulk (e.g.: increase defense
of all armors by 10)
โ†’ Simple syntax: attack = 50, defense += 10, etc.

๐Ÿ“ MSBT Editor
โ†’ Edit game texts (dialogues, names, descriptions)
โ†’ Syntax highlighting for better readability

๐Ÿ”ข Visual BYML Editor
โ†’ Modify statistics without writing code
โ†’ Checkboxes, spinboxes, text fields

๐Ÿ“‚ Archive Explorer
โ†’ Browse through .sarc, .zs, .pack files
โ†’ Extract and replace files in a few clicks

๐Ÿ”Ž Find & Replace
โ†’ Find text in open files
โ†’ Replace one or multiple times

๐Ÿ“ค Batch MSBT Export/Import
โ†’ Export all game texts to .txt
โ†’ Translate or modify files in a text editor
โ†’ Re-import with one click

๐Ÿ› ๏ธ COMPILATION (for developers)

If you wish to compile the tool from source code:

  1. Install Python 3.12
  2. Create a virtual environment:
    python -m venv venv
    venv\Scripts\activate
  3. Install dependencies:
    pip install -r requirements.txt
  4. Compile with PyInstaller:
    pyinstaller --windowed --name "TOTK_Romfs_Editor" TOTK_ROMFS_EDITOR_FINAL.py
  5. Copy the .pyd file next to the exe:
    copy venv\Lib\site-packages\oead.cp312-win_amd64.pyd dist\TOTK_Romfs_Editor\oead.pyd

๐Ÿ“ฆ FOLDER CONTENTS

TOTK_Romfs_Editor.exe โ†’ The main application
oead.pyd โ†’ Essential library (must be kept next to the exe)
README.txt โ†’ This instructions file

โ“ KNOWN ISSUES AND SOLUTIONS

โ€ข The application does not open or shows an oead error?
โ†’ Make sure the oead.pyd file is in the same folder as the exe.

โ€ข ROMFS does not open or .zs files are unreadable?
โ†’ Ensure that the ZsDic.pack.zs file is present in the Pack/
folder of your ROMFS. Without this file, .zs archives cannot be read.

โ€ข Changes do not apply in the game?
โ†’ Make sure you dumped the ROMFS with Updates and DLC enabled.
โ†’ Ensure the game is using the modified ROMFS (not a hidden copy).

โ€ข The application is slow or laggy?
โ†’ Archives of several GB (like Bootup.pack.zs) can take time
to open. Be patient during the first load (caching will speed up
subsequent openings).

๐Ÿ“Œ TIPS FOR BEGINNERS

โ€ข To modify armor, look for Armor_*.byml files
in the file tree (e.g.: Armor_001.bgyml).

โ€ข To modify weapons, look for Weapon_*.byml files.

โ€ข To modify texts, look for .msbt files.

โ€ข Use the Mod Manager to activate/deactivate your modifications
without having to manually copy/paste files.

โ€ข The Batch Patch is very useful for balancing the entire game at once
(e.g.: increase damage of all swords by 20%).

๐Ÿ“œ LICENSE

This tool is distributed under an open-source license (GPLv2).
It is provided "as is", without any warranty.
It is intended for personal and educational use.

The user is responsible for their use of this tool
and any modifications they make to the games.

๐Ÿ†˜ SUPPORT AND CONTRIBUTIONS

โ€ข Report a bug: https://github.com/yourusername/totk-romfs-editor/issues
โ€ข Suggest an improvement: https://github.com/yourusername/totk-romfs-editor/pulls
โ€ข Documentation: https://github.com/yourusername/totk-romfs-editor/wiki

๐Ÿ™ ACKNOWLEDGMENTS

โ€ข oead โ€“ for the parsing library
โ€ข PyQt5 โ€“ for the graphical interface
โ€ข The Zelda Modding community โ€“ for feedback and inspiration
โ€ข Claude AI, DeepSeek, Gemini Free Version
โ€ข You โ€“ for using this tool and helping improve it!

====================================================================
Happy modding, and have fun! ๐Ÿ—ก๏ธ