Update README.md

This commit is contained in:
notyouraveragehooman 2020-06-12 03:10:14 -07:00 committed by GitHub
parent a805b6e110
commit a3f1826351
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 1 deletions

View File

@ -1,9 +1,34 @@
# The Legend of Zelda: The Minish Cap
This is a disassembly of The Legend of Zelda: The Minish Cap (USA).
```diff
- WARNING! -
The ROM this repository builds cannot be 'shifted', primarily due to some hardcoded pointers which have yet
to be dumped. Thus this repository is currently in an experimental and research phase and cannot yet be used
traditionally as a source code base for general changes.
```
This is a WIP decompilation of The Legend of Zelda: The Minish Cap.
The purpose of the project is to recreate a source code base for the game from scratch, using information found inside the game along with static and/or dynamic analysis.
The only build currently supported is `The Legend of Zelda: The Minish Cap (USA)`, but other versions are planned to be supported.
It builds the following ROM:
* [**tmc.gba**](https://datomatic.no-intro.org/index.php?page=show_record&s=23&n=1841) `sha1: b4bd50e4131b027c334547b4524e2dbbd4227130`
**Note:** This repository does not include any of the assets necessary to build the ROM.
A prior copy of the game is required to extract the needed assets.
Website: <https://zelda64.dev/>
Discord: <https://discord.zelda64.dev>
To set up the repository, see [INSTALL.md](INSTALL.md).
## Contributing
All contributions are welcome. This is a group effort, and even small contributions can make a difference.
Some tasks also don't require much knowledge to get started.
Most discussions happen on our [Discord Server](https://discord.zelda64.dev), where you are welcome to ask if you need help getting started, or if you have any questions regarding this project and other decompilation projects.