mmm-nsf-changer/README.md

# Mega Man Maker Custom NSF Changer
Made by Timothy GFO (https://gamefeveronline.gitlab.io | https://youtube.com/gamefeveronline)

## What is this?
I got tired of waiting for actual custom music to be added to Mega Man Maker. So, I made this tool for changing the nsf files on Mega Man Maker to a custom one. The awesome part is that it works while you are playing. You only need to restart the level or respawn from check point. I made this in just one day (first commit), but I expect this to improve a lot in the future.

![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.

## 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.

## Support
If you have any issues, which is probable, make a gitlab issue. There *will* be bugs.

## Roadmap
fix slowdown on windows systems
Ability to change only the level music and leave the menu, or just the menu and leave the level music.
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.

## License
For open source projects, say how it is licensed.