maps4fs 2.9.2__py3-none-any.whl → 2.9.37__py3-none-any.whl

maps4fs/generator/component/texture.py

@@ -168,6 +168,14 @@ class Texture(ImageComponent):
         """
         return [layer for layer in self.layers if layer.indoor]
 
+    def get_building_category_layers(self) -> list[Layer]:
+        """Returns layers which have building category defined.
+
+        Returns:
+            list[Layer]: List of layers which have building category defined.
+        """
+        return [layer for layer in self.layers if layer.building_category is not None]
+
     def process(self) -> None:
         """Processes the data to generate textures."""
         self._prepare_weights()
@@ -469,8 +477,11 @@ class Texture(ImageComponent):
             self._draw_layer(layer, info_layer_data, layer_image)  # type: ignore
             self._add_roads(layer, info_layer_data)
 
-            output_image = cv2.bitwise_and(layer_image, mask)  # type: ignore
-            cumulative_image = cv2.bitwise_or(cumulative_image, output_image)  # type: ignore
+            if not layer.external:
+                output_image = cv2.bitwise_and(layer_image, mask)  # type: ignore
+                cumulative_image = cv2.bitwise_or(cumulative_image, output_image)  # type: ignore
+            else:
+                output_image = layer_image  # type: ignore
 
             cv2.imwrite(layer_path, output_image)
             self.logger.debug("Texture %s saved.", layer_path)
@@ -550,6 +561,7 @@ class Texture(ImageComponent):
                     "points": linestring,
                     "tags": str(layer.tags),
                     "width": layer.width,
+                    "road_texture": layer.road_texture,
                 }
                 info_layer_data[f"{layer.info_layer}_polylines"].append(linestring_entry)  # type: ignore
 
@@ -803,7 +815,7 @@ class Texture(ImageComponent):
         is_fieds = info_layer == "fields"
 
         ox_settings.use_cache = self.map.texture_settings.use_cache
-        ox_settings.requests_timeout = 30
+        ox_settings.requests_timeout = 10
 
         objects = self.fetch_osm_data(tags)
         if objects is None or objects.empty:
@@ -834,7 +846,7 @@ class Texture(ImageComponent):
             else:
                 objects = ox.features_from_bbox(bbox=self.new_bbox, tags=tags)
         except Exception as e:
-            self.logger.debug("Error fetching objects for tags: %s. Error: %s.", tags, e)
+            self.logger.warning("Error fetching objects for tags: %s. Error: %s.", tags, e)
             return None
 
         return objects

maps4fs/generator/config.py

@@ -40,7 +40,7 @@ logger.info(
 )
 
 TEMPLATES_STRUCTURE = {
-    "fs25": ["texture_schemas", "tree_schemas", "map_templates"],
+    "fs25": ["texture_schemas", "tree_schemas", "buildings_schemas", "map_templates"],
     "fs22": ["texture_schemas", "map_templates"],
 }
 
@@ -51,11 +51,19 @@ def ensure_templates():
     If MFS_TEMPLATES_DIR is empty or doesn't exist, clone the maps4fsdata
     repository and run the preparation script to populate it.
     """
-
     # Check if templates directory exists and has content
-    if os.path.exists(MFS_TEMPLATES_DIR) and os.listdir(MFS_TEMPLATES_DIR):
-        logger.info("Templates directory already exists and contains data: %s", MFS_TEMPLATES_DIR)
-        return
+    if os.path.exists(MFS_TEMPLATES_DIR):  # and os.listdir(MFS_TEMPLATES_DIR):
+        logger.info("Templates directory already exists: %s", MFS_TEMPLATES_DIR)
+
+        files = [
+            entry
+            for entry in os.listdir(MFS_TEMPLATES_DIR)
+            if os.path.isfile(os.path.join(MFS_TEMPLATES_DIR, entry))
+        ]
+
+        if files:
+            logger.info("Templates directory contains files and will not be modified.")
+            return
 
     logger.info("Templates directory is empty or missing, preparing data...")
 
@@ -82,15 +90,31 @@ def ensure_templates():
                 text=True,
             )
 
-            # Make the preparation script executable
-            prep_script = os.path.join(clone_dir, "prepare_data.sh")
+            if os.name == "nt":
+                logger.info("Detected Windows OS, running PowerShell preparation script...")
+                prep_script = os.path.join(clone_dir, "prepare_data.ps1")
+                for_subprocess = [
+                    "powershell",
+                    "-ExecutionPolicy",
+                    "Bypass",
+                    "-File",
+                    "prepare_data.ps1",
+                ]
+            else:
+                logger.info("Detected non-Windows OS, running bash preparation script...")
+                prep_script = os.path.join(clone_dir, "prepare_data.sh")
+                for_subprocess = ["./prepare_data.sh"]
+
             if os.path.exists(prep_script):
-                os.chmod(prep_script, 0o755)
+                try:
+                    os.chmod(prep_script, 0o755)
+                except Exception as e:
+                    logger.warning("Could not set execute permissions on script: %s", str(e))
 
                 logger.info("Running data preparation script...")
                 # Run the preparation script from the cloned directory
                 subprocess.run(
-                    ["./prepare_data.sh"], cwd=clone_dir, check=True, capture_output=True, text=True
+                    for_subprocess, cwd=clone_dir, check=True, capture_output=True, text=True
                 )
 
                 # Copy the generated data directory to templates directory
@@ -140,6 +164,27 @@ def ensure_template_subdirs() -> None:
     logger.info("Templates directory is ready at: %s", MFS_TEMPLATES_DIR)
 
 
+def reload_templates() -> None:
+    """Reload templates by removing existing files and re-preparing them.
+    Does not affect nested directories containing user data.
+    If needed, the files should be removed manually.
+    """
+    logger.info("Reloading templates...")
+    # Remove files from the templates directory.
+    # But do not remove nested directories, because they contain user data.
+    # Only remove files in the top-level templates directory.
+    for item in os.listdir(MFS_TEMPLATES_DIR):
+        item_path = os.path.join(MFS_TEMPLATES_DIR, item)
+        if os.path.isfile(item_path):
+            try:
+                os.remove(item_path)
+            except Exception as e:
+                logger.warning("Could not remove file %s: %s", item_path, str(e))
+    ensure_templates()
+    ensure_template_subdirs()
+    logger.info("Templates reloaded successfully.")
+
+
 ensure_templates()
 ensure_template_subdirs()
 
@@ -160,8 +205,31 @@ 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)
+
+CACHE_DIRS = [DTM_CACHE_DIR, SAT_CACHE_DIR, osmnx_cache, osmnx_data]
+
+
+def create_cache_dirs() -> None:
+    """Create cache directories if they do not exist."""
+    logger.info("Ensuring cache directories exist...")
+    for cache_dir in CACHE_DIRS:
+        os.makedirs(cache_dir, exist_ok=True)
+        logger.debug("Cache directory ensured: %s", cache_dir)
+    logger.info("All cache directories are ready.")
+
+
+def clean_cache() -> None:
+    """Clean all cache directories by removing and recreating them."""
+    logger.info("Cleaning cache directories...")
+    for cache_dir in CACHE_DIRS:
+        if os.path.exists(cache_dir):
+            shutil.rmtree(cache_dir)
+            logger.debug("Removed cache directory: %s", cache_dir)
+    create_cache_dirs()
+    logger.info("Cache directories cleaned and recreated.")
+
+
+create_cache_dirs()
 
 
 ox_settings.cache_folder = osmnx_cache

maps4fs/generator/game.py

@@ -5,12 +5,15 @@ template file and specific settings for map generation."""
 from __future__ import annotations
 
 import os
+from typing import Callable
 
 import maps4fs.generator.config as mfscfg
 from maps4fs.generator.component.background import Background
+from maps4fs.generator.component.building import Building
 from maps4fs.generator.component.config import Config
 from maps4fs.generator.component.grle import GRLE
 from maps4fs.generator.component.i3d import I3d
+from maps4fs.generator.component.road import Road
 from maps4fs.generator.component.satellite import Satellite
 from maps4fs.generator.component.texture import Texture
 
@@ -37,6 +40,7 @@ class Game:
     _texture_schema_file: str | None = None
     _grle_schema_file: str | None = None
     _tree_schema_file: str | None = None
+    _buildings_schema_file: str | None = None
     _i3d_processing: bool = True
     _plants_processing: bool = True
     _environment_processing: bool = True
@@ -45,7 +49,7 @@ class Game:
     _mesh_processing: bool = True
 
     # Order matters! Some components depend on others.
-    components = [Satellite, Texture, Background, GRLE, I3d, Config]
+    components = [Satellite, Texture, Background, GRLE, I3d, Config, Road, Building]
 
     def __init__(self, map_template_path: str | None = None):
         if map_template_path:
@@ -72,6 +76,11 @@ class Game:
         else:
             self._tree_schema = os.path.join(mfscfg.MFS_TEMPLATES_DIR, self._tree_schema_file)  # type: ignore
 
+        if not self._buildings_schema_file:
+            self._buildings_schema_file = None
+        else:
+            self._buildings_schema_file = os.path.join(mfscfg.MFS_TEMPLATES_DIR, self._buildings_schema_file)  # type: ignore
+
     def set_components_by_names(self, component_names: list[str]) -> None:
         """Sets the components used for map generation by their names.
 
@@ -159,6 +168,19 @@ class Game:
             raise ValueError("Tree layers schema path not set.")
         return self._tree_schema
 
+    @property
+    def buildings_schema(self) -> str:
+        """Returns the path to the buildings layers schema file.
+
+        Raises:
+            ValueError: If the buildings layers schema path is not set.
+
+        Returns:
+            str: The path to the buildings layers schema file."""
+        if not self._buildings_schema_file:
+            raise ValueError("Buildings layers schema path not set.")
+        return self._buildings_schema_file
+
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.
 
@@ -166,8 +188,7 @@ class Game:
             map_directory (str): The path to the map directory.
 
         Returns:
-            str: The path to the DEM file.
-        """
+            str: The path to the DEM file."""
         raise NotImplementedError
 
     def weights_dir_path(self, map_directory: str) -> str:
@@ -341,6 +362,45 @@ class Game:
             bool: True if the mesh should be processed, False otherwise."""
         return self._mesh_processing
 
+    def validate_template(self, map_directory: str) -> None:
+        """Validates that all required files exist in the map template directory.
+
+        Arguments:
+            map_directory (str): The path to the map directory.
+
+        Raises:
+            FileNotFoundError: If any required files are missing from the template.
+        """
+        all_files = []
+        for root, _, files in os.walk(map_directory):
+            for file in files:
+                all_files.append(os.path.join(root, file))
+
+        missing_files = []
+        for func in self.required_file_methods():
+            try:
+                required_filepath = func(map_directory)
+            except NotImplementedError:
+                continue
+            if required_filepath not in all_files:
+                missing_files.append(required_filepath)
+        if missing_files:
+            raise FileNotFoundError(f"The following files are not found: {missing_files}.")
+
+    def required_file_methods(self) -> list[Callable[[str], str]]:
+        """Returns a list of methods that return paths to required files for map generation.
+
+        Returns:
+            list[Callable[[str], str]]: List of methods that take a map directory path
+                and return file paths that are required for the map template.
+        """
+        return [
+            self.map_xml_path,
+            self.i3d_file_path,
+            self.get_environment_xml_path,
+            self.get_farmlands_xml_path,
+        ]
+
 
 class FS22(Game):
     """Class used to define the game version FS22."""
@@ -396,6 +456,7 @@ class FS25(Game):
     _texture_schema_file = "fs25-texture-schema.json"
     _grle_schema_file = "fs25-grle-schema.json"
     _tree_schema_file = "fs25-tree-schema.json"
+    _buildings_schema_file = "fs25-buildings-schema.json"
 
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.

maps4fs/generator/map.py

@@ -105,6 +105,7 @@ class Map:
         self.i3d_settings = generation_settings.i3d_settings
         self.texture_settings = generation_settings.texture_settings
         self.satellite_settings = generation_settings.satellite_settings
+        self.building_settings = generation_settings.building_settings
         self.process_settings()
 
         self.logger = logger if logger else Logger()
@@ -123,11 +124,13 @@ class Map:
         os.makedirs(self.map_directory, exist_ok=True)
         self.texture_custom_schema = kwargs.get("texture_custom_schema", None)
         self.tree_custom_schema = kwargs.get("tree_custom_schema", None)
+        self.buildings_custom_schema = kwargs.get("buildings_custom_schema", None)
 
         json_data = {
             "generation_settings.json": generation_settings_json,
             "texture_custom_schema.json": self.texture_custom_schema,
             "tree_custom_schema.json": self.tree_custom_schema,
+            "buildings_custom_schema.json": self.buildings_custom_schema,
         }
 
         for filename, data in json_data.items():

maps4fs/generator/settings.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 import re
 from datetime import datetime
-from typing import TYPE_CHECKING, Any, NamedTuple
+from typing import TYPE_CHECKING, Any, Literal, NamedTuple
 
 from pydantic import BaseModel, ConfigDict
 
@@ -279,6 +279,21 @@ class SatelliteSettings(SettingsModel):
     zoom_level: int = 16
 
 
+class BuildingSettings(SettingsModel):
+    """Represents the advanced settings for building component.
+
+    Attributes:
+        generate_buildings (bool): generate buildings on the map.
+        region (Literal["auto", "all", "EU", "US"]): region for the buildings.
+        tolerance_factor (float): tolerance factor representing allowed dimension difference
+            between OSM building footprint and the building model footprint.
+    """
+
+    generate_buildings: bool = True
+    region: Literal["auto", "all", "EU", "US"] = "auto"
+    tolerance_factor: float = 0.3
+
+
 class GenerationSettings(BaseModel):
     """Represents the settings for the map generation process."""
 
@@ -288,6 +303,7 @@ class GenerationSettings(BaseModel):
     i3d_settings: I3DSettings = I3DSettings()
     texture_settings: TextureSettings = TextureSettings()
     satellite_settings: SatelliteSettings = SatelliteSettings()
+    building_settings: BuildingSettings = BuildingSettings()
 
     def to_json(self) -> dict[str, Any]:
         """Convert the GenerationSettings instance to JSON format.
@@ -302,6 +318,7 @@ class GenerationSettings(BaseModel):
             "I3DSettings": self.i3d_settings.model_dump(),
             "TextureSettings": self.texture_settings.model_dump(),
             "SatelliteSettings": self.satellite_settings.model_dump(),
+            "BuildingSettings": self.building_settings.model_dump(),
         }
 
     @classmethod

maps4fs/generator/utils.py

@@ -4,7 +4,7 @@ import json
 import os
 import shutil
 from datetime import datetime
-from typing import Any
+from typing import Any, Literal
 from xml.etree import ElementTree as ET
 
 import osmnx as ox
@@ -122,6 +122,20 @@ def get_country_by_coordinates(coordinates: tuple[float, float]) -> str:
     return "Unknown"
 
 
+def get_region_by_coordinates(coordinates: tuple[float, float]) -> Literal["EU", "US"]:
+    """Get region (EU or US) by coordinates.
+
+    Arguments:
+        coordinates (tuple[float, float]): Latitude and longitude.
+
+    Returns:
+        Literal["EU", "US"]: Region code.
+    """
+    country = get_country_by_coordinates(coordinates)
+    # If country is not US, assume EU for simplicity.
+    return "US" if country == "United States" else "EU"
+
+
 def get_timestamp() -> str:
     """Get current underscore-separated timestamp.
 

{maps4fs-2.9.2.dist-info → maps4fs-2.9.37.dist-info}/METADATA

@@ -1,15 +1,14 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.9.2
+Version: 2.9.37
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
-License: GNU Affero General Public License v3.0
+License-Expression: CC-BY-NC-4.0
 Project-URL: Homepage, https://github.com/iwatkot/maps4fs
 Project-URL: Repository, https://github.com/iwatkot/maps4fs
 Keywords: farmingsimulator,fs,farmingsimulator22,farmingsimulator25,fs22,fs25
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
@@ -76,6 +75,7 @@ Dynamic: license-file
 🚜 **Farming Simulator 22 & 25** - Generate maps for both game versions<br>
 🗺️ **Flexible Map Sizes** - 2x2, 4x4, 8x8, 16x16 km + custom sizes<br>
 ✂️ **Map Scaling & Rotation** - Perfect positioning and sizing control<br>
+🏘️ **Adding buildings** - Automatic building placement system<br>
 
 🌍 **Real-World Foundation** - Built from OpenStreetMap and satellite data<br>
 🏞️ **Accurate Terrain** - SRTM elevation data with custom DTM support<br>
@@ -86,7 +86,9 @@ Dynamic: license-file
 🌲 **Natural Forests** - Tree placement with customizable density<br>
 🌊 **Water Systems** - Rivers, lakes, and water planes<br>
 🌿 **Decorative Foliage** - Realistic vegetation and grass areas<br>
+🏘️ **Intelligent Building Placement** - Automatic building placement in appropriate areas<br>
 
+🚧 **3D Road Generation** - Automatic road mesh creation with custom textures<br>
 🚧 **Complete Spline Networks** - Roads and infrastructure<br>
 🔷 **Background Terrain** - 3D *.obj files for surrounding landscape<br>
 📦 **Giants Editor Ready** - Import and start building immediately<br>
@@ -96,7 +98,7 @@ Dynamic: license-file
 📚 **Complete Documentation** - [Detailed guides](https://maps4fs.gitbook.io/docs) and video tutorials<br>
 
 <p align="center">
-<img src="https://github.com/iwatkot/maps4fsui/releases/download/0.0.2/mfstr.gif"><br>
+<img src="https://github.com/iwatkot/maps4fs/releases/download/2.9.34/mfsg.gif"><br>
 <i>Example of map generated with Maps4FS with no manual edits.</i>
 </p>
 

maps4fs-2.9.37.dist-info/RECORD

@@ -0,0 +1,32 @@
+maps4fs/__init__.py,sha256=5ixsCA5vgcIV0OrF9EJBm91Mmc_KfMiDRM-QyifMAvo,386
+maps4fs/logger.py,sha256=aZAa9glzgvH6ySVDLelSPTwHfWZtpGK5YBl-ufNUsPg,801
+maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/generator/config.py,sha256=o_zRT8Nauy1djELsC867yD7GTs1fwz1OtZ2jE4w_7Ts,9797
+maps4fs/generator/game.py,sha256=B7-a9gEBIOKAmC2eAAnEx65Ghx6U-edvNvU4a3WmjIw,18513
+maps4fs/generator/map.py,sha256=kkyMETKteFhnWRgmcR8gjdNBQy4roQzcdlFw1nE5chE,16116
+maps4fs/generator/monitor.py,sha256=Yrc7rClpmJK53SRzrOYZNBlwJmb5l6TkW-laFbyBEno,3524
+maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
+maps4fs/generator/settings.py,sha256=jrrIILNRtIpj7hpLrQqLTIagTY8tdJlLZDEN1M4n3Yc,14116
+maps4fs/generator/statistics.py,sha256=ol0MTiehcCbQFfyYA7cKU-M4_cjiLCktnGbid4GYABU,2641
+maps4fs/generator/utils.py,sha256=qaHmS5I30OhDwd213bbctlplQQlX-qkHugyszXGmh0U,5587
+maps4fs/generator/component/__init__.py,sha256=s01yVVVi8R2xxNvflu2D6wTd9I_g73AMM2x7vAC7GX4,490
+maps4fs/generator/component/background.py,sha256=3nzrIENqHVJiZzICqtMdgD-QbGS9125IeTCvO60y7jI,50155
+maps4fs/generator/component/building.py,sha256=VoLjj6mDT-4kVfwxXP-lD0r4vJVYszyWZtciVFwdkIk,27402
+maps4fs/generator/component/config.py,sha256=tI2RQaGIqBgJIi9KjYfMZZ8AWg_YVUm6KKsBHGV241g,31285
+maps4fs/generator/component/dem.py,sha256=vMVJtU2jAS-2lfB9JsqodZsrUvY1h5xr3Dh5qk6txwk,11895
+maps4fs/generator/component/grle.py,sha256=FAcGmG7yq0icOElRoO4QMsVisZMsNrLhfNSWvGKnOHg,29899
+maps4fs/generator/component/i3d.py,sha256=idOixc2UF6RSvQud9GCWmMuTcY1qKVuzijUHakSzWks,28952
+maps4fs/generator/component/layer.py,sha256=-pnKPlZFmsU-OmvG7EX-Nb55eETY0NTiYnnkCIRJuvY,7731
+maps4fs/generator/component/road.py,sha256=YHX3-GcRXEyy9UG5KpUwC75n0FEIysn9PJnC7-tiwkw,27850
+maps4fs/generator/component/satellite.py,sha256=1bPqd8JqAPqU0tEI9m-iuljMW9hXqlaCIxvq7kdpMY0,5219
+maps4fs/generator/component/texture.py,sha256=46eG1EUWqDEppdxkimgu_gCBcNf2KqvZXfkak3GO8EI,38584
+maps4fs/generator/component/base/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/generator/component/base/component.py,sha256=-7H3donrH19f0_rivNyI3fgLsiZkntXfGywEx4tOnM4,23924
+maps4fs/generator/component/base/component_image.py,sha256=GXFkEFARNRkWkDiGSjvU4WX6f_8s6R1t2ZYqZflv1jk,9626
+maps4fs/generator/component/base/component_mesh.py,sha256=2wGe_-wAZVRljMKzzVJ8jdzIETWg7LjxGj8A3inH5eI,25550
+maps4fs/generator/component/base/component_xml.py,sha256=MT-VhU2dEckLFxAgmxg6V3gnv11di_94Qq6atfpOLdc,5342
+maps4fs-2.9.37.dist-info/licenses/LICENSE.md,sha256=LzOB2xtN1AlHJi4hqoEsBlYLfmfRyXCPC2417miYoBc,19579
+maps4fs-2.9.37.dist-info/METADATA,sha256=rJbXUF1gfOOgila4vS8faBTPMkZSKX0bxCxotgQl940,10204
+maps4fs-2.9.37.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maps4fs-2.9.37.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-2.9.37.dist-info/RECORD,,