TimothyGFO/py-mmlv
1
0
Fork 0
mirror of https://gitlab.com/GameFeverOnline/py-mmlv.git synced 2025-12-18 17:57:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added get_block_contents and updated readme

Browse source
This commit is contained in:
Timothy GFO 2023-10-05 01:56:25 -04:00
parent c6be529e06
commit 45b6344f28
7 changed files with 172 additions and 260 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,7 +1,14 @@
# 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.
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 Py-MMLV.
This includes:
* Files generated with Py-MMLV will generally be *smaller* in file size, this could in theory improve load times. The reason is that Mega Man Maker stores integers as "1.000", while Py-MMLV just does "1". Py-MMLV will also be smart enough to automatically remove redundant entries in the file. (in the future)
* Every function that spawns something in the level should have intuitive naming and arguments.
* A stable base to improve upon: Every function will lookup in the definitions.py file.
* Be able to generate from scratch a valid mmlv file, as well as modifying a file (valid or not).
## Installation
Dependencies:
@ -18,7 +25,9 @@ When in beta, you should be able to import as a module in another python program
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.
add get functions
add automatic room activation to set_tile
add ability to all functions to accept raw x, y values (the times 16 numbers in mmlv) and raw codes (like "a" instead of "active")
## 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.