maps4fs 1.5.7__tar.gz → 1.6.91__tar.gz

{maps4fs-1.5.7 → maps4fs-1.6.91}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.5.7
+Version: 1.6.91
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -48,6 +48,7 @@ Requires-Dist: pydantic
   <a href="#Expert-settings">Expert settings</a> •
   <a href="#Resources">Resources</a> •
   <a href="#Bugs-and-feature-requests">Bugs and feature requests</a><br>
+  <a href="#DTM-Providers">DTM Providers</a> •
   <a href="#Special-thanks">Special thanks</a>
 </p>
 
@@ -69,6 +70,7 @@ Requires-Dist: pydantic
 
 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
 🔄 Support map rotation 🆕<br>
+🌐 Supports custom [DTM Providers](#DTM-Providers) 🆕<br>
 🌾 Automatically generates fields 🆕<br>
 🌽 Automatically generates farmlands 🆕<br>
 🌿 Automatically generates decorative foliage 🆕<br>
@@ -129,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:
@@ -183,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.
@@ -251,6 +255,10 @@ The tool now has a Modder Toolbox, which is a set of tools to help you with vari
 
 ### Tool Categories
 Tools are divided into categories, which are listed below.
+
+#### For custom schemas
+- **Tree Schema Editor** - allows you to view all the supported trees models and select the ones you need on your map. After it, you should click the Show updated schema button and copy the JSON schema to the clipboard. Then you can use it in the Expert settings to generate the map with the selected trees.
+
 #### For Textures and DEM
 - **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 a height map using it.
 
@@ -419,6 +427,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>
@@ -465,17 +474,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.
 
@@ -491,6 +495,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.
@@ -499,6 +512,18 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Add Farmyards - if enabled, the tool will create farmlands from the regions that are marked as farmyards in the OSM data. Those farmlands will not have fields and also will not be drawn on textures. By default, it's turned off.
 
+- Base grass - you can select which plant will be used as a base grass on the map. 
+
+- Plants island minimum size - when random plants are enabled, the generator will add islands of differents plants to the map and choose the random size of those island between the minimum and maximum values. This one is the minimum size of the island in meters.
+
+- Plants island maximum size - it's the same as above, but for the maximum size of the island in meters.
+
+- Plants island vertex count - the number of vertices in the island. The higher the value, the more detailed the island will be. Note, that high values will turn the smoothed island into geometric madness.
+
+- Plants insland rounding radius - used to round the vertices of the island. The higher the value, the more rounded the island will be.
+
+- Plants island percent - defines the relation between the map size and the number of islands of plants. For example, if set to 100% for map size of 2048 will be added 2048 islands of plants. 
+
 ### I3D Advanced settings
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
@@ -532,6 +557,8 @@ The tool also supports the expert settings. Do not use them until you read the d
 
 - Show schemas - you'll be able to edit or define your own texture or tree schemas. It's useful if you want to add some custom textures or trees to the map. Refer to the [Texture schema](#texture-schema) section to learn more about the schema structure. Any incorrect value here will lead to the completely broken map.
 
+- Upload custom background image - if you have an image, which represents the map and background terrain you can use it for generation. Note, that the image should meet the following requirements: 1:1 aspect ratio, size = map size + 2048 * 2, it should be uint16 (unsigned 16-bit integer) grayscale (single channel) image. The image should be in the PNG format. If any of the requirements are not met, the tool raises an error. If you're using rotation, the image should already be rotated.
+
 ## Resources
 In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
 To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
@@ -547,6 +574,15 @@ To create a basic map, you only need the Giants Editor. But if you want to creat
 ➡️ Please, before creating an issue or asking some questions, check the [FAQ](docs/FAQ.md) section.<br>
 If you find a bug or have an idea for a new feature, please create an issue [here](https://github.com/iwatkot/maps4fs/issues) or contact me directly on [Telegram](https://t.me/iwatkot) or on Discord: `iwatkot`.
 
+## DTM Providers
+
+The generator supports adding the own DTM providers, please refer to the [DTM Providers](docs/dtm_providers.md) section to learn how to add the custom DTM provider.
+
+### Supported DTM providers
+
+- [SRTM 30m](https://dwtkns.com/srtm30m/) - the 30 meters resolution DEM data from the SRTM mission for the whole world.
+- [USGS 1m](https://portal.opentopography.org/raster?opentopoID=OTNED.012021.4269.3) - the 1-meter resolution DEM data from the USGS for the USA. Developed by [ZenJakey](https://github.com/ZenJakey).
+
 ## Special thanks
 
 Of course, first of all, thanks to the direct [contributors](https://github.com/iwatkot/maps4fs/graphs/contributors) of the project.  
@@ -562,3 +598,4 @@ But also, I want to thank the people who helped me with the project in some way,
 - [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
 - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
 - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
+- [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.

{maps4fs-1.5.7 → maps4fs-1.6.91}/README.md

@@ -22,6 +22,7 @@
   <a href="#Expert-settings">Expert settings</a> •
   <a href="#Resources">Resources</a> •
   <a href="#Bugs-and-feature-requests">Bugs and feature requests</a><br>
+  <a href="#DTM-Providers">DTM Providers</a> •
   <a href="#Special-thanks">Special thanks</a>
 </p>
 
@@ -43,6 +44,7 @@
 
 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
 🔄 Support map rotation 🆕<br>
+🌐 Supports custom [DTM Providers](#DTM-Providers) 🆕<br>
 🌾 Automatically generates fields 🆕<br>
 🌽 Automatically generates farmlands 🆕<br>
 🌿 Automatically generates decorative foliage 🆕<br>
@@ -103,6 +105,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:
@@ -157,6 +160,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.
@@ -225,6 +229,10 @@ The tool now has a Modder Toolbox, which is a set of tools to help you with vari
 
 ### Tool Categories
 Tools are divided into categories, which are listed below.
+
+#### For custom schemas
+- **Tree Schema Editor** - allows you to view all the supported trees models and select the ones you need on your map. After it, you should click the Show updated schema button and copy the JSON schema to the clipboard. Then you can use it in the Expert settings to generate the map with the selected trees.
+
 #### For Textures and DEM
 - **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 a height map using it.
 
@@ -393,6 +401,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>
@@ -439,17 +448,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.
 
@@ -465,6 +469,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.
@@ -473,6 +486,18 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Add Farmyards - if enabled, the tool will create farmlands from the regions that are marked as farmyards in the OSM data. Those farmlands will not have fields and also will not be drawn on textures. By default, it's turned off.
 
+- Base grass - you can select which plant will be used as a base grass on the map. 
+
+- Plants island minimum size - when random plants are enabled, the generator will add islands of differents plants to the map and choose the random size of those island between the minimum and maximum values. This one is the minimum size of the island in meters.
+
+- Plants island maximum size - it's the same as above, but for the maximum size of the island in meters.
+
+- Plants island vertex count - the number of vertices in the island. The higher the value, the more detailed the island will be. Note, that high values will turn the smoothed island into geometric madness.
+
+- Plants insland rounding radius - used to round the vertices of the island. The higher the value, the more rounded the island will be.
+
+- Plants island percent - defines the relation between the map size and the number of islands of plants. For example, if set to 100% for map size of 2048 will be added 2048 islands of plants. 
+
 ### I3D Advanced settings
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
@@ -506,6 +531,8 @@ The tool also supports the expert settings. Do not use them until you read the d
 
 - Show schemas - you'll be able to edit or define your own texture or tree schemas. It's useful if you want to add some custom textures or trees to the map. Refer to the [Texture schema](#texture-schema) section to learn more about the schema structure. Any incorrect value here will lead to the completely broken map.
 
+- Upload custom background image - if you have an image, which represents the map and background terrain you can use it for generation. Note, that the image should meet the following requirements: 1:1 aspect ratio, size = map size + 2048 * 2, it should be uint16 (unsigned 16-bit integer) grayscale (single channel) image. The image should be in the PNG format. If any of the requirements are not met, the tool raises an error. If you're using rotation, the image should already be rotated.
+
 ## Resources
 In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
 To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
@@ -521,6 +548,15 @@ To create a basic map, you only need the Giants Editor. But if you want to creat
 ➡️ Please, before creating an issue or asking some questions, check the [FAQ](docs/FAQ.md) section.<br>
 If you find a bug or have an idea for a new feature, please create an issue [here](https://github.com/iwatkot/maps4fs/issues) or contact me directly on [Telegram](https://t.me/iwatkot) or on Discord: `iwatkot`.
 
+## DTM Providers
+
+The generator supports adding the own DTM providers, please refer to the [DTM Providers](docs/dtm_providers.md) section to learn how to add the custom DTM provider.
+
+### Supported DTM providers
+
+- [SRTM 30m](https://dwtkns.com/srtm30m/) - the 30 meters resolution DEM data from the SRTM mission for the whole world.
+- [USGS 1m](https://portal.opentopography.org/raster?opentopoID=OTNED.012021.4269.3) - the 1-meter resolution DEM data from the USGS for the USA. Developed by [ZenJakey](https://github.com/ZenJakey).
+
 ## Special thanks
 
 Of course, first of all, thanks to the direct [contributors](https://github.com/iwatkot/maps4fs/graphs/contributors) of the project.  
@@ -536,3 +572,4 @@ But also, I want to thank the people who helped me with the project in some way,
 - [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
 - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
 - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
+- [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.

{maps4fs-1.5.7 → maps4fs-1.6.91}/maps4fs/__init__.py

@@ -1,5 +1,7 @@
 # pylint: disable=missing-module-docstring
-from maps4fs.generator.dtm import DTMProvider
+from maps4fs.generator.dtm.dtm import DTMProvider
+from maps4fs.generator.dtm.srtm import SRTM30Provider
+from maps4fs.generator.dtm.usgs import USGSProvider
 from maps4fs.generator.game import Game
 from maps4fs.generator.map import Map
 from maps4fs.generator.settings import (

{maps4fs-1.5.7 → maps4fs-1.6.91}/maps4fs/generator/background.py

@@ -58,6 +58,10 @@ class Background(Component):
         os.makedirs(self.water_directory, exist_ok=True)
 
         self.output_path = os.path.join(self.background_directory, f"{FULL_NAME}.png")
+        if self.map.custom_background_path:
+            self.check_custom_background(self.map.custom_background_path)
+            shutil.copyfile(self.map.custom_background_path, self.output_path)
+
         self.not_substracted_path = os.path.join(self.background_directory, "not_substracted.png")
         self.not_resized_path = os.path.join(self.background_directory, "not_resized.png")
 
@@ -75,6 +79,28 @@ class Background(Component):
         self.dem.set_output_resolution((self.rotated_size, self.rotated_size))
         self.dem.set_dem_path(self.output_path)
 
+    def check_custom_background(self, image_path: str) -> None:
+        """Checks if the custom background image meets the requirements.
+
+        Arguments:
+            image_path (str): The path to the custom background image.
+
+        Raises:
+            ValueError: If the custom background image does not meet the requirements.
+        """
+        image = cv2.imread(image_path, cv2.IMREAD_UNCHANGED)  # pylint: disable=no-member
+        if image.shape[0] != image.shape[1]:
+            raise ValueError("The custom background image must be a square.")
+
+        if image.shape[0] != self.map_size + DEFAULT_DISTANCE * 2:
+            raise ValueError("The custom background image must have the size of the map + 4096.")
+
+        if len(image.shape) != 2:
+            raise ValueError("The custom background image must be a grayscale image.")
+
+        if image.dtype != np.uint16:
+            raise ValueError("The custom background image must be a 16-bit grayscale image.")
+
     def is_preview(self, name: str) -> bool:
         """Checks if the DEM is a preview.
 
@@ -91,7 +117,9 @@ class Background(Component):
         as a result the DEM files will be saved, then based on them the obj files will be
         generated."""
         self.create_background_textures()
-        self.dem.process()
+
+        if not self.map.custom_background_path:
+            self.dem.process()
 
         shutil.copyfile(self.dem.dem_path, self.not_substracted_path)
         self.cutout(self.dem.dem_path, save_path=self.not_resized_path)
@@ -148,6 +176,9 @@ class Background(Component):
             "east": east,
             "west": west,
         }
+
+        dem_info_sequence = self.dem.info_sequence()
+        data["DEM"] = dem_info_sequence
         return data  # type: ignore
 
     def qgis_sequence(self) -> None:
@@ -176,7 +207,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)  # 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:
@@ -219,16 +256,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.
 
@@ -236,11 +294,18 @@ class Background(Component):
             dem_data (np.ndarray) -- The DEM data as a numpy array.
             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
         )
@@ -275,7 +340,10 @@ class Background(Component):
                 bottom_left = top_left + cols
                 bottom_right = bottom_left + 1
 
-                if ground in [z[i, j], z[i, j + 1], z[i + 1, j], z[i + 1, j + 1]]:
+                if (
+                    ground in [z[i, j], z[i, j + 1], z[i + 1, j], z[i + 1, j + 1]]
+                    and not include_zeros
+                ):
                     skipped += 1
                     continue
 
@@ -294,16 +362,32 @@ class Background(Component):
         mesh.apply_transform(rotation_matrix_z)
 
         # if not include_zeros:
-        z_scaling_factor = 1 / self.map.dem_settings.multiplier
+        z_scaling_factor = self.get_z_scaling_factor()
         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 include_zeros:
+        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-1.5.7 → maps4fs-1.6.91}/maps4fs/generator/component.py

@@ -58,7 +58,7 @@ class Component:
         self.logger = logger
         self.kwargs = kwargs
 
-        self.logger.info(
+        self.logger.debug(
             "Component %s initialized. Map size: %s, map rotated size: %s",  # type: ignore
             self.__class__.__name__,
             self.map_size,
@@ -535,3 +535,26 @@ class Component:
         interpolated_polyline.append(polyline[-1])
 
         return interpolated_polyline
+
+    def get_z_scaling_factor(self) -> float:
+        """Calculates the scaling factor for the Z axis based on the map settings.
+
+        Returns:
+            float -- The scaling factor for the Z axis.
+        """
+
+        scaling_factor = 1 / self.map.dem_settings.multiplier
+        self.logger.debug("Z scaling factor including DEM multiplier: %s", scaling_factor)
+
+        if self.map.shared_settings.height_scale_multiplier:
+            scaling_factor *= self.map.shared_settings.height_scale_multiplier
+            self.logger.debug(
+                "Z scaling factor including height scale multiplier: %s", scaling_factor
+            )
+        if self.map.shared_settings.mesh_z_scaling_factor:
+            scaling_factor *= 1 / self.map.shared_settings.mesh_z_scaling_factor
+            self.logger.debug(
+                "Z scaling factor including mesh z scaling factor: %s", scaling_factor
+            )
+
+        return scaling_factor

{maps4fs-1.5.7 → maps4fs-1.6.91}/maps4fs/generator/dem.py

@@ -1,6 +1,7 @@
 """This module contains DEM class for processing Digital Elevation Model data."""
 
 import os
+from typing import Any
 
 import cv2
 import numpy as np
@@ -9,7 +10,7 @@ import numpy as np
 from pympler import asizeof  # type: ignore
 
 from maps4fs.generator.component import Component
-from maps4fs.generator.dtm import DTMProvider
+from maps4fs.generator.dtm.dtm import DTMProvider
 
 
 # pylint: disable=R0903, R0902
@@ -63,6 +64,7 @@ class DEM(Component):
             size=self.map_rotated_size,
             directory=self.temp_dir,
             logger=self.logger,
+            map=self.map,
         )
 
     @property
@@ -281,54 +283,15 @@ class DEM(Component):
         """
         return []
 
-    def _get_scaling_factor(self, maximum_deviation: int) -> float:
-        """Calculate scaling factor for DEM data normalization.
-        NOTE: Needs reconsideration for the implementation.
+    def info_sequence(self) -> dict[Any, Any] | None:  # type: ignore
+        """Returns the information sequence for the component. Must be implemented in the child
+        class. If the component does not have an information sequence, an empty dictionary must be
+        returned.
 
-        Arguments:
-            maximum_deviation (int): Maximum deviation in DEM data.
-
-        Returns:
-            float: Scaling factor for DEM data normalization.
-        """
-        ESTIMATED_MAXIMUM_DEVIATION = 1000  # pylint: disable=C0103
-        scaling_factor = maximum_deviation / ESTIMATED_MAXIMUM_DEVIATION
-        return scaling_factor if scaling_factor < 1 else 1
-
-    def _normalize_dem(self, data: np.ndarray) -> np.ndarray:
-        """Normalize DEM data to 16-bit unsigned integer using max height from settings.
-        Arguments:
-            data (np.ndarray): DEM data from SRTM file after cropping.
         Returns:
-            np.ndarray: Normalized DEM data.
+            dict[Any, Any]: The information sequence for the component.
         """
-        self.logger.debug("Starting DEM data normalization.")
-        # Calculate the difference between the maximum and minimum values in the DEM data.
-
-        max_height = data.max()
-        min_height = data.min()
-        max_dev = max_height - min_height
-        self.logger.debug(
-            "Maximum deviation: %s with maximum at %s and minimum at %s.",
-            max_dev,
-            max_height,
-            min_height,
-        )
-
-        scaling_factor = self._get_scaling_factor(max_dev)
-        adjusted_max_height = int(65535 * scaling_factor)
-        self.logger.debug(
-            "Maximum deviation: %s. Scaling factor: %s. Adjusted max height: %s.",
-            max_dev,
-            scaling_factor,
-            adjusted_max_height,
-        )
-        normalized_data = (
-            (data - data.min()) / (data.max() - data.min()) * adjusted_max_height
-        ).astype("uint16")
-        self.logger.debug(
-            "DEM data was normalized to %s - %s.",
-            normalized_data.min(),
-            normalized_data.max(),
-        )
-        return normalized_data
+        provider_info_sequence = self.dtm_provider.info_sequence()
+        if provider_info_sequence is None:
+            return {}
+        return provider_info_sequence