OpenMFOR/OpenMFOR
1
0
Fork 0
Code Issues 1 Pull requests Releases 3 Activity

update readme

Browse source
This commit is contained in:
Lucent 2024-02-08 01:08:33 +01:00
parent 82bd33daf9
commit cc64e2385a
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -2,11 +2,13 @@
This is the official unofficial Git repository for the Metroid Fusion Open Randomizer reverse engineering efforts, more casually referred to as MFOR or Fusion rando.
Considering the original repository states that the software is GPL-3.0 licensed, but no source was ever released, we're endeavouring on this (potentially failing) task of making MFOR Open Again️™️
Considering the original repository states that the software is GPL-3.0 licensed, but no source was ever released, we're ~~endeavouring on this (potentially failing) task of~~ making MFOR Open Again️™️
Caveat emptor: the project is already diverging from the original decompilation as logic variations have been applied already to this repository.
## Links
* [OpenMFOR repository][] (This project, in case you are looking at a fork)
* [OpenMFOR repository][] (this project, in case you are looking at a fork)
* The [original MFOR repository][] on Github
* The [original MFOR thread][] on Metroid Construction
@ -26,7 +28,7 @@ Considering the original repository states that the software is GPL-3.0 licensed
## Usage
Beware: stuff doesn't work as it should yet. Prerequisites are PySimpleGUI (and tkinter by proxy) and python-bps-continued. A prerequisites file is available so you can `pip install -r requirements.txt` away.
Beware: stuff doesn't _fully_ work as it should yet. Prerequisites are PySimpleGUI (and tkinter by proxy) and python-bps-continued. A prerequisites file is available so you can `pip install -r requirements.txt` away.
Clone the repository, install prerequisites manually via pip or your favourite package manager, `python MFOR.py`. Choose your game options (hover over a given option to see a tooltip explaining it), then click Generate. A popup will ask you to open an unmodified copy of the original game. This is not provided with the randomizer for legal reasons.
@ -38,6 +40,8 @@ The randomizer currently works with **only** the USA/Australia version of the ga
## Special Thanks
[magical](https://git.tilde.town/magical/OpenMFOR)'s efforts into untangling pretty much the entirety of the randomizer logic. Without their contribution this repository would be yet another project left to rot into yet another of my hard drives.
[Decompyle++](https://github.com/zrax/pycdc) has been used for the initial disassembly. [R. Bernstein](https://github.com/rocky) because uncompyle6, decompile3, xdis and python-control-flow kickstarted this project.
[Kazuto88](https://github.com/Kazuto88) for the actual development of the randomizer. Next lines are his special thanks to the people that contributed with the patching necessary to make this a reality: