Display markers for signs

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [Unreleased] - ReleaseDate
 
+### Added
+
+- Added sign layer
+
+  This feature is disabled by default. Use the `--sign-prefix` and `--sign-filter` options to
+  configure which signs to show on the map.
+
 ### Changed
 
 - Without `--verbose`, only a single warning is printed at the end of

Cargo.toml

@@ -39,7 +39,7 @@ pre-release-replacements = [
 [dependencies]
 anyhow = "1.0.68"
 bincode = "1.3.3"
-clap = { version = "4.1.4", features = ["derive"] }
+clap = { version = "4.1.4", features = ["derive", "wrap_help"] }
 fastnbt = "2.3.2"
 futures-util = "0.3.28"
 git-version = "0.3.5"
@@ -52,6 +52,7 @@ minedmap-types = { version = "0.1.2", path = "crates/types" }
 num-integer = "0.1.45"
 num_cpus = "1.16.0"
 rayon = "1.7.0"
+regex = "1.10.2"
 rustc-hash = "1.1.0"
 serde = { version = "1.0.152", features = ["rc", "derive"] }
 serde_json = "1.0.99"

README.md

@@ -23,7 +23,7 @@ based on [Leaflet](https://leafletjs.com/). The map renderer is heavily inspired
 ## How to use
 
 Minecraft stores its save data in a directory `~/.minecraft/saves` on Linux,
-and `C:\Users\<username>\AppData\Roaming\.minecraft\saves`. To generate minedmap
+and `C:\Users\<username>\AppData\Roaming\.minecraft\saves`. To generate MinedMap
 tile data from a save game called "World", use the a command like the following
 (replacing the first argument with the path to your save data; `viewer` refers
 to the directory where you unpacked the MinedMap viewer):
@@ -47,6 +47,34 @@ This test server is very slow and cannot handle multiple requests concurrently,
 a proper webserver like [nginx](https://nginx.org/) or upload the viewer together with
 the generated map files to public webspace to make the map available to others.
 
+### Signs
+
+![Sign screenshot](https://raw.githubusercontent.com/neocturne/MinedMap/e5d9c813ba3118d04dc7e52e3dc6f48808a69120/docs/images/signs.png)
+
+MinedMap can display sign markers on the map, which will open a popup showing
+the sign text when clicked.
+
+Generation of the sign layer is disabled by default. It can be enabled by passing
+the `--sign-prefix` or `--sign-filter` options to MinedMap. The options allow
+to configure which signs should be displayed, and they can be passed multiple
+times to show every sign that matches at least one prefix or filter.
+
+`--sign-prefix` will make all signs visible the text of which starts with the
+given prefix, so something like `--sign-prefix '[Map]'` would allow to put up
+signs that start with "\[Map\]" in Minecraft to add markers to the map. An
+empty prefix (`--sign-prefix ''`) can be used to make *all* signs visible on
+the map.
+
+`--sign-filter` can be used for more advanced filters based on regular expressions.
+`--sign-filter '\[Map\]'` would show all signs that contain "\[Map\]"
+anywhere in their text, and `--sign-filter '.'` makes all non-empty signs (signs
+containing at least one character) visible. See the documentation of the
+[regex crate](https://docs.rs/regex) for more information on the supported syntax.
+
+All prefixes and filters are applied to the front and back text separately, but
+both the front and the back text will be shown in the popup when one of them
+matches.
+
 ## Installation
 
 Binary builds of the map generator for Linux and Windows, as well as an archive

crates/resource/src/block_color.rs

@@ -1,6 +1,6 @@
 //! Functions for computations of block colors
 
-use super::{Biome, BlockType, Color, Colorf};
+use super::{Biome, BlockColor, Color, Colorf};
 
 /// Converts an u8 RGB color to a float vector
 fn color_vec_unscaled(color: Color) -> Colorf {
@@ -91,18 +91,18 @@ const BIRCH_COLOR: Colorf = Colorf::new(0.502, 0.655, 0.333); // == color_vec(Co
 /// Color multiplier for spruce leaves
 const EVERGREEN_COLOR: Colorf = Colorf::new(0.380, 0.600, 0.380); // == color_vec(Color([97, 153, 97]))
 
-/// Determined if calling [block_color] for a given [BlockType] needs biome information
-pub fn needs_biome(block: BlockType) -> bool {
+/// Determined if calling [block_color] for a given [BlockColor] needs biome information
+pub fn needs_biome(block: BlockColor) -> bool {
 	use super::BlockFlag::*;
 
 	block.is(Grass) || block.is(Foliage) || block.is(Water)
 }
 
-/// Determined the block color to display for a given [BlockType]
+/// Determined the block color to display for a given [BlockColor]
 ///
 /// [needs_biome] must be used to determine whether passing a [Biome] is necessary.
 /// Will panic if a [Biome] is necessary, but none is passed.
-pub fn block_color(block: BlockType, biome: Option<&Biome>, depth: f32) -> Colorf {
+pub fn block_color(block: BlockColor, biome: Option<&Biome>, depth: f32) -> Colorf {
 	use super::BlockFlag::*;
 
 	let get_biome = || biome.expect("needs biome to determine block color");