PlayerColorCompassAndQuickPinTweaks

A compass strip at the top of your screen that shows your map pins and the other players, plus a set of tools for working with map pins: track the ones that matter, pin what you are looking at with one key, share pins with your friends, and color-code them.

This mod used to be called PlayerColorCompass. It is now a separate listing. Please remove the old PlayerColorCompass if you have it, so you do not end up with two compasses. (Your settings carry over.)

Credit

The compass is a simplified fork of Compass by shudnal (Unlicense). The compass strip images and the idea of scrolling the strip with your view come from that mod. What is different here:

• Simplified. Pin filters, wildcard ignore lists, custom image folders and image syncing were left out.
• Player colors are handled through the server. Each player picks their own color, and the server stores it by Steam/Epic ID and shares it with everyone.
• Everything about pins (tracking, quick pins, sharing, colors) is new in this mod.

Server requirement

Some features need this mod on the server too (put it in the server's BepInEx/plugins folder, with BepInEx):

• player markers and player colors,
• shared pins and the server's pin list,
• the admin tools.

Everything else works anywhere, including single-player and servers without the mod: the compass with your own pins, tracking, the pin hotkey, saved quick pins and pin colors. Players without the mod can still join a server that has it; they just do not see player colors or shared pins.

Features

Compass

• Regular and detailed compass strip.
• Other players as colored markers (only players who share their position on the map). Optional names and distances.
• Your map pins (death, bed, bosses, placed pins) with optional names and distances. They shrink and fade with distance.
• Other players' icons and names on the map and minimap use the same colors.
• Everything is adjustable: marker size, font sizes, distance effects, position and scale.

Tracked pins

Left-click a pin on the map to cycle: nothing, red X, tracked, nothing. A tracked pin gets a thin magnifying glass around it on the map, and always shows on the compass at full size, however far away. This also works on the world pins the game draws for you, such as Haldor, Hildir and the Forsaken stones. (World pins cannot be removed this way; only the X and tracking change.)

• Tracking is yours alone and is remembered between sessions.
• To see only your tracked pins on the compass, turn ShowMapPins (Pins) off: tracked pins always show.

Quick pin hotkey

Press the pin hotkey (PinHotkey, default P) while looking at something within PinRange meters (default 10): a bush, an ore vein, a tree, a building, a cave entrance.

• The first time you pin a kind of thing, a small window asks for an icon, a color (a few ready-made ones) and a name. Press Enter to confirm or Esc to cancel.
• After that, pinning the same kind of thing places the same pin straight away.
• Hold Shift with the hotkey to change what a kind of thing is pinned as.
• Places like troll caves, burial chambers and sunken crypts are told apart.
• A pin is not made twice if one of that kind is already within 3 m.

Saved quick pins (config menu)

At the very bottom of Configuration Manager there is a list of everything you have saved with the hotkey. For each one you can:

• change its icon (drop down),
• rename it,
• set a color (click the swatch to step through ready-made colors, or type a hex code like E5483F),
• delete it, to be asked again next time.

Uniform pins (server rule): an admin can turn on EnforceQuickPins (in the same section). The server then keeps one list of saved quick pins (the admin's own list becomes the server's the first time it is turned on), everybody with the mod uses it, and only admins can add to it or change it. Other players can still quick-pin anything on the list, but not things that are not on it, and they only see the list in the config menu. Off by default; on a server that has the mod, the server's setting applies to everybody.

Colors show on your map, minimap and compass right away, and only for you. A new name or icon applies to new pins; press Sync pin settings to also change the pins already on your map (anything with the old name gets the new name and icon, and other players get the change too if pins are shared).

Shared pins

With SharePins on (the default), pins you place, rename or remove show up for everyone else on the server, and so does the red X. On a server that has the mod, the server's setting applies to everybody, and only admins can change it (in-game, or in the server's config file).

• The server keeps a list of all shared pins and which were deleted (BepInEx/config/PlayerColorCompass.serverpins.txt), and gives it to each player who joins, so you also get pins that were placed while you were away.
• ServerPinsReplaceMine (server rule, off by default): off means pins a joining player has that the server does not know about are added to the server and shared (unless they were deleted on the server); on means those pins are removed from the joining player's map instead.
• Only pins you place by hand are shared (not death, bed, boss or world pins).

For admins

• Admin - Player colors: one color setting for every other player who is online. Change it to set that player's color for everybody.
• Sync everybody's pins now: a button in the Pins section. It asks every player to send their placed pins to everybody. Missing pins are added and X marks are shared; nothing is removed. The server checks that you are on its admin list.

Picking your color

Open Configuration Manager and set MyColor (Players). Everyone on the server sees your color. The server keeps it, so it follows your account to other PCs.

Settings summary

Notes

• Other mods' pin icons: the compass, sharing and quick pins only handle the game's own pin icons. Pins with icons added by other mods show on your map as normal, but not on the compass, and are not shared.
• Files (in BepInEx/config): PlayerColorCompass.colors.txt (the server's player colors), PlayerColorCompass.tracked.txt (your tracked pins), PlayerColorCompass.pinpresets.txt (your saved quick pins), PlayerColorCompass.serverpins.txt (the server's pin list), PlayerColorCompass.serverpresets.txt (the server's saved quick pins, when enforced). The file names were kept from the old name so nothing is lost.
• Please do not run this together with shudnal's Compass: you would get two compasses.