ShadowOne333 / Metroid-Zero-Mission-Redux

WIP source code for an eventual Metroid: Zero Mission Redux hack
GNU General Public License v3.0
7 stars 0 forks source link

METROID ZERO MISSION REDUX

Index


Metroid Zero Mission Redux

“Metroid Zero Mission Redux” is a personal hack of "Metroid Zero Mission (U)" that has a few QoL features ported over from other QoL hacks available on the Metroid Construction website, more specifically, this is based on "Project ZM" v0.83 by FelixWright/Ckosmic, with some further modifications and improvements thrown in from other Zero Mission hacks.

Follow the GitHub repository for the full source code of the project: https://github.com/ShadowOne333/Metroid-Zero-Mission-Redux


Changelog


Optional patches

  1. Disable Low Health Alarm - Self-explanatory. Disables the alarm that you get when Samus is on low health

To-Do

  1. Reimplement the Introduction's closeup of Samus' face when starting the game (originally seen when starting in Brinstar. This was removed due to the starting location being changed to Crateria in Project ZM.
  2. There might be other things that might be added, but it's still uncertain whether or not I'd want to do more, since that's the only thing missing in Zero Mission for me to make it perfect.
  3. Include the "Hazard Damage Suit" and "Ledge Vault" codes from "addons" properly into Redux.
  4. Possibly more optional patches.

Compilation

Windows

For compilation on Windows, you need to download and install CygWin.

When installing Cygwin, be sure to also install git from the list of packages available, or you won't be able to clone the repository from the source.

Once you have it installed, browse to the directory where you downloaded the source code, and start the same steps as the Linux compilation.

(I recompiled the scompress Windows EXE in Cygwin so it works properly with the Windows compilation)

Linux

The source code was developed entirely on Linux (32bit), with armips being compiled from source to create the binary, same for FLIPS.

  1. Either download the source code as ZIP, or clone the repository by opening terminal and running git clone https://github.com/ShadowOne333/Metroid-Zero-Mission-Redux. Put the downloaded files anywhere in your PC.

  2. Grab your Metroid Zero Mission (USA) ROM with the name "Metroid Zero Mission (USA).gba" inside the "/rom/" folder.

  3. Open terminal in your Linux distribution, browse to the same folder as the "make.sh" file, and modify its permissions to be an executable script file by doing the following: sudo chmod +x make.sh

  4. If you want specific optional patches to be applied in your complation, open the optional.asm file inside /code/ and uncomment the .include "xxxx" file of the optional patch you desire to include during compilation.

  5. Enjoy the hack!


Instructions

To play Metroid Zero Mission Redux, the following is required:

Grab the patches from inside the /patches/ folder from the GitHub page, or alternatively, download the .zip file from the Releases page (once a proper release is out) and apply the patch over your Metroid Zero Mission ROM with Lunar IPS. If you want to apply any of the optional patches, you can use each Optional patch individually from inside the /patches/optional folder depending on your liking over your already patched Metroid Zero Mission Redux ROM, or you can either compile them manually from the source code, although this is not recommended if you are not familiar with compilations or ARMIPS assembly.


Credits


License

Metroid Zero Mission Redux is a project licensed under the terms of the GPLv3, which means that you are given legal permission to copy, distribute and/or modify this project, as long as:

  1. The source for the available modified project is shared and also available to the public without exception.
  2. The modified project subjects itself different naming convention, to differentiate it from the main and licensed Metroid Zero Mission Redux project.

You can find a copy of the license in the LICENSE file.