Gatherer - Valheim Resource Tracker

Version: 1.3.1 | Author: Imbrus_Chrapmajster

v1.3.1 - Valheim 1.0.21 dependency maintenance

• Updated the required denikson-BepInExPack_Valheim package to 5.4.2360 (BepInEx 5.4.23.6). The pack includes Doorstop 4.6.0 and loader/platform fixes; update it in the same r2modman profile as Gatherer.
• Checked against the installed Valheim 1.0.21 assemblies (Steam build 26249040). Gathering, mining, hover, cursor, map rendering and Cartography Table hook signatures remain compatible; no gameplay changes are needed.
• Build and automated tests are checked against the new game assemblies and loader. This is not a full in-game verification of this combination; the previous game log predates the update.
• Existing configuration, tracking selections, visibility filters and saved pins are unchanged. Updating BepInEx alone may be sufficient for v1.3.0 users; v1.3.1 declares the updated dependency for new installs and mod-manager updates.

Gatherer is a full-featured Valheim mod inspired by the legendary World of Warcraft Gatherer addon (v3.3.5a). It automatically logs, tracks, and pins gathered and discovered resource nodes on both your minimap and world map, prevents duplicate pin spam, supports granular per-resource mapping (e.g., mark mushrooms but ignore copper), and seamlessly shares all markings with clanmates through the in-game Cartography Table.

Local-import manual

START HERE: Install or update BepInExPack_Valheim to 5.4.2360 or newer in the same r2modman profile, import the Gatherer ZIP using Settings > Import local mod, and launch with Start modded. Load a character and world, then press F8 to open Gatherer. Import the ZIP, not the DLL: the ZIP carries this manual.

CHOOSE WHAT TO MARK: On a fresh configuration, every resource is OFF. In Resources & Categories, tick an individual resource such as Red Mushroom. Its category is enabled automatically, without selecting the other resources. A Category: ON switch selects every resource in that group; switching it OFF clears that group's selections. Select All and Deselect All affect all resource groups. Choices take effect immediately and are saved for this r2modman profile. Existing configurations keep their previous selections when upgrading; use Deselect All for a clean start.

ICONS AND VISIBILITY: In F8, open Map Icons & Visibility. Use item icons replaces recognized resource markers with their in-game item images where available; nodes without an item image keep their standard pin icon. Each resource has an independent visibility checkbox, plus Show All and Hide All. These affect both the world map and minimap, not tracking, saving, or Cartography Table sharing. Hidden pins remain underneath and can be shown again at any time. Friends with Gatherer interpret shared pin names using their own icon/filter settings; friends without Gatherer see ordinary pins.

FIRST MARKER: Select Red Mushroom, close the window with F8, Esc, or Close, and walk near a wild mushroom. The default discovery mode scans within 15 metres every 2 seconds and also records gathering/mining interactions. Open the world map with M to see the marker. Nearby nodes of the same resource are merged to prevent clutter. Turning tracking off stops new markers; it does not delete existing map pins.

DISCOVERY AND SETTINGS: General & Pin Settings contains the master Mod Enabled switch, cartography sharing, notifications, discovery mode, pin prefix, and merge distances. Interact Only records picking/mining; Interact & Proximity Radar also scans nearby nodes; Interact & Hover also records nodes you look at; All combines these triggers. Custom Filters & Radar adjusts scan radius and include/exclude lists. Exclude names block matching resources; include names explicitly opt matching resources into tracking even if their normal toggles are off. Leave both lists empty for checkbox-only tracking.

SHARE WITH FRIENDS: Leave Share On Cartography Table enabled. At a Cartography Table, use Record discoveries to upload your saved map pins. Friends then use Read map at that table to receive them. Friends do not need Gatherer just to receive the shared pins. Sharing is through the table, not automatic live synchronisation.

CONFIGURATION FILE: After the first modded launch, r2modman's Configuration editor lists com.watchdoge.valheim.gatherer.cfg. When editing that file, enable BOTH the relevant Track category and the individual resource entry. For red mushrooms only, set TrackMushrooms = true and RedMushroom = true; leave other resource entries false. ToggleUiKey changes the F8 shortcut. Edit files with the game closed.

TROUBLESHOOTING: If F8 does nothing, confirm Start modded was used and Gatherer and BepInEx are enabled in the selected profile. If no pins appear, check Mod Enabled, select a resource, clear unwanted exclusions, and visit a matching wild node; an existing nearby pin may suppress duplicates. If the cursor is still missing, confirm the updated Gatherer DLL is installed and inspect BepInEx's LogOutput.log for patch errors. The menu blocks character input; it does not pause the world.

FULL REFERENCE: The ZIP includes README.md with the complete settings and resource tables. Use r2modman's Settings > Browse profile folder, then open BepInEx\plugins and the Gatherer installation folder to find README.md. Locally imported mods do not get a rendered README page in the Installed list. This local-import package puts the guide above into the description shown when you expand Gatherer.

Table of Contents

1. Core Features & Overview
2. Prerequisites & Installation
   • Installing via r2modman (Recommended)
   • Manual Installation
3. User Manual & How It Works
   • 1. Discovery Modes (How Nodes are Detected)
   • 2. Cartography Table Sharing Guide
   • 3. Duplicate Prevention & Node Clustering
   • 4. Anti-Base Clutter (Base Crop Protection)
4. Configuration Guide
   • How to Access the Config
   • Common Configuration Scenarios
   • Comprehensive Settings Reference
5. Supported Resource Database
6. Advanced Filtering (Custom & Modded Prefabs)
7. Troubleshooting & FAQ

Core Features & Overview

• Resource Item Icons & Display Filters: F8 > Map Icons & Visibility offers item images and independent per-resource Show/Hide controls. Existing and shared pins are recognized by name; no custom pin types or asset downloads are required.
• WoW 3.3.5a Style Discovery: Automatically spots and maps resource spawns upon gathering, mining, walking near them (radar scan), or hovering over them.
• Native Cartography Table Integration: Markings are created using Valheim's persistent map pin system (m_save = true), meaning Record discoveries uploads your pins to the Cartography Table and Read map distributes them to everyone else on the server.
• Zero Client Lock-In (Vanilla Friendly): Other players on your server do not need the mod installed to view or download your pins from the Cartography Table!
• Granular Per-Resource Toggles: Every single resource has its own independent toggle. Want to track mushrooms and thistle, but never copper or tin? A single toggle in the config accomplishes that.
• Smart Duplicate Prevention: Uses distance clustering (default 10m for herbs/mushrooms, 20m for large mineral deposits) so you don't get 50 pins for one patch of berries.
• Customizable Pin Styles: Select icon shapes (Dot, Hammer, Fireplace, House, Portal) and optional prefixes (e.g., [G] ) for clear visual distinction.

Prerequisites & Installation

Installing via r2modman (Recommended)

Important Requirement: Any r2modman profile requires BepInExPack_Valheim as the core modloader before other mods can run.

1. Open r2modman and select Valheim.
2. Select or create your profile (e.g. Default or your custom profile).
3. If BepInEx is not yet installed in this profile:
   • Go to the Online tab in the left menu.
   • Click denikson-BepInExPack_Valheim (pinned at top).
   • Click Download → Download with dependencies.
4. Import Gatherer:
   • Go to Settings in the left menu.
   • Click Import local mod → From file.
   • Browse to Gatherer-1.3.1.zip and select it. Expand Gatherer in the Installed list to read the local-import manual.
   • Confirm the author is Imbrus_Chrapmajster. If replacing an older Unknown-Gatherer import, uninstall that entry first so two copies of the plugin are not loaded. Keep your configuration file.
5. Launch the game using Start modded in the upper-left corner of r2modman.

Manual Installation

1. Install denikson-BepInExPack_Valheim 5.4.2360 or newer into your game root folder, following the pack's installation instructions.
2. Extract ValheimGatherer.dll from Gatherer-1.3.1.zip.
3. Place ValheimGatherer.dll in <ValheimDirectory>\BepInEx\plugins\.
4. Launch Valheim via Steam.

User Manual & How It Works

1. Discovery Modes (How Nodes are Detected)

Gatherer provides 4 distinct discovery behaviors selectable via DiscoveryMode:

1. InteractOnly:
   • Classic WoW Gatherer behavior.
   • Pins are placed only when you interact with the node: pick a mushroom, pluck raspberries, or hit an ore vein with a pickaxe.
2. InteractAndProximity (Default):
   • Combines interaction tracking with a passive radar sweep.
   • Every ProximityScanInterval (default 2.0s), the mod sweeps a sphere around your character up to ProximityRadius (default 15m) and pins any eligible unmapped resources you walk past.
3. InteractAndHover:
   • Pins nodes whenever you gather them or look directly at them (crosshair hover text appears).
4. All:
   • Enables interaction, proximity radar, and crosshair hover checks simultaneously.

2. Cartography Table Sharing Guide

The in-game Cartography Table lets vikings exchange discovered map fog and pins:

                  ┌──────────────────────┐
                  │    Local Player      │
                  │  Discovers Resource  │
                  └──────────┬───────────┘
                             │
                      [Auto-Pin Added]
                             │
                             ▼
                  ┌──────────────────────┐
                  │   Cartography Table  │
                  │ "Record discoveries" │
                  └──────────┬───────────┘
                             │
                     Synchronized to World
                             │
                             ▼
                  ┌──────────────────────┐
                  │     Other Players    │
                  │      "Read map"      │
                  └──────────────────────┘

1. As you explore and collect items, Gatherer tags your pins with persistent author and save flags.
2. Return to your base and interact with the Cartography Table using "Record discoveries" (default E).
3. Your Gatherer pins are now saved into the shared table data.
4. When any other player walks up and presses "Read map", all your resource pins are instantly transferred to their map!
5. HUD Feedback: Gatherer notifies you with an on-screen prompt confirming pins were recorded to or synchronized from the table.

3. Duplicate Prevention & Node Clustering

In Valheim, resources like raspberries or mushrooms spawn in tight clusters of 3 to 6 instances, and copper deposits consist of dozens of hit voxels. Without duplicate control, this would clutter your map with overlapping markers.

Gatherer solves this with intelligent radius merging:

• Herbs, Berries & Mushrooms: Evaluated against HerbMergeRadius (default 10m). If a pin with the same resource name already exists within 10 meters, additional pins are skipped.
• Ores & Minerals: Evaluated against OreMergeRadius (default 20m) to encompass the full footprint of copper, silver, or obsidian deposits.
• Special POIs: Evaluated against SpecialMergeRadius (default 15m).

4. Anti-Base Clutter (Base Crop Protection)

Gatherer checks whether an object was cultivated or constructed by a player (Piece.IsPlacedByPlayer()).

• Farmed carrots, turnips, barley, onions, or player-built beehives inside your base will never trigger map pins.
• Only wild, naturally spawned nodes in the world will be mapped.

Configuration Guide

Resource Icons and Map Visibility (v1.3.0)

Press F8 > Map Icons & Visibility. All resources are visible by default, while new-resource tracking remains off until selected. These are separate settings: hiding Copper does not stop discovering copper pins, and disabling copper tracking does not hide existing pins.

• Use item icons: on by default. Mushrooms, berries, plants and ores use their existing in-game item sprites; wild beehives use the queen bee image. POIs without an item image and unavailable item prefabs retain the original pin icon.
• Resource checkboxes / Show All / Hide All: change local visibility on both maps, including labels. Hidden pins are not deleted and remain available for saving, deduplication and sharing. Valheim's own map icon-type filters still apply.
• Vanilla-compatible sharing: the saved pin type, name, owner and save flag are unchanged. Gatherer decorates the visible image only. Friends without Gatherer see the ordinary icon; friends with Gatherer use their own visibility preferences.
• Name recognition: exact resource IDs, English display/short names and names in your currently selected game language are recognized. Prefixes separated by whitespace or a closing bracket (for example [G] Copper) work for shared pins. Your configured PinNamePrefix also works without a separator. For other custom prefixes, use the same prefix setting on receiving clients. Renamed pins that no longer match a resource keep their normal appearance. Manual pins with matching resource names are also interpreted as resource pins; arbitrary modded/custom resource names are not filtered.
• These options are saved in 10 - Map Display (UseResourceIcons) and 11 - Resource Visibility (one Boolean per resource ID). They do not modify Cartography Table data.

How to Access the Config

• In-Game Interactive Menu (Built-in!): Press F8 anytime in-game to open Gatherer's custom interactive GUI. The mouse cursor appears automatically and game inputs are paused so you can freely click checkboxes, sliders, and buttons. You can toggle individual resources, categories, "Select All", radar ranges, and cartography sharing with real-time effect! (The keybind is rebindable via ToggleUiKey).
• Default State (Clean Slate): All resource tracking is disabled by default. You choose exactly what you want to track by opening F8 and checking what you need (e.g. check "Red Mushroom" or click "Category: ON" or "Select All").
• Inside r2modman: Click Configuration editor in the left sidebar, find com.watchdoge.valheim.gatherer.cfg, and click Edit Config.
• In-Game (via BepInEx ConfigurationManager): Press F1 while in-game (if installed) to modify settings live.
• Manual File: Found at <ValheimRoot>\BepInEx\config\com.watchdoge.valheim.gatherer.cfg.

Common Configuration Scenarios

Scenario A: Mark Mushrooms and Berries, but NEVER Copper or Ores

[3 - Categories]
TrackMushrooms = true
TrackBerries = true
TrackOresAndVeins = false

[4 - Specific Resources - Mushrooms]
RedMushroom = true
YellowMushroom = true
BlueMushroom = true
Magecap = true
JotunPuffs = true
SmokePuff = true

[5 - Specific Resources - Berries]
Raspberry = true
Blueberry = true
Cloudberry = true

[7 - Specific Resources - Ores]
CopperDeposit = false

Scenario B: Mark ONLY High-Tier Resources (Silver, Magecap, Jotun Puffs, Flametal)

[3 - Categories]
TrackMushrooms = true
TrackOresAndVeins = true

[4 - Specific Resources - Mushrooms]
RedMushroom = false
YellowMushroom = false
BlueMushroom = false
Magecap = true
JotunPuffs = true

[7 - Specific Resources - Ores]
CopperDeposit = false
TinDeposit = false
SilverVein = true
FlametalOre = true

Scenario C: Stealth / Exploration Radar (Quiet Mode)

[0 - General]
DiscoveryMode = InteractAndProximity
ShowHudNotification = false

[2 - Proximity Radar]
ProximityRadius = 25.0
ProximityScanInterval = 1.5

Comprehensive Settings Reference

Section: 0 - General

Section: 1 - Pin Settings

Section: 2 - Proximity Radar

Section: 3 - Categories

Section: 4 - Specific Resources - Mushrooms

Section: 5 - Specific Resources - Berries

Section: 6 - Specific Resources - Herbs and Plants

Section: 7 - Specific Resources - Ores

Section: 8 - Specific Resources - Special

Section: 9 - Advanced Filters

Sections: 10 - Map Display and 11 - Resource Visibility

Supported Resource Database

Advanced Filtering (Custom & Modded Prefabs)

Want to track custom items from mods like Epic Loot, Therzie's Warfare, or Plant Everything?

• To include extra prefabs: Set CustomIncludeFilter in Section 9:

  CustomIncludeFilter = DragonEgg, GoblinTotem, TarLiquid, CustomModdedHerb
  

• To blacklist unwanted items: Set CustomExcludeFilter in Section 9:

  CustomExcludeFilter = Flint, Stone, Branch
  

Custom include filters take precedence over category toggles, allowing surgical fine-tuning.

Troubleshooting & FAQ

Q: r2modman gives an error: Failed to find preloader dll ... scandir ... BepInEx\core?

A: This happens when a new profile is created in r2modman without the base mod loader installed. Go to Online in r2modman, download denikson-BepInExPack_Valheim, and then launch via Start modded.

Q: Do other players on my multiplayer server need this mod installed?

A: No! Other players do not need the mod installed. When you upload your pins to the in-game Cartography Table, Valheim saves them into standard vanilla world map packets. Any player can walk up to the table and download your pins onto their vanilla game map.

Q: How do I remove or delete a pin?

A: Use Valheim's standard map controls: open your map (M), hover over the pin, and Right-Click it to delete it.

Q: Will this mod pin crops in my garden?

A: No. Gatherer checks Piece.IsPlacedByPlayer() and ignores crops, beehives, and pieces planted or constructed by players.

License

Released under the MIT License. Created by watchdoge256.