From ef4bf07cef3d208eab72020934c7559bb1efa55f Mon Sep 17 00:00:00 2001 From: h7x4 Date: Sat, 22 Mar 2025 00:01:12 +0100 Subject: [PATCH] rewrite to python: add section about adding marker sets --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8624927..76d51f3 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Mapping is my passionfruit! ## 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 easily can do things like generating points in a loop, or other types of automation. +These markers are written in python so that we easily 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 popular minecraft map implementations. @@ -110,7 +110,33 @@ MARKERS = [ ## How to add a new marker set -TODO: Write this section +To add a new marker set, you need to: + +1. Create a new directory alongside the other marker sets in `src/minecraft_kartverket/marker_sets/`. +2. Create an `__init__.py` file in this directory with the following content: + +```python +from minecraft_kartverket.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/minecraft_kartverket/marker_sets//__init__.py`. + +```python +from . import MARKER_SET as _marker_set + +MARKER_SETS = [ + ... + portals_marker_set, +] +``` + +See the other marker sets for inspiration. ## How to add icons