🧭 FollowTheWay

FollowTheWay is a mod for PEAK that records your movement and lets you visualize paths right in-game. Plan safer routes, review tricky sections, and share your best runs with friends — all from a simple in-game menu.

✨ Features

• Path Recording: Capture your movement while you play and save each run as a JSON file.
• In-Game Visualization: Render saved paths using a configurable LineRenderer (width, color, smoothing, max points).
• Quick Menu (F6): Start/stop recording, browse runs, filter by outcome (Win/Death/Manual/Level Change), show/hide paths, delete runs.
• Local-First: All data is stored locally (BepInEx/config/FollowTheWay/paths). No server required.
• Metadata: Set a display name and author for runs; quickly apply metadata to the most recent save.
• Performance Controls: Decimation and a maximum point cap keep rendering smooth.

📋 Requirements

Using a mod manager is recommended:

• Gale or
• r2modman

Manual install is also supported. Before installing, make sure you have:

• BepInEx 5 — required to load the mod.

Note: No online dependencies. Everything works offline.

⌨️ Usage

• Press F6 to open the FollowTheWay menu.
• Click Start Recording / Stop Recording to control capture.
• Use Show/Hide to visualize a saved path in the current scene.
• Filter by Wins, Deaths, Manual, or Level Change and search by name/author.
• Use Apply to Last Saved to set a name/author on your most recent run quickly.

Paths are saved to: BepInEx/config/FollowTheWay/paths

⚙️ Configuration

The first time you run the game with FollowTheWay installed, a config file is created at: BepInEx/config/com.followtheway.peak.mod.cfg

[General]

• EnableRecording
  Toggles path recording feature on/off.
  Values: true / false — Default: true

• AllowUploads
  Enables Harmony patches for automatic events (recommended).
  Values: true / false — Default: true

• ShowToasts
  Enables simple toast notifications.
  Values: true / false — Default: true

• ShowPathSelectionUI
  Enables the in-game paths menu.
  Values: true / false — Default: true

[Hotkeys]

• ToggleMenu
  Open/close the menu.
  Values: Unity KeyCode — Default: F6

[Visual]

• LineWidth
  Line thickness (0.02–1.5).
  Decimal — Default: 0.35

• ForceOnTop
  Render line above world geometry (may help visibility).
  true / false — Default: false

• SmoothCorners
  Rounded caps/corners for the line.
  true / false — Default: true

• LineColorR, LineColorG, LineColorB
  Line color (0..1 per channel).
  Decimal — Default: 0, 1, 0 (green)

[Performance]

• DecimationStep
  Render each Nth point (>= 1). Higher = fewer rendered points.
  Integer — Default: 1

• MaxPoints
  Maximum points rendered by the LineRenderer (>= 100).
  Integer — Default: 10000

🧩 Installation (Manual)

1. Install BepInEx 5 for PEAK.
2. Download this mod’s .zip.
3. Extract to your game folder so that:

   BepInEx/plugins/FollowTheWay/FollowTheWay.dll
   

   exists.
4. Launch the game. Press F6 in-game to open the menu.

🛠 Troubleshooting

• “I don’t see the line”

  • Enable ForceOnTop in config or increase LineWidth to 0.5.
  • Make sure you pressed “Show” on a saved run with ≥ 2 points.

• “The game lags with many long runs”

  • Increase DecimationStep (e.g., 2 or 3).
  • Reduce MaxPoints (e.g., 5000).
  • Hide the visualization when not needed.

• “No runs are showing”

  • Check the save folder at BepInEx/config/FollowTheWay/paths.
  • Start/Stop a quick recording to generate a test file.

🤝 Help Wanted

I’m looking for contributors to help build a simple backend for path sharing:

• Minimal API (upload/download paths, simple auth or anonymous tokens)
• Storage (object storage or lightweight DB)
• Rate limiting and basic abuse prevention
• Optional: community features (public/featured runs, map tags)

If you’re interested:

• Open an issue or PR on the repo
• Suggest a lightweight architecture (e.g., FastAPI/Express + S3-compatible storage)
• Share deployment tips (Docker compose, fly.io, Railway, etc.)

Contact: ABBADON

🗑 Uninstall

Delete the mod folder: BepInEx/plugins/FollowTheWay/

Optionally delete local saves: BepInEx/config/FollowTheWay/paths

🙌 Credits

• Built with BepInEx and Harmony.
• Author: ABBADON