APCpp@185b6498d1 | ||
asm_hxx@9b1c186c76 | ||
data | ||
launcher/src | ||
mod | ||
UATServerIX | ||
utf8@217518d38b | ||
.clang-format | ||
.gitignore | ||
.gitmodules | ||
CMakeLists.txt | ||
constants.hxx.in | ||
LICENSE | ||
Makefile | ||
README.md |
Yoku's Island Adventure Randomizer Mod
Required Software
- Yoku's Island Adventure, from:
- GOG.com,
- Epic Games or
- Steam
- This Mod
Optional Software
-
For generating multiworld games: Archipelago and the Yoku's Island Express APWorld
-
For sending commands: An archipelago text client.
Installation
Download yam-x.y.z.tgz
from the releases page, and extract it into the game folder.
Launching
Launch the yam-launcher.exe
file however you normally launch the game:
GOG
It should be enough to just click yam-launcher.exe
, or make a shortcut, or whatever.
Epic
It should still work to simply open yam-launcher.exe
; the game may complain about not being launched from the Epic launcher, but it will still run.
Steam
Windows
Modify "Launch Options" to read:
"C:\...\yam-launcher.exe" %COMMAND%
Replace C:\...\yam-launcher.exe
with the correct full path to yam-launcher.exe
.
Alternatively, you can add yam-launcher.exe
as a non-steam game.
Linux
NOTE: I have not been able to test this code successfully on steam in linux. You're welcome to try it; YMMV.
On steam in linux, you will have to get proton to run yam-launcher.exe
. Create the following script in the game folder:
#!/bin/bash
"${@:1:$#-1}" "$STEAM_COMPAT_INSTALL_PATH"/yam-launcher.exe
Make it executable, then set your game's "Launch Options" to:
./yam-proton.sh %COMMAND%
Replace yam-proton.sh
with the name of the script file.
Opening a game and connecting to a server.
To open an archipelago game from the main menu:
- Select "Continue"
- Select an empty slot
- Select "Randomize mode"
- Set the difficulty to "Very Hard" (this does not depend on the configuration you set when you generated the world.)
- Choose any start option.
- When the beginning animation ends, the game will ask you if you want to load an APWorld. Select "Yes".
- The game will then prompt you for server/slot/password.
Bugs and Peculiarities
I can't see Yoku
If it's the beginning of the game, this may be because a dialog popped up before Yoku washed up. You're just off-screen to the left; walk right to fix it.
I can't get into the Boiling Underbelly
This is a known issue when the Key to the Underbelly
is received as a remote item. To fix it, just save and then Reload from Checkpoint
(you don't have to exit your game).
This isn't working on my system
If you're using steam on linux you might just be out of luck for now. I'm trying to figure out why that's not working correctly for me, but I don't have the answers yet.
If the game is starting but can't connect to a server, you may be experiencing an issue with your wine prefix's certificate store. To fix it, try running internet explorer (wine iexplorer.exe
) and then closing it.
If that doesn't do the trick another reported fix is building the project from source.
If you're not on linux, or the above fixes don't work, let me know about it!
For anything else
The issue tracker is the best place to let me know about it.
Building
On Linux
You will need msvc-wine, GNU make, and cmake.
Download the source, switch to the directory, and run make
. If that runs successfuly, then yam-<VERSION>.tgz
will be in the build folder.
On Windows
You will need Visual Studio and cmake.
Download the source, switch to the directory, and run:
cmake -Bbuild .
cmake --build build --config Release
NOTE: The project will only compile if you choose the Release
config because the Debug
and Release
versions of the std library are incompatible, and the game is compiled against the Release
version.