Skip to content

Commit 2ff4162

Browse files
Update README.md
1 parent 329978e commit 2ff4162

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# MSU Randomizer
22

3-
A multi game MSU randomizer originally created for the [SMZ3 Cas' Randomizer](https://github.com/Vivelin/SMZ3Randomizer). Select which MSUs you want as possibilities, then either have it shuffle them all together or have it pick a random one for you!
3+
A cross-platform multi-game MSU randomizer originally created for the [SMZ3 Cas' Randomizer](https://github.com/Vivelin/SMZ3Randomizer). Select which MSUs you want as possibilities, then either have it shuffle them all together or have it pick a random one for you!
44

5-
![image](https://github.com/MattEqualsCoder/MSURandomizer/assets/63823784/ee1f36bb-e0cb-4c28-b1e1-fbb08d8caa9b)
5+
![311780120-48b71042-85da-47f9-bec9-7a8b6034b4f0](https://github.com/MattEqualsCoder/MSURandomizer/assets/63823784/0fe5c230-1247-44d9-b1d3-84775ba97fed)
66

77
## Features
88

@@ -15,15 +15,22 @@ A multi game MSU randomizer originally created for the [SMZ3 Cas' Randomizer](ht
1515
- **Compile detailed MSU information** - MSU providers can create [YAML files](Docs/yaml.md) 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.
1616
- **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.
1717
- **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!
18+
- **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.
19+
- **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.
20+
- **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.
1821

19-
## Setup
22+
![311783793-36e83d5f-df74-42ea-94ed-d0c53ccd638f](https://github.com/MattEqualsCoder/MSURandomizer/assets/63823784/95548550-e9e6-4de1-8bcf-616178c1ca3f)
2023

21-
Download the latest exe installer from the [GitHub Releases](https://github.com/MattEqualsCoder/MSURandomizer/releases) page. It should automatically install all required dependencies.
24+
## Setup
2225

23-
## Planned Features
26+
### Windows
27+
- Download the latest exe setup from the [GitHub Releases](https://github.com/MattEqualsCoder/MSURandomizer/releases) page.
28+
- Run the setup, and it should automatically install the application and all required dependencies.
2429

25-
- Possible built-in support for determining which track is currently playing.
26-
- Linux version
30+
### Linux
31+
- Install [dotnet 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
32+
- Download the latest Linux tar file from the [GitHub Releases](https://github.com/MattEqualsCoder/MSURandomizer/releases) page.
33+
- Either set the MSURandomizer file to be executable or run dotnet MSURandomizer.dll
2734

2835
## Troubleshooting
2936

0 commit comments

Comments
 (0)