Guide for PEAK in MultiworldGG
Required Software
Setup the Mod
Install BepInEx:
- Download BepInEx 5.x for your platform
- Extract to your PEAK game directory
- Run the game once to generate BepInEx folders
Install the Plugin:
- Download the
peakpelagofolder from the releases - Drag the entire
peakpelagofolder into yourBepInEx/plugins/directory - The folder contains all necessary files
- Download the
Launch the Game:
- Start PEAK - the plugin will create a configuration file on first run
- Connect using the in game UI
How to Play
Generate a Multiworld:
- Create a YAML configuration for your PEAK world
- Generate the multiworld using Archipelago's generator
- Host or join a multiworld session
Start PEAK:
- Launch the game with the mod installed
- The in-game UI will show connection status
Connect to Archipelago:
- Use the in-game menu in the top left
- Fill in the connection details and click Connect or hit Enter
Play the Game:
- Ascents are initially locked - unlock them by receiving items
- Collecting items and completing objectives sends checks to other players
- Receive items from other players as they complete their objectives
- Work together (or compete) to complete your goals!
Troubleshooting
Plugin Not Loading
- Verify BepInEx is installed correctly
- Check
BepInEx/LogOutput.logfor errors - Ensure all dependencies are in the plugins folder
Cannot Connect to Server
- Verify server address and port in config
- Check firewall settings
- Ensure the Archipelago server is running and accessible
Items Not Received
- Check connection status in UI
- Verify slot name matches your generated world
- Review state file for corruption:
BepInEx/config/Peak.AP.state.*.txt
Locations Not Checking
- Ensure you're connected to the server
- Check that the location exists in the world definition
- Review debug logs for check submission errors