py-mmlv/README.md
2023-09-28 12:46:33 -04:00

1.3 KiB

Py-MMLV, a MMLV Format Python Library by Timothy GFO

The Goal

The goal of this project is to create a single, easy to use, and flexible Python Library for the MMLV format used in Mega Man Maker. This project takes advantage of the common ConfigParser Module, and uses it to read and write the files, for use in the Py-MMLV.

Installation

Dependencies: configparser os requests the included "definitions.py" After you install the required dependencies, you just download the mmlv_library.py file and import it on your program. It's still work in progress, not complete at all...

Usage

When in beta, you should be able to import as a module in another python program and call functions like "set_tile(mm1iceman, version_of_tile, x, y)". You need to specify the filename variable before doing anything. Maybe there is a better way to specify filenames...

Support

If you find a bug, remember to create an issue about it. But don't do it right now, there is more bug than code.

Roadmap

Create basic functions like set_tile, set_active_room, write_file.

Contributing

I would like to be the main developer of this project until it has some missing core functions and it reaches beta. After that feel free to leave pull requests for me to check.

License

GNU General Public License v3.0