115 lines
4.3 KiB
Markdown
115 lines
4.3 KiB
Markdown
Some Game
|
|
[![Build Status]][actions] ![Progress] ![DOL Progress] ![RELs Progress] [![Discord Badge]][discord]
|
|
=============
|
|
|
|
<!--
|
|
Replace with your repository's URL.
|
|
-->
|
|
[Build Status]: https://github.com/zeldaret/tww/actions/workflows/build.yml/badge.svg
|
|
[actions]: https://github.com/zeldaret/tww/actions/workflows/build.yml
|
|
<!---
|
|
Code progress URL:
|
|
https://progress.decomp.club/data/[project]/[version]/all/?mode=shield&measure=code
|
|
URL encoded then appended to: https://img.shields.io/endpoint?label=Code&url=
|
|
-->
|
|
[Progress]: https://img.shields.io/endpoint?label=Code&url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Ftww%2FGZLE01%2Fall%2F%3Fmode%3Dshield%26measure%3Dcode
|
|
<!---
|
|
DOL progress URL:
|
|
https://progress.decomp.club/data/[project]/[version]/dol/?mode=shield&measure=code
|
|
URL encoded then appended to: https://img.shields.io/endpoint?label=DOL&url=
|
|
-->
|
|
[DOL Progress]: https://img.shields.io/endpoint?label=DOL&url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Ftww%2FGZLE01%2Fdol%2F%3Fmode%3Dshield%26measure%3Dcode
|
|
<!--
|
|
REL progress URL:
|
|
https://progress.decomp.club/data/[project]/[version]/modules/?mode=shield&measure=code
|
|
URL encoded then appended to: https://img.shields.io/endpoint?label=RELs&url=
|
|
-->
|
|
[RELs Progress]: https://img.shields.io/endpoint?label=RELs&url=https%3A%2F%2Fprogress.decomp.club%2Fdata%2Ftww%2FGZLE01%2Fmodules%2F%3Fmode%3Dshield%26measure%3Dcode
|
|
<!--
|
|
Replace with your Discord server's ID and invite URL.
|
|
-->
|
|
[Discord Badge]: https://img.shields.io/discord/727908905392275526?color=%237289DA&logo=discord&logoColor=%23FFFFFF
|
|
[discord]: https://discord.gg/hKx3FJJgrV
|
|
|
|
A work-in-progress decompilation of Some Game.
|
|
|
|
This repository does **not** contain any game assets or assembly whatsoever. An existing copy of the game is required.
|
|
|
|
Supported versions:
|
|
|
|
- `GAMEID`: Rev 0 (USA)
|
|
|
|
Dependencies
|
|
============
|
|
|
|
Windows:
|
|
--------
|
|
|
|
On Windows, it's **highly recommended** to use native tooling. WSL or msys2 are **not** required.
|
|
When running under WSL, [objdiff](#diffing) is unable to get filesystem notifications for automatic rebuilds.
|
|
|
|
- Install [Python](https://www.python.org/downloads/) and add it to `%PATH%`.
|
|
- Also available from the [Windows Store](https://apps.microsoft.com/store/detail/python-311/9NRWMJP3717K).
|
|
- Download [ninja](https://github.com/ninja-build/ninja/releases) and add it to `%PATH%`.
|
|
- Quick install via pip: `pip install ninja`
|
|
|
|
macOS:
|
|
------
|
|
- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages):
|
|
```
|
|
brew install ninja
|
|
```
|
|
- Install [wine-crossover](https://github.com/Gcenx/homebrew-wine):
|
|
```
|
|
brew install --cask --no-quarantine gcenx/wine/wine-crossover
|
|
```
|
|
|
|
After OS upgrades, if macOS complains about `Wine Crossover.app` being unverified, you can unquarantine it using:
|
|
```sh
|
|
sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'
|
|
```
|
|
|
|
Linux:
|
|
------
|
|
- Install [ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages).
|
|
- For non-x86(_64) platforms: Install wine from your package manager.
|
|
- For x86(_64), [WiBo](https://github.com/decompals/WiBo), a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.
|
|
|
|
Building
|
|
========
|
|
|
|
- Clone the repository:
|
|
```
|
|
git clone https://github.com/my/repo.git
|
|
```
|
|
- Using [Dolphin Emulator](https://dolphin-emu.org/), extract your game to `orig/GAMEID`.
|
|
|
|
- To save space, the only necessary files are the following. Any others can be deleted.
|
|
- `sys/main.dol`
|
|
- `files/rels/*.rel`
|
|
- Configure:
|
|
```
|
|
python configure.py
|
|
```
|
|
To use a version other than `GAMEID` (USA), specify it with `--version`.
|
|
- Build:
|
|
```
|
|
ninja
|
|
```
|
|
|
|
Visual Studio Code
|
|
==================
|
|
|
|
If desired, use the recommended Visual Studio Code settings by renaming the `.vscode.example` directory to `.vscode`.
|
|
|
|
Diffing
|
|
=======
|
|
|
|
Once the initial build succeeds, an `objdiff.json` should exist in the project root.
|
|
|
|
Download the latest release from [encounter/objdiff](https://github.com/encounter/objdiff). Under project settings, set `Project directory`. The configuration should be loaded automatically.
|
|
|
|
Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, `configure.py`, `splits.txt` or `symbols.txt`.
|
|
|
|
|