added binary

pull

README.md

@@ -7,23 +7,35 @@ 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, requests, and packaging. You can just do "pip install -r requirements.txt". The rest of the dependencies *should* already be 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. Then you choose your nsf file and where your Mega Man Maker folder is.
-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.
+
+## 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.
+* -NEW- Support for "permanently" replacing a specific song to one of your liking, with restoring capabilities.
 
 ## Support
-If you have any issues, which is probable, make a gitlab issue. There *will* be bugs.
+If you have any issues make a gitlab issue. There may be bugs.
 
 ## Roadmap
-fix slowdown on windows systems
+* fix restore_ogmusic so that it doesn't replace custom music. Possible windows only behaviour, testing is needed.
-Ability to change only the level music and leave the menu, or just the menu and leave the level music.
+* consider the posibility of adding a alternate, custom music preserving, updater for Mega Man Maker.
-Instead of duplicating a single file a lot of times, maybe I'll implement symlink support.
+* improve the single-song actions to make them more persistant
-add autoupdater??
+* modify restore_ogmusic so it is able to restore only the last change. Maybe config files will be needed for this.
+* make it so that if "you press apply music and then replace song" it checks for that and doesn't allow the "replaced song" to be reverted back to original.
+* ability to preserve changes through Mega Man Maker updates, by using a config file and/or a downloaded zip of the game.
+* stop using os.path in favour of pathlib
+* switch to using a config file (or database) for keeping track of which tracks have been changed, that way only having one original_music folder and being able to *show* the user which song you used to replace which file.
+* add a way to show the available nsf files in the selected folder, like a playlist.
+* Instead of duplicating a single file a lot of times, maybe I'll implement symlink support.
 
 ## 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.
+GNU General Public License v3.0

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.

requirements.txt

@@ -0,0 +1,7 @@
+certifi==2023.11.17
+charset-normalizer==3.3.2
+idna==3.4
+packaging==23.2
+PySimpleGUI==4.60.5
+requests==2.31.0
+urllib3==2.1.0