🏔️ FollowMe-Peak

A BepInEx plugin for PEAK that automatically records paths in levels and displays them as a visual aid for other players.

📸 Screenshots

The modern UI interface matching Peak's visual style / Visual path display showing both local (red) and cloud (blue) paths

✨ Features

• 🤖 Automatic Path Recording: Automatically records your movements in each level.
• 🎨 Visual Path Display: Displays recorded paths as visible lines in the game.
  • Red Lines: Your locally saved paths.
  • Blue Lines: Paths loaded from the cloud.
• 🎮 Modern UI: Clean interface that matches Peak's visual style.
• 📊 Difficulty Tracking: Tracks and saves ascent levels for each climb.
• 🔍 Advanced Filtering: Easy search and filter climbs through the UI.
• 🏞️ Biome-Specific Paths: Saves paths separately for each biome of the day
• ☁️ Cloud Synchronization: Optionally share your paths with other players via a server.
• ⌨️ Easy to Use: The F1 key opens the settings menu.
• 💾 Persistent Storage: Paths are saved between game sessions.
• 💀 Death Tracking: Optional saving of climbs that end in death (with special marking)

🚀 Installation

1. Install BepInEx via a Mod Manager (e.g., r2modman or Thunderstore Mod Manager).
2. Install FollowMe-Peak via the Mod Manager.
3. Start the game. The plugin is now active.

🕹️ Usage

The plugin automatically starts recording as soon as you enter a level.

Opening & Using the Menu

1. Press the F1 key to open or close the settings menu.
2. IMPORTANT: After opening the menu, press the ESC key to unlock your mouse cursor. You can now click the buttons in the menu.

In the menu, you can:

• Toggle Visibility: Click the small icon next to a path in the list to enable or disable its display in the game.
• Filter by Difficulty: Use ascent level filters to find climbs matching your skill level.
• Search Climbs: Easily find specific climbs using the search feature.
• Configure Cloud Sync: Activate/Deactive the cloud sync.
• Manage Paths: Delete paths you no longer need.

Paths are automatically saved whenever you light a campfire.

🔄 Map Rotation Note

When the map rotation occurs, all saved routes are reset. Someone needs to climb ahead and share their route with others to rebuild the path database for the new rotation.

☁️ Cloud Synchronization (Optional)

The plugin can connect to an optional server to share paths. Server setup is optional; the plugin works completely offline.

• Upload: Upload your paths to share them with others.
• Download: Download paths from other players.
• Automatic Sync: New paths are fetched from the server every time a level starts.

How to Share Your Path

1. Enable Cloud Synchronization in the settings menu (F1 > ESC).
2. Select your recorded path from the list.
3. Click the button to copy the "Peak Code" for that path.
4. Send this code to your friends. They can paste it into the menu to download your path.

💻 Compatibility

• Game: PEAK
• Framework: BepInEx 5.4.21 or newer
• Platform: Windows / Steam

🛠️ Troubleshooting

If the plugin doesn't work as expected:

1. Check BepInEx Installation: Ensure that BepInEx is installed correctly and that you are launching the game via the mod manager.
2. Check the Logs: Look for error messages in the BepInEx log file at BepInEx/LogOutput.log.
3. Restart: Restart the game completely after installing the plugin.

📜 Changelog

v1.0.3

New Features

• Complete climb tracking from kiln to peak - Track your entire journey from the starting kiln all the way to the peak, fulfilling the dream of peaking!
• Improved climb timing - Climbs now start precisely with the "RUN STARTED" sequence for better accuracy
• Death tracking - Climbs with deaths can now be saved (configurable in settings)
  • Death climbs are marked with a small death icon
  • Death climbs have no share code and won't be uploaded to the cloud
• Global mod logger - Implemented centralized logging system with configurable log levels in BepInEx config

Improvements

• Climb tracking automatically stops on death or return to home
• Better climb start/stop detection for more accurate path recording
• Enhanced debugging capabilities through the new logging system

v1.0.2

New Features

• Improved flymod detection - Now only displays valid climbs without false positives
• Update notification system - Displays in-game notifications when a new mod version is available
• New settings menu - Customizable hotkey configuration for toggling the menu

Improvements

• Better climb validation to ensure only legitimate climbs are shown
• Push notification capability for mod updates

v1.0.1

Fix

• Fixed a rendering issue that caused the User Interface (UI) to display pink boxes instead of text when using Vulkan (e.g., on Linux/Steam Deck). All text is now rendering correctly.

v1.0.0

New Features:

• Completely redesigned UI that fits the design of the game
• Difficulty tracking implemented - Ascent level is now saved and can be used as a filter
• Optimized climb storage with reduced memory usage locally and on the server
• Non-blocking route display that doesn't obstruct the game view

Fixes & Optimizations:

• Fixed lag spikes when activating campfires
• Limited to 25 climbs per filter for better performance
• Automatic list updates with visible climbs at the top
• Improved sorting for cloud and local climbs by duration

v0.1.0

• Initial release
• Basic path recording and visualization
• Cloud synchronization implemented
• User interface added via F1

💬 Support & Feedback

We love hearing from the community! Your feedback, bug reports, and feature requests help make FollowMe-Peak better.

📢 Get in Touch:

• 🐛 Bug Reports & Feature Requests: Create an Issue in the GitHub Repository
• 💭 Discord Community: Join the discussion in our Discord Channel for quick help, feedback, and connecting with other climbers!
• 🌟 Show Your Support: If you enjoy the mod, consider giving us a star on GitHub!

Your input is invaluable - whether it's reporting a bug, suggesting a new feature, or just sharing your climbing experiences with FollowMe-Peak!