HUGE UPDATE added Mute button more formats supported

README.md

@@ -7,23 +7,32 @@ I got tired of waiting for actual custom music to be added to Mega Man Maker. So
 ![Alt text](/nsf_changer.png?raw=true "NSF Changer window")
 
 ## Installation
-You will need to install through PIP the package PySimpleGUI. The rest of the dependencies *should* be already installed.
+You will need to install through PIP the package PySimpleGUI and maybe requests. The rest of the dependencies *should* be already installed.
 
 ## Usage
 Please use at your own risk and make backups of the MegaManMaker folder before you use it.
-To use it just launch the executable file (if available for your os) or type "python mmm-nsf-changer.py" in the terminal or commandline, and the GUI will launch. Maybe CLI support will come in the future. Then you choose your nsf file and where your Mega Man Maker folder is. Please note that support for Windows systems is not tested much since I don't use it. On windows systems the program may freeze for about ten seconds, please DO NOT CLICK RESET ON MEGA MAKER WHILE THE TOOL IS FROZEN, IT WILL CRASH THE GAME.
+To use it just launch the executable file (if available for your os) or type "python mmm-nsf-changer.py" in the terminal or commandline, and the GUI will launch. Maybe CLI support will come in the future. Then you choose your nsf file and where your Mega Man Maker folder is. Please note that support for Windows systems is not tested much since I don't use it. On windows systems the program may freeze for about 5 seconds, please DO NOT CLICK RESET ON MEGA MAKER WHILE THE TOOL IS FROZEN, IT WILL CRASH THE GAME.
+
+## Features
+* Easy way to choose a NSF, NSFe, SPC, VGM, GYM, AY, HES, KSS, SAP or GBS file as a replacement for every song in the game. Yes, you heard that right: You can use SNES Music, Sega Genesis Music, and more in Mega Man Maker!
+* A "mute" button for replacing every song in the game with a silent song. For people that play Mega Man Maker with external music, like streamers.
+* Reliable way to restore the original songs.
+* A decent interface.
 
 ## Support
-If you have any issues, which is probable, make a gitlab issue. There *will* be bugs.
+If you have any issues, which is probable, make a gitlab issue. There may be bugs.
 
 ## Roadmap
-fix slowdown on windows systems
+* add selective mute, so that you mute every music except the boss music, or every song except menu music or both.
-Ability to change only the level music and leave the menu, or just the menu and leave the level music.
+* figure out the best way to add a setting for changing each of the level editor songs, menu music, or a specific level song. Maybe an extra popup window or a check box for "replace every one" "menu" and "levelBuild"
-Instead of duplicating a single file a lot of times, maybe I'll implement symlink support.
+* add a way to show the available nsf files in the selected folder, like a playlist.
-add autoupdater??
+* add a settings file for the last folder chosen, so if there is a path try to use that so that you don't have to choose it manually
+* fix slowdown on windows systems
+* Instead of duplicating a single file a lot of times, maybe I'll implement symlink support.
+* add autoupdater??
 
 ## Contributing
-You can help with the project by testing it and reporting issues, or by making pull requests.
+You can help with the project by testing it and reporting issues, or by making pull requests. Windows testers are especially needed since I don't daily drive Windows.
 
 ## License
 For open source projects, say how it is licensed.

bin/v1.1/before_you_use.txt

@@ -0,0 +1 @@
+This executable was made in Wine, a Windows compatibility layer for Linux. It is not perfect. Because of that, this exe package may not work properly. It is NOT TESTED.