You are viewing a potentially older version of this package. View all versions.
TXC-SharedMap-2.0.0 icon

SharedMap

Shared exploration layer plus public/private markers with owner-only delete, synced through the server. Crossplay-safe; players without the mod can still join.

By TXC
Date uploaded 2 weeks ago
Version 2.0.0
Download link TXC-SharedMap-2.0.0.zip
Downloads 39
Dependency string TXC-SharedMap-2.0.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

SharedMap

A shared map layer for your server: everyone's exploration and public markers, synced through the server and saved next to the world. Your own map stays your own.

Markers

  • Public marker: choose an icon and double-click the map. Everyone on the server sees it, tinted so you can tell it apart.
  • Private marker: hold Left Ctrl while double-clicking. Only you see it, like vanilla.
  • Cross out: left-click a marker to cross it out or undo the cross. Anyone can cross out a public marker.
  • Delete: right-click a marker. A public marker can only be deleted by the account that placed it or by an admin (listed in adminlist.txt; the host of a listen server counts as admin). The server logs every deletion with the player, marker name, icon, biome, coordinates and owner.
  • Duplicates: if a new public marker has the same icon and name as one within 20 m (configurable), the server removes the new one and keeps the original.

Personal map

  • Shared exploration shows as lighter fog, the same shading vanilla uses for cartography-table data. It is never written into your own exploration.
  • Hiding the shared map: untick the Shared map checkbox on the large map (or set ShowSharedMap = false). This hides shared exploration and public markers without changing your own exploration, private markers or cartography-table data.
  • Saving: public markers are never saved to your character or written to a cartography table. Your client receives them from the server each time you join.

Crossplay / network

  • Map data is sent in batches of compressed changes. The initial map goes out in bands of 64 rows. Nothing is sent pixel by pixel.
  • Sending pauses whenever a connection's send queue is busy, so the map never delays world and gameplay data.
  • There is no version enforcement. Players without the mod, including console players, can join and are never sent map data.

Install

  • Server: required. It stores the map in <world>.txcsharedmap next to the world .db file, keeping the previous save as .txcsharedmap.old.
  • Clients: every player who wants the shared map. The server and clients must run the same major version.

Config (BepInEx/config/txc.sharedmap.cfg)

Section Key Default
General ShareExploration true Server setting.
General SharePins true Server setting: allow public markers.
General ForcePublicPosition false Server setting: forces vanilla "Visible on map" on for every player, including players without the mod. For modded players the checkbox is ticked and locked.
General DuplicateRadius 20 Server setting: duplicate radius in metres. 0 = off.
Client ShowSharedMap true Show shared exploration and public markers.
Client PrivateMarkerKey LeftControl Hold this key while double-clicking to place a private marker.
Client PublicMarkerColor light gold Tint of public marker icons.
Network SendInterval 0.25 Seconds between send batches.
Network MaxMessagesPerTick 4 Maximum messages per connection per batch.
Network MaxSendQueueBytes 5120 Map sending pauses above this queue size. Vanilla world sync stops at 10240.

Notes

  • Public markers are identified by icon and position, rounded to 0.5 m.
  • Updating from 1.x: public copies previously saved to your character are replaced by the server's markers. Markers shared in 1.x have no recorded owner, so only admins can delete them.
  • Sync is done by the clients, like the vanilla game, so a modified client could send fake data. Permissions are enforced by the server.

CHANGELOG

Changelog

2.1.0

  • Fixed the map checkbox overlap. The new checkbox no longer covers vanilla's "Cartography Table Shared map" row. It is now its own row above it, labelled "Server shared map".
  • Cartography tables feed the shared map. Areas you read from a table are added to the server's shared exploration, like your own.
  • Vanilla's "Cartography Table Shared map" checkbox now only shows or hides cartography table pins while the server shared map is shown. With the server shared map off, it works as in vanilla.
  • Make markers public later. Shift + left-click a private marker, or a greyed-out cartography table marker, to make it public (key: PublishMarkerKey). A plain left-click on a greyed-out marker still makes it your own private (white) marker.
  • Duplicate removal covers every marker on your map: public (gold), private (white) and cartography (grey). Same icon and name within the server's DuplicateRadius: gold beats white beats grey, and within a colour the older marker stays.
  • Works with 2.0.x servers and clients (same protocol). Clients use the server's duplicate radius, or 20 m on a 2.0.x server.

2.0.1

  • Added this changelog.
  • Compatible with 2.0.0 (same protocol).

2.0.0

Rework of markers and the shared map. Server and all clients need 2.0.0; 1.x and 2.x don't sync with each other.

  • Public and private markers. A plain double-click places a public marker that everyone sees. Hold Left Ctrl while double-clicking for a private marker (vanilla, only you see it). Public markers are tinted light gold (PublicMarkerColor).
  • Permissions. Anyone can cross out a public marker (left-click). Only the account that placed it, or an admin, can delete it (right-click). The server enforces this and logs refused attempts.
  • Duplicate removal. A new public marker with the same icon and name as one within 20 m (DuplicateRadius, 0 = off) is removed by the server; the older one stays. Unnamed markers count too. Existing duplicates are cleaned up when the server starts.
  • Deletion log now includes the marker's owner.
  • Separate shared layer. Shared exploration shows as lighter fog and is no longer written into your own exploration. Public markers are no longer saved to your character or copied to cartography tables.
  • "Shared map" checkbox on the large map (ShowSharedMap) hides shared exploration and public markers without touching your own map, private markers or cartography data.
  • Names kept when clicking away. Typing a marker name and then clicking elsewhere on the map keeps the name (Escape still cancels it).
  • Hovering the shared layer shows the biome name.
  • Server files from 1.x are converted automatically. Markers shared in 1.x have no recorded owner, so only admins can delete them.

1.1.0

  • New server setting ForcePublicPosition (default off): every player is shown on the map, including players without the mod. Players with the mod get the "Visible on map" checkbox ticked and locked.

1.0.0

  • First release: explored map areas and hand-placed pins shared between players through the server.
  • Batched, throttled sync that yields to gameplay traffic. Built for crossplay servers.
  • Players without the mod (including console players) can still join.
  • The server logs every pin deletion with the player, pin name, biome and coordinates.