mirror of https://github.com/xbret/xenoblade.git synced 2024-10-06 19:13:44 +00:00

Decompilation of Xenoblade (JP)

Go to file

Amber Brault 49134b4c96 Some checks are pending Build / build (eu) (push) Waiting to run Details Build / build (jp) (push) Waiting to run Details Build / build (us) (push) Waiting to run Details CBattleManager.cpp progress		2024-10-06 14:55:40 -04:00
.github/workflows	Sync dtk files with main branch	2024-09-03 13:03:04 -04:00
.vscode	Fine i'll use spaces :p	2024-10-05 21:46:48 -04:00
config	CBattleManager.cpp progress	2024-10-06 14:55:40 -04:00
docs	Update dtk stuff (build fails for now)	2024-10-01 18:21:19 -04:00
include	Fix all_source/matching errors	2024-09-21 13:47:19 -04:00
libs	Use src_dir instead	2024-10-06 12:41:10 -04:00
orig	Add gitkeeps to the eu/us folders	2024-08-08 11:43:34 -04:00
src/kyoshin/appgame	CBattleManager.cpp progress	2024-10-06 14:55:40 -04:00
tools	Use src_dir instead	2024-10-06 12:41:10 -04:00
.gitattributes	Replace main branch with dtk changes	2024-08-08 11:34:49 -04:00
.gitignore	Update dtk stuff (build fails for now)	2024-10-01 18:21:19 -04:00
configure.py	Use src_dir instead	2024-10-06 12:41:10 -04:00
LICENSE	Replace main branch with dtk changes	2024-08-08 11:34:49 -04:00
README.md	Also use spaces for metrowerks stuff	2024-10-05 22:27:07 -04:00

README.md

Xenoblade

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

It builds the following executables:

Region	SHA1 hash	Code Progress	Data Progress
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.