cli/validate: allow exempting certain markers from validation

2026-01-27 16:52:07 +09:00
parent 306d35fb23
commit 7cb7e0c0e7
6 changed files with 98 additions and 15 deletions
@@ -172,6 +172,35 @@ See the other marker sets for inspiration.

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

+## Making exceptions for the validation tool
+
+Sometimes, you might want to add a marker that doesn't pass validation.
+You can do this by setting the `skip_validation` parameter to `True` when creating the marker.
+
+```python
+from lib_marker import Point, Track
+
+MARKERS = [
+    ...,
+    Point(
+        name="My Invalid Marker",
+        x=100,
+        y=200,
+        z=300,
+        skip_validation=True,
+    ),
+    Track(
+        name="My Invalid Track",
+        points=[
+            (0, 64, 0),
+            (10000, 64, 10000),
+        ],
+        skip_validation=True,
+    ),
+    ...,
+]
+```
+
 ## See also

 - [BlueMap documentation for markers](https://bluemap.bluecolored.de/wiki/customization/Markers.html)