maps4fs 0.9.98__tar.gz → 1.0.0__tar.gz

{maps4fs-0.9.98 → maps4fs-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.98
+Version: 1.0.0
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -31,8 +31,10 @@ Requires-Dist: pympler
 <p align="center">
   <a href="#Quick-Start">Quick Start</a> •
   <a href="#Overview">Overview</a> • 
-  <a href="#How-To-Run">How-To-Run</a> •
+  <a href="#Step-by-step">Create a map in 10 steps</a> •
+  <a href="#How-To-Run">How-To-Run</a><br>
   <a href="docs/FAQ.md">FAQ</a> •
+  <a href="docs/map_structure.md">Map Structure</a> •
   <a href="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -68,6 +70,7 @@ Requires-Dist: pympler
 🔷 Generates *.obj files for background terrain based on the real-world height map<br>
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 🧰 Modder Toolbox to help you with various of tasks 🆕<br>
+🌾 Automatically generates fields 🆕<br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -76,6 +79,8 @@ Requires-Dist: pympler
 🛰️ Realistic background terrain objects with satellite images.<br><br>
 <img src="https://github.com/user-attachments/assets/80e5923c-22c7-4dc0-8906-680902511f3a"><br>
 🗒️ True-to-life blueprints for fast and precise modding.<br><br>
+<img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
+🌾 Field generation with one click.<br><br>
 <img src="https://github.com/user-attachments/assets/cce45575-c917-4a1b-bdc0-6368e32ccdff"><br>
 📏 Almost any possible map sizes.
 </p>
@@ -126,6 +131,9 @@ Parameters:
 - coordinates: 45.15, 19.71
 - size: 16 x 16 km
 
+## Step by step
+Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -202,12 +210,15 @@ The map will be saved in the `map_directory` directory.
 ## Modder Toolbox
 The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
 
-![Modder Toolbox](https://github.com/user-attachments/assets/18f169e9-1a5b-474c-b488-6becfffadcea)
+![Modder Toolbox](https://github.com/user-attachments/assets/dffb252f-f5c0-4021-9d45-31e5bccc0d9b)
 
 ### Tool categories
 Tools are divided into categories, which are listed below.
 #### Textures and DEM
-- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image.
+- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image. It's useful when you have high-resolution DEM data and want to create the height map using it.
+
+#### Background terrain
+- **Convert image to obj model** - allows you to convert the image to the obj model. You can use this tool to create the background terrain for your map. It can be extremely useful if you have access to the sources of high-resolution DEM data and want to create the background terrain using it.
 
 ## Supported objects
 The project is based on the [OpenStreetMap](https://www.openstreetmap.org/) data. So, refer to [this page](https://wiki.openstreetmap.org/wiki/Map_Features) to understand the list below.
@@ -376,7 +387,7 @@ Let's have a closer look at the fields:
 
 ## Background terrain
 The tool now supports the generation of the background terrain. If you don't know what it is, here's a brief explanation. The background terrain is the world around the map. It's important to create it, because if you don't, the map will look like it's floating in the void. The background terrain is a simple plane which can (and should) be texture to look fine.<br>
-So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `objects/tiles` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
+So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `background` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
 If you don't want to work with separate tiles, the tool also generates the `FULL.obj` file, which includes everything around the map and the map itself. It may be a convinient approach to work with one file, one texture and then just cut the map from it.<br>
 
 ![Complete background terrain in Blender](https://github.com/user-attachments/assets/7266b8f1-bfa2-4c14-a740-1c84b1030a66)

{maps4fs-0.9.98 → maps4fs-1.0.0}/README.md

@@ -6,8 +6,10 @@
 <p align="center">
   <a href="#Quick-Start">Quick Start</a> •
   <a href="#Overview">Overview</a> • 
-  <a href="#How-To-Run">How-To-Run</a> •
+  <a href="#Step-by-step">Create a map in 10 steps</a> •
+  <a href="#How-To-Run">How-To-Run</a><br>
   <a href="docs/FAQ.md">FAQ</a> •
+  <a href="docs/map_structure.md">Map Structure</a> •
   <a href="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -43,6 +45,7 @@
 🔷 Generates *.obj files for background terrain based on the real-world height map<br>
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 🧰 Modder Toolbox to help you with various of tasks 🆕<br>
+🌾 Automatically generates fields 🆕<br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -51,6 +54,8 @@
 🛰️ Realistic background terrain objects with satellite images.<br><br>
 <img src="https://github.com/user-attachments/assets/80e5923c-22c7-4dc0-8906-680902511f3a"><br>
 🗒️ True-to-life blueprints for fast and precise modding.<br><br>
+<img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
+🌾 Field generation with one click.<br><br>
 <img src="https://github.com/user-attachments/assets/cce45575-c917-4a1b-bdc0-6368e32ccdff"><br>
 📏 Almost any possible map sizes.
 </p>
@@ -101,6 +106,9 @@ Parameters:
 - coordinates: 45.15, 19.71
 - size: 16 x 16 km
 
+## Step by step
+Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -177,12 +185,15 @@ The map will be saved in the `map_directory` directory.
 ## Modder Toolbox
 The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
 
-![Modder Toolbox](https://github.com/user-attachments/assets/18f169e9-1a5b-474c-b488-6becfffadcea)
+![Modder Toolbox](https://github.com/user-attachments/assets/dffb252f-f5c0-4021-9d45-31e5bccc0d9b)
 
 ### Tool categories
 Tools are divided into categories, which are listed below.
 #### Textures and DEM
-- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image.
+- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image. It's useful when you have high-resolution DEM data and want to create the height map using it.
+
+#### Background terrain
+- **Convert image to obj model** - allows you to convert the image to the obj model. You can use this tool to create the background terrain for your map. It can be extremely useful if you have access to the sources of high-resolution DEM data and want to create the background terrain using it.
 
 ## Supported objects
 The project is based on the [OpenStreetMap](https://www.openstreetmap.org/) data. So, refer to [this page](https://wiki.openstreetmap.org/wiki/Map_Features) to understand the list below.
@@ -351,7 +362,7 @@ Let's have a closer look at the fields:
 
 ## Background terrain
 The tool now supports the generation of the background terrain. If you don't know what it is, here's a brief explanation. The background terrain is the world around the map. It's important to create it, because if you don't, the map will look like it's floating in the void. The background terrain is a simple plane which can (and should) be texture to look fine.<br>
-So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `objects/tiles` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
+So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `background` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
 If you don't want to work with separate tiles, the tool also generates the `FULL.obj` file, which includes everything around the map and the map itself. It may be a convinient approach to work with one file, one texture and then just cut the map from it.<br>
 
 ![Complete background terrain in Blender](https://github.com/user-attachments/assets/7266b8f1-bfa2-4c14-a740-1c84b1030a66)

{maps4fs-0.9.98 → maps4fs-1.0.0}/maps4fs/generator/component.py

@@ -50,6 +50,7 @@ class Component:
 
         os.makedirs(self.previews_directory, exist_ok=True)
         os.makedirs(self.scripts_directory, exist_ok=True)
+        os.makedirs(self.info_layers_directory, exist_ok=True)
 
         self.save_bbox()
         self.preprocess()
@@ -87,6 +88,15 @@ class Component:
         """
         return os.path.join(self.map_directory, "previews")
 
+    @property
+    def info_layers_directory(self) -> str:
+        """The directory where the info layers are stored.
+
+        Returns:
+            str: The directory where the info layers are stored.
+        """
+        return os.path.join(self.map_directory, "info_layers")
+
     @property
     def scripts_directory(self) -> str:
         """The directory where the scripts are stored.

{maps4fs-0.9.98 → maps4fs-1.0.0}/maps4fs/generator/game.py

@@ -38,7 +38,8 @@ class Game:
     _texture_schema: str | None = None
     _grle_schema: str | None = None
 
-    components = [Config, Texture, GRLE, DEM, I3d, Background]
+    # Order matters! Some components depend on others.
+    components = [Texture, I3d, DEM, Config, GRLE, Background]
 
     def __init__(self, map_template_path: str | None = None):
         if map_template_path:

maps4fs-1.0.0/maps4fs/generator/i3d.py

@@ -0,0 +1,360 @@
+"""This module contains the Config class for map settings and configuration."""
+
+from __future__ import annotations
+
+import json
+import os
+from xml.etree import ElementTree as ET
+
+from shapely.geometry import Polygon, box  # type: ignore
+
+from maps4fs.generator.component import Component
+
+DEFAULT_HEIGHT_SCALE = 2000
+DEFAULT_MAX_LOD_DISTANCE = 10000
+DEFAULT_MAX_LOD_OCCLUDER_DISTANCE = 10000
+NODE_ID_STARTING_VALUE = 500
+
+
+# pylint: disable=R0903
+class I3d(Component):
+    """Component for map i3d file settings and configuration.
+
+    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.
+    """
+
+    _map_i3d_path: 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:
+            self._map_i3d_path = self.game.i3d_file_path(self.map_directory)
+            self.logger.debug("Map I3D path: %s.", self._map_i3d_path)
+        except NotImplementedError:
+            self.logger.info("I3D file processing is not implemented for this game.")
+            self._map_i3d_path = None
+
+    def process(self) -> None:
+        """Updates the map I3D file with the default settings."""
+        self._update_i3d_file()
+        self._add_fields()
+
+    def _get_tree(self) -> ET.ElementTree | None:
+        """Returns the ElementTree instance of the map I3D file."""
+        if not self._map_i3d_path:
+            self.logger.info("I3D is not obtained, skipping the update.")
+            return None
+        if not os.path.isfile(self._map_i3d_path):
+            self.logger.warning("I3D file not found: %s.", self._map_i3d_path)
+            return None
+
+        return ET.parse(self._map_i3d_path)
+
+    def _update_i3d_file(self) -> None:
+        """Updates the map I3D file with the default settings."""
+
+        tree = self._get_tree()
+        if tree is None:
+            return
+
+        self.logger.debug("Map I3D file loaded from: %s.", self._map_i3d_path)
+
+        root = tree.getroot()
+        for map_elem in root.iter("Scene"):
+            for terrain_elem in map_elem.iter("TerrainTransformGroup"):
+                terrain_elem.set("heightScale", str(DEFAULT_HEIGHT_SCALE))
+                self.logger.debug(
+                    "heightScale attribute set to %s in TerrainTransformGroup element.",
+                    DEFAULT_HEIGHT_SCALE,
+                )
+                terrain_elem.set("maxLODDistance", str(DEFAULT_MAX_LOD_DISTANCE))
+                self.logger.debug(
+                    "maxLODDistance attribute set to %s in TerrainTransformGroup element.",
+                    DEFAULT_MAX_LOD_DISTANCE,
+                )
+
+                terrain_elem.set("occMaxLODDistance", str(DEFAULT_MAX_LOD_OCCLUDER_DISTANCE))
+                self.logger.debug(
+                    "occMaxLODDistance attribute set to %s in TerrainTransformGroup element.",
+                    DEFAULT_MAX_LOD_OCCLUDER_DISTANCE,
+                )
+
+                self.logger.debug("TerrainTransformGroup element updated in I3D file.")
+
+        tree.write(self._map_i3d_path)  # type: ignore
+        self.logger.debug("Map I3D file saved to: %s.", self._map_i3d_path)
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images (empty list).
+        The component does not generate any preview images so it returns an empty list.
+
+        Returns:
+            list[str]: An empty list.
+        """
+        return []
+
+    # pylint: disable=R0914, R0915
+    def _add_fields(self) -> None:
+        """Adds fields to the map I3D file."""
+        tree = self._get_tree()
+        if tree is None:
+            return
+
+        textures_info_layer_path = os.path.join(self.info_layers_directory, "textures.json")
+        if not os.path.isfile(textures_info_layer_path):
+            self.logger.warning("Textures info layer not found: %s.", textures_info_layer_path)
+            return
+
+        with open(textures_info_layer_path, "r", encoding="utf-8") as textures_info_layer_file:
+            textures_info_layer = json.load(textures_info_layer_file)
+
+        fields: list[tuple[int, int]] | None = textures_info_layer.get("fields")
+        if not fields:
+            self.logger.warning("Fields data not found in textures info layer.")
+            return
+
+        self.logger.debug("Found %s fields in textures info layer.", len(fields))
+
+        root = tree.getroot()
+        gameplay_node = root.find(".//TransformGroup[@name='gameplay']")
+        if gameplay_node is not None:
+            self.logger.debug("Found the gameplay node.")
+
+            fields_node = gameplay_node.find(".//TransformGroup[@name='fields']")
+            user_attributes_node = root.find(".//UserAttributes")
+
+            if fields_node is not None:
+                node_id = NODE_ID_STARTING_VALUE
+
+                for field_id, field in enumerate(fields, start=1):
+                    # Convert the top-left coordinates to the center coordinates system.
+                    try:
+                        fitted_field = self.fit_polygon_into_bounds(field)  # type: ignore
+                    except ValueError as e:
+                        self.logger.warning(
+                            "Field %s could not be fitted into the map bounds.", field_id
+                        )
+                        self.logger.debug("Error: %s", e)
+                        continue
+                    field_ccs = [
+                        self.top_left_coordinates_to_center(point) for point in fitted_field
+                    ]
+
+                    # Creating the main field node.
+                    field_node = ET.Element("TransformGroup")
+                    field_node.set("name", f"field{field_id}")
+                    cx, cy = self.get_polygon_center(field_ccs)
+                    field_node.set("translation", f"{cx} 0 {cy}")
+                    field_node.set("nodeId", str(node_id))
+
+                    # Adding UserAttributes to the field node.
+                    user_attribute_node = self.create_user_attribute_node(node_id)
+                    user_attributes_node.append(user_attribute_node)  # type: ignore
+
+                    node_id += 1
+
+                    # Creating the polygon points node, which contains the points of the field.
+                    polygon_points_node = ET.Element("TransformGroup")
+                    polygon_points_node.set("name", "polygonPoints")
+                    polygon_points_node.set("nodeId", str(node_id))
+                    node_id += 1
+
+                    for point_id, point in enumerate(field_ccs, start=1):
+                        rx, ry = self.absolute_to_relative(point, (cx, cy))
+
+                        node_id += 1
+                        point_node = ET.Element("TransformGroup")
+                        point_node.set("name", f"point{point_id}")
+                        point_node.set("translation", f"{rx} 0 {ry}")
+                        point_node.set("nodeId", str(node_id))
+
+                        polygon_points_node.append(point_node)
+
+                    field_node.append(polygon_points_node)
+
+                    # Adding the name indicator node to the field node.
+                    name_indicator_node, node_id = self.get_name_indicator_node(node_id, field_id)
+                    field_node.append(name_indicator_node)
+
+                    # Adding the teleport indicator node to the field node.
+                    teleport_indicator_node, node_id = self.get_teleport_indicator_node(node_id)
+                    field_node.append(teleport_indicator_node)
+
+                    # Adding the field node to the fields node.
+                    fields_node.append(field_node)
+                    self.logger.debug("Field %s added to the I3D file.", field_id)
+
+                    node_id += 1
+
+            tree.write(self._map_i3d_path)  # type: ignore
+            self.logger.debug("Map I3D file saved to: %s.", self._map_i3d_path)
+
+    def get_name_indicator_node(self, node_id: int, field_id: int) -> tuple[ET.Element, int]:
+        """Creates a name indicator node with given node ID and field ID.
+
+        Arguments:
+            node_id (int): The node ID of the name indicator node.
+            field_id (int): The ID of the field.
+
+        Returns:
+            tuple[ET.Element, int]: The name indicator node and the updated node ID.
+        """
+        node_id += 1
+        name_indicator_node = ET.Element("TransformGroup")
+        name_indicator_node.set("name", "nameIndicator")
+        name_indicator_node.set("nodeId", str(node_id))
+
+        node_id += 1
+        note_node = ET.Element("Note")
+        note_node.set("name", "Note")
+        note_node.set("nodeId", str(node_id))
+        note_node.set("text", f"field{field_id}
0.00 ha")
+        note_node.set("color", "4278190080")
+        note_node.set("fixedSize", "true")
+
+        name_indicator_node.append(note_node)
+
+        return name_indicator_node, node_id
+
+    def get_teleport_indicator_node(self, node_id: int) -> tuple[ET.Element, int]:
+        """Creates a teleport indicator node with given node ID.
+
+        Arguments:
+            node_id (int): The node ID of the teleport indicator node.
+
+        Returns:
+            tuple[ET.Element, int]: The teleport indicator node and the updated node ID.
+        """
+        node_id += 1
+        teleport_indicator_node = ET.Element("TransformGroup")
+        teleport_indicator_node.set("name", "teleportIndicator")
+        teleport_indicator_node.set("nodeId", str(node_id))
+
+        return teleport_indicator_node, node_id
+
+    def get_polygon_center(self, polygon_points: list[tuple[int, int]]) -> tuple[int, int]:
+        """Calculates the center of a polygon defined by a list of points.
+
+        Arguments:
+            polygon_points (list[tuple[int, int]]): The points of the polygon.
+
+        Returns:
+            tuple[int, int]: The center of the polygon.
+        """
+        polygon = Polygon(polygon_points)
+        center = polygon.centroid
+        return int(center.x), int(center.y)
+
+    def absolute_to_relative(
+        self, point: tuple[int, int], center: tuple[int, int]
+    ) -> tuple[int, int]:
+        """Converts a pair of absolute coordinates to relative coordinates.
+
+        Arguments:
+            point (tuple[int, int]): The absolute coordinates.
+            center (tuple[int, int]): The center coordinates.
+
+        Returns:
+            tuple[int, int]: The relative coordinates.
+        """
+        cx, cy = center
+        x, y = point
+        return x - cx, y - cy
+
+    def top_left_coordinates_to_center(self, top_left: tuple[int, int]) -> tuple[int, int]:
+        """Converts a pair of coordinates from the top-left system to the center system.
+        In top-left system, the origin (0, 0) is in the top-left corner of the map, while in the
+        center system, the origin is in the center of the map.
+
+        Arguments:
+            top_left (tuple[int, int]): The coordinates in the top-left system.
+
+        Returns:
+            tuple[int, int]: The coordinates in the center system.
+        """
+        x, y = top_left
+        cs_x = x - self.map_width // 2
+        cs_y = y - self.map_height // 2
+
+        return cs_x, cs_y
+
+    def fit_polygon_into_bounds(
+        self, polygon_points: list[tuple[int, int]]
+    ) -> list[tuple[int, int]]:
+        """Fits a polygon into the bounds of the map.
+
+        Arguments:
+            polygon_points (list[tuple[int, int]]): The points of the polygon.
+
+        Returns:
+            list[tuple[int, int]]: The points of the polygon fitted into the map bounds.
+        """
+        min_x = min_y = 0
+        max_x, max_y = self.map_width, self.map_height
+
+        # Create a polygon from the given points
+        polygon = Polygon(polygon_points)
+
+        # Create a bounding box for the map bounds
+        bounds = box(min_x, min_y, max_x, max_y)
+
+        # Intersect the polygon with the bounds to fit it within the map
+        fitted_polygon = polygon.intersection(bounds)
+
+        if not isinstance(fitted_polygon, Polygon):
+            raise ValueError("The fitted polygon is not a valid polygon.")
+
+        # Return the fitted polygon points
+        return list(fitted_polygon.exterior.coords)
+
+    @staticmethod
+    def create_user_attribute_node(node_id: int) -> ET.Element:
+        """Creates an XML user attribute node with given node ID.
+
+        Arguments:
+            node_id (int): The node ID of the user attribute node.
+
+        Returns:
+            ET.Element: The created user attribute node.
+        """
+        user_attribute_node = ET.Element("UserAttribute")
+        user_attribute_node.set("nodeId", str(node_id))
+
+        attributes = [
+            ("angle", "integer", "0"),
+            ("missionAllowed", "boolean", "true"),
+            ("missionOnlyGrass", "boolean", "false"),
+            ("nameIndicatorIndex", "string", "1"),
+            ("polygonIndex", "string", "0"),
+            ("teleportIndicatorIndex", "string", "2"),
+        ]
+
+        for name, attr_type, value in attributes:
+            user_attribute_node.append(I3d.create_attribute_node(name, attr_type, value))
+
+        return user_attribute_node
+
+    @staticmethod
+    def create_attribute_node(name: str, attr_type: str, value: str) -> ET.Element:
+        """Creates an XML attribute node with given name, type, and value.
+
+        Arguments:
+            name (str): The name of the attribute.
+            attr_type (str): The type of the attribute.
+            value (str): The value of the attribute.
+
+        Returns:
+            ET.Element: The created attribute node.
+        """
+        attribute_node = ET.Element("Attribute")
+        attribute_node.set("name", name)
+        attribute_node.set("type", attr_type)
+        attribute_node.set("value", value)
+        return attribute_node

{maps4fs-0.9.98 → maps4fs-1.0.0}/maps4fs/generator/texture.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import json
 import os
 import warnings
+from collections import defaultdict
 from typing import Any, Callable, Generator, Optional
 
 import cv2
@@ -41,6 +42,9 @@ class Texture(Component):
             tags (dict[str, str | list[str]]): Dictionary of tags to search for.
             width (int | None): Width of the polygon in meters (only for LineString).
             color (tuple[int, int, int]): Color of the layer in BGR format.
+            exclude_weight (bool): Flag to exclude weight from the texture.
+            priority (int | None): Priority of the layer.
+            info_layer (str | None): Name of the corresnponding info layer.
 
         Attributes:
             name (str): Name of the layer.
@@ -58,6 +62,7 @@ class Texture(Component):
             color: tuple[int, int, int] | list[int] | None = None,
             exclude_weight: bool = False,
             priority: int | None = None,
+            info_layer: str | None = None,
         ):
             self.name = name
             self.count = count
@@ -66,6 +71,7 @@ class Texture(Component):
             self.color = color if color else (255, 255, 255)
             self.exclude_weight = exclude_weight
             self.priority = priority
+            self.info_layer = info_layer
 
         def to_json(self) -> dict[str, str | list[str] | bool]:  # type: ignore
             """Returns dictionary with layer data.
@@ -80,6 +86,7 @@ class Texture(Component):
                 "color": list(self.color),
                 "exclude_weight": self.exclude_weight,
                 "priority": self.priority,
+                "info_layer": self.info_layer,
             }
 
             data = {k: v for k, v in data.items() if v is not None}
@@ -178,6 +185,9 @@ class Texture(Component):
         self.info_save_path = os.path.join(self.map_directory, "generation_info.json")
         self.logger.debug("Generation info save path: %s.", self.info_save_path)
 
+        self.info_layer_path = os.path.join(self.info_layers_directory, "textures.json")
+        self.logger.debug("Info layer path: %s.", self.info_layer_path)
+
     def get_base_layer(self) -> Layer | None:
         """Returns base layer.
 
@@ -297,6 +307,10 @@ class Texture(Component):
 
         cumulative_image = None
 
+        # Dictionary to store info layer data.
+        # Key is a layer.info_layer, value is a list of polygon points as tuples (x, y).
+        info_layer_data = defaultdict(list)
+
         for layer in layers:
             if not layer.tags:
                 self.logger.debug("Layer %s has no tags, there's nothing to draw.", layer.name)
@@ -317,6 +331,8 @@ class Texture(Component):
             mask = cv2.bitwise_not(cumulative_image)
 
             for polygon in self.polygons(layer.tags, layer.width):  # type: ignore
+                if layer.info_layer:
+                    info_layer_data[layer.info_layer].append(self.np_to_polygon_points(polygon))
                 cv2.fillPoly(layer_image, [polygon], color=255)  # type: ignore
 
             output_image = cv2.bitwise_and(layer_image, mask)
@@ -326,6 +342,10 @@ class Texture(Component):
             cv2.imwrite(layer_path, output_image)
             self.logger.debug("Texture %s saved.", layer_path)
 
+        # Save info layer data.
+        with open(self.info_layer_path, "w", encoding="utf-8") as f:
+            json.dump(info_layer_data, f, ensure_ascii=False, indent=4)
+
         if cumulative_image is not None:
             self.draw_base_layer(cumulative_image)
 
@@ -428,6 +448,17 @@ class Texture(Component):
         """
         return int(self.map_height * (1 - (y - self.minimum_y) / (self.maximum_y - self.minimum_y)))
 
+    def np_to_polygon_points(self, np_array: np.ndarray) -> list[tuple[int, int]]:
+        """Converts numpy array of polygon points to list of tuples.
+
+        Arguments:
+            np_array (np.ndarray): Numpy array of polygon points.
+
+        Returns:
+            list[tuple[int, int]]: List of tuples.
+        """
+        return [(int(x), int(y)) for x, y in np_array.reshape(-1, 2)]
+
     # pylint: disable=W0613
     def _to_np(self, geometry: shapely.geometry.polygon.Polygon, *args) -> np.ndarray:
         """Converts Polygon geometry to numpy array of polygon points.

{maps4fs-0.9.98 → maps4fs-1.0.0}/maps4fs/generator/tile.py

@@ -36,10 +36,10 @@ class Tile(DEM):
 
         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)
+        background_directory = os.path.join(self.map_directory, "background")
+        os.makedirs(background_directory, exist_ok=True)
 
-        self._dem_path = os.path.join(tiles_directory, f"{self.code}.png")
+        self._dem_path = os.path.join(background_directory, f"{self.code}.png")
         self.logger.debug("DEM path for tile %s is %s", self.code, self._dem_path)
 
     def get_output_resolution(self) -> tuple[int, int]:

maps4fs-1.0.0/maps4fs/toolbox/background.py

@@ -0,0 +1,63 @@
+"""This module contains functions to work with the background terrain of the map."""
+
+import cv2
+import numpy as np
+import trimesh  # type: ignore
+
+
+# pylint: disable=R0801, R0914
+def plane_from_np(
+    dem_data: np.ndarray,
+    resize_factor: float,
+    simplify_factor: int,
+    save_path: str,
+) -> None:
+    """Generates a 3D obj file based on DEM data.
+
+    Arguments:
+        dem_data (np.ndarray) -- The DEM data as a numpy array.
+        resize_factor (float) -- The factor by which the DEM data will be resized. Bigger values
+            will result in a bigger mesh.
+        simplify_factor (int) -- The factor by which the mesh will be simplified. Bigger values
+            will result in a simpler mesh.
+        save_path (str) -- The path to save the obj file.
+    """
+    dem_data = cv2.resize(  # pylint: disable=no-member
+        dem_data, (0, 0), fx=resize_factor, fy=resize_factor
+    )
+
+    # Invert the height values.
+    dem_data = dem_data.max() - dem_data
+
+    rows, cols = dem_data.shape
+    x = np.linspace(0, cols - 1, cols)
+    y = np.linspace(0, rows - 1, rows)
+    x, y = np.meshgrid(x, y)
+    z = dem_data
+
+    vertices = np.column_stack([x.ravel(), y.ravel(), z.ravel()])
+    faces = []
+
+    for i in range(rows - 1):
+        for j in range(cols - 1):
+            top_left = i * cols + j
+            top_right = top_left + 1
+            bottom_left = top_left + cols
+            bottom_right = bottom_left + 1
+
+            faces.append([top_left, bottom_left, bottom_right])
+            faces.append([top_left, bottom_right, top_right])
+
+    faces = np.array(faces)  # type: ignore
+    mesh = trimesh.Trimesh(vertices=vertices, faces=faces)
+
+    # Apply rotation: 180 degrees around Y-axis and Z-axis
+    rotation_matrix_y = trimesh.transformations.rotation_matrix(np.pi, [0, 1, 0])
+    rotation_matrix_z = trimesh.transformations.rotation_matrix(np.pi, [0, 0, 1])
+    mesh.apply_transform(rotation_matrix_y)
+    mesh.apply_transform(rotation_matrix_z)
+
+    # Simplify the mesh to reduce the number of faces.
+    mesh = mesh.simplify_quadric_decimation(face_count=len(faces) // simplify_factor)
+
+    mesh.export(save_path)

{maps4fs-0.9.98 → maps4fs-1.0.0}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.98
+Version: 1.0.0
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -31,8 +31,10 @@ Requires-Dist: pympler
 <p align="center">
   <a href="#Quick-Start">Quick Start</a> •
   <a href="#Overview">Overview</a> • 
-  <a href="#How-To-Run">How-To-Run</a> •
+  <a href="#Step-by-step">Create a map in 10 steps</a> •
+  <a href="#How-To-Run">How-To-Run</a><br>
   <a href="docs/FAQ.md">FAQ</a> •
+  <a href="docs/map_structure.md">Map Structure</a> •
   <a href="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -68,6 +70,7 @@ Requires-Dist: pympler
 🔷 Generates *.obj files for background terrain based on the real-world height map<br>
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 🧰 Modder Toolbox to help you with various of tasks 🆕<br>
+🌾 Automatically generates fields 🆕<br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -76,6 +79,8 @@ Requires-Dist: pympler
 🛰️ Realistic background terrain objects with satellite images.<br><br>
 <img src="https://github.com/user-attachments/assets/80e5923c-22c7-4dc0-8906-680902511f3a"><br>
 🗒️ True-to-life blueprints for fast and precise modding.<br><br>
+<img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
+🌾 Field generation with one click.<br><br>
 <img src="https://github.com/user-attachments/assets/cce45575-c917-4a1b-bdc0-6368e32ccdff"><br>
 📏 Almost any possible map sizes.
 </p>
@@ -126,6 +131,9 @@ Parameters:
 - coordinates: 45.15, 19.71
 - size: 16 x 16 km
 
+## Step by step
+Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -202,12 +210,15 @@ The map will be saved in the `map_directory` directory.
 ## Modder Toolbox
 The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
 
-![Modder Toolbox](https://github.com/user-attachments/assets/18f169e9-1a5b-474c-b488-6becfffadcea)
+![Modder Toolbox](https://github.com/user-attachments/assets/dffb252f-f5c0-4021-9d45-31e5bccc0d9b)
 
 ### Tool categories
 Tools are divided into categories, which are listed below.
 #### Textures and DEM
-- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image.
+- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image. It's useful when you have high-resolution DEM data and want to create the height map using it.
+
+#### Background terrain
+- **Convert image to obj model** - allows you to convert the image to the obj model. You can use this tool to create the background terrain for your map. It can be extremely useful if you have access to the sources of high-resolution DEM data and want to create the background terrain using it.
 
 ## Supported objects
 The project is based on the [OpenStreetMap](https://www.openstreetmap.org/) data. So, refer to [this page](https://wiki.openstreetmap.org/wiki/Map_Features) to understand the list below.
@@ -376,7 +387,7 @@ Let's have a closer look at the fields:
 
 ## Background terrain
 The tool now supports the generation of the background terrain. If you don't know what it is, here's a brief explanation. The background terrain is the world around the map. It's important to create it, because if you don't, the map will look like it's floating in the void. The background terrain is a simple plane which can (and should) be texture to look fine.<br>
-So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `objects/tiles` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
+So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `background` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
 If you don't want to work with separate tiles, the tool also generates the `FULL.obj` file, which includes everything around the map and the map itself. It may be a convinient approach to work with one file, one texture and then just cut the map from it.<br>
 
 ![Complete background terrain in Blender](https://github.com/user-attachments/assets/7266b8f1-bfa2-4c14-a740-1c84b1030a66)

{maps4fs-0.9.98 → maps4fs-1.0.0}/maps4fs.egg-info/SOURCES.txt

@@ -22,5 +22,6 @@ maps4fs/generator/qgis.py
 maps4fs/generator/texture.py
 maps4fs/generator/tile.py
 maps4fs/toolbox/__init__.py
+maps4fs/toolbox/background.py
 maps4fs/toolbox/dem.py
 tests/test_generator.py

{maps4fs-0.9.98 → maps4fs-1.0.0}/pyproject.toml

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

maps4fs-0.9.98/maps4fs/generator/i3d.py

@@ -1,89 +0,0 @@
-"""This module contains the Config class for map settings and configuration."""
-
-from __future__ import annotations
-
-import os
-from xml.etree import ElementTree as ET
-
-from maps4fs.generator.component import Component
-
-DEFAULT_HEIGHT_SCALE = 2000
-DEFAULT_MAX_LOD_DISTANCE = 10000
-DEFAULT_MAX_LOD_OCCLUDER_DISTANCE = 10000
-
-
-# pylint: disable=R0903
-class I3d(Component):
-    """Component for map i3d file settings and configuration.
-
-    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.
-    """
-
-    _map_i3d_path: 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:
-            self._map_i3d_path = self.game.i3d_file_path(self.map_directory)
-            self.logger.debug("Map I3D path: %s.", self._map_i3d_path)
-        except NotImplementedError:
-            self.logger.info("I3D file processing is not implemented for this game.")
-            self._map_i3d_path = None
-
-    def process(self) -> None:
-        """Updates the map I3D file with the default settings."""
-        self._update_i3d_file()
-
-    def _update_i3d_file(self) -> None:
-        """Updates the map I3D file with the default settings."""
-        if not self._map_i3d_path:
-            self.logger.info("I3D is not obtained, skipping the update.")
-            return
-        if not os.path.isfile(self._map_i3d_path):
-            self.logger.warning("I3D file not found: %s.", self._map_i3d_path)
-            return
-
-        tree = ET.parse(self._map_i3d_path)
-
-        self.logger.debug("Map I3D file loaded from: %s.", self._map_i3d_path)
-
-        root = tree.getroot()
-        for map_elem in root.iter("Scene"):
-            for terrain_elem in map_elem.iter("TerrainTransformGroup"):
-                terrain_elem.set("heightScale", str(DEFAULT_HEIGHT_SCALE))
-                self.logger.debug(
-                    "heightScale attribute set to %s in TerrainTransformGroup element.",
-                    DEFAULT_HEIGHT_SCALE,
-                )
-                terrain_elem.set("maxLODDistance", str(DEFAULT_MAX_LOD_DISTANCE))
-                self.logger.debug(
-                    "maxLODDistance attribute set to %s in TerrainTransformGroup element.",
-                    DEFAULT_MAX_LOD_DISTANCE,
-                )
-
-                terrain_elem.set("occMaxLODDistance", str(DEFAULT_MAX_LOD_OCCLUDER_DISTANCE))
-                self.logger.debug(
-                    "occMaxLODDistance attribute set to %s in TerrainTransformGroup element.",
-                    DEFAULT_MAX_LOD_OCCLUDER_DISTANCE,
-                )
-
-                self.logger.debug("TerrainTransformGroup element updated in I3D file.")
-
-        tree.write(self._map_i3d_path)
-        self.logger.debug("Map I3D file saved to: %s.", self._map_i3d_path)
-
-    def previews(self) -> list[str]:
-        """Returns a list of paths to the preview images (empty list).
-        The component does not generate any preview images so it returns an empty list.
-
-        Returns:
-            list[str]: An empty list.
-        """
-        return []