maps4fs 0.6.8__tar.gz → 0.7.2__tar.gz

{maps4fs-0.6.8 → maps4fs-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.6.8
+Version: 0.7.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -16,7 +16,6 @@ License-File: LICENSE.md
 Requires-Dist: opencv-python
 Requires-Dist: osmnx<2.0.0
 Requires-Dist: rasterio
-Requires-Dist: python_dotenv
 Requires-Dist: tqdm
 
 <div align="center" markdown>
@@ -28,7 +27,7 @@ Requires-Dist: tqdm
   <a href="#How-To-Run">How-To-Run</a> • 
   <a href="#Features">Features</a> • 
   <a href="#Supported-objects">Supported objects</a> • 
-  <a href="Settings">Settings</a> • 
+  <a href="#Advanced Settings">Advanced Settings</a> • 
   <a href="#Bugs-and-feature-requests">Bugs and feature requests</a>
 </p>
 
@@ -80,6 +79,20 @@ So, if you're new to map making, here's a quick overview of the process:
 3. Open the map template in the Giants Editor.
 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
 
+### Previews
+
+The generator also creates a multiple previews of the map. Here's the list of them:
+1. General preview - merging all the layers into one image with different colors.
+2. Grayscale DEM preview - a grayscale image of the height map (as it is).
+3. Colored DEM preview - a colored image of the height map (from blue to red). The blue color represents the lowest point, and the red color represents the highest point.
+
+![16 km map](https://github.com/user-attachments/assets/82543bcc-1289-479e-bd13-85a8890f0485)<br>
+*Preview of a 16 km map with a 500-meter mountain in the middle of it.*<br>
+
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -143,10 +156,9 @@ import maps4fs as mfs
 map = mfs.Map(
   game,
   (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  distance=1024,  # The DISTANCE from the center to the edge of the map in meters. The map will be 2048x2048 meters.
+  height=1024,  # The height of the map in meters.
+  width=1024,  # The width of the map in meters.
   map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-  blur_seed=5,  # The seed for the blur algorithm. The default value is 5, which means 5 meters.
-  max_height=400  # The maximum height of the map.
 )
 ```
 
@@ -157,11 +169,6 @@ map.generate()
 
 The map will be saved in the `map_directory` directory.
 
-## Settings
-Advanced settings are available in the tool's UI under the **Advanced Settings** tab. Here's the list of them:
-- `max_height` - the maximum height of the map. The default value is 400. Select smaller values for plain-like maps and bigger values for mountainous maps. You may need to experiment with this value to get the desired result.
-- `blur_seed` - the seed for the blur algorithm. The default value is 5, which means 5 meters. The bigger the value, the smoother the map will be. The smaller the value, the more detailed the map will be. Keep in mind that for some regions, where terrain is bumpy, disabling the blur algorithm may lead to a very rough map. So, I recommend leaving this value as it is.
-
 ## Features
 - Allows to enter a location by lat and lon (e.g. from Google Maps).
 - Allows to select a size of the map (2x2, 4x4, 8x8 km, 16x16 km).
@@ -186,18 +193,28 @@ The list will be updated as the project develops.
 The script will also generate the `generation_info.json` file in the `output` folder. It contains the following keys: <br>
 `"coordinates"` - the coordinates of the map center which you entered,<br>
 `"bbox"` - the bounding box of the map in lat and lon,<br>
-`"distance"` - the size of the map in meters,<br>
+`"map_height"` - the height of the map in meters (this one is from the user input, e.g. 2048 and so on),<br>
+`"map_width"` - the width of the map in meters (same as above),<br>
 `"minimum_x"` - the minimum x coordinate of the map (UTM projection),<br>
 `"minimum_y"` - the minimum y coordinate of the map (UTM projection),<br>
 `"maximum_x"` - the maximum x coordinate of the map (UTM projection),<br>
 `"maximum_y"` - the maximum y coordinate of the map (UTM projection),<br>
-`"height"` - the height of the map in meters (it won't be equal to the distance since the Earth is not flat, sorry flat-earthers),<br>
-`"width"` - the width of the map in meters,<br>
+`"height"` - the height of the map in meters (it won't be equal to the parameters above since the Earth is not flat, sorry flat-earthers),<br>
+`"width"` - the width of the map in meters (same as above),<br>
 `"height_coef"` - since we need a texture of exact size, the height of the map is multiplied by this coefficient,<br>
 `"width_coef"` - same as above but for the width,<br>
 `"tile_name"` - the name of the SRTM tile which was used to generate the height map, e.g. "N52E013"<br>
 
 You can use this information to adjust some other sources of data to the map, e.g. textures, height maps, etc.
 
+## Advanced Settings
+You can also apply some advanced settings to the map generation process. Note that they're ADVANCED, so you don't need to use them if you're not sure what they do.<br>
+
+Here's the list of the advanced settings:
+
+- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. So, by default this value is set to 3. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the [heightScale](https://www.farming-simulator.org/19/terrain-heightscale.php) parameter on the [PMC Farming Simulator](https://www.farming-simulator.org/) website.
+
+- DEM Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result as a Minecraft-like map.
+
 ## Bugs and feature requests
 If you find a bug or have an idea for a new feature, please create an issue [here](https://github.com/iwatkot/maps4fs/issues) or contact me directly on [Telegram](https://t.me/iwatkot).<br>

{maps4fs-0.6.8 → maps4fs-0.7.2}/README.md

@@ -7,7 +7,7 @@
   <a href="#How-To-Run">How-To-Run</a> • 
   <a href="#Features">Features</a> • 
   <a href="#Supported-objects">Supported objects</a> • 
-  <a href="Settings">Settings</a> • 
+  <a href="#Advanced Settings">Advanced Settings</a> • 
   <a href="#Bugs-and-feature-requests">Bugs and feature requests</a>
 </p>
 
@@ -59,6 +59,20 @@ So, if you're new to map making, here's a quick overview of the process:
 3. Open the map template in the Giants Editor.
 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
 
+### Previews
+
+The generator also creates a multiple previews of the map. Here's the list of them:
+1. General preview - merging all the layers into one image with different colors.
+2. Grayscale DEM preview - a grayscale image of the height map (as it is).
+3. Colored DEM preview - a colored image of the height map (from blue to red). The blue color represents the lowest point, and the red color represents the highest point.
+
+![16 km map](https://github.com/user-attachments/assets/82543bcc-1289-479e-bd13-85a8890f0485)<br>
+*Preview of a 16 km map with a 500-meter mountain in the middle of it.*<br>
+
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -122,10 +136,9 @@ import maps4fs as mfs
 map = mfs.Map(
   game,
   (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  distance=1024,  # The DISTANCE from the center to the edge of the map in meters. The map will be 2048x2048 meters.
+  height=1024,  # The height of the map in meters.
+  width=1024,  # The width of the map in meters.
   map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-  blur_seed=5,  # The seed for the blur algorithm. The default value is 5, which means 5 meters.
-  max_height=400  # The maximum height of the map.
 )
 ```
 
@@ -136,11 +149,6 @@ map.generate()
 
 The map will be saved in the `map_directory` directory.
 
-## Settings
-Advanced settings are available in the tool's UI under the **Advanced Settings** tab. Here's the list of them:
-- `max_height` - the maximum height of the map. The default value is 400. Select smaller values for plain-like maps and bigger values for mountainous maps. You may need to experiment with this value to get the desired result.
-- `blur_seed` - the seed for the blur algorithm. The default value is 5, which means 5 meters. The bigger the value, the smoother the map will be. The smaller the value, the more detailed the map will be. Keep in mind that for some regions, where terrain is bumpy, disabling the blur algorithm may lead to a very rough map. So, I recommend leaving this value as it is.
-
 ## Features
 - Allows to enter a location by lat and lon (e.g. from Google Maps).
 - Allows to select a size of the map (2x2, 4x4, 8x8 km, 16x16 km).
@@ -165,18 +173,28 @@ The list will be updated as the project develops.
 The script will also generate the `generation_info.json` file in the `output` folder. It contains the following keys: <br>
 `"coordinates"` - the coordinates of the map center which you entered,<br>
 `"bbox"` - the bounding box of the map in lat and lon,<br>
-`"distance"` - the size of the map in meters,<br>
+`"map_height"` - the height of the map in meters (this one is from the user input, e.g. 2048 and so on),<br>
+`"map_width"` - the width of the map in meters (same as above),<br>
 `"minimum_x"` - the minimum x coordinate of the map (UTM projection),<br>
 `"minimum_y"` - the minimum y coordinate of the map (UTM projection),<br>
 `"maximum_x"` - the maximum x coordinate of the map (UTM projection),<br>
 `"maximum_y"` - the maximum y coordinate of the map (UTM projection),<br>
-`"height"` - the height of the map in meters (it won't be equal to the distance since the Earth is not flat, sorry flat-earthers),<br>
-`"width"` - the width of the map in meters,<br>
+`"height"` - the height of the map in meters (it won't be equal to the parameters above since the Earth is not flat, sorry flat-earthers),<br>
+`"width"` - the width of the map in meters (same as above),<br>
 `"height_coef"` - since we need a texture of exact size, the height of the map is multiplied by this coefficient,<br>
 `"width_coef"` - same as above but for the width,<br>
 `"tile_name"` - the name of the SRTM tile which was used to generate the height map, e.g. "N52E013"<br>
 
 You can use this information to adjust some other sources of data to the map, e.g. textures, height maps, etc.
 
+## Advanced Settings
+You can also apply some advanced settings to the map generation process. Note that they're ADVANCED, so you don't need to use them if you're not sure what they do.<br>
+
+Here's the list of the advanced settings:
+
+- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. So, by default this value is set to 3. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the [heightScale](https://www.farming-simulator.org/19/terrain-heightscale.php) parameter on the [PMC Farming Simulator](https://www.farming-simulator.org/) website.
+
+- DEM Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result as a Minecraft-like map.
+
 ## Bugs and feature requests
 If you find a bug or have an idea for a new feature, please create an issue [here](https://github.com/iwatkot/maps4fs/issues) or contact me directly on [Telegram](https://t.me/iwatkot).<br>

maps4fs-0.7.2/maps4fs/generator/component.py

@@ -0,0 +1,99 @@
+"""This module contains the base class for all map generation components."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+import osmnx as ox  # type: ignore
+
+if TYPE_CHECKING:
+    from maps4fs.generator.game import Game
+
+
+# pylint: disable=R0801, R0903, R0902
+class Component:
+    """Base class for all map generation components.
+
+    Args:
+        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
+        map_height (int): The height of the map in pixels.
+        map_width (int): The width of the map in pixels.
+        map_directory (str): The directory where the map files are stored.
+        logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
+            info, warning. If not provided, default logging will be used.
+    """
+
+    def __init__(
+        self,
+        game: Game,
+        coordinates: tuple[float, float],
+        map_height: int,
+        map_width: int,
+        map_directory: str,
+        logger: Any = None,
+        **kwargs,  # pylint: disable=W0613, R0913, R0917
+    ):
+        self.game = game
+        self.coordinates = coordinates
+        self.map_height = map_height
+        self.map_width = map_width
+        self.map_directory = map_directory
+        self.logger = logger
+        self.kwargs = kwargs
+
+        self.save_bbox()
+        self.preprocess()
+
+    def preprocess(self) -> None:
+        """Prepares the component for processing. Must be implemented in the child class.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in the child class.
+        """
+        raise NotImplementedError
+
+    def process(self) -> None:
+        """Launches the component processing. Must be implemented in the child class.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in the child class.
+        """
+        raise NotImplementedError
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images. Must be implemented in the child class.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in the child class.
+        """
+        raise NotImplementedError
+
+    def get_bbox(self, project_utm: bool = False) -> tuple[int, int, int, int]:
+        """Calculates the bounding box of the map from the coordinates and the height and
+        width of the map.
+
+        Args:
+            project_utm (bool, optional): Whether to project the bounding box to UTM.
+
+        Returns:
+            tuple[int, int, int, int]: The bounding box of the map.
+        """
+        north, south, _, _ = ox.utils_geo.bbox_from_point(
+            self.coordinates, dist=self.map_height / 2, project_utm=project_utm
+        )
+        _, _, east, west = ox.utils_geo.bbox_from_point(
+            self.coordinates, dist=self.map_width / 2, project_utm=project_utm
+        )
+        bbox = north, south, east, west
+        self.logger.debug(
+            f"Calculated bounding box for component: {self.__class__.__name__}: {bbox}, "
+            f"project_utm: {project_utm}"
+        )
+        return bbox
+
+    def save_bbox(self) -> None:
+        """Saves the bounding box of the map to the component instance from the coordinates and the
+        height and width of the map.
+        """
+        self.bbox = self.get_bbox(project_utm=False)
+        self.logger.debug(f"Saved bounding box: {self.bbox}")

{maps4fs-0.6.8 → maps4fs-0.7.2}/maps4fs/generator/config.py

@@ -14,7 +14,8 @@ class Config(Component):
 
     Args:
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
-        distance (int): The distance from the center to the edge of the map.
+        map_height (int): The height of the map in pixels.
+        map_width (int): The width of the map in pixels.
         map_directory (str): The directory where the map files are stored.
         logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
             info, warning. If not provided, default logging will be used.
@@ -22,7 +23,7 @@ class Config(Component):
 
     def preprocess(self) -> None:
         self._map_xml_path = self.game.map_xml_path(self.map_directory)
-        self.logger.debug(f"Map XML path: {self._map_xml_path}")
+        self.logger.debug("Map XML path: %s.", self._map_xml_path)
 
     def process(self):
         self._set_map_size()
@@ -36,9 +37,19 @@ class Config(Component):
         self.logger.debug("Map XML file loaded from: %s.", self._map_xml_path)
         root = tree.getroot()
         for map_elem in root.iter("map"):
-            width = height = str(self.distance * 2)
-            map_elem.set("width", width)
-            map_elem.set("height", height)
-            self.logger.debug("Map size set to %sx%s in Map XML file.", width, height)
+            map_elem.set("width", str(self.map_width))
+            map_elem.set("height", str(self.map_height))
+            self.logger.debug(
+                "Map size set to %sx%s in Map XML file.", self.map_width, self.map_height
+            )
         tree.write(self._map_xml_path)
         self.logger.debug("Map XML file saved to: %s.", self._map_xml_path)
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images (empty list).
+        The component does not generate any preview images so it returns an empty list.
+
+        Returns:
+            list[str]: An empty list.
+        """
+        return []

{maps4fs-0.6.8 → maps4fs-0.7.2}/maps4fs/generator/dem.py

@@ -7,13 +7,14 @@ import shutil
 
 import cv2
 import numpy as np
-import osmnx as ox  # type: ignore
 import rasterio  # type: ignore
 import requests
 
 from maps4fs.generator.component import Component
 
 SRTM = "https://elevation-tiles-prod.s3.amazonaws.com/skadi/{latitude_band}/{tile_name}.hgt.gz"
+DEFAULT_MULTIPLIER = 3
+DEFAULT_BLUR_RADIUS = 21
 
 
 # pylint: disable=R0903
@@ -22,16 +23,14 @@ class DEM(Component):
 
     Args:
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
-        distance (int): The distance from the center to the edge of the map.
+        map_height (int): The height of the map in pixels.
+        map_width (int): The width of the map in pixels.
         map_directory (str): The directory where the map files are stored.
         logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
             info, warning. If not provided, default logging will be used.
     """
 
     def preprocess(self) -> None:
-        self._blur_seed: int = self.kwargs.get("blur_seed") or 5
-        self._max_height: int = self.kwargs.get("max_height") or 200
-
         self._dem_path = self.game.dem_file_path(self.map_directory)
         self.temp_dir = "temp"
         self.hgt_dir = os.path.join(self.temp_dir, "hgt")
@@ -39,24 +38,27 @@ class DEM(Component):
         os.makedirs(self.hgt_dir, exist_ok=True)
         os.makedirs(self.gz_dir, exist_ok=True)
 
+        self.multiplier = self.kwargs.get("multiplier", DEFAULT_MULTIPLIER)
+        self.blur_radius = self.kwargs.get("blur_radius", DEFAULT_BLUR_RADIUS)
+        self.logger.debug(
+            "DEM multiplier is %s, blur radius is %s.", self.multiplier, self.blur_radius
+        )
+
     # pylint: disable=no-member
     def process(self) -> None:
         """Reads SRTM file, crops it to map size, normalizes and blurs it,
         saves to map directory."""
-        north, south, east, west = ox.utils_geo.bbox_from_point(  # pylint: disable=W0632
-            self.coordinates, dist=self.distance
-        )
-        self.logger.debug(
-            f"Processing DEM. North: {north}, south: {south}, east: {east}, west: {west}."
-        )
+        north, south, east, west = self.bbox
 
-        dem_output_size = self.distance * self.game.dem_multipliyer + 1
+        dem_height = self.map_height * self.game.dem_multipliyer + 1
+        dem_width = self.map_width * self.game.dem_multipliyer + 1
         self.logger.debug(
-            "DEM multiplier is %s, DEM output size is %s.",
+            "DEM multiplier is %s, DEM height is %s, DEM width is %s.",
             self.game.dem_multipliyer,
-            dem_output_size,
+            dem_height,
+            dem_width,
         )
-        dem_output_resolution = (dem_output_size, dem_output_size)
+        dem_output_resolution = (dem_width, dem_height)
         self.logger.debug("DEM output resolution: %s.", dem_output_resolution)
 
         tile_path = self._srtm_tile()
@@ -87,19 +89,34 @@ class DEM(Component):
             f"Min: {data.min()}, max: {data.max()}."
         )
 
-        normalized_data = self._normalize_dem(data)
-
         resampled_data = cv2.resize(
-            normalized_data, dem_output_resolution, interpolation=cv2.INTER_LINEAR
+            data, dem_output_resolution, interpolation=cv2.INTER_LINEAR
+        ).astype("uint16")
+
+        self.logger.debug(
+            f"Maximum value in resampled data: {resampled_data.max()}, "
+            f"minimum value: {resampled_data.min()}."
         )
+
+        resampled_data = resampled_data * self.multiplier
+        self.logger.debug(
+            f"DEM data multiplied by {self.multiplier}. Shape: {resampled_data.shape}, "
+            f"dtype: {resampled_data.dtype}. "
+            f"Min: {resampled_data.min()}, max: {resampled_data.max()}."
+        )
+
         self.logger.debug(
             f"DEM data was resampled. Shape: {resampled_data.shape}, "
             f"dtype: {resampled_data.dtype}. "
             f"Min: {resampled_data.min()}, max: {resampled_data.max()}."
         )
 
-        blurred_data = cv2.GaussianBlur(resampled_data, (self._blur_seed, self._blur_seed), 0)
-        cv2.imwrite(self._dem_path, blurred_data)
+        resampled_data = cv2.GaussianBlur(resampled_data, (self.blur_radius, self.blur_radius), 0)
+        self.logger.debug(
+            f"Gaussion blur applied to DEM data with kernel size {self.blur_radius}. "
+        )
+
+        cv2.imwrite(self._dem_path, resampled_data)
         self.logger.debug("DEM data was saved to %s.", self._dem_path)
 
     def _tile_info(self, lat: float, lon: float) -> tuple[str, str]:
@@ -182,26 +199,42 @@ class DEM(Component):
         cv2.imwrite(self._dem_path, dem_data)  # pylint: disable=no-member
         self.logger.warning("DEM data filled with zeros and saved to %s.", self._dem_path)
 
-    def _normalize_dem(self, data: np.ndarray) -> np.ndarray:
-        """Normalize DEM data to 16-bit unsigned integer using max height from settings.
+    def grayscale_preview(self) -> str:
+        """Converts DEM image to grayscale RGB image and saves it to the map directory.
+        Returns path to the preview image.
 
-        Args:
-            data (np.ndarray): DEM data from SRTM file after cropping.
+        Returns:
+            str: Path to the preview image.
+        """
+        rgb_dem_path = self._dem_path.replace(".png", "_grayscale.png")
+        dem_data = cv2.imread(self._dem_path, cv2.IMREAD_GRAYSCALE)
+        dem_data_rgb = cv2.cvtColor(dem_data, cv2.COLOR_GRAY2RGB)
+        cv2.imwrite(rgb_dem_path, dem_data_rgb)
+        return rgb_dem_path
+
+    def colored_preview(self) -> str:
+        """Converts DEM image to colored RGB image and saves it to the map directory.
+        Returns path to the preview image.
 
         Returns:
-            np.ndarray: Normalized DEM data.
+            list[str]: List with a single path to the DEM file
         """
-        max_dev = data.max() - data.min()
-        scaling_factor = max_dev / self._max_height if max_dev < self._max_height else 1
-        adjusted_max_height = int(65535 * scaling_factor)
-        self.logger.debug(
-            f"Maximum deviation: {max_dev}. Scaling factor: {scaling_factor}. "
-            f"Adjusted max height: {adjusted_max_height}."
-        )
-        normalized_data = (
-            (data - data.min()) / (data.max() - data.min()) * adjusted_max_height
-        ).astype("uint16")
-        self.logger.debug(
-            f"DEM data was normalized to {normalized_data.min()} - {normalized_data.max()}."
-        )
-        return normalized_data
+
+        colored_dem_path = self._dem_path.replace(".png", "_colored.png")
+        dem_data = cv2.imread(self._dem_path, cv2.IMREAD_GRAYSCALE)
+
+        # Normalize the DEM data to the range [0, 255]
+        # dem_data_normalized = cv2.normalize(dem_data, None, 0, 255, cv2.NORM_MINMAX)
+
+        dem_data_colored = cv2.applyColorMap(dem_data, cv2.COLORMAP_JET)
+
+        cv2.imwrite(colored_dem_path, dem_data_colored)
+        return colored_dem_path
+
+    def previews(self) -> list[str]:
+        """Get list of preview images.
+
+        Returns:
+            list[str]: List of preview images.
+        """
+        return [self.grayscale_preview(), self.colored_preview()]

{maps4fs-0.6.8 → maps4fs-0.7.2}/maps4fs/generator/map.py

@@ -6,21 +6,21 @@ from typing import Any
 
 from tqdm import tqdm
 
+from maps4fs.generator.component import Component
 from maps4fs.generator.game import Game
 from maps4fs.logger import Logger
 
 
-# pylint: disable=R0913
+# pylint: disable=R0913, R0902
 class Map:
     """Class used to generate map using all components.
 
     Args:
         game (Type[Game]): Game for which the map is generated.
         coordinates (tuple[float, float]): Coordinates of the center of the map.
-        distance (int): Distance from the center of the map.
+        height (int): Height of the map in pixels.
+        width (int): Width of the map in pixels.
         map_directory (str): Path to the directory where map files will be stored.
-        blur_seed (int): Seed used for blur effect.
-        max_height (int): Maximum height of the map.
         logger (Any): Logger instance
     """
 
@@ -28,15 +28,17 @@ class Map:
         self,
         game: Game,
         coordinates: tuple[float, float],
-        distance: int,
+        height: int,
+        width: int,
         map_directory: str,
-        blur_seed: int,
-        max_height: int,
         logger: Any = None,
+        **kwargs,
     ):
         self.game = game
+        self.components: list[Component] = []
         self.coordinates = coordinates
-        self.distance = distance
+        self.height = height
+        self.width = width
         self.map_directory = map_directory
 
         if not logger:
@@ -44,6 +46,8 @@ class Map:
         self.logger = logger
         self.logger.debug("Game was set to %s", game.code)
 
+        self.kwargs = kwargs
+
         os.makedirs(self.map_directory, exist_ok=True)
         self.logger.debug("Map directory created: %s", self.map_directory)
 
@@ -53,15 +57,6 @@ class Map:
         except Exception as e:
             raise RuntimeError(f"Can not unpack map template due to error: {e}") from e
 
-        # Blur seed should be positive and odd.
-        if blur_seed <= 0:
-            raise ValueError("Blur seed should be positive.")
-        if blur_seed % 2 == 0:
-            blur_seed += 1
-
-        self.blur_seed = blur_seed
-        self.max_height = max_height
-
     def generate(self) -> None:
         """Launch map generation using all components."""
         with tqdm(total=len(self.game.components), desc="Generating map...") as pbar:
@@ -69,11 +64,11 @@ class Map:
                 component = game_component(
                     self.game,
                     self.coordinates,
-                    self.distance,
+                    self.height,
+                    self.width,
                     self.map_directory,
                     self.logger,
-                    blur_seed=self.blur_seed,
-                    max_height=self.max_height,
+                    **self.kwargs,
                 )
                 try:
                     component.process()
@@ -84,7 +79,7 @@ class Map:
                         e,
                     )
                     raise e
-                setattr(self, game_component.__name__.lower(), component)
+                self.components.append(component)
 
                 pbar.update(1)
 
@@ -94,7 +89,10 @@ class Map:
         Returns:
             list[str]: List of preview images.
         """
-        return self.texture.previews()  # type: ignore # pylint: disable=no-member
+        previews = []
+        for component in self.components:
+            previews.extend(component.previews())
+        return previews
 
     def pack(self, archive_name: str) -> str:
         """Pack map directory to zip archive.

{maps4fs-0.6.8 → maps4fs-0.7.2}/maps4fs/generator/texture.py

@@ -116,7 +116,6 @@ class Texture(Component):
         self.logger.info("Loaded %s layers.", len(self.layers))
 
         self._weights_dir = os.path.join(self.map_directory, "maps", "map", "data")
-        self._bbox = ox.utils_geo.bbox_from_point(self.coordinates, dist=self.distance)
         self.info_save_path = os.path.join(self.map_directory, "generation_info.json")
 
     def process(self):
@@ -132,9 +131,8 @@ class Texture(Component):
         - map dimensions in meters
         - map coefficients (meters per pixel)
         """
-        north, south, east, west = ox.utils_geo.bbox_from_point(  # pylint: disable=W0632
-            self.coordinates, dist=self.distance, project_utm=True
-        )
+        north, south, east, west = self.get_bbox(project_utm=True)
+
         # Parameters of the map in UTM format (meters).
         self.minimum_x = min(west, east)
         self.minimum_y = min(south, north)
@@ -147,8 +145,8 @@ class Texture(Component):
         self.width = abs(east - west)
         self.logger.info("Map dimensions (HxW): %s x %s.", self.height, self.width)
 
-        self.height_coef = self.height / (self.distance * 2)
-        self.width_coef = self.width / (self.distance * 2)
+        self.height_coef = self.height / self.map_height
+        self.width_coef = self.width / self.map_width
         self.logger.debug("Map coefficients (HxW): %s x %s.", self.height_coef, self.width_coef)
 
     def info_sequence(self) -> None:
@@ -157,7 +155,8 @@ class Texture(Component):
         Info sequence contains following attributes:
             - coordinates
             - bbox
-            - distance
+            - map_height
+            - map_width
             - minimum_x
             - minimum_y
             - maximum_x
@@ -170,7 +169,8 @@ class Texture(Component):
         useful_attributes = [
             "coordinates",
             "bbox",
-            "distance",
+            "map_height",
+            "map_width",
             "minimum_x",
             "minimum_y",
             "maximum_x",
@@ -201,7 +201,7 @@ class Texture(Component):
             texture_name (str): Name of the texture.
             layer_numbers (int): Number of layers in the texture.
         """
-        size = self.distance * 2
+        size = (self.map_height, self.map_width)
         postfix = "_weight.png"
         if layer_numbers == 0:
             filepaths = [os.path.join(self._weights_dir, texture_name + postfix)]
@@ -212,7 +212,7 @@ class Texture(Component):
             ]
 
         for filepath in filepaths:
-            img = np.zeros((size, size), dtype=np.uint8)
+            img = np.zeros(size, dtype=np.uint8)
             cv2.imwrite(filepath, img)  # pylint: disable=no-member
 
     @property
@@ -356,7 +356,7 @@ class Texture(Component):
         try:
             with warnings.catch_warnings():
                 warnings.simplefilter("ignore", DeprecationWarning)
-                objects = ox.features_from_bbox(bbox=self._bbox, tags=tags)
+                objects = ox.features_from_bbox(bbox=self.bbox, tags=tags)
         except Exception as e:  # pylint: disable=W0718
             self.logger.warning("Error fetching objects for tags: %s.", tags)
             self.logger.warning(e)

{maps4fs-0.6.8 → maps4fs-0.7.2}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.6.8
+Version: 0.7.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -16,7 +16,6 @@ License-File: LICENSE.md
 Requires-Dist: opencv-python
 Requires-Dist: osmnx<2.0.0
 Requires-Dist: rasterio
-Requires-Dist: python_dotenv
 Requires-Dist: tqdm
 
 <div align="center" markdown>
@@ -28,7 +27,7 @@ Requires-Dist: tqdm
   <a href="#How-To-Run">How-To-Run</a> • 
   <a href="#Features">Features</a> • 
   <a href="#Supported-objects">Supported objects</a> • 
-  <a href="Settings">Settings</a> • 
+  <a href="#Advanced Settings">Advanced Settings</a> • 
   <a href="#Bugs-and-feature-requests">Bugs and feature requests</a>
 </p>
 
@@ -80,6 +79,20 @@ So, if you're new to map making, here's a quick overview of the process:
 3. Open the map template in the Giants Editor.
 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
 
+### Previews
+
+The generator also creates a multiple previews of the map. Here's the list of them:
+1. General preview - merging all the layers into one image with different colors.
+2. Grayscale DEM preview - a grayscale image of the height map (as it is).
+3. Colored DEM preview - a colored image of the height map (from blue to red). The blue color represents the lowest point, and the red color represents the highest point.
+
+![16 km map](https://github.com/user-attachments/assets/82543bcc-1289-479e-bd13-85a8890f0485)<br>
+*Preview of a 16 km map with a 500-meter mountain in the middle of it.*<br>
+
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -143,10 +156,9 @@ import maps4fs as mfs
 map = mfs.Map(
   game,
   (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  distance=1024,  # The DISTANCE from the center to the edge of the map in meters. The map will be 2048x2048 meters.
+  height=1024,  # The height of the map in meters.
+  width=1024,  # The width of the map in meters.
   map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-  blur_seed=5,  # The seed for the blur algorithm. The default value is 5, which means 5 meters.
-  max_height=400  # The maximum height of the map.
 )
 ```
 
@@ -157,11 +169,6 @@ map.generate()
 
 The map will be saved in the `map_directory` directory.
 
-## Settings
-Advanced settings are available in the tool's UI under the **Advanced Settings** tab. Here's the list of them:
-- `max_height` - the maximum height of the map. The default value is 400. Select smaller values for plain-like maps and bigger values for mountainous maps. You may need to experiment with this value to get the desired result.
-- `blur_seed` - the seed for the blur algorithm. The default value is 5, which means 5 meters. The bigger the value, the smoother the map will be. The smaller the value, the more detailed the map will be. Keep in mind that for some regions, where terrain is bumpy, disabling the blur algorithm may lead to a very rough map. So, I recommend leaving this value as it is.
-
 ## Features
 - Allows to enter a location by lat and lon (e.g. from Google Maps).
 - Allows to select a size of the map (2x2, 4x4, 8x8 km, 16x16 km).
@@ -186,18 +193,28 @@ The list will be updated as the project develops.
 The script will also generate the `generation_info.json` file in the `output` folder. It contains the following keys: <br>
 `"coordinates"` - the coordinates of the map center which you entered,<br>
 `"bbox"` - the bounding box of the map in lat and lon,<br>
-`"distance"` - the size of the map in meters,<br>
+`"map_height"` - the height of the map in meters (this one is from the user input, e.g. 2048 and so on),<br>
+`"map_width"` - the width of the map in meters (same as above),<br>
 `"minimum_x"` - the minimum x coordinate of the map (UTM projection),<br>
 `"minimum_y"` - the minimum y coordinate of the map (UTM projection),<br>
 `"maximum_x"` - the maximum x coordinate of the map (UTM projection),<br>
 `"maximum_y"` - the maximum y coordinate of the map (UTM projection),<br>
-`"height"` - the height of the map in meters (it won't be equal to the distance since the Earth is not flat, sorry flat-earthers),<br>
-`"width"` - the width of the map in meters,<br>
+`"height"` - the height of the map in meters (it won't be equal to the parameters above since the Earth is not flat, sorry flat-earthers),<br>
+`"width"` - the width of the map in meters (same as above),<br>
 `"height_coef"` - since we need a texture of exact size, the height of the map is multiplied by this coefficient,<br>
 `"width_coef"` - same as above but for the width,<br>
 `"tile_name"` - the name of the SRTM tile which was used to generate the height map, e.g. "N52E013"<br>
 
 You can use this information to adjust some other sources of data to the map, e.g. textures, height maps, etc.
 
+## Advanced Settings
+You can also apply some advanced settings to the map generation process. Note that they're ADVANCED, so you don't need to use them if you're not sure what they do.<br>
+
+Here's the list of the advanced settings:
+
+- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. So, by default this value is set to 3. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the [heightScale](https://www.farming-simulator.org/19/terrain-heightscale.php) parameter on the [PMC Farming Simulator](https://www.farming-simulator.org/) website.
+
+- DEM Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result as a Minecraft-like map.
+
 ## Bugs and feature requests
 If you find a bug or have an idea for a new feature, please create an issue [here](https://github.com/iwatkot/maps4fs/issues) or contact me directly on [Telegram](https://t.me/iwatkot).<br>

{maps4fs-0.6.8 → maps4fs-0.7.2}/maps4fs.egg-info/requires.txt

@@ -1,5 +1,4 @@
 opencv-python
 osmnx<2.0.0
 rasterio
-python_dotenv
 tqdm

{maps4fs-0.6.8 → maps4fs-0.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "0.6.8"
+version = "0.7.2"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "MIT License"}
@@ -20,7 +20,6 @@ dependencies = [
     "opencv-python",
     "osmnx<2.0.0",
     "rasterio",
-    "python_dotenv",
     "tqdm",
 ]
 

{maps4fs-0.6.8 → maps4fs-0.7.2}/tests/test_generator.py

@@ -1,7 +1,7 @@
 import json
 import os
 import shutil
-from random import choice, randint
+from random import choice
 from time import time
 
 import cv2
@@ -9,8 +9,6 @@ import cv2
 from maps4fs import Map
 from maps4fs.generator.game import Game
 
-# from maps4fs.generator.texture import TEXTURES
-
 working_directory = os.getcwd()
 
 base_directory = os.path.join(working_directory, "tests/data")
@@ -30,32 +28,14 @@ coordinates_cases = [
 game_code_cases = ["FS22"]
 
 
-def random_distance() -> int:
-    """Return random distance.
-
-    Returns:
-        int: Random distance.
-    """
-    distances_cases = [1024, 2048, 4096, 8192]
-    return choice(distances_cases[:2])  # Larger maps are too slow for automated tests.
-
-
-def random_blur_seed() -> int:
-    """Return random blur seed.
-
-    Returns:
-        int: Random blur seed.
-    """
-    return randint(1, 30)
-
-
-def random_max_height() -> int:
-    """Return random max height.
+def get_random_size() -> tuple[int, int]:
+    """Return random size.
 
     Returns:
-        int: Random max height.
+        tuple[int, int]: Random size.
     """
-    return randint(100, 3000)
+    sizes_cases = [(1024, 1024), (2048, 2048), (4096, 4096), (8192, 8192)]
+    return choice(sizes_cases[:2])  # Larger maps are too slow for automated tests.
 
 
 def map_directory() -> str:
@@ -88,18 +68,15 @@ def test_map():
     for game_code in game_code_cases:
         game = Game.from_code(game_code)
         for coordinates in coordinates_cases:
-            distance = random_distance()
-            blur_seed = random_blur_seed()
-            max_height = random_max_height()
+            height, width = get_random_size()
             directory = map_directory()
 
             map = Map(
                 game=game,
                 coordinates=coordinates,
-                distance=distance,
+                height=height,
+                width=width,
                 map_directory=directory,
-                blur_seed=blur_seed,
-                max_height=max_height,
             )
 
             map.generate()
@@ -121,41 +98,36 @@ def test_map():
                     img = cv2.imread(texture_path)
                     assert img is not None, f"Texture could not be read: {texture_path}"
                     assert img.shape == (
-                        distance * 2,
-                        distance * 2,
+                        height,
+                        width,
                         3,
-                    ), f"Texture shape mismatch: {img.shape} != {(distance * 2, distance * 2, 3)}"
+                    ), f"Texture shape mismatch: {img.shape} != {(height, width, 3)}"
                     assert img.dtype == "uint8", f"Texture dtype mismatch: {img.dtype} != uint8"
 
             dem_file = os.path.join(textures_directory, "map_dem.png")
             assert os.path.isfile(dem_file), f"DEM file not found: {dem_file}"
             img = cv2.imread(dem_file, cv2.IMREAD_UNCHANGED)
             assert img is not None, f"DEM could not be read: {dem_file}"
-            assert img.shape == (
-                distance + 1,
-                distance + 1,
-            ), f"DEM shape mismatch: {img.shape} != {(distance + 1, distance + 1)}"
+
             assert img.dtype == "uint16", f"DEM dtype mismatch: {img.dtype} != uint16"
 
 
 def test_map_preview():
     """Test Map preview generation."""
     case = choice(coordinates_cases)
-    distance = random_distance()
-    blur_seed = random_blur_seed()
-    max_height = random_max_height()
 
     game_code = choice(game_code_cases)
     game = Game.from_code(game_code)
 
+    height, width = get_random_size()
+
     directory = map_directory()
     map = Map(
         game=game,
         coordinates=case,
-        distance=distance,
+        height=height,
+        width=width,
         map_directory=directory,
-        blur_seed=blur_seed,
-        max_height=max_height,
     )
     map.generate()
     previews_paths = map.previews()
@@ -163,32 +135,24 @@ def test_map_preview():
         assert os.path.isfile(preview_path), f"Preview not found: {preview_path}"
         img = cv2.imread(preview_path)
         assert img is not None, f"Preview could not be read: {preview_path}"
-        assert img.shape == (
-            2048,
-            2048,
-            3,
-        ), f"Preview shape mismatch: {img.shape} != (2048, 2048, 3)"
-        assert img.dtype == "uint8", f"Preview dtype mismatch: {img.dtype} != uint8"
 
 
 def test_map_pack():
     """Test Map packing into zip archive."""
     case = choice(coordinates_cases)
-    distance = random_distance()
-    blur_seed = random_blur_seed()
-    max_height = random_max_height()
 
     game_code = choice(game_code_cases)
     game = Game.from_code(game_code)
 
+    height, width = get_random_size()
+
     directory = map_directory()
     map = Map(
         game=game,
         coordinates=case,
-        distance=distance,
+        height=height,
+        width=width,
         map_directory=directory,
-        blur_seed=blur_seed,
-        max_height=max_height,
     )
     map.generate()
     archive_name = os.path.join(base_directory, "archive")

maps4fs-0.6.8/maps4fs/generator/component.py

@@ -1,55 +0,0 @@
-"""This module contains the base class for all map generation components."""
-
-from __future__ import annotations
-
-from typing import TYPE_CHECKING, Any
-
-if TYPE_CHECKING:
-    from maps4fs.generator.game import Game
-
-
-# pylint: disable=R0801, R0903
-class Component:
-    """Base class for all map generation components.
-
-    Args:
-        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
-        distance (int): The distance from the center to the edge of the map.
-        map_directory (str): The directory where the map files are stored.
-        logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
-            info, warning. If not provided, default logging will be used.
-    """
-
-    def __init__(
-        self,
-        game: Game,
-        coordinates: tuple[float, float],
-        distance: int,
-        map_directory: str,
-        logger: Any = None,
-        **kwargs,  # pylint: disable=W0613, R0913, R0917
-    ):
-        self.game = game
-        self.coordinates = coordinates
-        self.distance = distance
-        self.map_directory = map_directory
-        self.logger = logger
-        self.kwargs = kwargs
-
-        self.preprocess()
-
-    def preprocess(self) -> None:
-        """Prepares the component for processing. Must be implemented in the child class.
-
-        Raises:
-            NotImplementedError: If the method is not implemented in the child class.
-        """
-        raise NotImplementedError
-
-    def process(self) -> None:
-        """Launches the component processing. Must be implemented in the child class.
-
-        Raises:
-            NotImplementedError: If the method is not implemented in the child class.
-        """
-        raise NotImplementedError