BlueMap Sign Markers

Overview

This Fabric plugin for BlueMap enables creating map markers based on in-game signs in Minecraft. The mod automatically displays special markers in BlueMap using information from signs placed throughout the game world.

Installation

To install, place the mod file in the mods folder along with the main BlueMap mod. It's important to note that this plugin works only on the server side.

Usage

To create a marker on the map, place a sign or hanging sign with specific text. On the front or back of the sign, write:

[poi]
<short description>

After this, a marker will appear on the BlueMap at the sign's location with the text <short description>. If the sign is destroyed, the corresponding marker will automatically be removed from the map.

Note that marker prefixes can be configured through the configuration file.

Configuration

The mod creates a configuration file BMSM-Core.json in the config/bluemapsignmarkers folder. This file offers the following options:

• markerGroups - a list of marker groups (described in detail below); defaults to containing one group for the [poi] prefix.

Marker Groups

A marker group is a set of labels that can be enabled and disabled in the BlueMap interface. Each marker group is configured with the following parameters:

• prefix - the prefix that a sign must contain to be included in the marker group (required parameter);
• matchType - the type of match when checking the first non-empty line of text on the sign; optional parameter; defaults to STARTS_WITH (exact match case-sensitive);
  • STARTS_WITH - the line must start with the prefix;
  • REGEX - the line must match the regular expression (uses Java's regex engine);
• name - the name of the marker group (required parameter);
• type - the type of marker to display; optional parameter; defaults to POI;
• icon - the path to the icon or URL for displaying the marker; optional parameter; defaults to null (uses BlueMap's standard POI icon);
• offsetX - the marker's offset on the X-axis; optional parameter; defaults to 0 (corresponds to anchor.x in BlueMap's base configuration);
• offsetY - the marker's offset on the Y-axis; optional parameter; defaults to 0 (corresponds to anchor.y in BlueMap's base configuration).

Configuration Example

{
  "markerGroups": [
    {
      "prefix": "[poi]",
      "name": "Points of Interest"
    },
    {
      "prefix": "[store]",
      "name": "Stores",
      "icon": "assets/store.png"
    },
    {
      "prefix": "\[[vV][iI][lL][lL][aA][gG][eE]\]",
      "matchType": "REGEX",
      "name": "Villages"
    }
  ]
}

This example creates three marker groups: for signs with the [poi] prefix, for signs with the [store] prefix, and for signs where the prefix matches the regular expression for villages (e.g., [Village] or [VILLAGE]).

The [poi] and Villages marker groups use the standard POI icon, while the [store] group uses a custom icon from the file assets/store.png.

Signs with the [poi] prefix will be displayed in the "Points of Interest" group, signs with the [store] prefix in the "Stores" group, and signs matching the village regex in the 'Villages' group.