You are viewing a potentially older version of this package. View all versions.
I3_rett-NearbyPanel-1.1.0 icon

NearbyPanel

Lists the creatures near you with distance, direction, taming and growth progress, and why an animal is or is not breeding. Client-side only.

Date uploaded 2 weeks ago
Version 1.1.0
Download link I3_rett-NearbyPanel-1.1.0.zip
Downloads 200
Dependency string I3_rett-NearbyPanel-1.1.0

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2351 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2351

README

NearbyPanel

Lists the creatures around you — how far, which way, how high, how many stars, what they have noticed, how far along any animal you are taming or raising is, and why a tamed animal is or is not breeding. Press N.

Client-side only. The server does not need it, and it will not stop you joining a server that does not have it. Players without the mod are unaffected and see nothing different.

Lox calves growing under a tower, each with its growth percentage

A boar pen at night: piglets growing, the parents, and a greyling further out

Features

  • Every creature within 50 m, nearest first, refreshed four times a second; animals you have named come first
  • Distance along the ground, so it is the number you actually walk
  • Direction as an arrow from where you are looking, or in degrees, relative letters, or world compass points that do not turn when you do
  • Star rating, and altitude relative to you
  • What each creature has noticed: nothing, something, or you specifically when the game can confirm it
  • A red row for anything hostile that has been alerted — the deathsquito you did not see take aggro
  • Live taming progress, read from the same record the game uses, so an animal a friend is taming reports its progress too, along with whether it is hungry or frightened
  • Growth of young animals, and taming, growth and pregnancy as a percentage, a time left or both: 62% grown · 12 min. Taming time accounts for Brew of Animal Whispers
  • Breeding: Love 2/4, Pregnant, or what is stopping it — Crowded 5/4 · Lox Calf 18.4 m, Partner pregnant, Partner hungry, No partner — with each species' own ranges
  • Column widths are settings, so the panel fits your font and screen
  • Filter the list by name with nearby_filter boar, or clear it with nearby_filter
  • nearby_dump writes the current list to the log, which is useful in a bug report
  • Other players are never listed

The panel takes no clicks and never touches your cursor, so it cannot interfere with the game.

Scope

It lists every creature within 50 m, which means it shows you things through trees and fog that you could not see yourself. Decide whether that suits the people you play with.

Two limits are fixed in the source rather than left as settings: the 50 m radius, because reach is what separates this from surveillance and a limit you can slide is not a limit, and other players are never listed. The game only keeps creatures loaded within roughly 64-128 m of you, so nothing beyond that is visible to any client-side mod anyway.

Configuration

A config file is generated on first launch at BepInEx/config/I3_rett.NearbyPanel.cfg. Edit it with a text editor, or in game with Configuration Manager. The settings most people want are the toggle key, the screen corner the panel is pinned to, and the direction format.

Console commands

Both need Valheim's console, which is off by default: enable it in the game's settings, or add -console to the launch parameters (r2modman: Settings → Launch parameters). Then press F5 in game.

  • nearby_filter <text> shows only creatures whose name contains the text, e.g. nearby_filter lox. With no argument it clears the filter. Also a setting.
  • nearby_dump writes the list as the panel shows it, same filter, to the console and to BepInEx/LogOutput.log. Under each animal that breeds it adds what the breeding checks counted: its ranges, and every animal considered with its 3-D and ground distance, height and whether it is ready to mate. That is the place to look when a pen reads Crowded or No partner and you cannot see why.

Neither marks your character as having used cheats. When reporting a bug, attach LogOutput.log with a nearby_dump taken at the moment it happened.

Compatibility

  • No Harmony patches, no RPC, and nothing is ever written to the world, so removing the mod cannot damage a save
  • Running nearby_dump does not mark your character as having used cheats
  • Tested against Valheim 1.0.16 with BepInEx 5.4.2351

Installation

A mod manager does this for you. Manually: install BepInExPack Valheim, then extract NearbyPanel.dll and NearbyPanel.Core.dll into BepInEx/plugins/NearbyPanel/. The archive is also attached to each release on GitHub.

Source

MIT licensed. Code and issues: https://github.com/I3-rett/NearbyPanel

CHANGELOG

Changelog

1.2.0

  • Fish. Fish now appear in the list with the creatures, nearest first. Their size shows in the ★ column the way creature levels do (the game's [2] hover is one star), and STATUS lists the baits the species bites on, with a percentage only when the chance is under 100 %. nearby_filter fish shows only fish. Read-only like the rest: no fish is ever made visible or claimed, only its position and prefab data are read.

1.1.1

  • Names with colour tags. The Hildir quest bosses (Brenna, Geirrhafa, Zil, Thungr) and Lord Reto are localized by the game as <color=orange>…</color>. The panel, which draws without rich text, showed the tag cut by the column width. Tags are now removed from names and status text before display.

1.1.0

Built around watching a breeding pen.

  • Breeding. A tamed adult that breeds shows why it is or is not: Pregnant 25% · 45 s, Crowded 5/4 · Lox Calf 18.4 m with the nearest animal in the way, Partner pregnant, Partner hungry, No partner, or Love 2/4. Love points and pregnancy are read from the game's record; crowding and the partner check are recomputed with the game's own rule and each species' own ranges (a lox counts within 20 m, not 10)
  • Growth. A young animal shows how far it has grown: 62% grown
  • Time left. Taming, growth and pregnancy can read as a percentage, a time left, or both (62% grown · 12 min, the new default). Taming time says fed, since it only runs down while the animal has eaten, and counts Brew of Animal Whispers on players near the animal
  • Arrows. A fourth direction format, eight arrows from where you are looking, now the default
  • Named animals first, each group nearest first, so the parents are never pushed off the bottom of the list. A setting, on by default
  • Column widths are settings, in pixels; STATUS takes the rest. The panel now defaults to the bottom-right corner
  • The awareness column is headed ALERT, and no stars is blank rather than -
  • The list counts every creature in range; it used to stop at 25
  • nearby_dump lists, under each breeding animal, every animal the checks counted and how far away it is

Existing settings are kept: new defaults only apply to a fresh config.

1.0.0

First public release.

  • A panel listing every creature within 50 m, nearest first, toggled with N
  • Ground distance, altitude, star rating, and direction in one of three formats: degrees from where you are looking, relative letters, or world compass points
  • What each creature has noticed, and a red row for anything hostile that has been alerted
  • Live taming progress, read from the same record the game uses, so an animal a friend is taming reports its progress too
  • Text filter by name: nearby_filter boar
  • nearby_dump writes the current list to the log
  • Settings for the toggle key, the screen corner, the size and the direction format, editable in game with Configuration Manager
  • Client-side only: no RPC, no Harmony patches, and nothing written to the world

Tested against Valheim 1.0.16 with BepInEx 5.4.2351, including joining a dedicated server that does not have the mod.

Two things are deliberately not configurable: the 50 m radius, and the exclusion of other players from the list.