# Final Fantasy VII decomp (PS1)

## Contribute

This project is open to contributors!
Decompiling a video game is a collaborative effort made possible by passionate people.

* If you’d like to know more about how to contribute, feel free to reach out to me on Discord.
* New pull requests are always welcome!

## Set-up

Clone the repository, then run `git submodule update --init --recursive`

```shell
git clone git@github.com:Xeeynamo/ff7-decomp.git --recursive &&\
cd ff7-decomp
```

Install the necessary dependencies:

```shell
#Create the python virtual environment
make requirements

# Debian/Ubuntu
sudo add-apt-repository ppa:longsleep/golang-backports
sudo apt update
sudo apt install golang-go ninja-build 7zip bchunk binutils-mipsel-linux-gnu gcc-mipsel-linux-gnu

# Arch Linux
sudo pacman -S go ninja 7zip bchunk
yay mipsel-linux-gnu-binutils mipsel-linux-gnu-gcc
```


Create a /disks directory and place the required disk images within:

```shell
#Create the disks directory
mkdir disks

# Copy the following files into /disks
'disks/Final Fantasy VII (USA) (Disc 1).bin'
'disks/Final Fantasy VII (USA) (Disc 1).cue'
'disks/Final Fantasy VII (USA) (Interactive Sampler CD).bin' # OPTIONAL!
'disks/Final Fantasy VII (USA) (Interactive Sampler CD).cue' # OPTIONAL!
```

after this extract the data files:

```shell
make disks
```

## Tooling

* `make build`: build project
* `make clean`: remove generated files from `./build`
* `make format`: format codebase
* `make disks`: extract the individual data files from the .bin disk image
* `./mako.sh rank <source_path>`: find remaining functions to decompile, sorted from easiest to hardest
* `./mako.sh dec <function_name>`: decompile function
* `./mako.sh symbols add <path> <name> <offset> [size]`: add or rename a symbol

## Game strings

The game uses a custom character encoding instead of standard ASCII.
In this codebase, such strings are represented as `_S("Hello FF7!")`.

To decode a FF7-style string into readable ASCII, use the included tool:

```shell
# compile it at least once
make bin/str

# specify an overlay and an offset in hex
bin/str disks/us/MENU/SAVEMENU.MNU 12DF8

# the program prints the decoded string to your terminal:
Saving. Do not remove Memory card.
```

## AI / LLM stance

The matching decompilation of Final Fantasy VII in this repository is done by humans. Every pull request submitted will strictly be reviewed by humans, line by line to ensure the highest quality bar is maintained. This project has no place for LLM-accelerated decompilation work. You may use LLMs for tooling, to permute a hard function, or to hunt bugs at runtime; ultimately the decompiled code you submit must be your own work. Any hostile fork used as a fast-lane is strictly forbidden, and we will enforce the project's license against them. Please familiarize yourself with [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more about our LLM stance.

Decompiling a game is not a sprint, it is a marathon.