Skip to content

add build instructions for WSL #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roengstrom merged 2 commits into from
Sep 9, 2026
Merged

add build instructions for WSL #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15c8b68
add build instructions for wsl
dargor123 Sep 7, 2026
a3c9042
remove sudo mention from build instructions
dargor123 Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,21 @@ Any help is greatly appreciated! Below are some basic steps to get started and b
git clone --recursive https://github.com/roengstrom/ff8-decomp.git
cd ff8-decomp
```
- **Note:** If you are using Windows, you must use **WSL 2** to build the project.

The following distributions have been tested for building the project:

| Distro | Can build? |
|:------------:|:----------:|
| Ubuntu-22.04 | ✅ |
| Ubuntu-24.04 | ✅ |
| Ubuntu-26.04 | ❌ |

On a fresh installation, run the following commands to install the packages required to build the project:
```bash
sudo apt update
sudo apt install python3-venv make build-essential binutils-mipsel-linux-gnu
```

2. **Create a Python venv and install splat**:
```bash
Expand Down