Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 5.32 KB

README.md

File metadata and controls

50 lines (35 loc) · 5.32 KB
Raw

MSU Randomizer

A cross-platform multi-game MSU randomizer originally created for the SMZ3 Cas' Randomizer. Select which MSUs you want as possibilities, then either have it shuffle them all together or have it pick a random one for you!

311780120-48b71042-85da-47f9-bec9-7a8b6034b4f0

Features

  • Support for over 20 games and randomizers - Randomize A Link to the Past, Super Metroid, SMZ3, Donkey King Country, Super Mario World, and others! Built on configs managed by Minnie Trethewey.
  • Auto detects MSUs - Simply give the MSU Randomizer the parent folder for all of your MSUs, and it'll automatically detect all MSUs and try to determine what type of MSU it is. Each supported game can have its own parent MSU directory.
  • Assign MSUs to a rom or folder - Apply a specific MSU to a rom or copy it to a folder, or let the MSU randomizer pick a random one for you!
  • Create shuffled MSUs - Select multiple MSUs and let the MSU randomizer create a shuffled mix of songs pulling from each of the selected MSUs. Each track will be used in its proper location, so no boss tracks for dungeon themes!
  • Continously shuffled MSUs - Tired of listening to the same Hyrule Field track an entire run? Use the continuously shuffled feature to allow the MSU randomizer to change all of the songs every minute! (The current playing track will not be swapped out.)
  • Convert MSUs of different types - Combine ALttP and Super Metroid MSUs into a single SMZ3 MSU, or use an SMZ3 MSU for ALttP or Super Metroid! Or, if you have an old SMZ3 MSU built around the old Conn patch or the original SMZ3 Cas' MSU support, let the MSU Randomizer update them to match the new built-in MSU support for SMZ3.
  • Compile detailed MSU information - MSU providers can create YAML files to package along with their MSUs. This will allow the MSU Randomizer to pull information about the MSU such as its name and creator as well as track details such as song names and artists, then create a YAML file with the outputted MSU details so that you (or any application) can view the songs picked.
  • Alternative track support - Sometimes you just have too many ideas for a song! MSU creators can package in alternative pcm files for tracks which will be picked up and randomly selected instead of the default ones. The YAML detail files even allows for adding information for each of the alt tracks so that the MSU Randomizer will know which one was picked and save the relevant info to the output YAML file.
  • Favorite MSU packs - Favorite MSU packs so that they appear at the top of the list. You can also filter on just the MSU packs you've favorited!
  • Various shuffle styles - You can control what types of tracks are shuffled with each other by various different shuffle style, varying from shuffling songs meant just for a given location to various chaos shuffle options.
  • Randomly pick and load hardware MSUs - Have an FxPakPro or similar hardware? The MSU Randomizer will detect what MSUs are on it and can randomly pick an MSU for you, pushing the selected rom to the correct folder and launching it.
  • Display currently playing track - Currently only supported in ALttP Randomizer and SMZ3 Cas', it will let you know what MSU a track is from, including song and artist information if provided by the MSU creator. Compatible with most any setup that works with auto tracking.

311783793-36e83d5f-df74-42ea-94ed-d0c53ccd638f

Setup

Windows

  • Download the latest exe setup from the GitHub Releases page.
  • Run the setup, and it should automatically install the application and all required dependencies.

Linux

  • Install dotnet 8
  • Download the latest Linux tar file from the GitHub Releases page.
  • Either set the MSURandomizer file to be executable or run dotnet MSURandomizer.dll

Troubleshooting

Having problems? You can view the support document for more assistance. If you are still running into problems, please feel free to post an Issue on GitHub.

Randomizer Libraries

Interested in using the MSU Randomizer libraries in your own .net based application? Lookup MattEqualsCoder.MSURandomizer.Library and MattEqualsCoder.MSURandomizer.UI on nuget to use them in your project!

Credits & Thanks

  • Vivelin for the SMZ3 Cas' Randomizer, from which I borrowed some code snippets here and there.
  • PinkKittyRose for testing this and the_betus for playing it so enthusiastically for me to keep working on it.
  • Minnie Trethewey for creating all of the JSON files that are used for the MSU Randomizer.
  • All the MSU creators that made enough MSUs to make this worth it.