maps4fs 2.1.4__tar.gz → 2.1.6__tar.gz

{maps4fs-2.1.4 → maps4fs-2.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.4
+Version: 2.1.6
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/component/background.py

@@ -69,6 +69,8 @@ class Background(MeshComponent, ImageComponent):
         )
         self.not_resized_path: str = os.path.join(self.background_directory, "not_resized.png")
 
+        self.flatten_water_to: int | None = None
+
         self.dem = DEM(
             self.game,
             self.map,
@@ -520,11 +522,22 @@ class Background(MeshComponent, ImageComponent):
             if self.map.shared_settings.mesh_z_scaling_factor is not None
             else 257
         )
+        flatten_to = None
+        subtract_by = int(self.map.dem_settings.water_depth * z_scaling_factor)
+
+        if self.map.background_settings.flatten_water:
+            try:
+                mask = water_resources_image == 255
+                flatten_to = int(np.mean(dem_image[mask]) - subtract_by)  # type: ignore
+                self.flatten_water_to = flatten_to  # type: ignore
+            except Exception as e:
+                self.logger.warning("Error occurred while flattening water: %s", e)
 
         dem_image = self.subtract_by_mask(
             dem_image,  # type: ignore
             water_resources_image,  # type: ignore
-            int(self.map.dem_settings.water_depth * z_scaling_factor),
+            subtract_by=subtract_by,
+            flatten_to=flatten_to,
         )
 
         dem_image = self.blur_edges_by_mask(
@@ -598,7 +611,7 @@ class Background(MeshComponent, ImageComponent):
             return
 
         # Create a mesh from the 3D polygons
-        mesh = self.mesh_from_3d_polygons(fitted_polygons)
+        mesh = self.mesh_from_3d_polygons(fitted_polygons, single_z_value=self.flatten_water_to)
         if mesh is None:
             self.logger.warning("No mesh could be created from the water polygons.")
             return
@@ -611,13 +624,16 @@ class Background(MeshComponent, ImageComponent):
         mesh.export(line_based_save_path)
         self.logger.debug("Line-based water mesh saved to %s", line_based_save_path)
 
-    def mesh_from_3d_polygons(self, polygons: list[shapely.Polygon]) -> Trimesh | None:
+    def mesh_from_3d_polygons(
+        self, polygons: list[shapely.Polygon], single_z_value: int | None = None
+    ) -> Trimesh | None:
         """Create a simple mesh from a list of 3D shapely Polygons.
         Each polygon must be flat (all Z the same or nearly the same for each polygon).
         Returns a single Trimesh mesh.
 
         Arguments:
             polygons (list[shapely.Polygon]): List of 3D shapely Polygons to create the mesh from.
+            single_z_value (int | None): The Z value to use for all vertices in the mesh.
 
         Returns:
             Trimesh: A single Trimesh object containing the mesh created from the polygons.
@@ -649,9 +665,12 @@ class Background(MeshComponent, ImageComponent):
                 dists = np.linalg.norm(exterior_2d - v[:2], axis=1)
                 idx = np.argmin(dists)
                 # z = exterior_coords[idx, 2]
-                z = self.get_z_coordinate_from_dem(
-                    not_resized_dem, exterior_coords[idx, 0], exterior_coords[idx, 1]  # type: ignore
-                )
+                if not single_z_value:
+                    z = self.get_z_coordinate_from_dem(
+                        not_resized_dem, exterior_coords[idx, 0], exterior_coords[idx, 1]  # type: ignore
+                    )
+                else:
+                    z = single_z_value
                 vertices_3d.append([v[0], v[1], z])
             vertices_3d = np.array(vertices_3d)  # type: ignore
 
@@ -814,7 +833,7 @@ class Background(MeshComponent, ImageComponent):
                 full_mask[mask == 255] = 255
 
         main_dem_path = self.game.dem_file_path(self.map_directory)
-        dem_image = self.blur_by_mask(dem_image, full_mask)
+        dem_image = self.blur_by_mask(dem_image, full_mask, blur_radius=5)
         dem_image = self.blur_edges_by_mask(dem_image, full_mask)
 
         output_size = dem_image.shape[0] + 1

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/component/base/component_image.py

@@ -67,6 +67,7 @@ class ImageComponent(Component):
         mask_by: int = 255,
         erode_kernel: int | None = 3,
         erode_iter: int | None = 1,
+        flatten_to: int | None = None,
     ) -> np.ndarray:
         """Subtracts a value from the image where the mask is equal to the mask by value.
 
@@ -77,6 +78,7 @@ class ImageComponent(Component):
             mask_by (int, optional): The value to mask by. Defaults to 255.
             erode_kernel (int, optional): The kernel size for the erosion. Defaults to 3.
             erode_iter (int, optional): The number of iterations for the erosion. Defaults to 1.
+            flatten_to_mean (bool, optional): Whether to flatten the image to the mean value.
 
         Returns:
             np.ndarray: The image with the subtracted value.
@@ -90,6 +92,10 @@ class ImageComponent(Component):
             ).astype(bool)
 
         image[mask] = image[mask] - subtract_by
+
+        if flatten_to:
+            image[mask] = flatten_to
+
         return image
 
     @staticmethod
@@ -190,7 +196,7 @@ class ImageComponent(Component):
             raise ValueError("Data and mask must have the same dimensions.")
 
         # Create a blurred version of the data
-        blurred_data = cv2.GaussianBlur(data, (blur_radius, blur_radius), sigmaX=3)
+        blurred_data = cv2.GaussianBlur(data, (blur_radius, blur_radius), sigmaX=10)
 
         # Combine the blurred data with the original data using the mask
         result = np.where(mask == 255, blurred_data, data)

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/component/base/component_mesh.py

@@ -235,7 +235,9 @@ class MeshComponent(Component):
             pass
         cube_mesh = trimesh.creation.box([remove_size, remove_size, z_size * 4])
 
-        return trimesh.boolean.difference([mesh_copy, cube_mesh], check_volume=False)
+        return trimesh.boolean.difference(
+            [mesh_copy, cube_mesh], check_volume=False, engine="blender"
+        )
 
     @staticmethod
     def mesh_to_origin(mesh: trimesh.Trimesh) -> trimesh.Trimesh:

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/component/dem.py

@@ -10,6 +10,7 @@ from pydtmdl import DTMProvider
 # import rasterio  # type: ignore
 from pympler import asizeof  # type: ignore
 
+import maps4fs.generator.config as mfscfg
 from maps4fs.generator.component.base.component_image import ImageComponent
 
 
@@ -30,7 +31,6 @@ class DEM(ImageComponent):
 
     def preprocess(self) -> None:
         self._dem_path = self.game.dem_file_path(self.map_directory)
-        self.temp_dir = "temp"
 
         self.logger.debug("Map size: %s x %s.", self.map_size, self.map_size)
         self.logger.debug(
@@ -44,7 +44,7 @@ class DEM(ImageComponent):
             coordinates=self.coordinates,
             user_settings=self.map.dtm_provider_settings,
             size=self.map_rotated_size,
-            directory=self.temp_dir,
+            directory=mfscfg.DTM_CACHE_DIR,
             logger=self.logger,
         )
 

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/component/satellite.py

@@ -7,6 +7,7 @@ from typing import NamedTuple
 
 from pygmdl import save_image
 
+import maps4fs.generator.config as mfscfg
 from maps4fs.generator.component.base.component_image import ImageComponent
 from maps4fs.generator.settings import Parameters
 
@@ -85,6 +86,7 @@ class Satellite(ImageComponent):
                     zoom=task.zoom,
                     from_center=True,
                     logger=self.logger,
+                    tiles_dir=mfscfg.SAT_CACHE_DIR,
                 )
 
             except Exception as e:

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/component/texture.py

@@ -20,8 +20,7 @@ from tqdm import tqdm
 
 from maps4fs.generator.component.base.component_image import ImageComponent
 from maps4fs.generator.component.layer import Layer
-
-PREVIEW_MAXIMUM_SIZE = 2048
+from maps4fs.generator.settings import Parameters
 
 
 class Texture(ImageComponent):
@@ -834,7 +833,7 @@ class Texture(ImageComponent):
         Returns:
             str: Path to the preview.
         """
-        scaling_factor = PREVIEW_MAXIMUM_SIZE / self.map_size
+        scaling_factor = Parameters.PREVIEW_MAXIMUM_SIZE / self.map_size
 
         preview_size = (
             int(self.map_size * scaling_factor),

maps4fs-2.1.6/maps4fs/generator/config.py

@@ -0,0 +1,52 @@
+"""This module contains configuration files for the maps4fs generator."""
+
+import os
+import subprocess
+
+from osmnx import settings as ox_settings
+
+MFS_ROOT_DIR = os.getenv("MFS_ROOT_DIRECTORY", os.path.join(os.getcwd(), "mfsrootdir"))
+MFS_CACHE_DIR = os.path.join(MFS_ROOT_DIR, "cache")
+MFS_DATA_DIR = os.path.join(MFS_ROOT_DIR, "data")
+os.makedirs(MFS_CACHE_DIR, exist_ok=True)
+os.makedirs(MFS_DATA_DIR, exist_ok=True)
+
+DTM_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "dtm")
+SAT_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "sat")
+
+osmnx_cache = os.path.join(MFS_CACHE_DIR, "osmnx")
+osmnx_data = os.path.join(MFS_CACHE_DIR, "odata")
+os.makedirs(osmnx_cache, exist_ok=True)
+os.makedirs(osmnx_data, exist_ok=True)
+
+
+ox_settings.cache_folder = osmnx_cache
+ox_settings.data_folder = osmnx_data
+
+
+def get_package_version(package_name: str) -> str:
+    """Get the package version.
+
+    Arguments:
+        package_name (str): The name of the package to check.
+
+    Returns:
+        str: The version of the package, or "unknown" if it cannot be determined.
+    """
+    try:
+        result = subprocess.run(
+            [os.sys.executable, "-m", "pip", "show", package_name],  # type: ignore
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+            check=True,
+        )
+        for line in result.stdout.splitlines():
+            if line.startswith("Version:"):
+                return line.split(":", 1)[1].strip()
+        return "unknown"
+    except Exception:
+        return "unknown"
+
+
+PACKAGE_VERSION = get_package_version("maps4fs")

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/map.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import json
 import os
 import shutil
+from datetime import datetime
 from typing import Any, Generator
 from xml.etree import ElementTree as ET
 
@@ -14,13 +15,16 @@ from osmnx._errors import InsufficientResponseError
 from pydtmdl import DTMProvider
 from pydtmdl.base.dtm import DTMProviderSettings
 
+import maps4fs.generator.config as mfscfg
 from maps4fs.generator.component import Background, Component, Layer, Texture
 from maps4fs.generator.game import FS25, Game
 from maps4fs.generator.settings import (
     BackgroundSettings,
     DEMSettings,
+    GenerationSettings,
     GRLESettings,
     I3DSettings,
+    MainSettings,
     SatelliteSettings,
     SharedSettings,
     TextureSettings,
@@ -48,7 +52,7 @@ class Map:
         coordinates: tuple[float, float],
         size: int,
         rotation: int,
-        map_directory: str,
+        map_directory: str | None = None,
         logger: Any = None,
         custom_osm: str | None = None,
         dem_settings: DEMSettings = DEMSettings(),
@@ -81,11 +85,13 @@ class Map:
         self.dtm_provider_settings = dtm_provider_settings
         self.components: list[Component] = []
         self.coordinates = coordinates
-        self.map_directory = map_directory
+        self.map_directory = map_directory or self.suggest_map_directory(
+            coordinates=coordinates, game_code=game.code  # type: ignore
+        )
 
-        try:
-            main_settings = {
-                "game": game.code,
+        main_settings = MainSettings.from_json(
+            {
+                "game": game.code,  # type: ignore
                 "latitude": coordinates[0],
                 "longitude": coordinates[1],
                 "country": self.get_country_by_coordinates(),
@@ -95,11 +101,24 @@ class Map:
                 "custom_osm": bool(custom_osm),
                 "is_public": kwargs.get("is_public", False),
                 "api_request": kwargs.get("api_request", False),
+                "date": datetime.now().strftime("%Y-%m-%d"),
+                "time": datetime.now().strftime("%H:%M:%S"),
+                "version": mfscfg.PACKAGE_VERSION,
+                "completed": False,
+                "error": None,
             }
-            send_main_settings(main_settings)
+        )
+        main_settings_json = main_settings.to_json()
+
+        try:
+            send_main_settings(main_settings_json)
         except Exception as e:
             self.logger.error("Error sending main settings: %s", e)
 
+        self.main_settings_path = os.path.join(self.map_directory, "main_settings.json")
+        with open(self.main_settings_path, "w", encoding="utf-8") as file:
+            json.dump(main_settings_json, file, indent=4)
+
         log_entry = ""
         log_entry += f"Map instance created for Game: {game.code}. "
         log_entry += f"Coordinates: {coordinates}. Size: {size}. Rotation: {rotation}. "
@@ -154,19 +173,14 @@ class Map:
         os.makedirs(self.map_directory, exist_ok=True)
         self.logger.debug("Map directory created: %s", self.map_directory)
 
-        settings = [
-            dem_settings,
-            background_settings,
-            grle_settings,
-            i3d_settings,
-            texture_settings,
-            satellite_settings,
-        ]
-
-        settings_json = {}
-
-        for setting in settings:
-            settings_json[setting.__class__.__name__] = setting.model_dump()
+        settings_json = GenerationSettings(
+            dem_settings=dem_settings,
+            background_settings=background_settings,
+            grle_settings=grle_settings,
+            i3d_settings=i3d_settings,
+            texture_settings=texture_settings,
+            satellite_settings=satellite_settings,
+        ).to_json()
 
         try:
             send_advanced_settings(settings_json)
@@ -205,6 +219,52 @@ class Map:
         except Exception as e:
             raise RuntimeError(f"Can not unpack map template due to error: {e}") from e
 
+        self.logger.debug(
+            "MFS_DATA_DIR: %s. MFS_CACHE_DIR %s", mfscfg.MFS_DATA_DIR, mfscfg.MFS_CACHE_DIR
+        )
+
+    @staticmethod
+    def suggest_map_directory(coordinates: tuple[float, float], game_code: str) -> str:
+        """Generate map directory path from coordinates and game code.
+
+        Returns:
+            str: Map directory path.
+        """
+        return os.path.join(mfscfg.MFS_DATA_DIR, Map.suggest_directory_name(coordinates, game_code))
+
+    @staticmethod
+    def suggest_directory_name(coordinates: tuple[float, float], game_code: str) -> str:
+        """Generate directory name from coordinates and game code.
+
+        Returns:
+            str: Directory name.
+        """
+        lat, lon = coordinates
+        latr = Map.coordinate_to_string(lat)
+        lonr = Map.coordinate_to_string(lon)
+        return f"{Map.get_timestamp()}_{game_code}_{latr}_{lonr}".lower()
+
+    @staticmethod
+    def get_timestamp() -> str:
+        """Get current underscore-separated timestamp.
+
+        Returns:
+            str: Current timestamp.
+        """
+        return datetime.now().strftime("%Y%m%d_%H%M%S")
+
+    @staticmethod
+    def coordinate_to_string(coordinate: float) -> str:
+        """Convert coordinate to string with 3 decimal places.
+
+        Arguments:
+            coordinate (float): Coordinate value.
+
+        Returns:
+            str: Coordinate as string.
+        """
+        return f"{coordinate:.3f}".replace(".", "_")
+
     @property
     def texture_schema(self) -> list[dict[str, Any]] | None:
         """Return texture schema (custom if provided, default otherwise).
@@ -230,6 +290,7 @@ class Map:
             self.size,
             self.rotation,
         )
+        error_text = None
 
         for game_component in self.game.components:
             component = game_component(
@@ -256,8 +317,19 @@ class Map:
                     component.__class__.__name__,
                     e,
                 )
+                error_text = str(e)
                 raise e
 
+            finally:
+                with open(self.main_settings_path, "r", encoding="utf-8") as file:
+                    main_settings_json = json.load(file)
+
+                main_settings_json["completed"] = True
+                main_settings_json["error"] = error_text
+
+                with open(self.main_settings_path, "w", encoding="utf-8") as file:
+                    json.dump(main_settings_json, file, indent=4)
+
             try:
                 component.commit_generation_info()
             except Exception as e:

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/generator/settings.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import re
-from typing import Any
+from typing import Any, NamedTuple
 
 from pydantic import BaseModel, ConfigDict
 
@@ -164,6 +164,8 @@ class BackgroundSettings(SettingsModel):
         remove_center (bool): remove the center of the background terrain.
             It will be used to remove the center of the map where the player starts.
         flatten_roads (bool): if True, roads will be flattened in the DEM data.
+        flatten_water (bool): if True, the bottom of the water resources will be flattened
+            to the average height of the water resources.
     """
 
     generate_background: bool = False
@@ -171,6 +173,7 @@ class BackgroundSettings(SettingsModel):
     water_blurriness: int = 20
     remove_center: bool = True
     flatten_roads: bool = False
+    flatten_water: bool = False
 
 
 class GRLESettings(SettingsModel):
@@ -249,3 +252,104 @@ class SatelliteSettings(SettingsModel):
 
     download_images: bool = False
     zoom_level: int = 16
+
+
+class GenerationSettings(BaseModel):
+    """Represents the settings for the map generation process."""
+
+    dem_settings: DEMSettings
+    background_settings: BackgroundSettings
+    grle_settings: GRLESettings
+    i3d_settings: I3DSettings
+    texture_settings: TextureSettings
+    satellite_settings: SatelliteSettings
+
+    def to_json(self) -> dict[str, Any]:
+        """Convert the GenerationSettings instance to JSON format.
+
+        Returns:
+            dict[str, Any]: JSON representation of the GenerationSettings.
+        """
+        return {
+            "DEMSettings": self.dem_settings.model_dump(),
+            "BackgroundSettings": self.background_settings.model_dump(),
+            "GRLESettings": self.grle_settings.model_dump(),
+            "I3DSettings": self.i3d_settings.model_dump(),
+            "TextureSettings": self.texture_settings.model_dump(),
+            "SatelliteSettings": self.satellite_settings.model_dump(),
+        }
+
+    @classmethod
+    def from_json(cls, data: dict[str, Any]) -> GenerationSettings:
+        """Create a GenerationSettings instance from JSON data.
+
+        Arguments:
+            data (dict[str, Any]): JSON data.
+
+        Returns:
+            GenerationSettings: Instance of GenerationSettings.
+        """
+        return cls(
+            dem_settings=DEMSettings(**data["DEMSettings"]),
+            background_settings=BackgroundSettings(**data["BackgroundSettings"]),
+            grle_settings=GRLESettings(**data["GRLESettings"]),
+            i3d_settings=I3DSettings(**data["I3DSettings"]),
+            texture_settings=TextureSettings(**data["TextureSettings"]),
+            satellite_settings=SatelliteSettings(**data["SatelliteSettings"]),
+        )
+
+
+class MainSettings(NamedTuple):
+    """Represents the main settings for the map generation."""
+
+    game: str
+    latitude: float
+    longitude: float
+    country: str
+    size: int
+    rotation: int
+    dtm_provider: str
+    custom_osm: bool
+    is_public: bool
+    api_request: bool
+    date: str
+    time: str
+    version: str
+    completed: bool
+    error: str | None = None
+
+    @classmethod
+    def from_json(cls, data: dict[str, str | float | int | bool | None]) -> MainSettings:
+        """Create a MainSettings instance from JSON data.
+
+        Arguments:
+            data (dict[str, str | float | int | bool | None]): JSON data.
+
+        Returns:
+            MainSettings: Instance of MainSettings.
+        """
+        return cls(**data)  # type: ignore
+
+    def to_json(self) -> dict[str, str | float | int | bool | None]:
+        """Convert the MainSettings instance to JSON format.
+
+        Returns:
+            dict[str, str | float | int | bool | None]: JSON representation of the MainSettings.
+        """
+        return {
+            "game": self.game,
+            "latitude": self.latitude,
+            "longitude": self.longitude,
+            "country": self.country,
+            "size": self.size,
+            "rotation": self.rotation,
+            "dtm_provider": self.dtm_provider,
+            "custom_osm": self.custom_osm,
+            "is_public": self.is_public,
+            "api_request": self.api_request,
+            "date": self.date,
+            "time": self.time,
+            "version": self.version,
+            "completed": self.completed,
+            "error": self.error,
+        }

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs/logger.py

@@ -1,13 +1,10 @@
 """This module contains the Logger class for logging to the file and stdout."""
 
 import logging
-import os
 import sys
 from typing import Literal
 
 LOGGER_NAME = "maps4fs"
-log_directory = os.path.join(os.getcwd(), "logs")
-os.makedirs(log_directory, exist_ok=True)
 
 
 class Logger(logging.Logger):

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.4
+Version: 2.1.6
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0

{maps4fs-2.1.4 → maps4fs-2.1.6}/maps4fs.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ maps4fs.egg-info/dependency_links.txt
 maps4fs.egg-info/requires.txt
 maps4fs.egg-info/top_level.txt
 maps4fs/generator/__init__.py
+maps4fs/generator/config.py
 maps4fs/generator/game.py
 maps4fs/generator/map.py
 maps4fs/generator/qgis.py

{maps4fs-2.1.4 → maps4fs-2.1.6}/pyproject.toml

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