You are viewing a potentially older version of this package. View all versions.
Sparroh-CollectableWaypoints-1.0.5 icon

CollectableWaypoints

Shows map waypoints for undiscovered data logs, pumpkins, bears, and other punch collectables so you can track them more easily.

Date uploaded 3 weeks ago
Version 1.0.5
Download link Sparroh-CollectableWaypoints-1.0.5.zip
Downloads 84
Dependency string Sparroh-CollectableWaypoints-1.0.5

This mod requires the following mods to function

BepInEx-BepInExPack_Mycopunk-5.4.2403 icon
BepInEx-BepInExPack_Mycopunk

BepInEx pack for Mycopunk. Preconfigured and ready to use.

Preferred version: 5.4.2403

README

Collectable Waypoints

A client-side BepInEx mod for Mycopunk that adds map waypoints for undiscovered collectables so you can find them more easily during missions.

Features

  • Data Log Waypoints — Marks undiscovered data logs. Waypoints are removed when a log is opened.
  • Pumpkin Waypoints — Marks undiscovered pumpkins (col_pump*). Waypoints clear when punched.
  • Bear Waypoints — Marks undiscovered teddy bears / bear collectables. Waypoints clear when punched. Does not mark the Bruiser character.
  • Other Punch Collectables — Automatically marks any other or future punch-collectable sets (eggs, event items, etc.) without a mod update.
  • Colored Waypoints — Each category uses its own color (configurable).
  • Independent Toggles — Enable or disable each category separately in the config.
  • Live Config Reload — Saving the config file applies toggles and colors immediately in the current mission (no restart required).

Installation

Dependencies

Thunderstore (recommended)

  1. Install via Thunderstore Mod Manager / r2modman.
  2. The mod is placed in the correct plugins folder automatically.

Manual

  1. Build or download CollectableWaypoints.dll.
  2. Place it in <Mycopunk Directory>/BepInEx/plugins/.

The mod loads automatically with BepInEx. On success, the console shows:

CollectableWaypoints loaded successfully.

Configuration

Settings live in:

<Mycopunk Directory>/BepInEx/config/sparroh.collectablewaypoints.cfg

The config file is watched while the game is running. Saving changes reloads settings and rebuilds waypoints in the current mission.

General

Setting Default Description
Data Log Waypoints true Show waypoints for undiscovered data logs
Pumpkin Waypoints true Show waypoints for pumpkins
Bear Waypoints true Show waypoints for bears
Other Waypoints true Show waypoints for other / future punch collectables

Colors

Colors accept #RRGGBB, #RRGGBBAA, or R,G,B[,A] (components as 0–255 or 0–1).

Setting Default Description
Data Log Waypoint Color #33E64D Green — data logs
Bear Waypoint Color #408CFF Blue — bears
Pumpkin Waypoint Color #FF8C1A Orange — pumpkins
Other Waypoint Color #D973FF Purple — other punch collectables

Building

  1. Clone this repository.
  2. Open the solution in Visual Studio, Rider, or another C# IDE.
  3. Build in Release mode (netstandard2.1).

Or with the .NET CLI:

dotnet build --configuration Release

Output DLL:

bin/Release/netstandard2.1/CollectableWaypoints.dll

Troubleshooting

  • Mod not loading? Confirm BepInEx is installed correctly and check the BepInEx console for errors.
  • No waypoints appearing? Enable the relevant config toggles and make sure you are in a mission (not the hub).
  • Data log waypoints not clearing? Fully open the log so discovery is registered.
  • What did the game call a collectable? Check BepInEx logs for lines like [PunchCollectable] kind=... apiName=... (logged once per mission scene).

Authors

  • Sparroh

License

This project is licensed under the MIT License — see the LICENSE file for details.

CHANGELOG

Changelog

1.0.7

  • Added Upgrade Crate Waypoints for punchable upgrade crates (UpgradeHittable)
  • Configurable gold/yellow waypoint color (default #FFE14D)
  • Waypoints clear when a crate is punched; mid-mission spawns (e.g. bunker rewards) are picked up via Awake

1.0.6

  • Fixed NullReferenceException when applying waypoints before the local player/Highlighter exists
  • Use Highlighter.TryGetInstance instead of the unsafe Highlighter.Instance getter
  • Defer waypoint setup via Update-loop retry until Highlighter is ready (no GameManager spawn callback)

1.0.5

  • Refactor

1.0.4

  • Configurable waypoint colors per category (defaults: data logs green, bears blue, pumpkins orange, other purple)
  • Shared WaypointUtil helper for colored add/remove
  • Cleaned up data log patches to match punch-collectable structure (still a separate system)
  • Color and toggle changes rebuild waypoints immediately

1.0.3

  • Future-proof punch collectables: unknown PunchCollectable sets are waypointed under Other Waypoints
  • Pumpkins match known API ids (col_pump*) as well as name tokens
  • Unique punch-collectable profiles are logged once per scene with classified kind

1.0.2

  • Fixed bear waypoints incorrectly marking the Bruiser player/character
  • Bears and pumpkins now use the game's PunchCollectable type instead of loose object-name matching
  • Shared punch-collectable waypoint helper for bears and pumpkins
  • Waypoints clear immediately when a bear or pumpkin is punched
  • Improved pumpkin matching via profile API name, display name, and object name
  • Logs punch-collectable profile ids once per scene to help identify API names

1.0.1

  • Config file hot-reloads when changed on disk (no restart required)
  • Toggling waypoint types applies immediately in the current mission

1.0.0

  • Initial release
  • Waypoints for undiscovered data logs
  • Waypoints for pumpkins
  • Waypoints for bears
  • Independent config toggles for each collectable type