Xenoblade

<!-- Replace with your Discord server's ID and invite URL. -->

This is a work-in-progress decompilation of Xenoblade.

It builds the following executables:

Region	SHA1 hash
JP	a564033aee46988743d8f5e6fdc50a8c65791160
EU	10d34dbf901e5d6547718176303a6073ee80dda2
US	214b15173fa3bad23a067476d58d3933ad7037b7

This repository does not contain any game assets or assembly whatsoever. An existing copy of the game is required.

Dependencies

Windows

On Windows, it's highly recommended to use native tooling. WSL or msys2 are not required. When running under WSL, objdiff is unable to get filesystem notifications for automatic rebuilds.

• Install Python and add it to %PATH%.
  • Also available from the Windows Store.
• Download ninja and add it to %PATH%.
  • Quick install via pip: pip install ninja

macOS

• Install ninja:

  brew install ninja
  

• Install wine-crossover:

  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:

sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'

Linux

• Install ninja.
• For non-x86(_64) platforms: Install wine from your package manager.
  • For x86(_64), 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, extract your game to orig/jp.

  • 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 jp, 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. 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.

Contributions

All contributions are welcome and very much appreciated. However, no LLM assisted contributions will be accepted. Additionally, make sure your code follows the style guidelines.