maps4fs 1.8.1__tar.gz → 1.8.12__tar.gz

{maps4fs-1.8.1 → maps4fs-1.8.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.8.1
+Version: 1.8.12
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -611,6 +611,8 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
 
+- Trees relative shift - represents the maximum possible shift of the tree from it's original position in percents of the forest density value. The higher the value, the more the trees will be shifted from their original positions. Warning: higher values can lead to overlapping trees.
+
 ### Texture Advanced settings
 
 - Dissolve - if enabled, the values from one layer will be splitted between different layers of texture, making it look more natural. Warning: it's a time-consuming process, recommended to enable it, when you generating the final version of the map, not some test versions.
@@ -692,3 +694,5 @@ But also, I want to thank the people who helped me with the project in some way,
 - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
 - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
 - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
+- [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
+

{maps4fs-1.8.1 → maps4fs-1.8.12}/README.md

@@ -585,6 +585,8 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
 
+- Trees relative shift - represents the maximum possible shift of the tree from it's original position in percents of the forest density value. The higher the value, the more the trees will be shifted from their original positions. Warning: higher values can lead to overlapping trees.
+
 ### Texture Advanced settings
 
 - Dissolve - if enabled, the values from one layer will be splitted between different layers of texture, making it look more natural. Warning: it's a time-consuming process, recommended to enable it, when you generating the final version of the map, not some test versions.
@@ -666,3 +668,5 @@ But also, I want to thank the people who helped me with the project in some way,
 - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
 - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
 - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
+- [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
+

{maps4fs-1.8.1 → maps4fs-1.8.12}/maps4fs/generator/background.py

@@ -13,7 +13,7 @@ import numpy as np
 import trimesh  # type: ignore
 from tqdm import tqdm
 
-from maps4fs.generator.component import Component
+from maps4fs.generator.component.base.component import Component
 from maps4fs.generator.dem import DEM
 from maps4fs.generator.texture import Texture
 
@@ -89,7 +89,7 @@ class Background(Component):
         Raises:
             ValueError: If the custom background image does not meet the requirements.
         """
-        image = cv2.imread(image_path, cv2.IMREAD_UNCHANGED)  # pylint: disable=no-member
+        image = cv2.imread(image_path, cv2.IMREAD_UNCHANGED)
         if image.shape[0] != image.shape[1]:
             raise ValueError("The custom background image must be a square.")
 
@@ -207,7 +207,7 @@ class Background(Component):
         save_path = os.path.join(self.background_directory, f"{filename}.obj")
         self.logger.debug("Generating obj file in path: %s", save_path)
 
-        dem_data = cv2.imread(self.dem.dem_path, cv2.IMREAD_UNCHANGED)  # pylint: disable=no-member
+        dem_data = cv2.imread(self.dem.dem_path, cv2.IMREAD_UNCHANGED)
         self.plane_from_np(
             dem_data,
             save_path,
@@ -227,7 +227,7 @@ class Background(Component):
         Returns:
             str -- The path to the cutout DEM file.
         """
-        dem_data = cv2.imread(dem_path, cv2.IMREAD_UNCHANGED)  # pylint: disable=no-member
+        dem_data = cv2.imread(dem_path, cv2.IMREAD_UNCHANGED)
 
         center = (dem_data.shape[0] // 2, dem_data.shape[1] // 2)
         half_size = self.map_size // 2
@@ -238,7 +238,7 @@ class Background(Component):
         dem_data = dem_data[x1:x2, y1:y2]
 
         if save_path:
-            cv2.imwrite(save_path, dem_data)  # pylint: disable=no-member
+            cv2.imwrite(save_path, dem_data)
             self.logger.debug("Not resized DEM saved: %s", save_path)
             return save_path
 
@@ -251,12 +251,11 @@ class Background(Component):
         except FileNotFoundError:
             pass
 
-        # pylint: disable=no-member
         resized_dem_data = cv2.resize(
             dem_data, (output_size, output_size), interpolation=cv2.INTER_LINEAR
         )
 
-        cv2.imwrite(main_dem_path, resized_dem_data)  # pylint: disable=no-member
+        cv2.imwrite(main_dem_path, resized_dem_data)
         self.logger.debug("DEM cutout saved: %s", main_dem_path)
 
         return main_dem_path
@@ -301,9 +300,7 @@ class Background(Component):
                 playable area is will be cut out.
         """
         resize_factor = 1 / self.map.background_settings.resize_factor
-        dem_data = cv2.resize(  # pylint: disable=no-member
-            dem_data, (0, 0), fx=resize_factor, fy=resize_factor
-        )
+        dem_data = cv2.resize(dem_data, (0, 0), fx=resize_factor, fy=resize_factor)
         if remove_center:
             dem_data = self.remove_center(dem_data, resize_factor)
             self.logger.debug("Center removed from DEM data.")
@@ -410,7 +407,6 @@ class Background(Component):
 
         self.stl_preview_path = preview_path  # pylint: disable=attribute-defined-outside-init
 
-    # pylint: disable=no-member
     def previews(self) -> list[str]:
         """Returns the path to the image previews paths and the path to the STL preview file.
 

maps4fs-1.8.12/maps4fs/generator/component/base/__init__.py

@@ -0,0 +1 @@
+# pylint: disable=missing-module-docstring

{maps4fs-1.8.1/maps4fs/generator → maps4fs-1.8.12/maps4fs/generator/component/base}/component.py

@@ -7,11 +7,11 @@ import os
 from copy import deepcopy
 from typing import TYPE_CHECKING, Any
 
-import cv2  # type: ignore
-import osmnx as ox  # type: ignore
+import cv2
+import osmnx as ox
 from pyproj import Transformer
-from shapely.affinity import rotate, translate  # type: ignore
-from shapely.geometry import LineString, Polygon, box  # type: ignore
+from shapely.affinity import rotate, translate
+from shapely.geometry import LineString, Polygon, box
 
 from maps4fs.generator.qgis import save_scripts
 
@@ -20,7 +20,6 @@ if TYPE_CHECKING:
     from maps4fs.generator.map import Map
 
 
-# pylint: disable=R0801, R0903, R0902, R0904, R0913, R0917
 class Component:
     """Base class for all map generation components.
 
@@ -39,7 +38,7 @@ class Component:
     def __init__(
         self,
         game: Game,
-        map: Map,  # pylint: disable=W0622
+        map: Map,
         coordinates: tuple[float, float],
         map_size: int,
         map_rotated_size: int,
@@ -59,7 +58,7 @@ class Component:
         self.kwargs = kwargs
 
         self.logger.debug(
-            "Component %s initialized. Map size: %s, map rotated size: %s",  # type: ignore
+            "Component %s initialized. Map size: %s, map rotated size: %s",
             self.__class__.__name__,
             self.map_size,
             self.map_rotated_size,
@@ -90,12 +89,13 @@ class Component:
         raise NotImplementedError
 
     def previews(self) -> list[str]:
-        """Returns a list of paths to the preview images. Must be implemented in the child class.
+        """Returns a list of paths to the preview images. If the component does not generate any
+        previews, the method may not be re-implemented in the child class.
 
-        Raises:
-            NotImplementedError: If the method is not implemented in the child class.
+        Returns:
+            list[str]: A list of paths to the preview images.
         """
-        raise NotImplementedError
+        return []
 
     @property
     def previews_directory(self) -> str:
@@ -205,7 +205,7 @@ class Component:
         coordinates = coordinates or self.coordinates
         distance = distance or int(self.map_rotated_size / 2)
 
-        west, south, east, north = ox.utils_geo.bbox_from_point(  # type: ignore
+        west, south, east, north = ox.utils_geo.bbox_from_point(
             coordinates,
             dist=distance,
         )
@@ -260,11 +260,11 @@ class Component:
         epsg3857_south, epsg3857_east = transformer.transform(south, east)
 
         if add_margin:
-            MARGIN = 500  # pylint: disable=C0103
-            epsg3857_north = int(epsg3857_north - MARGIN)
-            epsg3857_south = int(epsg3857_south + MARGIN)
-            epsg3857_east = int(epsg3857_east - MARGIN)
-            epsg3857_west = int(epsg3857_west + MARGIN)
+            margin = 500
+            epsg3857_north = int(epsg3857_north - margin)
+            epsg3857_south = int(epsg3857_south + margin)
+            epsg3857_east = int(epsg3857_east - margin)
+            epsg3857_west = int(epsg3857_west + margin)
 
         return epsg3857_north, epsg3857_south, epsg3857_east, epsg3857_west
 
@@ -345,7 +345,6 @@ class Component:
 
         return cs_x, cs_y
 
-    # pylint: disable=R0914
     def fit_object_into_bounds(
         self,
         polygon_points: list[tuple[int, int]] | None = None,
@@ -404,9 +403,7 @@ class Component:
             fitted_osm_object = osm_object.intersection(bounds)
             self.logger.debug("Fitted the osm_object into the bounds: %s", bounds)
         except Exception as e:
-            raise ValueError(  # pylint: disable=W0707
-                f"Could not fit the osm_object into the bounds: {e}"
-            )
+            raise ValueError(f"Could not fit the osm_object into the bounds: {e}")
 
         if not isinstance(fitted_osm_object, object_type):
             raise ValueError("The fitted osm_object is not valid (probably splitted into parts).")
@@ -438,7 +435,27 @@ class Component:
             return None
         return info_layer_path
 
-    # pylint: disable=R0913, R0917, R0914
+    def get_infolayer_data(self, layer_name: str, layer_key: str) -> Any | None:
+        """Reads the JSON file of the requested info layer and returns the value of the requested
+        key. If the layer or the key does not exist, None is returned.
+
+        Arguments:
+            layer_name (str): The name of the layer.
+            layer_key (str): The key to get the value of.
+
+        Returns:
+            Any | None: The value of the requested key or None if the layer or the key does not
+                exist.
+        """
+        infolayer_path = self.get_infolayer_path(layer_name)
+        if not infolayer_path:
+            return None
+
+        with open(infolayer_path, "r", encoding="utf-8") as file:
+            data = json.load(file)
+
+        return data.get(layer_key)
+
     def rotate_image(
         self,
         image_path: str,
@@ -460,7 +477,6 @@ class Component:
             self.logger.warning("Image %s does not exist", image_path)
             return
 
-        # pylint: disable=no-member
         image = cv2.imread(image_path, cv2.IMREAD_UNCHANGED)
         if image is None:
             self.logger.warning("Image %s could not be read", image_path)

maps4fs-1.8.12/maps4fs/generator/component/base/component_xml.py

@@ -0,0 +1,95 @@
+"""Base class for all components that primarily used to work with XML files."""
+
+import os
+from xml.etree import ElementTree as ET
+
+from maps4fs.generator.component.base.component import Component
+
+
+class XMLComponent(Component):
+    """Base class for all components that primarily used to work with XML files."""
+
+    xml_path: str | None = None
+
+    def get_tree(self, xml_path: str | None = None) -> ET.ElementTree:
+        """Parses the XML file and returns the tree.
+        If the XML path is not provided, the class attribute is used.
+
+        Arguments:
+            xml_path (str, optional): The path to the XML file. Defaults to None.
+
+        Raises:
+            ValueError: If the XML path is not set as a class attribute nor provided as an
+                argument.
+            FileNotFoundError: If the XML file does not exist
+
+        Returns:
+            ET.ElementTree: The parsed XML tree.
+        """
+        xml_path = xml_path or self.xml_path
+        if not xml_path:
+            raise ValueError(
+                "XML path was not set as a class attribute nor provided as an argument."
+            )
+
+        if not os.path.isfile(xml_path):
+            raise FileNotFoundError(f"XML file {xml_path} does not exist.")
+
+        return ET.parse(xml_path)
+
+    def save_tree(self, tree: ET.ElementTree, xml_path: str | None = None) -> None:
+        """Saves the XML tree to the file.
+        If the XML path is not provided, the class attribute is used.
+
+        Arguments:
+            tree (ET.ElementTree): The XML tree to save.
+            xml_path (str, optional): The path to the XML file. Defaults to None.
+
+        Raises:
+            ValueError: If the XML path is not set as a class attribute nor provided as an
+                argument.
+        """
+        xml_path = xml_path or self.xml_path
+        if not xml_path:
+            raise ValueError(
+                "XML path was not set as a class attribute nor provided as an argument."
+            )
+
+        tree.write(xml_path, encoding="utf-8", xml_declaration=True)
+
+    def get_and_update_element(self, root: ET.Element, path: str, data: dict[str, str]) -> None:
+        """Finds the element by the path and updates it with the provided data.
+
+        Arguments:
+            root (ET.Element): The root element of the XML tree.
+            path (str): The path to the element.
+            data (dict[str, str]): The data to update the element with.
+        """
+        element = root.find(path)
+        if element is not None:
+            self.update_element(element, data)
+
+    def update_element(self, element: ET.Element, data: dict[str, str]) -> None:
+        """Updates the element with the provided data.
+
+        Arguments:
+            element (ET.Element): The element to update.
+            data (dict[str, str]): The data to update the element with.
+        """
+        for key, value in data.items():
+            element.set(key, value)
+
+    def create_element(self, element_name: str, data: dict[str, str]) -> ET.Element:
+        """Creates an element with the provided data.
+
+        Arguments:
+            element_name (str): The name of the element.
+            data (dict[str, str]): The data to set the element attributes to.
+
+        Returns:
+            ET.Element: The created element.
+        """
+        element = ET.Element(element_name)
+        for key, value in data.items():
+            element.set(key, value)
+        return element

{maps4fs-1.8.1/maps4fs/generator → maps4fs-1.8.12/maps4fs/generator/component}/config.py

@@ -2,14 +2,11 @@
 
 from __future__ import annotations
 
-import os
-from xml.etree import ElementTree as ET
-
-from maps4fs.generator.component import Component
+from maps4fs.generator.component.base.component_xml import XMLComponent
 
 
 # pylint: disable=R0903
-class Config(Component):
+class Config(XMLComponent):
     """Component for map settings and configuration.
 
     Arguments:
@@ -25,8 +22,7 @@ class Config(Component):
 
     def preprocess(self) -> None:
         """Gets the path to the map XML file and saves it to the instance variable."""
-        self._map_xml_path = self.game.map_xml_path(self.map_directory)
-        self.logger.debug("Map XML path: %s.", self._map_xml_path)
+        self.xml_path = self.game.map_xml_path(self.map_directory)
 
     def process(self) -> None:
         """Sets the map size in the map.xml file."""
@@ -34,31 +30,20 @@ class Config(Component):
 
     def _set_map_size(self) -> None:
         """Edits map.xml file to set correct map size."""
-        if not os.path.isfile(self._map_xml_path):
-            self.logger.warning("Map XML file not found: %s.", self._map_xml_path)
-            return
-        tree = ET.parse(self._map_xml_path)
-        self.logger.debug("Map XML file loaded from: %s.", self._map_xml_path)
+        tree = self.get_tree()
+        if not tree:
+            raise FileNotFoundError(f"Map XML file not found: {self.xml_path}")
+
         root = tree.getroot()
-        for map_elem in root.iter("map"):
-            map_elem.set("width", str(self.map_size))
-            map_elem.set("height", str(self.map_size))
-            self.logger.debug(
-                "Map size set to %sx%s in Map XML file.",
-                self.map_size,
-                self.map_size,
-            )
-        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.
+        data = {
+            "width": str(self.map_size),
+            "height": str(self.map_size),
+        }
 
-        Returns:
-            list[str]: An empty list.
-        """
-        return []
+        for element in root.iter("map"):
+            self.update_element(element, data)
+            break
+        self.save_tree(tree)
 
     def info_sequence(self) -> dict[str, dict[str, str | float | int]]:
         """Returns information about the component.