hackern64/HackerOoT
0
0
Fork 0
mirror of https://github.com/HackerN64/HackerOoT.git synced 2026-01-21 10:37:37 -08:00
Code Issues Packages Projects Releases Wiki Activity

readme update

Browse Source
This commit is contained in:
Yanis42
2022-12-03 20:20:24 +01:00
parent c4be73b629
commit f27bf4cd73
1 changed files with 17 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@@ -1,44 +1,28 @@
# The Legend of Zelda: Ocarina of Time
# Hacker Zelda: Ocarina of Time (HackerOoT)
[![Build Status][jenkins-badge]][jenkins] [![Decompilation Progress][progress-badge]][progress] [![Contributors][contributors-badge]][contributors] [![Discord Channel][discord-badge]][discord]
This project, based on the [Zelda: Ocarina of Time decompilation project](https://github.com/zeldaret/oot/), aims to be an easy-to-use base to make Zelda: Ocarina of Time mods. **It is not producing a PC port.**
[jenkins]: https://jenkins.deco.mp/job/OOT/job/master
[jenkins-badge]: https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fjenkins.deco.mp%2Fjob%2FOOT%2Fjob%2Fmaster
[progress]: https://zelda64.dev/games/oot
[progress-badge]: https://img.shields.io/endpoint?url=https://zelda64.dev/assets/csv/progress-oot-shield.json
[contributors]: https://github.com/zeldaret/oot/graphs/contributors
[contributors-badge]: https://img.shields.io/github/contributors/zeldaret/oot
[discord]: https://discord.zelda64.dev
[discord-badge]: https://img.shields.io/discord/688807550715560050?color=%237289DA&logo=discord&logoColor=%23FFFFFF
```diff
- WARNING! -
This repository is a work in progress, and while it can be used to make certain changes, it's still
constantly evolving. If you use it for modding purposes in its current state, please be aware that
the codebase can drastically change at any time. Also note that some parts of the ROM may not be
'shiftable' yet, so modifying them could be difficult at this point.
```
This is a WIP **decompilation** of ***The Legend of Zelda: Ocarina of Time***. 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. **It is not producing a PC port.** For more information you can get in touch with the team on our [Discord server](https://discord.zelda64.dev).
The only build currently supported is Master Quest (Debug), but other versions are planned to be supported.
The only build currently supported is Master Quest (Debug), other versions will eventually be supported.
It builds the following ROM:
* zelda_ocarina_mq_dbg.z64 `md5: f0b7f35375f9cc8ca1b2d59d78e35405`
* zelda_ocarina_mq_dbg.z64
**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.**
## HackerN64
**Discord:** <https://discord.gg/brETAakcXr>
## Zelda Decompilation
**Website:** <https://zelda64.dev>
**Discord:** <https://discord.zelda64.dev>
## Installation
Note: instructions for setting up Visual Studio Code can be found [here](docs/vscode.md).
We recommend using WSL on Windows, or native Linux, which the rest of this readme describes. We currently have instructions for
* [Windows](#Windows), with and without WSL
@@ -86,16 +70,16 @@ If you are using GCC as the compiler for Ocarina of Time, you will also need:
**N.B.** If using WSL, we strongly encourage you to clone into WSL's Linux filesystem using Linux's `git`.
Cloning into the Windows filesystem will result in much slower read/write speeds, and often causes issues when Windows copies the files with the wrong line endings, which the compiler IDO cannot handle correctly.
Clone `https://github.com/zeldaret/oot.git` where you wish to have the project, with a command such as:
Clone `https://github.com/HackerN64/HackerOOT.git` where you wish to have the project, with a command such as:
```bash
git clone https://github.com/zeldaret/oot.git
git clone https://github.com/HackerN64/HackerOOT.git
```
This will copy the GitHub repository contents into a new folder in the current directory called `oot`. Change into this directory before doing anything else:
This will copy the GitHub repository contents into a new folder in the current directory called `HackerOOT`. Change into this directory before doing anything else:
```bash
cd oot
cd HackerOOT
```
#### 3. Prepare a base ROM
@@ -126,18 +110,9 @@ make
If all goes well, a new ROM called "zelda_ocarina_mq_debug.z64" should be built and the following text should be printed:
```bash
zelda_ocarina_mq_dbg.z64: OK
tools/elf2rom -cic 6105 zelda_ocarina_mq_dbg.elf zelda_ocarina_mq_dbg.z64
```
If you instead see the following:
```bash
zelda_ocarina_mq_dbg.z64: FAILED
md5sum: WARNING: 1 computed checksum did NOT match
```
This means that the built ROM isn't the same as the base one, so something went wrong or some part of the code doesn't match.
**NOTE:** to speed up the build, you can either:
* pass `-jN` to `make setup` and `make`, where N is the number of threads to use in the build. The generally-accepted wisdom is to use the number of virtual cores your computer has.
@@ -151,4 +126,4 @@ Both of these have the disadvantage that the ordering of the terminal output is
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.
Most discussions happen on our [Discord Server](https://discord.gg/brETAakcXr), 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.