maps4fs 0.9.93__tar.gz → 0.9.96__tar.gz

maps4fs-0.9.96/LICENSE.md

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 [iwatkot](https://github.com/iwatkot)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{maps4fs-0.9.93 → maps4fs-0.9.96}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.93
+Version: 0.9.96
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/background.py

@@ -17,7 +17,6 @@ from maps4fs.generator.dem import (
 )
 from maps4fs.generator.path_steps import DEFAULT_DISTANCE, PATH_FULL_NAME, get_steps
 from maps4fs.generator.tile import Tile
-from maps4fs.logger import timeit
 
 RESIZE_FACTOR = 1 / 4
 SIMPLIFY_FACTOR = 10
@@ -28,7 +27,7 @@ FULL_SIMPLIFY_FACTOR = 20
 class Background(Component):
     """Component for creating 3D obj files based on DEM data around the map.
 
-    Args:
+    Arguments:
         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.
@@ -151,10 +150,9 @@ class Background(Component):
             self.logger.debug("Generating obj file for tile %s in path: %s", tile.code, save_path)
 
             dem_data = cv2.imread(tile.dem_path, cv2.IMREAD_UNCHANGED)  # pylint: disable=no-member
-            self.plane_from_np(tile.code, dem_data, save_path)
+            self.plane_from_np(tile.code, dem_data, save_path)  # type: ignore
 
     # pylint: disable=too-many-locals
-    @timeit
     def plane_from_np(self, tile_code: str, dem_data: np.ndarray, save_path: str) -> None:
         """Generates a 3D obj file based on DEM data.
 

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/component.py

@@ -20,7 +20,7 @@ if TYPE_CHECKING:
 class Component:
     """Base class for all map generation components.
 
-    Args:
+    Arguments:
         game (Game): The game instance for which the map is generated.
         coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
         map_height (int): The height of the map in pixels.
@@ -123,7 +123,7 @@ class Component:
         """Updates the generation info with the provided data.
         If the generation info file does not exist, it will be created.
 
-        Args:
+        Arguments:
             data (dict[Any, Any]): The data to update the generation info with.
         """
         if os.path.isfile(self.generation_info_path):
@@ -158,7 +158,7 @@ class Component:
         width of the map.
         If coordinates and distance are not provided, the instance variables are used.
 
-        Args:
+        Arguments:
             coordinates (tuple[float, float], optional): The latitude and longitude of the center of
                 the map. Defaults to None.
             height_distance (int, optional): The distance from the center of the map to the edge of
@@ -219,7 +219,7 @@ class Component:
         """Converts the bounding box to EPSG:3857.
         If the bounding box is not provided, the instance variable is used.
 
-        Args:
+        Arguments:
             bbox (tuple[float, float, float, float], optional): The bounding box to convert.
             add_margin (bool, optional): Whether to add a margin to the bounding box.
 
@@ -247,7 +247,7 @@ class Component:
         """Converts the bounding box to EPSG:3857 string.
         If the bounding box is not provided, the instance variable is used.
 
-        Args:
+        Arguments:
             bbox (tuple[float, float, float, float], optional): The bounding box to convert.
             add_margin (bool, optional): Whether to add a margin to the bounding box.
 
@@ -265,7 +265,7 @@ class Component:
         bounding box coordinates in EPSG:3857.
         For filenames, the class name is used as a prefix.
 
-        Args:
+        Arguments:
             qgis_layers (list[tuple[str, float, float, float, float]]): The list of layers to
                 create scripts for.
         """

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/config.py

@@ -12,7 +12,7 @@ from maps4fs.generator.component import Component
 class Config(Component):
     """Component for map settings and configuration.
 
-    Args:
+    Arguments:
         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.

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/dem.py

@@ -23,7 +23,7 @@ DEFAULT_PLATEAU = 0
 class DEM(Component):
     """Component for processing Digital Elevation Model data.
 
-    Args:
+    Arguments:
         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.
@@ -231,7 +231,7 @@ class DEM(Component):
     def make_copy(self, dem_name: str) -> None:
         """Copies DEM data to additional DEM file.
 
-        Args:
+        Arguments:
             dem_name (str): Name of the additional DEM file.
         """
         dem_directory = os.path.dirname(self._dem_path)
@@ -244,7 +244,7 @@ class DEM(Component):
     def _tile_info(self, lat: float, lon: float) -> tuple[str, str]:
         """Returns latitude band and tile name for SRTM tile from coordinates.
 
-        Args:
+        Arguments:
             lat (float): Latitude.
             lon (float): Longitude.
 
@@ -392,7 +392,7 @@ class DEM(Component):
         """Calculate scaling factor for DEM data normalization.
         NOTE: Needs reconsideration for the implementation.
 
-        Args:
+        Arguments:
             maximum_deviation (int): Maximum deviation in DEM data.
 
         Returns:
@@ -404,7 +404,7 @@ class DEM(Component):
 
     def _normalize_dem(self, data: np.ndarray) -> np.ndarray:
         """Normalize DEM data to 16-bit unsigned integer using max height from settings.
-        Args:
+        Arguments:
             data (np.ndarray): DEM data from SRTM file after cropping.
         Returns:
             np.ndarray: Normalized DEM data.

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/game.py

@@ -9,6 +9,7 @@ import os
 from maps4fs.generator.background import Background
 from maps4fs.generator.config import Config
 from maps4fs.generator.dem import DEM
+from maps4fs.generator.grle import GRLE
 from maps4fs.generator.i3d import I3d
 from maps4fs.generator.texture import Texture
 
@@ -35,8 +36,9 @@ class Game:
     _additional_dem_name: str | None = None
     _map_template_path: str | None = None
     _texture_schema: str | None = None
+    _grle_schema: str | None = None
 
-    components = [Config, Texture, DEM, I3d, Background]
+    components = [Config, Texture, GRLE, DEM, I3d, Background]
 
     def __init__(self, map_template_path: str | None = None):
         if map_template_path:
@@ -94,6 +96,19 @@ class Game:
             raise ValueError("Texture layers schema path not set.")
         return self._texture_schema
 
+    @property
+    def grle_schema(self) -> str:
+        """Returns the path to the GRLE layers schema file.
+
+        Raises:
+            ValueError: If the GRLE layers schema path is not set.
+
+        Returns:
+            str: The path to the GRLE layers schema file."""
+        if not self._grle_schema:
+            raise ValueError("GRLE layers schema path not set.")
+        return self._grle_schema
+
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.
 
@@ -171,6 +186,7 @@ class FS25(Game):
     _additional_dem_name = "unprocessedHeightMap.png"
     _map_template_path = os.path.join(working_directory, "data", "fs25-map-template.zip")
     _texture_schema = os.path.join(working_directory, "data", "fs25-texture-schema.json")
+    _grle_schema = os.path.join(working_directory, "data", "fs25-grle-schema.json")
 
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.

maps4fs-0.9.96/maps4fs/generator/grle.py

@@ -0,0 +1,75 @@
+"""This module contains the GRLE class for generating InfoLayer PNG files based on GRLE schema."""
+
+import json
+import os
+
+import cv2
+import numpy as np
+
+from maps4fs.generator.component import Component
+
+
+# pylint: disable=W0223
+class GRLE(Component):
+    """Component for to generate InfoLayer PNG files based on GRLE schema.
+
+    Arguments:
+        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.
+    """
+
+    _grle_schema: dict[str, float | int | str] | None = None
+
+    def preprocess(self) -> None:
+        """Gets the path to the map I3D file from the game instance and saves it to the instance
+        attribute. If the game does not support I3D files, the attribute is set to None."""
+        try:
+            grle_schema_path = self.game.grle_schema
+        except ValueError:
+            self.logger.info("GRLE schema processing is not implemented for this game.")
+            return
+
+        try:
+            with open(grle_schema_path, "r", encoding="utf-8") as file:
+                self._grle_schema = json.load(file)
+            self.logger.debug("GRLE schema loaded from: %s.", grle_schema_path)
+        except (json.JSONDecodeError, FileNotFoundError) as error:
+            self.logger.error("Error loading GRLE schema from %s: %s.", grle_schema_path, error)
+            self._grle_schema = None
+
+    def process(self) -> None:
+        """Generates InfoLayer PNG files based on the GRLE schema."""
+        if not self._grle_schema:
+            self.logger.info("GRLE schema is not obtained, skipping the processing.")
+            return
+
+        for info_layer in self._grle_schema:
+            if isinstance(info_layer, dict):
+                file_path = os.path.join(
+                    self.game.weights_dir_path(self.map_directory), info_layer["name"]
+                )
+
+                height = int(self.map_height * info_layer["height_multiplier"])
+                width = int(self.map_width * info_layer["width_multiplier"])
+                data_type = info_layer["data_type"]
+
+                self.logger.debug(
+                    "Creating InfoLayer PNG file %s with dimensions %dx%d, %d channels, "
+                    "and data type %s.",
+                    file_path,
+                    height,
+                    width,
+                    data_type,
+                )
+
+                # Create the InfoLayer PNG file with zeros.
+                info_layer_data = np.zeros((height, width), dtype=data_type)
+                print(info_layer_data.shape)
+                cv2.imwrite(file_path, info_layer_data)  # pylint: disable=no-member
+                self.logger.info("InfoLayer PNG file %s created.", file_path)
+            else:
+                self.logger.warning("Invalid InfoLayer schema: %s.", info_layer)

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/i3d.py

@@ -16,7 +16,7 @@ DEFAULT_MAX_LOD_OCCLUDER_DISTANCE = 10000
 class I3d(Component):
     """Component for map i3d file settings and configuration.
 
-    Args:
+    Arguments:
         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.

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/map.py

@@ -15,7 +15,7 @@ from maps4fs.logger import Logger
 class Map:
     """Class used to generate map using all components.
 
-    Args:
+    Arguments:
         game (Type[Game]): Game for which the map is generated.
         coordinates (tuple[float, float]): Coordinates of the center of the map.
         height (int): Height of the map in pixels.
@@ -119,7 +119,7 @@ class Map:
     def pack(self, archive_path: str, remove_source: bool = True) -> str:
         """Pack map directory to zip archive.
 
-        Args:
+        Arguments:
             archive_path (str): Path to the archive.
             remove_source (bool, optional): Remove source directory after packing.
 
@@ -129,6 +129,9 @@ class Map:
         archive_path = shutil.make_archive(archive_path, "zip", self.map_directory)
         self.logger.info("Map packed to %s.zip", archive_path)
         if remove_source:
-            shutil.rmtree(self.map_directory)
-            self.logger.info("Map directory removed: %s", self.map_directory)
+            try:
+                shutil.rmtree(self.map_directory)
+                self.logger.info("Map directory removed: %s", self.map_directory)
+            except Exception as e:  # pylint: disable=W0718
+                self.logger.error("Error removing map directory %s: %s", self.map_directory, e)
         return archive_path

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/qgis.py

@@ -115,7 +115,7 @@ for layer in layers:
 def _get_template(layers: list[tuple[str, float, float, float, float]], template: str) -> str:
     """Returns a template for creating layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
         template (str): The template for creating layers in QGIS.
@@ -136,7 +136,7 @@ def _get_template(layers: list[tuple[str, float, float, float, float]], template
 def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for creating bounding box layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
 
@@ -149,7 +149,7 @@ def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> s
 def get_point_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for creating point layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
 
@@ -162,7 +162,7 @@ def get_point_template(layers: list[tuple[str, float, float, float, float]]) ->
 def get_rasterize_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for rasterizing bounding box layers in QGIS.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
 
@@ -177,7 +177,7 @@ def save_scripts(
 ) -> None:
     """Saves QGIS scripts for creating bounding box, point, and raster layers.
 
-    Args:
+    Arguments:
         layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
             layer name and the bounding box coordinates.
         save_dir (str): The directory to save the scripts.

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/texture.py

@@ -36,7 +36,7 @@ class Texture(Component):
         """Class which represents a layer with textures and tags.
         It's using to obtain data from OSM using tags and make changes into corresponding textures.
 
-        Args:
+        Arguments:
             name (str): Name of the layer.
             tags (dict[str, str | list[str]]): Dictionary of tags to search for.
             width (int | None): Width of the polygon in meters (only for LineString).
@@ -89,7 +89,7 @@ class Texture(Component):
         def from_json(cls, data: dict[str, str | list[str] | bool]) -> Texture.Layer:
             """Creates a new instance of the class from dictionary.
 
-            Args:
+            Arguments:
                 data (dict[str, str | list[str] | bool]): Dictionary with layer data.
 
             Returns:
@@ -110,7 +110,51 @@ class Texture(Component):
             weight_postfix = "_weight" if not self.exclude_weight else ""
             return os.path.join(weights_directory, f"{self.name}{idx}{weight_postfix}.png")
 
+        def path_preview(self, previews_directory: str) -> str:
+            """Returns path to the preview of the first texture of the layer.
+
+            Arguments:
+                previews_directory (str): Path to the directory with previews.
+
+            Returns:
+                str: Path to the preview.
+            """
+            return self.path(previews_directory).replace(".png", "_preview.png")
+
+        def get_preview_or_path(self, previews_directory: str) -> str:
+            """Returns path to the preview of the first texture of the layer if it exists,
+            otherwise returns path to the texture.
+
+            Arguments:
+                previews_directory (str): Path to the directory with previews.
+
+            Returns:
+                str: Path to the preview or texture.
+            """
+            preview_path = self.path_preview(previews_directory)
+            return preview_path if os.path.isfile(preview_path) else self.path(previews_directory)
+
+        def paths(self, weights_directory: str) -> list[str]:
+            """Returns a list of paths to the textures of the layer.
+            NOTE: Works only after the textures are generated, since it just lists the directory.
+
+            Arguments:
+                weights_directory (str): Path to the directory with weights.
+
+            Returns:
+                list[str]: List of paths to the textures.
+            """
+            weight_files = os.listdir(weights_directory)
+            return [
+                os.path.join(weights_directory, weight_file)
+                for weight_file in weight_files
+                if weight_file.startswith(self.name)
+            ]
+
     def preprocess(self) -> None:
+        self.light_version = self.kwargs.get("light_version", False)
+        self.logger.debug("Light version: %s.", self.light_version)
+
         if not os.path.isfile(self.game.texture_schema):
             raise FileNotFoundError(f"Texture layers schema not found: {self.game.texture_schema}")
 
@@ -192,7 +236,7 @@ class Texture(Component):
         """Generates weight files for textures. Each file is a numpy array of zeros and
             dtype uint8 (0-255).
 
-        Args:
+        Arguments:
             layer (Layer): Layer with textures and tags.
         """
         size = (self.map_height, self.map_width)
@@ -222,7 +266,7 @@ class Texture(Component):
     def layers(self, layers: list[Layer]) -> None:
         """Sets list of layers with textures and tags.
 
-        Args:
+        Arguments:
             layers (list[Layer]): List of layers.
         """
         self._layers = layers
@@ -285,11 +329,73 @@ class Texture(Component):
         if cumulative_image is not None:
             self.draw_base_layer(cumulative_image)
 
+        if not self.light_version:
+            self.dissolve()
+        else:
+            self.logger.info("Skipping dissolve in light version of the map.")
+
+    def dissolve(self) -> None:
+        """Dissolves textures of the layers with tags into sublayers for them to look more
+        natural in the game.
+        Iterates over all layers with tags and reads the first texture, checks if the file
+        contains any non-zero values (255), splits those non-values between different weight
+        files of the corresponding layer and saves the changes to the files.
+        """
+        for layer in self.layers:
+            if not layer.tags:
+                self.logger.debug("Layer %s has no tags, there's nothing to dissolve.", layer.name)
+                continue
+            layer_path = layer.path(self._weights_dir)
+            layer_paths = layer.paths(self._weights_dir)
+
+            if len(layer_paths) < 2:
+                self.logger.debug("Layer %s has only one texture, skipping.", layer.name)
+                continue
+
+            self.logger.debug("Dissolving layer from %s to %s.", layer_path, layer_paths)
+
+            # Check if the image contains any non-zero values, otherwise continue.
+            layer_image = cv2.imread(layer_path, cv2.IMREAD_UNCHANGED)
+
+            if not np.any(layer_image):
+                self.logger.debug(
+                    "Layer %s does not contain any non-zero values, skipping.", layer.name
+                )
+                continue
+
+            # Save the original image to use it for preview later, without combining the sublayers.
+            cv2.imwrite(layer.path_preview(self._weights_dir), layer_image.copy())
+
+            # Get the coordinates of non-zero values.
+            non_zero_coords = np.column_stack(np.where(layer_image > 0))
+
+            # Prepare sublayers.
+            sublayers = [np.zeros_like(layer_image) for _ in range(layer.count)]
+
+            # Randomly assign non-zero values to sublayers.
+            for coord in non_zero_coords:
+                sublayers[np.random.randint(0, layer.count)][coord[0], coord[1]] = 255
+
+            # # ! Debug test if the sublayers are correct.
+            # if True:
+            #     combined = cv2.bitwise_or(*sublayers)
+            #     # Match the original image with the combined sublayers.
+            #     assert np.array_equal(layer_image, combined), "Sublayers are not correct."
+
+            # Save the sublayers.
+            for sublayer, sublayer_path in zip(sublayers, layer_paths):
+                cv2.imwrite(sublayer_path, sublayer)
+                self.logger.debug("Sublayer %s saved.", sublayer_path)
+
+            self.logger.info("Dissolved layer %s.", layer.name)
+
+        self.logger.info("Dissolving finished.")
+
     def draw_base_layer(self, cumulative_image: np.ndarray) -> None:
         """Draws base layer and saves it into the png file.
         Base layer is the last layer to be drawn, it fills the remaining area of the map.
 
-        Args:
+        Arguments:
             cumulative_image (np.ndarray): Cumulative image with all layers.
         """
         base_layer = self.get_base_layer()
@@ -303,7 +409,7 @@ class Texture(Component):
     def get_relative_x(self, x: float) -> int:
         """Converts UTM X coordinate to relative X coordinate in map image.
 
-        Args:
+        Arguments:
             x (float): UTM X coordinate.
 
         Returns:
@@ -314,7 +420,7 @@ class Texture(Component):
     def get_relative_y(self, y: float) -> int:
         """Converts UTM Y coordinate to relative Y coordinate in map image.
 
-        Args:
+        Arguments:
             y (float): UTM Y coordinate.
 
         Returns:
@@ -326,9 +432,9 @@ class Texture(Component):
     def _to_np(self, geometry: shapely.geometry.polygon.Polygon, *args) -> np.ndarray:
         """Converts Polygon geometry to numpy array of polygon points.
 
-        Args:
+        Arguments:
             geometry (shapely.geometry.polygon.Polygon): Polygon geometry.
-            *args: Additional arguments:
+            *Arguments: Additional arguments:
                 - width (int | None): Width of the polygon in meters.
 
         Returns:
@@ -343,7 +449,7 @@ class Texture(Component):
     def _to_polygon(self, obj: pd.core.series.Series, width: int | None) -> np.ndarray | None:
         """Converts OSM object to numpy array of polygon points.
 
-        Args:
+        Arguments:
             obj (pd.core.series.Series): OSM object.
             width (int | None): Width of the polygon in meters.
 
@@ -365,7 +471,7 @@ class Texture(Component):
     ) -> np.ndarray:
         """Converts LineString or Point geometry to numpy array of polygon points.
 
-        Args:
+        Arguments:
             geometry (shapely.geometry.linestring.LineString | shapely.geometry.point.Point):
                 LineString or Point geometry.
             width (int | None): Width of the polygon in meters.
@@ -381,7 +487,7 @@ class Texture(Component):
     ) -> Optional[Callable[[BaseGeometry, Optional[int]], np.ndarray]]:
         """Returns a converter function for a given geometry type.
 
-        Args:
+        Arguments:
             geom_type (str): Geometry type.
 
         Returns:
@@ -395,7 +501,7 @@ class Texture(Component):
     ) -> Generator[np.ndarray, None, None]:
         """Generator which yields numpy arrays of polygons from OSM data.
 
-        Args:
+        Arguments:
             tags (dict[str, str | list[str]]): Dictionary of tags to search for.
             width (int | None): Width of the polygon in meters (only for LineString).
 
@@ -455,7 +561,8 @@ class Texture(Component):
 
         images = [
             cv2.resize(
-                cv2.imread(layer.path(self._weights_dir), cv2.IMREAD_UNCHANGED), preview_size
+                cv2.imread(layer.get_preview_or_path(self._weights_dir), cv2.IMREAD_UNCHANGED),
+                preview_size,
             )
             for layer in active_layers
         ]

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/generator/tile.py

@@ -34,13 +34,13 @@ class Tile(DEM):
         if not self.code:
             raise ValueError("Tile code was not provided")
 
-        self.logger.debug(f"Generating tile {self.code}")
+        self.logger.debug("Generating tile for code %s", self.code)
 
         tiles_directory = os.path.join(self.map_directory, "objects", "tiles")
         os.makedirs(tiles_directory, exist_ok=True)
 
         self._dem_path = os.path.join(tiles_directory, f"{self.code}.png")
-        self.logger.debug(f"DEM path for tile {self.code} is {self._dem_path}")
+        self.logger.debug("DEM path for tile %s is %s", self.code, self._dem_path)
 
     def get_output_resolution(self) -> tuple[int, int]:
         """Return the resolution of the output image.

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/logger.py

@@ -4,9 +4,7 @@ import logging
 import os
 import sys
 from datetime import datetime
-from logging import getLogger
-from time import perf_counter
-from typing import Any, Callable, Literal
+from typing import Literal
 
 LOGGER_NAME = "maps4fs"
 log_directory = os.path.join(os.getcwd(), "logs")
@@ -46,25 +44,3 @@ class Logger(logging.Logger):
         today = datetime.now().strftime("%Y-%m-%d")
         log_file = os.path.join(log_directory, f"{today}.txt")
         return log_file
-
-
-def timeit(func: Callable[..., Any]) -> Callable[..., Any]:
-    """Decorator to log the time taken by a function to execute.
-
-    Args:
-        func (function): The function to be timed.
-
-    Returns:
-        function: The timed function.
-    """
-
-    def timed(*args, **kwargs):
-        logger = getLogger("maps4fs")
-        start = perf_counter()
-        result = func(*args, **kwargs)
-        end = perf_counter()
-        if logger is not None:
-            logger.info("Function %s took %s seconds to execute", func.__name__, end - start)
-        return result
-
-    return timed

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs/toolbox/dem.py

@@ -11,7 +11,7 @@ from rasterio.windows import from_bounds  # type: ignore
 def read_geo_tiff(file_path: str) -> DatasetReader:
     """Read a GeoTIFF file and return the DatasetReader object.
 
-    Args:
+    Arguments:
         file_path (str): The path to the GeoTIFF file.
 
     Raises:
@@ -43,7 +43,7 @@ def get_geo_tiff_bbox(
 ) -> tuple[float, float, float, float]:
     """Return the bounding box of a GeoTIFF file in the destination CRS.
 
-    Args:
+    Arguments:
         src (DatasetReader): The DatasetReader object for the GeoTIFF file.
         dst_crs (str, optional): The destination CRS. Defaults to "EPSG:4326".
 
@@ -65,7 +65,7 @@ def get_geo_tiff_bbox(
 def extract_roi(file_path: str, bbox: tuple[float, float, float, float]) -> str:
     """Extract a region of interest (ROI) from a GeoTIFF file and save it as a new file.
 
-    Args:
+    Arguments:
         file_path (str): The path to the GeoTIFF file.
         bbox (tuple[float, float, float, float]): The bounding box of the region of interest
             as (north, south, east, west).

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.93
+Version: 0.9.96
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License

{maps4fs-0.9.93 → maps4fs-0.9.96}/maps4fs.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ maps4fs/generator/component.py
 maps4fs/generator/config.py
 maps4fs/generator/dem.py
 maps4fs/generator/game.py
+maps4fs/generator/grle.py
 maps4fs/generator/i3d.py
 maps4fs/generator/map.py
 maps4fs/generator/path_steps.py

{maps4fs-0.9.93 → maps4fs-0.9.96}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "0.9.93"
+version = "0.9.96"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "MIT License"}

{maps4fs-0.9.93 → maps4fs-0.9.96}/tests/test_generator.py

@@ -57,7 +57,7 @@ def map_directory(game_code: str) -> str:
 def load_textures_schema(json_path: str) -> dict:
     """Load textures schema from JSON file.
 
-    Args:
+    Arguments:
         json_path (str): Path to the JSON file.
 
     Returns:

maps4fs-0.9.93/LICENSE.md

@@ -1,21 +0,0 @@
-# MIT License
-
-Copyright © [2024] [iwatkot]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.