PEAK Archipelago Mod

An Archipelago integration mod for the game PEAK, allowing the game to be played as part of a multiworld randomizer.

Overview

This mod connects PEAK to the Archipelago multiworld randomizer system. Ascent unlocks, badges, and other progression items are randomized across multiple games and players, creating a unique cooperative or competitive experience.

Features

• Ascent Progression: Unlock ascents (1-7) by receiving Archipelago items
• Badge Randomization: Badges are tracked and managed through Archipelago
• Location Checks: Game events and collectibles send progression to other players
• DeathLink Support: Optional death synchronization with other players
• Auto-Reconnect: Automatically reconnects to the Archipelago server if disconnected
• Persistent State: Tracks received items and checked locations across game sessions
• Real-time Integration: Seamlessly integrates with PEAK's gameplay

Components

This mod consists of two main components:

1. Client Plugin (C# / BepInEx)

• File: PeakArchipelagoPlugin.cs
• Purpose: Runs inside the PEAK game client
• Dependencies: BepInEx, Archipelago.MultiClient.Net, Harmony

2. Archipelago World (Python)

• Location: peak/ directory
• Purpose: Defines game logic, items, locations, and rules for the Archipelago server
• Files:
  • __init__.py - Main world definition
  • Items.py - Item definitions and classifications
  • Locations.py - Location (check) definitions
  • Options.py - Player-configurable options
  • Regions.py - Game region structure
  • Rules.py - Progression logic and access rules

Installation

Client Plugin Installation

1. Install BepInEx:

   • Download BepInEx 5.x for your platform
   • Extract to your PEAK game directory
   • Run the game once to generate BepInEx folders

2. Install the Plugin:

   • Download the PeakArchipelagoPluginDLL folder from the releases
   • Drag the entire PeakArchipelagoPluginDLL folder into your BepInEx/plugins/ directory
   • The folder contains all necessary DLLs including the plugin and Archipelago.MultiClient.Net

3. Launch the Game:

   • Start PEAK - the plugin will create a configuration file on first run
   • Configure your connection settings (see Configuration section)

Archipelago World Installation

1. Locate Archipelago Installation:

   • Find your Archipelago installation directory
   • Navigate to lib/worlds/ or worlds/

2. Copy World Files:

   • Copy the entire peak/ folder to the Archipelago worlds directory

3. Verify Installation:

   • Run Archipelago's world validator to ensure proper installation
   • The "PEAK" option should appear when generating games

Configuration

Client Configuration

The plugin creates a configuration file at BepInEx/config/com.yourname.peak.ap.cfg:

[Connection]
# Archipelago server address
Server = archipelago.gg

# Server port
Port = 38281

# Your slot/player name
Slot = Player1

# Room password (if required)
Password = 

# Auto-reconnect on disconnect
AutoReconnect = true

[DeathLink]
# Enable DeathLink mode
DeathLink = false

# Death behavior: 0 = Reset Run, 1 = Reset to Checkpoint
DeathLinkBehavior = 0

# Drop items on DeathLink death
DeathLinkDropItems = true

# Apply status effects on DeathLink death
DeathLinkApplyStatus = true

World Options

When generating an Archipelago game, the following PEAK-specific options are available:

• Goal: Choose between "Reach Peak" or "Complete All Badges"
• Required Ascent Count: Number of ascents needed to complete (0-7, default: 4)
• Required Badge Count: Number of badges needed for badge completion goal (10-50, default: 20)
• Death Link: Enable death synchronization with other players
• Death Link Behavior: Choose between full run reset or checkpoint reset

How to Play

1. Generate a Multiworld:

   • Create a YAML configuration for your PEAK world
   • Generate the multiworld using Archipelago's generator
   • Host or join a multiworld session

2. Start PEAK:

   • Launch the game with the mod installed
   • The in-game UI will show connection status

3. Connect to Archipelago:

   • Use the in-game menu (press the UI toggle key)
   • Connection will happen automatically based on your config
   • Verify connection status in the UI overlay

4. 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!

In-Game UI

The mod includes an on-screen overlay showing:

• Connection status
• Current server/slot information
• Items received counter
• Last received item and timestamp
• Luggage opened count
• DeathLink status and history
• Unlocked ascents

Toggle the UI visibility using the configured hotkey.

Development

Building the Client Plugin

Requirements:

• .NET Framework compatible with Unity
• BepInEx 5.x references
• Archipelago.MultiClient.Net library
• Harmony library
• PEAK game assemblies for reference

Modifying the World

The Python world code follows Archipelago's world API:

• Modify Items.py to add/change items
• Update Locations.py for new location checks
• Edit Rules.py to adjust progression logic
• Change Options.py to add player options

Testing

1. Test the client plugin in isolation with debug logging enabled
2. Generate test multiworld with only PEAK
3. Verify item receiving and location checking
4. Test with other Archipelago games for integration

Troubleshooting

Plugin Not Loading

• Verify BepInEx is installed correctly
• Check BepInEx/LogOutput.log for 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

Credits

• Mod Author: [Your Name]
• Archipelago: Archipelago Team
• PEAK: [Original Game Developer]
• BepInEx: BepInEx Team

Version

Current Version: 0.3.0

License

[Specify your license here]

Links

• Archipelago Website
• Archipelago Discord
• BepInEx Documentation

---

Note: This is a fan-made mod and is not affiliated with or endorsed by the original PEAK developers.