Output size feature: possibility to resize the map to the specified dimensions

* Output size feature.

* WebUI update for Output size.

* README update.

* Message update

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: iwatkot

.pylintrc

@@ -27,4 +27,5 @@ disable=raw-checker-failed,
         unused-argument,
         consider-using-from-import,
         line-too-long,
-        import-outside-toplevel
+        import-outside-toplevel,
+        too-many-branches

README.md

@@ -9,8 +9,9 @@
   <a href="docs/step_by_step.md">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="docs/map_structure.md">Map Structure</a>
+  <a href="#Modder-Toolbox">Modder Toolbox</a> •
+  <a href="#Main-Settings">Main Settings</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
   <a href="#Texture-schema">Texture schema</a> •
@@ -42,15 +43,16 @@
 </div>
 
 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
+✂️ Supports map scaling 🆕<br>
 🔄 Support map rotation<br>
-🌐 Supports custom [DTM Providers](#DTM-Providers) 🆕<br>
+🌐 Supports custom [DTM Providers](#DTM-Providers)<br>
 🌾 Automatically generates fields<br>
 🌽 Automatically generates farmlands<br>
 🌿 Automatically generates decorative foliage<br>
 🌲 Automatically generates forests<br>
 🌊 Automatically generates water planes<br>
-📈 Automatically generates splines 🆕<br>
-🛰️ Automatically downloads high resolution satellite images 🆕<br>
+📈 Automatically generates splines<br>
+🛰️ Automatically downloads high resolution satellite images<br>
 🌍 Based on real-world data from OpenStreetMap<br>
 🗺️ Supports [custom OSM maps](/docs/custom_osm.md)<br>
 🏞️ Generates height map using SRTM dataset<br>
@@ -168,7 +170,8 @@ Don't know where to start? Don't worry, just follow this [step-by-step guide](do
 
 🟢 Recommended for all users.  
 🛠️ Don't need to install anything.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8 km.  
+🗺️ Supported map sizes: 2x2, 4x4.  
+✂️ Map scaling: not supported.  
 ⚙️ Advanced settings: enabled.  
 🖼️ Texture dissolving: enabled.  
 Using the public version on [maps4fs.xyz](https://maps4fs.xyz) is the easiest way to generate a map template. Just open the link and follow the instructions.
@@ -181,6 +184,7 @@ Using it is easy and doesn't require any guides. Enjoy!
 🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
 🛠️ Launch with one single command.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
 ⚙️ Advanced settings: enabled.  
 🖼️ Texture dissolving: enabled.  
 Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
@@ -212,6 +216,7 @@ Remember to replace `*.*.*` with the version you want to use, e.g. `iwatkot/maps
 
 🔴 Recommended for developers.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
 ⚙️ Advanced settings: enabled.  
 🖼️ Texture dissolving: enabled.  
 You can use the Python package to generate maps. Follow these steps:
@@ -316,6 +321,40 @@ Tools are divided into categories, which are listed below.
 
 - **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.
 
+## Main Settings
+
+### Game Selection
+The tool supports two games: Farming Simulator 22 and Farming Simulator 25. You can select the game you want to generate the map for in the `Game` dropdown list. The default value is `FS25`, but you can change it to `FS22` if you want to generate a map for Farming Simulator 22.<br>
+**NOTE:** Support for Farming Simulator 22 is discontinued. The tool will not be updated for this game anymore. Some features, such as forest generation, fields generation not implemented and not planned to be implemented. The tool will be updated only for Farming Simulator 25.<br>
+
+### Latitude and Longitude
+These are the coordinates of the center of the map. The coordinates should be in decimal format, e.g. `45.28, 20.23`, any other format will not work.
+
+### Map Size
+
+#### Default sizes
+The tool supports all possible sizes of maps, but some of them only available in the [Docker version](#option-2-docker-version). <br>
+The sizes are:
+- 2x2 km
+- 4x4 km
+- 8x8 km
+- 16x16 km
+
+**NOTE:** 16 km maps probably won't work for FS25 due to the limitations of the game engine. The map will be generated, but you may have issues trying to open it in the Giants Editor.
+
+#### Custom size
+You can also specify any custom size of the map. Be aware that Giants Editor supports only square maps, which size is a power of 2 (2048, 4096 and so on). All other sizes will be generated, but if you try to open them in the Giants Editor, it will crash. If you want your map to cover other real-world region, use the [Output size](#output-size) option.
+
+#### Output size
+This setting can be useful if you want add some scaling to your map. For example, you can select a region of 3000 meters in real world and set the output size to 2048 meters. In this case, the map will be generated with a size of 2048x2048 meters, but it will contain the region of 3000x3000 meters in real world.
+
+### DTM Provider
+DTM Provider is a source of the height map data. will find the list of available providers in the [DTM Providers](#dtm-providers) section. The default provider is `SRTM30Provider` which is available all aroung the globe, but the resolution is not very high. If you want to use a different provider, you can select it in the dropdown list. You will only see the providers that are available for the selected region. It's better to use the provider that has the highest resolution for the selected region.
+**NOTE:** Some of the providers are community-developed and may not work properly. I do not provide any support for them. If you have any issues with them, please contact the provider's author.
+
+### Map Rotation
+You can rotate the map by any angle. The rotation is applied to the map and the height map. The rotation is in degrees, so you can use any value from 0 to 360. The default value is `0`, which means that the map will be generated without rotation.
+
 ## 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.

demo.py

@@ -28,10 +28,11 @@
 dtm_provider = mfs.dtm.SRTM30Provider
 
 # 3️⃣ Define the coordinates of the central point of the map, size and rotation.
-lat, lon = 45.28, 20.23
+lat, lon = 45.2915463035936, 20.219764914521804
 coordinates = (lat, lon)
 size = 2048
-rotation = 0
+rotation = 15
+output_size = 1024
 
 # 4️⃣ Define the output directory.
 map_directory = "map_directory"
@@ -44,9 +45,9 @@
 
 # 6️⃣ Optional: advanced settings. You can use the default settings, but
 # it's recommended to change them according to your needs.
-dem_settings = mfs.settings.DEMSettings(multiplier=1, blur_radius=15, plateau=15, water_depth=10)
+dem_settings = mfs.settings.DEMSettings(multiplier=1, blur_radius=40, plateau=15, water_depth=10)
 background_settings = mfs.settings.BackgroundSettings(
-    # generate_background=True,
+    generate_background=True,
     generate_water=True,
     water_blurriness=50,
     resize_factor=8,
@@ -95,6 +96,7 @@
     satellite_settings=satellite_settings,
     # texture_custom_schema=texture_custom_schema,
     # tree_custom_schema=tree_custom_schema,
+    output_size=output_size,
 )
 
 # 9️⃣ Launch the generation process.

maps4fs/generator/component/background.py

@@ -87,15 +87,14 @@ def process(self) -> None:
 
         if not self.map.custom_background_path:
             self.dem.process()
-            self.validate_np_for_mesh(self.dem.dem_path, self.map_size)
-
-        shutil.copyfile(self.dem.dem_path, self.not_substracted_path)
-        self.save_map_dem(self.dem.dem_path, save_path=self.not_resized_path)
+            self.validate_np_for_mesh(self.output_path, self.map_size)
 
         if self.map.dem_settings.water_depth:
             self.subtraction()
 
-        cutted_dem_path = self.save_map_dem(self.dem.dem_path)
+        cutted_dem_path = self.save_map_dem(self.output_path)
+        shutil.copyfile(self.output_path, self.not_substracted_path)
+        self.save_map_dem(self.output_path, save_path=self.not_resized_path)
         if self.game.additional_dem_name is not None:
             self.make_copy(cutted_dem_path, self.game.additional_dem_name)
 
@@ -213,19 +212,28 @@ def generate_obj_files(self) -> None:
         """Iterates over all dems and generates 3D obj files based on DEM data.
         If at least one DEM file is missing, the generation will be stopped at all.
         """
-        if not os.path.isfile(self.dem.dem_path):
+        if not os.path.isfile(self.output_path):
             self.logger.error(
-                "DEM file not found, generation will be stopped: %s", self.dem.dem_path
+                "DEM file not found, generation will be stopped: %s", self.output_path
             )
             return
 
-        self.logger.debug("DEM file for found: %s", self.dem.dem_path)
+        self.logger.debug("DEM file for found: %s", self.output_path)
 
-        filename = os.path.splitext(os.path.basename(self.dem.dem_path))[0]
+        filename = os.path.splitext(os.path.basename(self.output_path))[0]
         save_path = os.path.join(self.background_directory, f"{filename}.obj")
         self.logger.debug("Generating obj file in path: %s", save_path)
 
-        dem_data = cv2.imread(self.dem.dem_path, cv2.IMREAD_UNCHANGED)
+        dem_data = cv2.imread(self.output_path, cv2.IMREAD_UNCHANGED)
+
+        if self.map.output_size is not None:
+            scaled_background_size = int(self.background_size * self.map.size_scale)
+            dem_data = cv2.resize(
+                dem_data,
+                (scaled_background_size, scaled_background_size),
+                interpolation=cv2.INTER_NEAREST,
+            )
+
         self.plane_from_np(
             dem_data,
             save_path,
@@ -255,7 +263,7 @@ def save_map_dem(self, dem_path: str, save_path: str | None = None) -> str:
         if self.map.dem_settings.add_foundations:
             dem_data = self.create_foundations(dem_data)
 
-        output_size = self.map_size + 1
+        output_size = self.scaled_size + 1
 
         main_dem_path = self.game.dem_file_path(self.map_directory)
 
@@ -265,7 +273,7 @@ def save_map_dem(self, dem_path: str, save_path: str | None = None) -> str:
             pass
 
         resized_dem_data = cv2.resize(
-            dem_data, (output_size, output_size), interpolation=cv2.INTER_LINEAR
+            dem_data, (output_size, output_size), interpolation=cv2.INTER_NEAREST
         )
 
         cv2.imwrite(main_dem_path, resized_dem_data)
@@ -301,7 +309,7 @@ def plane_from_np(
             decimation_percent=self.map.background_settings.decimation_percent,
             decimation_agression=self.map.background_settings.decimation_agression,
             remove_center=remove_center,
-            remove_size=self.map_size,
+            remove_size=self.scaled_size,
         )
 
         try:
@@ -348,7 +356,7 @@ def previews(self) -> list[str]:
         preview_paths = self.dem_previews(self.game.dem_file_path(self.map_directory))
 
         background_dem_preview_path = os.path.join(self.previews_directory, "background_dem.png")
-        background_dem_preview_image = cv2.imread(self.dem.dem_path, cv2.IMREAD_UNCHANGED)
+        background_dem_preview_image = cv2.imread(self.output_path, cv2.IMREAD_UNCHANGED)
 
         background_dem_preview_image = cv2.resize(
             background_dem_preview_image, (0, 0), fx=1 / 4, fy=1 / 4
@@ -458,6 +466,7 @@ def create_background_textures(self) -> None:
             map_directory=self.map_directory,
             logger=self.logger,
             texture_custom_schema=background_layers,  # type: ignore
+            skip_scaling=True,  # type: ignore
         )
 
         self.background_texture.preprocess()
@@ -545,6 +554,19 @@ def generate_water_resources_obj(self) -> None:
         # Single channeled 16 bit DEM image of terrain.
         background_dem = cv2.imread(self.not_substracted_path, cv2.IMREAD_UNCHANGED)
 
+        if self.map.output_size is not None:
+            scaled_background_size = int(self.background_size * self.map.size_scale)
+            plane_water = cv2.resize(
+                plane_water,
+                (scaled_background_size, scaled_background_size),
+                interpolation=cv2.INTER_NEAREST,
+            )
+            background_dem = cv2.resize(
+                background_dem,
+                (scaled_background_size, scaled_background_size),
+                interpolation=cv2.INTER_NEAREST,
+            )
+
         if self.map.background_settings.water_blurriness:
             # Apply Gaussian blur to the background dem.
             blur_power = self._get_blur_power()

maps4fs/generator/component/base/component.py

@@ -339,8 +339,8 @@ def top_left_coordinates_to_center(self, top_left: tuple[int, int]) -> tuple[int
             tuple[int, int]: The coordinates in the center system.
         """
         x, y = top_left
-        cs_x = x - self.map_size // 2
-        cs_y = y - self.map_size // 2
+        cs_x = x - self.scaled_size // 2
+        cs_y = y - self.scaled_size // 2
 
         return cs_x, cs_y
 
@@ -368,23 +368,22 @@ def fit_object_into_bounds(
             raise ValueError("Either polygon or linestring points must be provided.")
 
         min_x = min_y = 0 + border
-        max_x = max_y = self.map_size - border
+        max_x = max_y = self.scaled_size - border
 
         object_type = Polygon if polygon_points else LineString
 
-        # polygon = Polygon(polygon_points)
         osm_object = object_type(polygon_points or linestring_points)
 
         if angle:
-            center_x = center_y = self.map_rotated_size // 2
+            center_x = center_y = self.map_rotated_size * self.map.size_scale // 2
             self.logger.debug(
                 "Rotating the osm_object by %s degrees with center at %sx%s",
                 angle,
                 center_x,
                 center_y,
             )
             osm_object = rotate(osm_object, -angle, origin=(center_x, center_y))
-            offset = (self.map_size / 2) - (self.map_rotated_size / 2)
+            offset = int((self.map_size / 2) - (self.map_rotated_size / 2)) * self.map.size_scale
             self.logger.debug("Translating the osm_object by %s", offset)
             osm_object = translate(osm_object, xoff=offset, yoff=offset)
             self.logger.debug("Rotated and translated the osm_object.")
@@ -566,3 +565,12 @@ def get_z_scaling_factor(self, ignore_height_scale_multiplier: bool = False) ->
             scaling_factor *= 1 / self.map.shared_settings.mesh_z_scaling_factor
 
         return scaling_factor
+
+    @property
+    def scaled_size(self) -> int:
+        """Returns the output size of the map if it was set, otherwise returns the map size.
+
+        Returns:
+            int: The output size of the map or the map size.
+        """
+        return self.map_size if self.map.output_size is None else self.map.output_size

maps4fs/generator/component/base/component_image.py

@@ -161,3 +161,17 @@ def apply_blur(
         )
 
         return blurred_data
+
+    def get_blur_radius(self) -> int:
+        """Get the blur radius from the DEM settings.
+
+        Returns:
+            int: The blur radius.
+        """
+        blur_radius = self.map.dem_settings.blur_radius
+        if blur_radius is None or blur_radius <= 0:
+            # We'll disable blur if the radius is 0 or negative.
+            blur_radius = 0
+        elif blur_radius % 2 == 0:
+            blur_radius += 1
+        return blur_radius

maps4fs/generator/component/config.py

@@ -36,8 +36,8 @@ def _set_map_size(self) -> None:
 
         root = tree.getroot()
         data = {
-            "width": str(self.map_size),
-            "height": str(self.map_size),
+            "width": str(self.scaled_size),
+            "height": str(self.scaled_size),
         }
 
         for element in root.iter("map"):

maps4fs/generator/component/dem.py

@@ -40,20 +40,6 @@ def preprocess(self) -> None:
         self.output_resolution = self.get_output_resolution()
         self.logger.debug("Output resolution for DEM data: %s.", self.output_resolution)
 
-        blur_radius = self.map.dem_settings.blur_radius
-        if blur_radius is None or blur_radius <= 0:
-            # We'll disable blur if the radius is 0 or negative.
-            blur_radius = 0
-        elif blur_radius % 2 == 0:
-            blur_radius += 1
-        self.blur_radius = blur_radius
-        self.multiplier = self.map.dem_settings.multiplier
-        self.logger.debug(
-            "DEM value multiplier is %s, blur radius is %s.",
-            self.multiplier,
-            self.blur_radius,
-        )
-
         self.dtm_provider: DTMProvider = self.map.dtm_provider(  # type: ignore
             coordinates=self.coordinates,
             user_settings=self.map.dtm_provider_settings,
@@ -200,7 +186,7 @@ def process(self) -> None:
         self.update_info("normalized", resampled_data)
 
         # 6. Blur DEM data.
-        resampled_data = self.apply_blur(resampled_data, blur_radius=self.blur_radius)
+        resampled_data = self.apply_blur(resampled_data, blur_radius=self.get_blur_radius())
 
         cv2.imwrite(self._dem_path, resampled_data)
         self.logger.debug("DEM data was saved to %s.", self._dem_path)
@@ -288,13 +274,14 @@ def apply_multiplier(self, data: np.ndarray) -> np.ndarray:
         Returns:
             np.ndarray: Multiplied DEM data.
         """
-        if not self.multiplier != 1:
+        multiplier = self.map.dem_settings.multiplier
+        if not multiplier != 1:
             return data
 
-        multiplied_data = data * self.multiplier
+        multiplied_data = data * multiplier
         self.logger.debug(
             "DEM data was multiplied by %s. Min: %s, max: %s.",
-            self.multiplier,
+            multiplier,
             multiplied_data.min(),
             multiplied_data.max(),
         )