MSU Scripter v2.0.0 RC 1

Note: This is a release candidate and may have some bugs. Creating a backup of your msup files is recommended.

Change Log

Better PyMusicLooper Integration

Thanks to changes from arkrow, PyMusicLooper can now export multiple possible loop points. A new modal window has been created to leverage these changes. You can see multiple results, play them to test them out, and even adjust the parameters for calling PyMusicLooper. To use this functionality, you'll need to update to the latest version of PyMusicLooper, which you can find information about on the PyMusicLooper GitHub.

Add Song Window

There is now a new window for adding songs to streamline the process. It only contains the most commonly used fields and will automatically pull in the song details, run PyMusicLooper, and has a button to check the audio levels. Hopefully this will make the process a bit smoother for simple songs.

Copyright Test Video Creation

By installing the MSU Test Video Creator application, originally created by StructuralMike, you can create a video that compiles all of the pcm files into single wav/mp4 files which can be used to upload to YouTube to check for potential copyright flags. This can be accessed via the Export dropdown.

Miscellaneous Updates and Bug Fixes

• Added track search button - Next to the track dropdown is a search button which can be used to type in a string to filter the track list by.
• Added Validate YAML button - In the export dropdown menu, there is now an option to validate the YAML to ensure that all tracks in the project exist in the exported MSU.
• Added warning when regenerating tracks with alts - Because alt tracks require the file length and hash to be stored in the YAML for proper identification, when generating pcm files for tracks with alt versions, the status bar text will now contain a reminder to regenerate the YAML.
• Generated PCMs are now cached - When generating a pcm, data used to generate the pcm is now cached to prevent the need to regenerate PCM files unnecessarily.
• Main window location is now restored on relaunching - The location and size of the main window will now be restored when closing and reopening.
• PCM Player support added to Linux - Simplified support for playing PCM files has been added to the Linux version by installing the PCM Player.
• Fixed opening folder in Linux - The open MSU folder option now works with Linux, and the window that comes up when there is a crash will now open the log folder correctly.
• Changed internal MSU Scripter folders - The folders used by the MSU Scripter for logs and cache files have been updated to be cleaner, and temp files are now in the appropriate system folders.

MSU Scripter v1.1.1

Change Log

• Updated to try calling PyMusicLooper via Python rather than as a standalone application in case it's installed via pip instead of pipx (#11)
• Changed the way the "you have pending changes" window pops up to avoid potential crashes (#9)
• Fixed an issue where it would hang when using PyMusicLooper while music is playing (#10)
• Updated the way the MSU type configs are pulled in and changed some of the paths for Linux to make it easier to make appimage/flatpaks in the future.
• Updated logs to use Serilog
• Created GitHub action for builds

MSU Scripter v1.1.0

Change Log

• Added the ability to create a track list text file on export. Track lists can either be in a list with the formatting "%album% - %song% (%artist%) or in a table. The track list export can be disabled if desired.
• Made an update so that you can ignore warnings from msupcm++ for specific songs when it does actually generate the file despite the warning. Note that if you generate a full MSU, it'll still display the warnings in the MSU generation window still.
• Added the current timestamp and song duration to the audio panel in the bottom left when playing a song.
• Added an option to disable the creation of MSU Randomizer YAML files.
• Fixed an issue where generated PCM files with msupcm++ warnings could not be played.
• Fixed an issue where YAML wasn't being exported when msupcm++ was disabled.

MSU Scripter v1.0.5 Beta 1

Change Log

• Fixed an issue where generated PCM files with warnings could not be played.
• Made an update so that you can ignore warnings from msupcm++ for specific songs when generating individual PCM files to prevent future popups for that song. Note that if you generate a full MSU, it'll still display the warnings in the MSU generation window still.
• Added the current timestamp and song duration to the audio panel in the bottom left when playing a song.

MSU Scripter v1.0.4

Change Log

• Fixed an issue with some mp3s not properly pulling in metadata
• Fixed an issue whether MSU version number was not exporting correctly
• Updated alt track details in YAML to export more consistently with the regular track details

MSU Scripter v1.0.3

Change Log

• Fixed an issue that prevented loading metadata from mp3s without urls

MSU Scripter v1.0.2

Change Log

• Removed the track number from alt tracks within ALttP and SM YAML files created from an SMZ3 project as they were unnecessary.
• Updated the generation of ALttP and SM YAML files for SMZ3 projects to happen after pcm generation to resolve issues with inconsistent file hashes in the YAML files.

MSU Scripter v1.0.1

Change Log

• Added msupcm++ track compression option

MSU Scripter v1.0.0

A cross platform application built for creating MSUs and related files. The application works as a wrapper around msupcm++, creating the necessary JSON and executing it to generate pcm files. Furthermore, it also creates YAML files for the MSU Randomizer to help it identify MSUs and their tracks, intended to be used in SMZ3 Cas' Randomizer to identify the current playing track.

Features

• Converts audio files into pcm files (msupcm++ required) - Through the UI you can enter almost any field available to msupcm++ and generate either all pcm files for the MSU-1 or even just single files for testing. The MSU Scripter will even verify that created pcms are valid and can run multiple instances of msupcm++ simultaneously for faster generation of MSUs.
• Create MSU YAML files with song information - The MSU Scripter will write YAML files for the MSU Randomizer to pull information about the MSU and the songs such as the song name, artist, and album. These YAML files also double as generated user friendly track lists! View more information about the MSU Randomizer YAML files here.
• Play generated pcm files (Windows only) - Built into the MSU Scripter is an audio player for playing pcm files, including an option to start playing near the end of the song to test loop points.
• Audio balance analysis - After creating your MSU, run the Audio Analysis to scan through all of the generated files to look for songs that have an average volume or peak that is louder than the overall averages of all of the songs.
• Auto loop detection (PyMusicLooper required) - By using the PyMusicLooper script, the MSU Scripter can attempt to find a loop point for you.
• Import audio metadata - Automatically pulls in mp3 and flac metadata for song names, artists, and playlists.
• Alt file support - Want to include different options for people for particular tracks? Add multiple songs to a track, and it will generate different pcm files for each track. Optionally, the MSU Scripter will even generate a .bat (batch) file for swapping between the original base file and the alt files.
• Auto create split ALttPR and VARIA files for SMZ3 MSUs - Creating an SMZ3 MSU and want to allow people to change it to work with ALttPR or VARIA randomizers? The MSU Scripter will create separate MSUs and their YAML files and then create a .bat file for swapping between combined SMZ3 and split ALttPR and VARIA MSUs.
• Import previously created MSUs - Already have an MSU you want to create YAML files for or make updates to the pcm files? Simply point the MSU Scripter to a previously created MSU and, if msupcm++ is being used, the msupcm++ json file and the directory you previously executed msupcm++ from. It'll pull in all the info it can from the files.
• Supports over 20 types of MSUs - Thanks to JSON files created by Minnie Trethewey, the MSU Scripter supports a variety of MSU types, such as A Link to the Past, Super Metroid, SMZ3, Donkey Kong Country, Super Mario World, and others!

Setup

• Download the latest release via the GitHub Releases page
  • Windows - Run the installer exe file to install all pre-requisites and the MSU Scripter
  • Linux - Make sure to have .net 7 installed. Either make the MSUScripter file executable and run it or run dotnet MSUScripter.dll
• Download msupcm++ if generating pcms is desired
• Install PyMusicLooper if automatic loop point detection is desired (make sure you can run it via a PowerShell or Terminal window)
• Add in all details desired about the MSU and the tracks
• Click on export to generate the MSU and all related files

MSU Scripter v1.0.0 RC 6

NOTE: As this is a new application that has not been fully tested, it is recommended that if you are converting old MSUs to make backups just in case.

A cross platform application built for creating MSUs and related files. The application works as a wrapper around msupcm++, creating the necessary JSON and executing it to generate pcm files. Furthermore, it also creates YAML files for the MSU Randomizer to help it identify MSUs and their tracks, intended to be used in SMZ3 Cas' Randomizer to identify the current playing track.

Features

• Converts audio files into pcm files (msupcm++ required) - Through the UI you can enter almost any field available to msupcm++ and generate either all pcm files for the MSU-1 or even just single files for testing. The MSU Scripter will even verify that created pcms are valid and can run multiple instances of msupcm++ simultaneously for faster generation of MSUs.
• Create MSU YAML files with song information - The MSU Scripter will write YAML files for the MSU Randomizer to pull information about the MSU and the songs such as the song name, artist, and album. These YAML files also double as generated user friendly track lists! View more information about the MSU Randomizer YAML files here.
• Play generated pcm files (Windows only) - Built into the MSU Scripter is an audio player for playing pcm files, including an option to start playing near the end of the song to test loop points.
• Audio balance analysis - After creating your MSU, run the Audio Analysis to scan through all of the generated files to look for songs that have an average volume or peak that is louder than the overall averages of all of the songs.
• Auto loop detection (PyMusicLooper required) - By using the PyMusicLooper script, the MSU Scripter can attempt to find a loop point for you.
• Import audio metadata - Automatically pulls in mp3 and flac metadata for song names, artists, and playlists.
• Alt file support - Want to include different options for people for particular tracks? Add multiple songs to a track, and it will generate different pcm files for each track. Optionally, the MSU Scripter will even generate a .bat (batch) file for swapping between the original base file and the alt files.
• Auto create split ALttPR and VARIA files for SMZ3 MSUs - Creating an SMZ3 MSU and want to allow people to change it to work with ALttPR or VARIA randomizers? The MSU Scripter will create separate MSUs and their YAML files and then create a .bat file for swapping between combined SMZ3 and split ALttPR and VARIA MSUs.
• Import previously created MSUs - Already have an MSU you want to create YAML files for or make updates to the pcm files? Simply point the MSU Scripter to a previously created MSU and, if msupcm++ is being used, the msupcm++ json file and the directory you previously executed msupcm++ from. It'll pull in all the info it can from the files.
• Supports over 20 types of MSUs - Thanks to JSON files created by Minnie Trethewey, the MSU Scripter supports a variety of MSU types, such as A Link to the Past, Super Metroid, SMZ3, Donkey Kong Country, Super Mario World, and others!

Setup

• Download the latest release via the GitHub Releases page
  • Windows - Run the installer exe file to install all pre-requisites and the MSU Scripter
  • Linux - Make sure to have .net 7 installed. Either make the MSUScripter file executable and run it or run dotnet MSUScripter.dll
• Download msupcm++ if generating pcms is desired
• Install PyMusicLooper if automatic loop point detection is desired (make sure you can run it via a PowerShell or Terminal window)
• Add in all details desired about the MSU and the tracks
• Click on export to generate the MSU and all related files