maps4fs 2.1.1__tar.gz → 2.1.2__tar.gz

{maps4fs-2.1.1 → maps4fs-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.1
+Version: 2.1.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -546,6 +546,9 @@ Let's have a closer look at the fields:
 - `border` - this value defines the border between the texture and the edge of the map. It's used to prevent the texture from being drawn on the edge of the map. The value is in pixels.
 - `precise_tags` - can be used for more specific tags, for example instead of `"natural": "wood"` you can use `"leaf_type": "broadleaved"` to draw only broadleaved trees.
 - `precise_usage` - the same as `usage`, but being used with `precise_tags`.
+- `area_type` - one of the supported by Giants Editor area types, such as: "open_land", "city", "village", "harbor", "industrial", "open_water". It will be reflected in the environment info layer file.  
+- `area_water` - whenever this field is set to true, the area will be considered as water, and it will be changed in the environment info layer file.
+- `indoor` - whenever this field is set to true, the area will be considered as indoor, and it will be reflected in the indoorMask info layer.
 
 ## Background terrain
 

{maps4fs-2.1.1 → maps4fs-2.1.2}/README.md

@@ -515,6 +515,9 @@ Let's have a closer look at the fields:
 - `border` - this value defines the border between the texture and the edge of the map. It's used to prevent the texture from being drawn on the edge of the map. The value is in pixels.
 - `precise_tags` - can be used for more specific tags, for example instead of `"natural": "wood"` you can use `"leaf_type": "broadleaved"` to draw only broadleaved trees.
 - `precise_usage` - the same as `usage`, but being used with `precise_tags`.
+- `area_type` - one of the supported by Giants Editor area types, such as: "open_land", "city", "village", "harbor", "industrial", "open_water". It will be reflected in the environment info layer file.  
+- `area_water` - whenever this field is set to true, the area will be considered as water, and it will be changed in the environment info layer file.
+- `indoor` - whenever this field is set to true, the area will be considered as indoor, and it will be reflected in the indoorMask info layer.
 
 ## Background terrain
 

{maps4fs-2.1.1 → maps4fs-2.1.2}/maps4fs/generator/component/grle.py

@@ -11,8 +11,13 @@ from tqdm import tqdm
 
 from maps4fs.generator.component.base.component_image import ImageComponent
 from maps4fs.generator.component.base.component_xml import XMLComponent
+from maps4fs.generator.component.layer import Layer
 from maps4fs.generator.settings import Parameters
 
+# This value sums up the pixel value of the basic area type to convert it from "No Water" to "Near Water".
+# For example, if the basic area type is "city" (1), then the pixel value for "near water" will be 9.
+WATER_AREA_PIXEL_VALUE = 8
+
 
 def plant_to_pixel_value(plant_name: str) -> int | None:
     """Returns the pixel value representation of the plant.
@@ -31,6 +36,27 @@ def plant_to_pixel_value(plant_name: str) -> int | None:
     return plants.get(plant_name)
 
 
+def area_type_to_pixel_value(area_type: str) -> int | None:
+    """Returns the pixel value representation of the area type.
+    If not found, returns None.
+
+    Arguments:
+        area_type (str): name of the area type
+
+    Returns:
+        int | None: pixel value of the area type or None if not found.
+    """
+    area_types = {
+        "open_land": 0,
+        "city": 1,
+        "village": 2,
+        "harbor": 3,
+        "industrial": 4,
+        "open_water": 5,
+    }
+    return area_types.get(area_type)
+
+
 class GRLE(ImageComponent, XMLComponent):
     """Component for to generate InfoLayer PNG files based on GRLE schema.
 
@@ -104,6 +130,9 @@ class GRLE(ImageComponent, XMLComponent):
         self._add_farmlands()
         if self.game.plants_processing and self.map.grle_settings.add_grass:
             self._add_plants()
+        if self.game.environment_processing:
+            self._process_environment()
+            self._process_indoor()
 
     def previews(self) -> list[str]:
         """Returns a list of paths to the preview images (empty list).
@@ -130,6 +159,9 @@ class GRLE(ImageComponent, XMLComponent):
             cv2.imwrite(save_path, image_colored)
             preview_paths.append(save_path)
 
+            if preview_name != "farmlands":
+                continue
+
             with_fields_save_path = os.path.join(
                 self.previews_directory, f"{preview_name}_with_fields.png"
             )
@@ -462,3 +494,149 @@ class GRLE(ImageComponent, XMLComponent):
         image_np[:, 0] = 0  # Left side
         image_np[:, -1] = 0  # Right side
         return image_np
+
+    def _process_environment(self) -> None:
+        info_layer_environment_path = self.game.get_environment_path(self.map_directory)
+        if not info_layer_environment_path or not os.path.isfile(info_layer_environment_path):
+            self.logger.warning(
+                "Environment InfoLayer PNG file not found in %s.", info_layer_environment_path
+            )
+            return
+
+        self.logger.debug(
+            "Processing environment InfoLayer PNG file: %s.", info_layer_environment_path
+        )
+
+        environment_image = cv2.imread(info_layer_environment_path, cv2.IMREAD_UNCHANGED)
+        if environment_image is None:
+            self.logger.error("Failed to read the environment InfoLayer PNG file.")
+            return
+
+        self.logger.debug(
+            "Environment InfoLayer PNG file loaded, shape: %s.", environment_image.shape
+        )
+
+        environment_size = int(environment_image.shape[0])
+
+        # 1. Get the texture layers that contain "area_type" property.
+        # 2. Read the corresponding weight image (not the dissolved ones!).
+        # 3. Resize it to match the environment image size (probably 1/4 of the texture size).
+        # 4. Dilate the texture mask to make it little bit bigger.
+        # 5. Set the corresponding pixel values of the environment image to the pixel value of the area type.
+        # 6. Get the texture layer that "area_water" is True.
+        # 7. Same as resize, dilate, etc.
+        # 8. Sum the current pixel value with the WATER_AREA_PIXEL_VALUE.
+
+        texture_component = self.map.get_texture_component()
+        if not texture_component:
+            self.logger.warning("Texture component not found in the map.")
+            return
+
+        for layer in texture_component.get_area_type_layers():
+            pixel_value = area_type_to_pixel_value(layer.area_type)  # type: ignore
+            weight_image = self.get_resized_weight(layer, environment_size)  # type: ignore
+            if weight_image is None:
+                self.logger.warning("Weight image for area type layer not found in %s.", layer.name)
+                continue
+            environment_image[weight_image > 0] = pixel_value  # type: ignore
+
+        for layer in texture_component.get_water_area_layers():
+            pixel_value = WATER_AREA_PIXEL_VALUE
+            weight_image = self.get_resized_weight(layer, environment_size)
+            if weight_image is None:
+                self.logger.warning(
+                    "Weight image for water area layer not found in %s.", layer.name
+                )
+                continue
+            environment_image[weight_image > 0] += pixel_value  # type: ignore
+
+        cv2.imwrite(info_layer_environment_path, environment_image)
+        self.logger.debug("Environment InfoLayer PNG file saved: %s.", info_layer_environment_path)
+        self.preview_paths["environment"] = info_layer_environment_path
+
+    def get_resized_weight(
+        self, layer: Layer, resize_to: int, dilations: int = 3
+    ) -> np.ndarray | None:
+        """Get the resized weight image for a given layer.
+
+        Arguments:
+            layer (Layer): The layer for which to get the weight image.
+            resize_to (int): The size to which the weight image should be resized.
+            dilations (int): The number of dilations to apply to the weight image.
+
+        Returns:
+            np.ndarray | None: The resized and dilated weight image, or None if the image could not be loaded.
+        """
+        weight_image_path = layer.get_preview_or_path(
+            self.game.weights_dir_path(self.map_directory)
+        )
+        self.logger.debug("Weight image path for area type layer: %s.", weight_image_path)
+
+        if not weight_image_path or not os.path.isfile(weight_image_path):
+            self.logger.warning(
+                "Weight image for area type layer not found in %s.", weight_image_path
+            )
+            return None
+
+        weight_image = cv2.imread(weight_image_path, cv2.IMREAD_UNCHANGED)
+        if weight_image is None:
+            self.logger.error("Failed to read the weight image for area type layer.")
+            return None
+
+        self.logger.debug("Weight image for area type layer loaded, shape: %s.", weight_image.shape)
+
+        # Resize the weight image to match the environment image size.
+        weight_image = cv2.resize(
+            weight_image,
+            (resize_to, resize_to),
+            interpolation=cv2.INTER_NEAREST,
+        )
+
+        self.logger.debug(
+            "Resized weight image for area type layer, new shape: %s.", weight_image.shape
+        )
+
+        if dilations <= 0:
+            return weight_image
+
+        dilated_weight_image = cv2.dilate(
+            weight_image.astype(np.uint8), np.ones((dilations, dilations), np.uint8), iterations=dilations  # type: ignore
+        )
+
+        return dilated_weight_image
+
+    def _process_indoor(self) -> None:
+        """Processes the indoor layers."""
+        info_layer_indoor_path = self.game.get_indoor_mask_path(self.map_directory)
+        if not info_layer_indoor_path or not os.path.isfile(info_layer_indoor_path):
+            self.logger.warning(
+                "Indoor InfoLayer PNG file not found in %s.", info_layer_indoor_path
+            )
+            return
+
+        indoor_mask_image = cv2.imread(info_layer_indoor_path, cv2.IMREAD_UNCHANGED)
+        if indoor_mask_image is None:
+            self.logger.warning(
+                "Failed to read the indoor InfoLayer PNG file %s.", info_layer_indoor_path
+            )
+            return
+
+        indoor_mask_size = int(indoor_mask_image.shape[0])
+        self.logger.debug("Indoor InfoLayer PNG file loaded, shape: %s.", indoor_mask_image.shape)
+
+        texture_component = self.map.get_texture_component()
+        if not texture_component:
+            self.logger.warning("Texture component not found in the map.")
+            return
+
+        for layer in texture_component.get_indoor_layers():
+            weight_image = self.get_resized_weight(layer, indoor_mask_size, dilations=0)
+            if weight_image is None:
+                self.logger.warning("Weight image for indoor layer not found in %s.", layer.name)
+                continue
+
+            indoor_mask_image[weight_image > 0] = 1
+
+        cv2.imwrite(info_layer_indoor_path, indoor_mask_image)
+        self.logger.debug("Indoor InfoLayer PNG file saved: %s.", info_layer_indoor_path)
+        self.preview_paths["indoor"] = info_layer_indoor_path

{maps4fs-2.1.1 → maps4fs-2.1.2}/maps4fs/generator/component/layer.py

@@ -46,6 +46,9 @@ class Layer:
         border: int | None = None,
         precise_tags: dict[str, str | list[str] | bool] | None = None,
         precise_usage: str | None = None,
+        area_type: str | None = None,
+        area_water: bool = False,
+        indoor: bool = False,
     ):
         self.name = name
         self.count = count
@@ -62,6 +65,9 @@ class Layer:
         self.border = border
         self.precise_tags = precise_tags
         self.precise_usage = precise_usage
+        self.area_type = area_type
+        self.area_water = area_water
+        self.indoor = indoor
 
     def to_json(self) -> dict[str, str | list[str] | bool]:  # type: ignore
         """Returns dictionary with layer data.
@@ -84,6 +90,9 @@ class Layer:
             "border": self.border,
             "precise_tags": self.precise_tags,
             "precise_usage": self.precise_usage,
+            "area_type": self.area_type,
+            "area_water": self.area_water,
+            "indoor": self.indoor,
         }
 
         data = {k: v for k, v in data.items() if v is not None}

{maps4fs-2.1.1 → maps4fs-2.1.2}/maps4fs/generator/component/texture.py

@@ -137,6 +137,36 @@ class Texture(ImageComponent):
         """
         return [layer for layer in self.layers if layer.usage == usage]
 
+    def get_area_type_layers(self, area_type: str | None = None) -> list[Layer]:
+        """Returns layers by area type. If area_type is None, returns all layers
+        with area_type set (not None).
+
+        Arguments:
+            area_type (str | None): Area type of the layer.
+
+        Returns:
+            list[Layer]: List of layers.
+        """
+        if area_type is None:
+            return [layer for layer in self.layers if layer.area_type is not None]
+        return [layer for layer in self.layers if layer.area_type == area_type]
+
+    def get_water_area_layers(self) -> list[Layer]:
+        """Returns layers which are water areas.
+
+        Returns:
+            list[Layer]: List of layers which are water areas.
+        """
+        return [layer for layer in self.layers if layer.area_water]
+
+    def get_indoor_layers(self) -> list[Layer]:
+        """Returns layers which are indoor areas.
+
+        Returns:
+            list[Layer]: List of layers which are indoor areas.
+        """
+        return [layer for layer in self.layers if layer.indoor]
+
     def process(self) -> None:
         """Processes the data to generate textures."""
         self._prepare_weights()

{maps4fs-2.1.1 → maps4fs-2.1.2}/maps4fs/generator/game.py

@@ -40,6 +40,7 @@ class Game:
     _tree_schema: str | None = None
     _i3d_processing: bool = True
     _plants_processing: bool = True
+    _environment_processing: bool = True
     _fog_processing: bool = True
     _dissolve: bool = True
 
@@ -180,6 +181,28 @@ class Game:
         weights_dir = self.weights_dir_path(map_directory)
         return os.path.join(weights_dir, "infoLayer_farmlands.png")
 
+    def get_environment_path(self, map_directory: str) -> str:
+        """Returns the path to the environment file.
+
+        Arguments:
+            map_directory (str): The path to the map directory.
+
+        Returns:
+            str: The path to the environment file."""
+        weights_dir = self.weights_dir_path(map_directory)
+        return os.path.join(weights_dir, "infoLayer_environment.png")
+
+    def get_indoor_mask_path(self, map_directory: str) -> str:
+        """Returns the path to the indoor mask file.
+
+        Arguments:
+            map_directory (str): The path to the map directory.
+
+        Returns:
+            str: The path to the indoor mask file."""
+        weights_dir = self.weights_dir_path(map_directory)
+        return os.path.join(weights_dir, "infoLayer_indoorMask.png")
+
     def get_farmlands_xml_path(self, map_directory: str) -> str:
         """Returns the path to the farmlands xml file.
 
@@ -218,6 +241,14 @@ class Game:
             bool: True if the i3d file should be processed, False otherwise."""
         return self._i3d_processing
 
+    @property
+    def environment_processing(self) -> bool:
+        """Returns whether the environment should be processed.
+
+        Returns:
+            bool: True if the environment should be processed, False otherwise."""
+        return self._environment_processing
+
     @property
     def fog_processing(self) -> bool:
         """Returns whether the fog should be processed.
@@ -269,6 +300,7 @@ class FS22(Game):
     _map_template_path = os.path.join(working_directory, "data", "fs22-map-template.zip")
     _texture_schema = os.path.join(working_directory, "data", "fs22-texture-schema.json")
     _i3d_processing = False
+    _environment_processing = False
     _fog_processing = False
     _plants_processing = False
     _dissolve = False

{maps4fs-2.1.1 → maps4fs-2.1.2}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.1
+Version: 2.1.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -546,6 +546,9 @@ Let's have a closer look at the fields:
 - `border` - this value defines the border between the texture and the edge of the map. It's used to prevent the texture from being drawn on the edge of the map. The value is in pixels.
 - `precise_tags` - can be used for more specific tags, for example instead of `"natural": "wood"` you can use `"leaf_type": "broadleaved"` to draw only broadleaved trees.
 - `precise_usage` - the same as `usage`, but being used with `precise_tags`.
+- `area_type` - one of the supported by Giants Editor area types, such as: "open_land", "city", "village", "harbor", "industrial", "open_water". It will be reflected in the environment info layer file.  
+- `area_water` - whenever this field is set to true, the area will be considered as water, and it will be changed in the environment info layer file.
+- `indoor` - whenever this field is set to true, the area will be considered as indoor, and it will be reflected in the indoorMask info layer.
 
 ## Background terrain
 

{maps4fs-2.1.1 → maps4fs-2.1.2}/pyproject.toml

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