diff --git a/README.md b/README.md index 830aae6..df8e4a4 100644 --- a/README.md +++ b/README.md @@ -58,17 +58,32 @@ opengoal-launcher 1. Launch the launcher and set your install directory 2. Select a game and let the launcher download the game version binaries -3. **Run the patch script** to make the downloaded binaries NixOS-compatible: +3. Patch the downloaded files for NixOS ⚠️ +This is the one NixOS-specific step. The game engine files the launcher just +downloaded won't run on NixOS out of the box, so we need to patch them. + +The `opengoal-patch-bins` script is included with this package — the same +install that gave you `opengoal-launcher` also gives you this script. + +Open a terminal and run: ```bash -opengoal-patch-bins /path/to/opengoal/versions/official/vX.Y.Z +opengoal-patch-bins /path/to/your/install/folder/versions/official/v0.3.1 ``` -For example: +Replace the path with wherever you told the launcher to install in Step 1, and +replace `v0.3.1` with whatever version the launcher downloaded. You can find +the correct version number by looking inside the `versions/official/` folder +in your install directory. + +For example, if you installed to `/home/user/Games/opengoal` it would be: ```bash -opengoal-patch-bins ~/.local/share/opengoal/versions/official/v0.3.1 +opengoal-patch-bins /home/user/Games/opengoal/versions/official/v0.3.1 ``` +You should see `Done: gk`, `Done: extractor`, and `Done: goalc` printed out. +If you see "already patched" for all three, see the Troubleshooting section. + 4. Point the launcher at your PS2 ISO and let it extract, decompile, and compile the game 5. Click Play