diff --git a/worlds/jakanddaxter/docs/setup_en.md b/worlds/jakanddaxter/docs/setup_en.md index f11953d6dd..78e950615e 100644 --- a/worlds/jakanddaxter/docs/setup_en.md +++ b/worlds/jakanddaxter/docs/setup_en.md @@ -37,8 +37,21 @@ At this time, this method of setup works on Windows only, but Linux support is a - Reminder: the default installation location for Archipelago is `C:\ProgramData\Archipelago`. - Run the Archipelago Launcher. - From the left-most list, click `Generate Template Options`. -- Select `Jak and Daxter The Precursor Legacy.yaml`. In the text file that opens, enter the name you want and remember it for later. +- Select `Jak and Daxter The Precursor Legacy.yaml`. +- In the text file that opens, enter the name you want and remember it for later. - Save this file in `Archipelago/players`. You can now close the file. +- Back in the Archipelago Launcher, click `Open host.yaml`. +- In the text file that opens, search for `jakanddaxter_options`. If you do not see it, you will need it add it. + - Change (or add) the `root_directory` entry and provide the path you noted earlier containing `gk.exe` and `goalc.exe`. + - **CHANGE ALL BACKSLASHES `\ ` TO FORWARD SLASHES `/ `.** + - The result should look like this. You can now save and close the file. + +``` +jakanddaxter_options: + # Path to folder containing the ArchipelaGOAL mod executables (gk.exe and goalc.exe). + root_directory: "C:/Users//AppData/Roaming/OpenGOAL-Mods/archipelagoal" +``` + - Back in the Launcher, from the left-most list, click `Generate`. A window will appear to generate your seed and close itself. - If you plan to host the game yourself, from the left-most list, click `Host`. - When asked to select your multiworld seed, navigate to `Archipelago/output` and select the zip file containing the seed you just generated. @@ -115,6 +128,37 @@ Input file iso_data/jak1/MUS/TWEAKVAL.MUS does not exist. - If the game freezes by replaying the same two frames over and over, but the music still runs in the background, you may have accidentally interacted with the powershell windows in the background - they halt the game if you:scroll up in them, highlight text in them, etc. - To unfreeze the game, scroll to the very bottom of the log output and right click. That will release powershell from your control and allow the game to continue. - It is recommended to keep these windows minimized and out of your way. +- If the client cannot open a REPL connection to the game, you may need to ensure you are not hosting anything on ports 8181 and 8112. + +***Special PAL Instructions*** + +PAL versions of the game seem to require additional troubleshooting/setup in order to work properly. Below are some instructions that may help. + +- If you have `-- Compilation Error! --` after pressing `Recompile` or Launching the ArchipelaGOAL mod. Try this: + - Remove these folders if you have them: + - `%appdata%\OpenGOAL-Mods\iso_data` + - `%appdata%\OpenGOAL-Mods\archipelagoal\iso_data` + - `%appdata%\OpenGOAL-Mods\archipelagoal\data\iso_data` + - Place Jak1 ISO in: `%appdata%\OpenGOAL-Mods\archipelagoal` rename it to `JakAndDaxter.iso` + - Type "CMD" in Windows search, Right click Command Prompt, and pick "Run as Administrator" + - Run: `cd %appdata%\OpenGOAL-Mods\archipelagoal` + - Then run: `extractor.exe --extract --extract-path .\data\iso_data "JakAndDaxter.iso"` + - (Command should end by saying `Uses Decompiler Config Version - ntsc_v1` or `... - pal`) + - Rename: `%appdata%\OpenGOAL-Mods\archipelagoal\data\iso_data\jak1` to `jak1_pal`* + - Run next: `decompiler.exe data\decompiler\config\jak1\jak1_config.jsonc --version "pal" data\iso_data data\decompiler_out`* + - *For NTSCv1 (USA Black Label) keep the folder as `jak1`, and use command: `decompiler.exe data\decompiler\config\jak1\jak1_config.jsonc --version "ntsc_v1" data\iso_data data\decompiler_out` + - Rename: `%appdata%\OpenGOAL-Mods\archipelagoal\data\iso_data\jak1_pal` to `jak1` + - Rename: `%appdata%\OpenGOAL-Mods\archipelagoal\data\decompiler_out\jak1_pal` to `jak1` +- You have to do this last bit in two different terminal **(2 powershell)**. First, from one terminal, launch the compiler: + - `cd %appdata%\OpenGOAL-Mods\archipelagoal` + - `.\goalc.exe --user-auto --game jak1` + - From the compiler (in the same terminal): `(mi)` + - This should compile the game. **Note that the parentheses are important.** + - **Don't close this first terminal, you will need it at the end.** +- Then, **from the second terminal (powershell)**, execute the game: + - `cd %appdata%\OpenGOAL-Mods\archipelagoal` + - `.\gk.exe -v --game jak1 -- -boot -fakeiso -debug` +- Finally, **from the first terminal still in the Goalc compiler**, connect to the game: `(lt)` ### Known Issues