minecraft-kartverket

Map markers for PVV's minecraft server

What is this?

This project is meant to let PVV members contribute map data for PVV's minecraft server, like coordinates for bases, cities, and other points of interest. These markers are written in python so that we can do things like generating points in a loop, calculating distances, and other types of automation.

There is also a cli tool that we use to export these points into the formats of several minecraft map implementations.

Marker sets

Here is an overview of the different marker sets, and what they are meant for.

• Overworld

  • Area Names: larger areas with names
  • Buildings: important buildings and world wonders.
  • Cities: an area that consist of several bases and/or public infrastructure.
  • Homes: single bases consisting of 1-3 people.
  • Huts: small huts, meant for visitors and travelers.
  • Infrastructure: public infrastructure, like bridges, ports, tunnels, etc.
  • Mines: public mines
  • Nature: similar to "Area Names", but specifically for mostly untouched nature-named areas.
  • Other: anything that doesn't fit into the other categories
  • Railways: railways
  • Roads: roads
  • Villages: villages generated by minecraft (as opposed to player made cities)

• Nether

  • Ice Tracks: ice tracks meant for boats.
  • Other: anything that doesn't fit into the other categories
  • Portals: named portals that lead back to the overworld.
  • Railways: railways

• The End

  • Other: anything that doesn't fit into the other categories
  • Portals: end portals that send you back to the center of the map

How to add a point marker

1. Find the correct marker set file in src/marker_sets/<world>.
2. Add the marker to the list in the file. You can look at neighbouring markers for inspiration.
3. Run the cli tool to verify that the marker has been added correctly.

uv run mckart verify
uv run mckart print

4. Open a PR

How to add a railway / road

This is very similar to adding a point marker, but the content of the marker is different.

You can follow the previous guide, but for step 3, use this template or look at other markers for inspiration.

from lib_marker import Track

MARKERS = [
    ...,
    Track(
        name="Nordbanen",
        points = [
            (848, 70, 1583),
            (920, 70, 1583),
            (920, 70, 1200),
            ...
        ],
    ),
    ...,
]

How to add a new marker set

To add a new marker set, you need to:

1. Create a new file the other marker sets in src/marker_sets/<world>.
2. Create a marker set in this file, using this template:

from lib_marker.marker_set import MarkerSet

MARKER_SET = MarkerSet(
    name="My Marker Set",
    markers=[
    ],
)

3. Add the marker set to the MARKER_SETS list in src/marker_sets/<world>/__init__.py.

from .<marker_set_name> import MARKER_SET as <marker_set_name>_marker_set

MARKER_SETS = [
    ...
    portals_marker_set,
]

See the other marker sets for inspiration.

4. Add the marker set with a description to this README file.

See also

• BlueMap documentation for markers
• Mapcrafter documentation for markers