maps4fs 1.6.3__py3-none-any.whl → 1.6.5__py3-none-any.whl

maps4fs/generator/background.py

@@ -179,7 +179,13 @@ class Background(Component):
         self.logger.debug("Generating obj file in path: %s", save_path)
 
         dem_data = cv2.imread(self.dem.dem_path, cv2.IMREAD_UNCHANGED)  # pylint: disable=no-member
-        self.plane_from_np(dem_data, save_path, create_preview=True)  # type: ignore
+        self.plane_from_np(
+            dem_data,
+            save_path,
+            create_preview=True,
+            remove_center=self.map.background_settings.remove_center,
+            include_zeros=False,
+        )  # type: ignore
 
     # pylint: disable=too-many-locals
     def cutout(self, dem_path: str, save_path: str | None = None) -> str:
@@ -222,17 +228,37 @@ class Background(Component):
         )
 
         cv2.imwrite(main_dem_path, resized_dem_data)  # pylint: disable=no-member
-        self.logger.info("DEM cutout saved: %s", main_dem_path)
+        self.logger.debug("DEM cutout saved: %s", main_dem_path)
 
         return main_dem_path
 
-    # pylint: disable=too-many-locals
+    def remove_center(self, dem_data: np.ndarray, resize_factor: float) -> np.ndarray:
+        """Removes the center part of the DEM data.
+
+        Arguments:
+            dem_data (np.ndarray) -- The DEM data as a numpy array.
+            resize_factor (float) -- The resize factor of the DEM data.
+
+        Returns:
+            np.ndarray -- The DEM data with the center part removed.
+        """
+        center = (dem_data.shape[0] // 2, dem_data.shape[1] // 2)
+        half_size = int(self.map_size // 2 * resize_factor)
+        x1 = center[0] - half_size
+        x2 = center[0] + half_size
+        y1 = center[1] - half_size
+        y2 = center[1] + half_size
+        dem_data[x1:x2, y1:y2] = 0
+        return dem_data
+
+    # pylint: disable=R0913, R0917, R0915
     def plane_from_np(
         self,
         dem_data: np.ndarray,
         save_path: str,
         include_zeros: bool = True,
         create_preview: bool = False,
+        remove_center: bool = False,
     ) -> None:
         """Generates a 3D obj file based on DEM data.
 
@@ -241,11 +267,17 @@ class Background(Component):
             save_path (str) -- The path where the obj file will be saved.
             include_zeros (bool, optional) -- If True, the mesh will include the zero height values.
             create_preview (bool, optional) -- If True, a simplified mesh will be saved as an STL.
+            remove_center (bool, optional) -- If True, the center of the mesh will be removed.
+                This setting is used for a Background Terrain, where the center part where the
+                playable area is will be cut out.
         """
         resize_factor = 1 / self.map.background_settings.resize_factor
         dem_data = cv2.resize(  # pylint: disable=no-member
             dem_data, (0, 0), fx=resize_factor, fy=resize_factor
         )
+        if remove_center:
+            dem_data = self.remove_center(dem_data, resize_factor)
+            self.logger.debug("Center removed from DEM data.")
         self.logger.debug(
             "DEM data resized to shape: %s with factor: %s", dem_data.shape, resize_factor
         )
@@ -306,12 +338,28 @@ class Background(Component):
         self.logger.debug("Z scaling factor: %s", z_scaling_factor)
         mesh.apply_scale([1 / resize_factor, 1 / resize_factor, z_scaling_factor])
 
+        old_faces = len(mesh.faces)
+        self.logger.debug("Mesh generated with %s faces.", old_faces)
+
+        if self.map.background_settings.apply_decimation:
+            percent = self.map.background_settings.decimation_percent / 100
+            mesh = mesh.simplify_quadric_decimation(
+                percent=percent, aggression=self.map.background_settings.decimation_agression
+            )
+
+            new_faces = len(mesh.faces)
+            decimation_percent = (old_faces - new_faces) / old_faces * 100
+
+            self.logger.debug(
+                "Mesh simplified to %s faces. Decimation percent: %s", new_faces, decimation_percent
+            )
+
         mesh.export(save_path)
         self.logger.debug("Obj file saved: %s", save_path)
 
         if create_preview:
             # Simplify the preview mesh to reduce the size of the file.
-            mesh = mesh.simplify_quadric_decimation(face_count=len(mesh.faces) // 2**7)
+            # mesh = mesh.simplify_quadric_decimation(face_count=len(mesh.faces) // 2**7)
 
             # Apply scale to make the preview mesh smaller in the UI.
             mesh.apply_scale([0.5, 0.5, 0.5])

maps4fs/generator/grle.py

@@ -114,12 +114,12 @@ class GRLE(Component):
             self.logger.warning("Fields data not found in textures info layer.")
             return
 
-        self.logger.info("Found %s fields in textures info layer.", len(fields))
+        self.logger.debug("Found %s fields in textures info layer.", len(fields))
 
         farmyards: list[list[tuple[int, int]]] | None = textures_info_layer.get("farmyards")
         if farmyards and self.map.grle_settings.add_farmyards:
             fields.extend(farmyards)
-            self.logger.info("Found %s farmyards in textures info layer.", len(farmyards))
+            self.logger.debug("Found %s farmyards in textures info layer.", len(farmyards))
 
         info_layer_farmlands_path = os.path.join(
             self.game.weights_dir_path(self.map_directory), "infoLayer_farmlands.png"

maps4fs/generator/i3d.py

@@ -155,7 +155,7 @@ class I3d(Component):
             self.logger.warning("Roads polylines data not found in textures info layer.")
             return
 
-        self.logger.info("Found %s roads polylines in textures info layer.", len(roads_polylines))
+        self.logger.debug("Found %s roads polylines in textures info layer.", len(roads_polylines))
         self.logger.debug("Starging to add roads polylines to the I3D file.")
 
         root = tree.getroot()
@@ -300,7 +300,7 @@ class I3d(Component):
             self.logger.warning("Fields data not found in textures info layer.")
             return
 
-        self.logger.info("Found %s fields in textures info layer.", len(fields))
+        self.logger.debug("Found %s fields in textures info layer.", len(fields))
         self.logger.debug("Starging to add fields to the I3D file.")
 
         root = tree.getroot()

maps4fs/generator/settings.py

@@ -98,6 +98,10 @@ class BackgroundSettings(SettingsModel):
     generate_background: bool = False
     generate_water: bool = False
     resize_factor: int = 8
+    remove_center: bool = False
+    apply_decimation: bool = False
+    decimation_percent: int = 25
+    decimation_agression: int = 3
 
 
 class GRLESettings(SettingsModel):

maps4fs/generator/texture.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import json
 import os
 import re
+import shutil
 from collections import defaultdict
 from typing import Any, Callable, Generator, Optional
 
@@ -69,6 +70,7 @@ class Texture(Component):
             usage: str | None = None,
             background: bool = False,
             invisible: bool = False,
+            procedural: list[str] | None = None,
         ):
             self.name = name
             self.count = count
@@ -81,6 +83,7 @@ class Texture(Component):
             self.usage = usage
             self.background = background
             self.invisible = invisible
+            self.procedural = procedural
 
         def to_json(self) -> dict[str, str | list[str] | bool]:  # type: ignore
             """Returns dictionary with layer data.
@@ -99,6 +102,7 @@ class Texture(Component):
                 "usage": self.usage,
                 "background": self.background,
                 "invisible": self.invisible,
+                "procedural": self.procedural,
             }
 
             data = {k: v for k, v in data.items() if v is not None}
@@ -212,6 +216,10 @@ class Texture(Component):
 
         self._weights_dir = self.game.weights_dir_path(self.map_directory)
         self.logger.debug("Weights directory: %s.", self._weights_dir)
+        self.procedural_dir = os.path.join(self._weights_dir, "masks")
+        os.makedirs(self.procedural_dir, exist_ok=True)
+        self.logger.debug("Procedural directory: %s.", self.procedural_dir)
+
         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)
 
@@ -251,11 +259,56 @@ class Texture(Component):
                 return layer
         return None
 
-    def process(self):
+    def process(self) -> None:
+        """Processes the data to generate textures."""
         self._prepare_weights()
         self._read_parameters()
         self.draw()
         self.rotate_textures()
+        self.copy_procedural()
+
+    def copy_procedural(self) -> None:
+        """Copies some of the textures to use them as mask for procedural generation.
+        Creates an empty blockmask if it does not exist."""
+        blockmask_path = os.path.join(self.procedural_dir, "BLOCKMASK.png")
+        if not os.path.isfile(blockmask_path):
+            self.logger.debug("BLOCKMASK.png not found, creating an empty file.")
+            img = np.zeros((self.map_size, self.map_size), dtype=np.uint8)
+            cv2.imwrite(blockmask_path, img)  # pylint: disable=no-member
+
+        pg_layers_by_type = defaultdict(list)
+        for layer in self.layers:
+            if layer.procedural:
+                # Get path to the original file.
+                texture_path = layer.get_preview_or_path(self._weights_dir)
+                for procedural_layer_name in layer.procedural:
+                    pg_layers_by_type[procedural_layer_name].append(texture_path)
+
+        if not pg_layers_by_type:
+            self.logger.debug("No procedural layers found.")
+            return
+
+        for procedural_layer_name, texture_paths in pg_layers_by_type.items():
+            procedural_save_path = os.path.join(self.procedural_dir, f"{procedural_layer_name}.png")
+            if len(texture_paths) > 1:
+                # If there are more than one texture, merge them.
+                merged_texture = np.zeros((self.map_size, self.map_size), dtype=np.uint8)
+                for texture_path in texture_paths:
+                    # pylint: disable=E1101
+                    texture = cv2.imread(texture_path, cv2.IMREAD_UNCHANGED)
+                    merged_texture[texture == 255] = 255
+                cv2.imwrite(procedural_save_path, merged_texture)  # pylint: disable=no-member
+                self.logger.debug(
+                    "Procedural file %s merged from %s textures.",
+                    procedural_save_path,
+                    len(texture_paths),
+                )
+            elif len(texture_paths) == 1:
+                # Otherwise, copy the texture.
+                shutil.copyfile(texture_paths[0], procedural_save_path)
+                self.logger.debug(
+                    "Procedural file %s copied from %s.", procedural_save_path, texture_paths[0]
+                )
 
     def rotate_textures(self) -> None:
         """Rotates textures of the layers which have tags."""
@@ -507,7 +560,7 @@ class Texture(Component):
                 cv2.imwrite(sublayer_path, sublayer)
                 self.logger.debug("Sublayer %s saved.", sublayer_path)
 
-            self.logger.info("Dissolved layer %s.", layer.name)
+            self.logger.debug("Dissolved layer %s.", layer.name)
 
     def draw_base_layer(self, cumulative_image: np.ndarray) -> None:
         """Draws base layer and saves it into the png file.

{maps4fs-1.6.3.dist-info → maps4fs-1.6.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.6.3
+Version: 1.6.5
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -131,6 +131,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
 ```
 And open [http://localhost:8501](http://localhost:8501) in your browser.<br>
 If you don't know how to use Docker, navigate to the [Docker version](#option-2-docker-version), it's really simple.<br>
+Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 
 ### 🤯 For developers
 **Option 3:** Python package. Install the package using the following command:
@@ -185,6 +186,7 @@ Using it is easy and doesn't require any guides. Enjoy!
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
 ⚙️ Advanced settings: enabled.   
 🖼️ Texture dissolving: enabled.  
+Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:
 
 1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
@@ -421,6 +423,7 @@ Let's have a closer look at the fields:
 - `background` - set it to True for the textures, which should have impact on the Background Terrain, by default it's used to subtract the water depth from the DEM and background terrain.
 - `info_layer` - if the layer is saving some data in JSON format, this section will describe it's name in the JSON file. Used to find the needed JSON data, for example for fields it will be `fields` and as a value - list of polygon coordinates.
 - `invisible` - set it to True for the textures, which should not be drawn in the files, but only to save the data in the JSON file (related to the previous field).
+- `procedural` - is a list of corresponding files, that will be used for a procedural generation. For example: `"procedural": ["PG_meadow", "PG_acres"]` - means that the texture will be used for two procedural generation files: `masks/PG_meadow.png` and `masks/PG_acres.png`. Note, that the one procuderal name can be applied to multiple textures, in this case they will be merged into one mask.
 
 ## 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 that can (and should) be textured to look fine.<br>
@@ -467,17 +470,12 @@ List of the important DDS files:
 - `mapsUS/overview.dds` - 4096x4096 pixels, the overview image of the map (in-game map)
 
 ## Advanced settings
-The tool supports the custom size of the map. To use this feature select `Custom` in the `Map size` dropdown and enter the desired size. The tool will generate a map with the size you entered.<br>
 
-⛔️ Do not use this feature, if you don't know what you're doing. In most cases, the Giants Editor will just crash on opening the file, because you need to enter specific values for the map size.<br><br>
-
-![Advanced settings](https://github.com/user-attachments/assets/9e8e178a-58d9-4aa6-aefd-4ed53408701d)
-
-You can also apply some advanced settings to the map generation process. Note that they're ADVANCED, so you don't need to use them if you're not sure what they do.<br>
+You can also apply some advanced settings to the map generation process.<br>
 
 ### DEM Advanced settings
 
-- Multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum available value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the DEM file and the heightScale parameter in [docs](docs/dem.md). By default, it's set to 1.
+- Multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum available value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the DEM file and the heightScale parameter in [docs](docs/dem.md). To match the in-game heights with SRTM Data provider, the recommended value is 255 (if easy mode is disabled), but depending on the place, you will need to play with both multiplier and the height scale in Giants Editor to find the best values.
 
 - Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result in a Minecraft-like map.
 
@@ -493,6 +491,15 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Resize factor - the factor by which the background terrain will be resized. It will be used as 1 / resize_factor while generating the models. Which means that the larger the value the more the terrain will be resized. The lowest value is 1, in this case background terrain will not be resized. Note, than low values will lead to long processing and enormous size of the obj files.
 
+- Remove center - if enabled, the playable region (map terrain) will  be removed from the background terrain. Note, that it will require low resize factors, to avoid gaps between the map and the background terrain.
+
+- Apply decimation - if enabled, the mesh will be simplified to reduce the number of faces.
+
+- Decimation percent - the target percentage of decimation. The higher the value, the more simplified the mesh will be. Note, that high values will break the 3D model entirely.
+
+- Decimation agression - the aggression of the decimation. The higher the value, the more aggressive the
+decimation will be, which means the higher it will affect the geometry. It's not recommended to make it higher than the default value, otherwise the background terrain will not match the map terrain.
+
 ### GRLE Advanced settings
 
 - Farmlands margin - this value (in meters) will be applied to each farmland, making it bigger. You can use the value to adjust how much the farmland should be bigger than the actual field. By default, it's set to 3.

{maps4fs-1.6.3.dist-info → maps4fs-1.6.5.dist-info}/RECORD

@@ -1,18 +1,18 @@
 maps4fs/__init__.py,sha256=WbT36EzJ_74GN0RUUrLIYECdSdtRiZaxKl17KUt7pjA,492
 maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=dpvhhkDUJtOt_pobIOuDp6DV8Z1HJfLyP8pzkIkk-G8,22615
+maps4fs/generator/background.py,sha256=JZNSiPZzA6_Kihu83qdCbsJc9bGeeSBY0SP6jTtdvU4,24595
 maps4fs/generator/component.py,sha256=GrTI7803gOQFhqocdjFG-wh0HOkC6HWoyKr8pR2Xp28,20409
 maps4fs/generator/config.py,sha256=0QmK052B8bxyHVhg3jzCORLfOBMMmqVfhhbqXKf6OMk,4383
 maps4fs/generator/dem.py,sha256=20gx0dzX0LyO6ipvDitst-BwGfcKogFqgQf9Q2qMH5U,10933
 maps4fs/generator/game.py,sha256=QHgVnyGYvEnfwGZ84-u-dpbCRr3UeVVqBbrwr5WG8dE,7992
-maps4fs/generator/grle.py,sha256=u8ZwSs313PIOkH_0B_O2tVTaZ-eYNkc30eKGtBxWzTM,17846
-maps4fs/generator/i3d.py,sha256=rjOm_vlh9dofmNpYJd9P2U9S7VxZ6r3e-JDJxnMQFD8,24943
+maps4fs/generator/grle.py,sha256=rU84Q1PBHr-V-JzdHJ7BXLHC_LztGw6Z1FS2w_1HIF0,17848
+maps4fs/generator/i3d.py,sha256=D1QBHCFygTkml6GZmLRlUagWEVQb0tNeyZ-MAY-Uf0Q,24945
 maps4fs/generator/map.py,sha256=8CYUs7NNVoQBvABqtoKtnbj280JuvseNORDCsebkQ_c,9357
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
 maps4fs/generator/satellite.py,sha256=_7RcuNmR1mjxEJWMDsjnzKUIqWxnGUn50XtjB7HmSPg,3661
-maps4fs/generator/settings.py,sha256=1ORjaa55sDIiwVZ0G7TIHEBSDLt7c8xAWgp4QcsInUM,4817
-maps4fs/generator/texture.py,sha256=dtMpNkmJalaV5IOuv6vhVQHmjbfaWZGYZSSfhs2_m8U,31134
+maps4fs/generator/settings.py,sha256=zPdewt348ulparOAlWo-TmfyF77bm1567fcliL6YP6s,4951
+maps4fs/generator/texture.py,sha256=jWorYVOzBI-plzy_mh42O2NZuB13M5yDaCOfrpX6Dck,33836
 maps4fs/generator/dtm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maps4fs/generator/dtm/dtm.py,sha256=azy-RWsc5PgenKDtgG0lrddMwWEw1hYzdng9V8zphMk,9167
 maps4fs/generator/dtm/srtm.py,sha256=2-pX6bWrJX6gr8IM7ueX6mm_PW7_UQ58MtdzDHae2OQ,9030
@@ -20,8 +20,8 @@ maps4fs/generator/dtm/usgs.py,sha256=ZTi10RNDA3EBrsVg2ZoYrdN4uqiG1Jvk7FzdcKdgNkU
 maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/toolbox/background.py,sha256=9BXWNqs_n3HgqDiPztWylgYk_QM4YgBpe6_ZNQAWtSc,2154
 maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.6.3.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.6.3.dist-info/METADATA,sha256=TQauyiX5_h1vu-5ToYBGJOwHMNNiWied40jjkmTYCGI,36231
-maps4fs-1.6.3.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
-maps4fs-1.6.3.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.6.3.dist-info/RECORD,,
+maps4fs-1.6.5.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.6.5.dist-info/METADATA,sha256=OUF4EOb79OP5f4LT18s7UL4MdYtupLqFv8Y9Cle9hWo,37195
+maps4fs-1.6.5.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+maps4fs-1.6.5.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.6.5.dist-info/RECORD,,