Subscribe to download
Zens Map Enhancement

This mod adds a few extra immersive and quality of life features to the vanilla map functionality.

- Adding/removing map markers
- Server-side config for adding static markers
- Full server admin config to enable/disable certain features
- Plugin code for admins to add dynamic map markers (eg. missions, quests)
- Uses mostly vanilla code so lightweight, robust & no wipe required to add/remove mod


This map adds features to existing vanilla map, so all vanilla map config still applies (eg. anything you tweak in cfggameplay.json will apply to this mod).

A JSON config file will be automatically generated in server_profiles/Zenarchist/ZenMapConfig.json

TakeMapToHandsOnHotkey:
Enable/disable when player presses M the character takes map into hands & opens it

MapsRepairableWithDuctTape:
Enable/disable repairing damaged maps using duct tape

SaveMarkersOntoMapItem:
Enable/disable ability to save markers directly onto map item. If enabled, then map markers can be added to the map item itself - meaning that players can share maps in-game with markers persistent on the map itself, useful for treasure maps, organizing combined activities like raids etc with other players, all in-game. Just be careful marking valuable locations - if you lose your map or get killed other players can see your markers! If disabled then the markers are only saved client-side.

AllowPlayerToDecide:
Enable/disable players being able to choose where the map marker is saved (only works if SaveMarkersOntoMapItem setting is enabled). So if they want to mark treasure maps etc they can, while keeping their personal markers private. A marker added to the map item while this setting is enabled is tagged with a * symbol to differentiate them from private client-side markers.

AllowCopyMapToMap:
Enable/disable the ability to copy one map's markers onto another map item - only works if SaveMarkersOntoMapItem is enabled.

RequirePenToMark:
Enable/disable the requirement of a non-ruined pen in player inventory to be able to edit markers on maps or copy markers if AllowCopyMapToMap setting is enabled. Make sure to enable vanilla pen spawning in types.xml if you turn this on: classnames are Pen_Black, Pen_Blue, Pen_Green, Pen_Red

MaxMarkerCountPerMapItem:
Set the maximum marker limit per map item. Only applies if SaveMarkersOntoMapItem is enabled, to prevent server sync issues if a player goes silly with map markers on their map item. Client-side has no marker limit.

PenMarkerConsumeQuantityPercent:
How much quantity OR health to take from the pen for each map action. If the pen has a quantity bar (eg. you're running my ZenNotes mod) then the pen's quantity will drain. Otherwise its health will drain instead. This is the total % of health/quantity to drain - so 10% = 10 uses of a Pristine pen.

DamageMapOnOpenPercent:
How much to damage the map whenever a player opens it. Disabled by default. Also a % - so 1% would mean 100 opens of a Pristine map before ruined. I recommend enabling MapsRepairableWithDuctTape if you use this setting.

NoPenColors:
The list of usable colors for map markers if a pen is NOT required to mark maps (RequirePenToMark is disabled).

IconFiles:
The list of usable map marker icons, moddable to easily add more markers if desired.

ServerMapMarkers:
A list of static server-side markers for admins who want to add certain POI's to the vanilla map.

To add or remove a map marker using script code, you can do this:



Install this mod like any other mod - copy it into your server folder and add it to your mods list. Make sure to copy the .bikey into your server keys if you're not using a server management tool like OmegaManager which does that automatically.

This mod must be run on both client and server.

A JSON config file will be automatically generated in server_profiles/Zenarchist/ZenMapConfig.json

Repack & Source Code:

You can repack this mod if you like, and do anything else you want with it for that matter. Just keep in mind my future updates won't be applied so make sure to check back for new versions if you notice any bugs. The source code is on my GitHub at www.zenarchist.com

Buy Me A Coffee:

All my mods are free and open source, but it takes an enormous amount of time to put some of these mods together. If I've helped you out, please consider helping me buy my next coffee! I don't expect it, but I very much appreciate it.

https://buymeacoffee.com/zenarchist

Enjoy