MSBT Editor Reloaded 3DS: Difference between revisions

From GameBrew
No edit summary
No edit summary
Line 15: Line 15:
Hey there gbatemp,
Hey there gbatemp,


<span style="font-size: 26px">'''<span style="color: #ff0000">Notice:</span> [https://gbatemp.net/threads/release-kuriimu-a-general-purpose-game-translation-toolkit-for-authors-of-fan-translations.452375/ For a more advanced and complete MSBT solution, check out Kuriimu.]'''</span>
For a more advanced and complete MSBT solution, check out [[Kuriimu 3DS]]


I created this editor a while ago to support a translation project I was planning; Which is now cancelled since Picross 3D 2 is slated for a North American release. It has since grown beyond anything I could have imagined and is now used by many in the modding community on all sorts of projects. I hope you find it useful in your own projects!
I created this editor a while ago to support a translation project I was planning; Which is now cancelled since Picross 3D 2 is slated for a North American release. It has since grown beyond anything I could have imagined and is now used by many in the modding community on all sorts of projects. I hope you find it useful in your own projects!


Credit is welcome. [[File:styles/default/xenforo/clear.png|class=mceSmilieSprite mceSmilie2|;)]]
Credit is welcome.


[[File:proxy.php?image=http%3A%2F%2Fsx.sytes.net%2Fmsbt%2Fpreview.png&hash=2a47e8776ef3c64777283ce7988dcc54|class=bbCodeImage LbImage|[?IMG]]]
https://dlhb.gamebrew.org/3dshomebrew/MSBTEditorReloaded.jpg


<span style="font-size: 26px">'''Releases'''</span>
==Changelog===
 
[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.8 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.8'''</span>]


'''MSBT Editor Reloaded v0.9.8'''


* Fixed CSV exporting.
* Fixed CSV exporting.
Line 32: Line 31:
'''Older Changelog Entries:'''
'''Older Changelog Entries:'''


 
'''MSBT Editor Reloaded v0.9.7b'''
<div class="ToggleTriggerAnchor bbCodeSpoilerContainer">
 
<span>Spoiler</span>
<div class="SpoilerTarget bbCodeSpoilerText">
 
[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.7b <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.7b'''</span>]


* Fixed the BG4 extraction menu not showing up.
* Fixed the BG4 extraction menu not showing up.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.7 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.7'''</span>]
'''MSBT Editor Reloaded v0.9.7'''


* Finally corrected the label renaming bugs.
* Finally corrected the label renaming bugs.
** v0.9.7 will correct broken files that were previously broken by v0.9.6 and v0.9.5b. Just open the broken file and then click save to fix it. Broken files created by v0.9.5 and below can not currently be fixed with the program. Contact me directly if you need your heavily modified file fixed so you don't lose any work.
** v0.9.7 will correct broken files that were previously broken by v0.9.6 and v0.9.5b. Just open the broken file and then click save to fix it. Broken files created by v0.9.5 and below can not currently be fixed with the program. Contact me directly if you need your heavily modified file fixed so you don't lose any work.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.6 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.6'''</span>]
'''MSBT Editor Reloaded v0.9.6'''


* Added the Export Mod feature for XMSBT files.
* Added the Export Mod feature for XMSBT files.
** Export the differences between two MSBT files to an XMSBT delta file.
** Export the differences between two MSBT files to an XMSBT delta file.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.5b <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.5b'''</span>]
'''MSBT Editor Reloaded v0.9.5b'''


* Actually fixed the label length bug this time. Label renaming wasn't updating the length value.
* Actually fixed the label length bug this time. Label renaming wasn't updating the length value.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.5 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.5'''</span>]
'''MSBT Editor Reloaded v0.9.5'''


* Added links to the GBAtemp thread as well as the GitHub page.
* Added links to the GBAtemp thread as well as the GitHub page.
Line 65: Line 58:
* Allowed other software to read (not write) the currently open MSBT file at the same time.
* Allowed other software to read (not write) the currently open MSBT file at the same time.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.4 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.4'''</span>]
'''MSBT Editor Reloaded v0.9.4'''


* Implemented batch import and export for XMSBT files.
* Implemented batch import and export for XMSBT files.
Line 74: Line 67:
* Fixed a bug with UMSBT extraction where the overwrite choice was being ignored.
* Fixed a bug with UMSBT extraction where the overwrite choice was being ignored.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.3 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.3'''</span>]
'''MSBT Editor Reloaded v0.9.3'''


* Added the new XMSBT translation tools.
* Added the new XMSBT translation tools.


XMSBT files are XML files that contain the labels and text from an MSBT file. The strings are stored on separate lines so that the files are source control friendly. This gives fan translation authors the ability to collaborate on the same file without having to manually merge the changes from multiple translators as most source control solutions will take care of merging.
XMSBT files are XML files that contain the labels and text from an MSBT file. The strings are stored on separate lines so that the files are source control friendly.
[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.2 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.2'''</span>]
 
This gives fan translation authors the ability to collaborate on the same file without having to manually merge the changes from multiple translators as most source control solutions will take care of merging.
 
'''MSBT Editor Reloaded v0.9.2'''


* Added null byte support via &quot;\0&quot; for control characters in the text.
* Added null byte support via &quot;\0&quot; for control characters in the text.
Line 92: Line 88:
* Removed the Preview box as the full string is now visible in the Edit box.
* Removed the Preview box as the full string is now visible in the Edit box.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.1 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.1'''</span>]
'''MSBT Editor Reloaded v0.9.1'''


* Added the new Search Directory feature.
* Added the new Search Directory feature.
* Fixed user settings not saving properly.
* Fixed user settings not saving properly.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.9.0 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.9.0'''</span>]
'''MSBT Editor Reloaded v0.9.0'''


* Added the ability to add and remove labels in MSBT files!
* Added the ability to add and remove labels in MSBT files!
* Fixed the LZ11 windows not appearing.
* Fixed the LZ11 windows not appearing.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8.6 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8.6'''</span>]
'''MSBT Editor Reloaded v0.8.6'''


* Added support for managing UMSBT archives.
* Added support for managing UMSBT archives.
Line 109: Line 105:
** LZ11 Compression windows do not appear.
** LZ11 Compression windows do not appear.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8.5 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8.5'''</span>]
'''MSBT Editor Reloaded v0.8.5'''


* Added support for the ATO1 section.
* Added support for the ATO1 section.
* Now supports Miitomo.
* Now supports Miitomo.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8.4 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8.4'''</span>]
'''MSBT Editor Reloaded v0.8.4'''


* Added support for UTF8 encoded MSBT files.
* Added support for UTF8 encoded MSBT files.
* Now supports Art Academy and Detective Pikachu.
* Now supports Art Academy and Detective Pikachu.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8.3 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8.3'''</span>]
'''MSBT Editor Reloaded v0.8.3'''


* Added a search feature to find strings in the file.
* Added a search feature to find strings in the file.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8.2 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8.2'''</span>]
'''MSBT Editor Reloaded v0.8.2'''


* Added a new icon for the BG4 Extraction tool.
* Added a new icon for the BG4 Extraction tool.
Line 129: Line 125:
* Patched my BigEndian reading class. Fixes support for large BigEndian files in Super Smash Bros 3DS/WiiU.
* Patched my BigEndian reading class. Fixes support for large BigEndian files in Super Smash Bros 3DS/WiiU.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8.1 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8.1'''</span>]
'''MSBT Editor Reloaded v0.8.1'''


* More fully reverse engineered the BG4 format. BG4 extraction success is basically 100% now.
* More fully reverse engineered the BG4 format. BG4 extraction success is basically 100% now.
Line 138: Line 134:
* Added some minor exception handling checks.
* Added some minor exception handling checks.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.8 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.8'''</span>]
'''MSBT Editor Reloaded v0.8'''


* Added support for Mario &amp; Luigi Paper Jam MSBT files.
* Added support for Mario &amp; Luigi Paper Jam MSBT files.
* Added a tool to extract files from BG4 archives. An M&amp;LPJ archive format containing MSBT files.
* Added a tool to extract files from BG4 archives. An M&amp;LPJ archive format containing MSBT files.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.7 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.7'''</span>]
'''MSBT Editor Reloaded v0.7'''


* Added some error handling to correct files that were edited with v0.4.
* Added some error handling to correct files that were edited with v0.4.
Line 149: Line 145:
* When saving, the Original entries now get updated without reloading the file.
* When saving, the Original entries now get updated without reloading the file.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.6 <span style="font-size: 15px">'''MSBT Editor Reloaded v0.6'''</span>]
'''MSBT Editor Reloaded v0.6'''
'''
 
Read and Write accuracy is now 100%'''
Read and Write accuracy is now 100%'''


Line 161: Line 157:
* Ctrl+A now works on all text boxes including the hex view.
* Ctrl+A now works on all text boxes including the hex view.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.5-beta <span style="font-size: 15px">'''MSBT Editor Reloaded v0.5 Beta'''</span>]
'''MSBT Editor Reloaded v0.5 Beta'''


* Added support for sub strings. Certain MSBT files contain null bytes in between string offsets.
* Added support for sub strings. Certain MSBT files contain null bytes in between string offsets.
Line 170: Line 166:
* Patched saving so that the section size is correctly written to the file.
* Patched saving so that the section size is correctly written to the file.


[https://github.com/IcySon55/3DLandMSBTeditor/releases/tag/v0.4-beta <span style="font-size: 12px"><span style="font-size: 15px">'''MSBT Editor Reloaded v0.4 Beta'''</span></span>]
'''MSBT Editor Reloaded v0.4 Beta'''


* Initial release with basic MSBT support and a few bugs.
* Initial release with basic MSBT support and a few bugs.


 
==Planned Feature(s)==
</div>
 
</div>
 
'''<span style="font-size: 15px">Planned Feature(s)</span>'''
 
 
* Creating MSBT files from scratch.
* Creating MSBT files from scratch.


'''<span style="font-size: 15px">Supported MSBT Sections</span>'''
==Supported MSBT Sections==
 
 
* LBL1 - Full support.
* LBL1 - Full support.
* NLI1 - Preliminary support. Most content is unknown.
* NLI1 - Preliminary support. Most content is unknown.
Line 194: Line 181:
* TXT2 - Full support.
* TXT2 - Full support.


'''<span style="font-size: 15px">Supported Games</span>'''
==Supported Games==
 
 
* Super Mario 3D Land - Not tested.
* Super Mario 3D Land - Not tested.
* Mario Kart 7 - Supported.
* Mario Kart 7 - Supported.
Line 212: Line 197:
* Others may be supported, need feedback.
* Others may be supported, need feedback.


<span style="font-size: 15px">'''XMSBT Translation Tools'''</span>
==XMSBT Translation Tools==
 
 
* This is the MSBT translator's dream feature! This format allows translators to work together and collaborate on the same file(s) without losing any work due to files being overwritten or files being impossible to merge easily.
* This is the MSBT translator's dream feature! This format allows translators to work together and collaborate on the same file(s) without losing any work due to files being overwritten or files being impossible to merge easily.
* Export an open MSBT file to the human readable XMSBT (XML) format.
* Export an open MSBT file to the human readable XMSBT (XML) format.
Line 222: Line 205:
* Export only the differences between two MSBT files to an XMSBT delta file using the new Export Mod feature!
* Export only the differences between two MSBT files to an XMSBT delta file using the new Export Mod feature!


<span style="font-size: 15px">'''Other Features'''</span>
==Other Features==
 
 
* Add and Remove labels. (Limited to files with an LBL1 section which is 99% of them.)
* Add and Remove labels. (Limited to files with an LBL1 section which is 99% of them.)
* Find - I've added the ability to search for strings in the file making translation that much easier.
* Find - I've added the ability to search for strings in the file making translation that much easier.
Line 234: Line 215:
* v0.9.7 will correct broken files that were previously broken by v0.9.6 and v0.9.5b. Just open the broken file and then click save to fix it. Broken files created by v0.9.5 and below can not currently be fixed with the program. Contact me directly if you need your heavily modified file fixed so you don't lose any work.
* v0.9.7 will correct broken files that were previously broken by v0.9.6 and v0.9.5b. Just open the broken file and then click save to fix it. Broken files created by v0.9.5 and below can not currently be fixed with the program. Contact me directly if you need your heavily modified file fixed so you don't lose any work.


<span style="font-size: 15px">'''Known Issues'''</span>
==Known Issues==
 
 
* v0.8.6 - LZ11 Compression windows do not appear. Update to v0.9.0+.
* v0.8.6 - LZ11 Compression windows do not appear. Update to v0.9.0+.
* v0.9.6 and below - Label renaming is broken. Update to v0.9.7+.
* v0.9.6 and below - Label renaming is broken. Update to v0.9.7+.
<div class="messageTextEndMarker">
</div></blockquote>

Revision as of 14:39, 23 September 2021

Template:Infobox-3DS-Homebrews

Hey there gbatemp,

For a more advanced and complete MSBT solution, check out Kuriimu 3DS

I created this editor a while ago to support a translation project I was planning; Which is now cancelled since Picross 3D 2 is slated for a North American release. It has since grown beyond anything I could have imagined and is now used by many in the modding community on all sorts of projects. I hope you find it useful in your own projects!

Credit is welcome.

MSBTEditorReloaded.jpg

Changelog=

MSBT Editor Reloaded v0.9.8

  • Fixed CSV exporting.

Older Changelog Entries:

MSBT Editor Reloaded v0.9.7b

  • Fixed the BG4 extraction menu not showing up.

MSBT Editor Reloaded v0.9.7

  • Finally corrected the label renaming bugs.
    • v0.9.7 will correct broken files that were previously broken by v0.9.6 and v0.9.5b. Just open the broken file and then click save to fix it. Broken files created by v0.9.5 and below can not currently be fixed with the program. Contact me directly if you need your heavily modified file fixed so you don't lose any work.

MSBT Editor Reloaded v0.9.6

  • Added the Export Mod feature for XMSBT files.
    • Export the differences between two MSBT files to an XMSBT delta file.

MSBT Editor Reloaded v0.9.5b

  • Actually fixed the label length bug this time. Label renaming wasn't updating the length value.

MSBT Editor Reloaded v0.9.5

  • Added links to the GBAtemp thread as well as the GitHub page.
  • Added new icons to support webpage links.
  • Allowed users to drag the splitters between UI elements.
  • Adjusted spacing between all UI elements to maximize screen real-estate.
  • Patched label addition where new labels created with spaces in their names would have an invalid length and cause a broken MSBT file to be saved.
  • Allowed other software to read (not write) the currently open MSBT file at the same time.

MSBT Editor Reloaded v0.9.4

  • Implemented batch import and export for XMSBT files.
  • Implemented label addition when using XMSBT import (batch included).
  • Rearranged the menu bar slightly.
  • Changed the shortcut keys because of adding more XMSBT tools.
  • Added some new icons for the XMSBT functions.
  • Fixed a bug with UMSBT extraction where the overwrite choice was being ignored.

MSBT Editor Reloaded v0.9.3

  • Added the new XMSBT translation tools.

XMSBT files are XML files that contain the labels and text from an MSBT file. The strings are stored on separate lines so that the files are source control friendly.

This gives fan translation authors the ability to collaborate on the same file without having to manually merge the changes from multiple translators as most source control solutions will take care of merging.

MSBT Editor Reloaded v0.9.2

  • Added null byte support via "\0" for control characters in the text.
  • Added a console window while in Debug mode.
  • Implemented the IEntry interface to mostly separate the UI from the MSBT class.
  • Extensive rewrite of the MSBT class to support IEntry and the removal of SubStrings.
  • Extended BinaryReaderX and BinaryWriterX functionality.
  • Patched the SearchDirectory feature to properly select the correct entry after double clicking a result.
  • Patched the RemoveLabel functionality to correctly remove a label and re-sequence the existing TXT2 entries.
  • Made the Add, Remove and Save label features only available for files that have an LBL1 section. (Temporary)
  • Removed SubStrings and supporting UI elements. (Replaced by null byte support.)
  • Removed the Preview box as the full string is now visible in the Edit box.

MSBT Editor Reloaded v0.9.1

  • Added the new Search Directory feature.
  • Fixed user settings not saving properly.

MSBT Editor Reloaded v0.9.0

  • Added the ability to add and remove labels in MSBT files!
  • Fixed the LZ11 windows not appearing.

MSBT Editor Reloaded v0.8.6

  • Added support for managing UMSBT archives.
  • Now supports Animal Crossing: New Leaf.
  • Fixed a few grammatical errors.
    • LZ11 Compression windows do not appear.

MSBT Editor Reloaded v0.8.5

  • Added support for the ATO1 section.
  • Now supports Miitomo.

MSBT Editor Reloaded v0.8.4

  • Added support for UTF8 encoded MSBT files.
  • Now supports Art Academy and Detective Pikachu.

MSBT Editor Reloaded v0.8.3

  • Added a search feature to find strings in the file.

MSBT Editor Reloaded v0.8.2

  • Added a new icon for the BG4 Extraction tool.
  • Added a new export feature that dumps MSBT values into a CSV file.
  • Patched my BigEndian reading class. Fixes support for large BigEndian files in Super Smash Bros 3DS/WiiU.

MSBT Editor Reloaded v0.8.1

  • More fully reverse engineered the BG4 format. BG4 extraction success is basically 100% now.
  • Some files inside BG4 archives without extensions now extract with their expected extensions.
    • Only MSBT, BCH, and PTX for now.
    • If the extension is in the BG4 already, it will be used.
  • Cleaned up some UI handling code. Used directories are now remembered properly.
  • Added some minor exception handling checks.

MSBT Editor Reloaded v0.8

  • Added support for Mario & Luigi Paper Jam MSBT files.
  • Added a tool to extract files from BG4 archives. An M&LPJ archive format containing MSBT files.

MSBT Editor Reloaded v0.7

  • Added some error handling to correct files that were edited with v0.4.
  • Patched a few UI bugs that prevented some features from working properly.
  • When saving, the Original entries now get updated without reloading the file.

MSBT Editor Reloaded v0.6

Read and Write accuracy is now 100%

  • Added support for BigEndian files which includes Super Mario Galaxy 2 support.
  • The last major action will now be displayed in the center at the bottom.
  • File changes will now be tracked and the user will be prompted to save changes when opening another file or quitting the program.
  • Patched sub string support to properly read in the last set of strings in the file.
  • Fixed text boxes not updating when text is changed in the edit and hex views.
  • The tab key now also cycles through sub strings and doesn't depend on focus being given to the Edit text box to function.
  • Ctrl+A now works on all text boxes including the hex view.

MSBT Editor Reloaded v0.5 Beta

  • Added support for sub strings. Certain MSBT files contain null bytes in between string offsets.
  • Added new shortcut keys. When focus is given to the Edit text box:
    • Ctrl+A selects all text
    • Tab cycles down through the strings. Shift+Tab cycles up.
  • Added a preview text box that shows all sub strings concatenated together.
  • Patched saving so that the section size is correctly written to the file.

MSBT Editor Reloaded v0.4 Beta

  • Initial release with basic MSBT support and a few bugs.

Planned Feature(s)

  • Creating MSBT files from scratch.

Supported MSBT Sections

  • LBL1 - Full support.
  • NLI1 - Preliminary support. Most content is unknown.
  • ATO1 - Preliminary support. Content is all 0xFF without padding.
  • ATR1 - Preliminary support. Content is usually blank.
  • TSY1 - Preliminary support. Content is unknown.
  • TXT2 - Full support.

Supported Games

  • Super Mario 3D Land - Not tested.
  • Mario Kart 7 - Supported.
  • Super Mario Galaxy 2 - Partially tested.
  • Super Smash Bros. 3DS - Supported.
  • Super Smash Bros. WiiU - Supported.
  • Mario & Luigi Paper Jam - Supported.
  • Art Academy - Partially tested.
  • Detective Pikachu - Supported.
  • Miitomo - Partially tested.
  • Animal Crossing: New Leaf - Supported.
  • Tokyo Mirage Sessions #FE - Supported.
  • Paper Mario: Sticker Star - Not tested.
  • Paper Mario: Color Splash - Supported.
  • Others may be supported, need feedback.

XMSBT Translation Tools

  • This is the MSBT translator's dream feature! This format allows translators to work together and collaborate on the same file(s) without losing any work due to files being overwritten or files being impossible to merge easily.
  • Export an open MSBT file to the human readable XMSBT (XML) format.
  • Import XMSBT files into an open MSBT file. Text is imported by matching the label names.
  • Batch Export and Batch Import support all of the same features as the single file tools.
  • To use the batch tools, keep the MSBT and XMSBT files in the same directory. (Export does this automatically, and Import expects it.)
  • Export only the differences between two MSBT files to an XMSBT delta file using the new Export Mod feature!

Other Features

  • Add and Remove labels. (Limited to files with an LBL1 section which is 99% of them.)
  • Find - I've added the ability to search for strings in the file making translation that much easier.
  • Search Directory - Works like Find except that it searches all MSBT files in a directory. (Subdirectories supported)
  • Export CSV - Exports the currently open file and any changes made to a CSV file.
  • BG4 Extraction - Extract files from within BG4 archives found in games like Mario & Luigi Paper Jam.
  • LZ11 De/Compression - Compress and Decompress files using LZ11. Held onto this feature from Exelix11's original version.
  • UMSBT Extraction & Packing - Extract MSBT files from UMSBT archives and repack them into UMSBT archives.
  • v0.9.7 will correct broken files that were previously broken by v0.9.6 and v0.9.5b. Just open the broken file and then click save to fix it. Broken files created by v0.9.5 and below can not currently be fixed with the program. Contact me directly if you need your heavily modified file fixed so you don't lose any work.

Known Issues

  • v0.8.6 - LZ11 Compression windows do not appear. Update to v0.9.0+.
  • v0.9.6 and below - Label renaming is broken. Update to v0.9.7+.

Advertising: