maps4fs 0.9.4__py3-none-any.whl → 0.9.7__py3-none-any.whl

maps4fs/generator/background.py

@@ -10,13 +10,18 @@ import numpy as np
 import trimesh  # type: ignore
 
 from maps4fs.generator.component import Component
+from maps4fs.generator.dem import (
+    DEFAULT_BLUR_RADIUS,
+    DEFAULT_MULTIPLIER,
+    DEFAULT_PLATEAU,
+)
 from maps4fs.generator.path_steps import DEFAULT_DISTANCE, PATH_FULL_NAME, get_steps
 from maps4fs.generator.tile import Tile
 from maps4fs.logger import timeit
 
 RESIZE_FACTOR = 1 / 4
 SIMPLIFY_FACTOR = 10
-FULL_RESIZE_FACTOR = 1 / 4
+FULL_RESIZE_FACTOR = 1 / 8
 FULL_SIMPLIFY_FACTOR = 20
 
 
@@ -58,9 +63,9 @@ class Background(Component):
                 logger=self.logger,
                 tile_code=path_step.code,
                 auto_process=False,
-                blur_radius=self.kwargs.get("blur_radius"),
-                multiplier=self.kwargs.get("multiplier", 1),
-                plateau=self.kwargs.get("plateau", 0),
+                blur_radius=self.kwargs.get("blur_radius", DEFAULT_BLUR_RADIUS),
+                multiplier=self.kwargs.get("multiplier", DEFAULT_MULTIPLIER),
+                plateau=self.kwargs.get("plateau", DEFAULT_PLATEAU),
             )
 
             # Update the origin for the next tile.
@@ -217,9 +222,28 @@ class Background(Component):
         mesh = mesh.simplify_quadric_decimation(face_count=len(faces) // simplify_factor)
         self.logger.debug("Mesh simplified to %s faces", len(mesh.faces))
 
+        if tile_code == PATH_FULL_NAME:
+            self.mesh_to_stl(mesh)
+
         mesh.export(save_path)
         self.logger.info("Obj file saved: %s", save_path)
 
+    def mesh_to_stl(self, mesh: trimesh.Trimesh) -> None:
+        """Converts the mesh to an STL file and saves it in the previews directory.
+        Uses powerful simplification to reduce the size of the file since it will be used
+        only for the preview.
+
+        Arguments:
+            mesh (trimesh.Trimesh) -- The mesh to convert to an STL file.
+        """
+        preview_path = os.path.join(self.previews_directory, "background_dem.stl")
+        mesh = mesh.simplify_quadric_decimation(percent=0.05)
+        mesh.export(preview_path)
+
+        self.logger.info("STL file saved: %s", preview_path)
+
+        self.stl_preview_path = preview_path  # pylint: disable=attribute-defined-outside-init
+
     def previews(self) -> list[str]:
         """Generates a preview by combining all tiles into one image.
         NOTE: The map itself is not included in the preview, so it will be empty.
@@ -238,6 +262,8 @@ class Background(Component):
 
         for tile in self.tiles:
             # pylint: disable=no-member
+            if tile.code == PATH_FULL_NAME:
+                continue
             tile_image = cv2.imread(tile.dem_path, cv2.IMREAD_UNCHANGED)
 
             self.logger.debug(
@@ -297,7 +323,7 @@ class Background(Component):
         image = cv2.cvtColor(image, cv2.COLOR_GRAY2BGR)  # type: ignore
         cv2.imwrite(preview_path, image)
 
-        return [preview_path]
+        return [preview_path, self.stl_preview_path]
 
 
 # Creates tiles around the map.

maps4fs/generator/dem.py

@@ -13,8 +13,9 @@ import requests
 from maps4fs.generator.component import Component
 
 SRTM = "https://elevation-tiles-prod.s3.amazonaws.com/skadi/{latitude_band}/{tile_name}.hgt.gz"
-DEFAULT_MULTIPLIER = 1
+DEFAULT_MULTIPLIER = 1.0
 DEFAULT_BLUR_RADIUS = 35
+DEFAULT_PLATEAU = 0
 
 
 # pylint: disable=R0903, R0902
@@ -134,6 +135,16 @@ class DEM(Component):
         else:
             self.logger.debug("Auto processing is disabled, DEM data will not be normalized.")
             resampled_data = resampled_data * self.multiplier
+            # Clip values to 16-bit unsigned integer range.
+            resampled_data = np.clip(resampled_data, 0, 65535)
+            resampled_data = resampled_data.astype("uint16")
+            self.logger.debug(
+                "DEM data was multiplied by %s and clipped to 16-bit unsigned integer range. "
+                "Min: %s, max: %s.",
+                self.multiplier,
+                resampled_data.min(),
+                resampled_data.max(),
+            )
 
         self.logger.debug(
             "DEM data was resampled. Shape: %s, dtype: %s. Min: %s, max: %s.",

maps4fs/generator/qgis.py

@@ -52,7 +52,7 @@ for layer in layers:
     points = [top_left, top_right, bottom_right, bottom_left, top_left]
 
     # Create a new layer
-    layer = QgsVectorLayer('Point?crs=EPSG:4326', name, 'memory')
+    layer = QgsVectorLayer('Point?crs=EPSG:3857', name, 'memory')
     provider = layer.dataProvider()
 
     # Add fields

{maps4fs-0.9.4.dist-info → maps4fs-0.9.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.4
+Version: 0.9.7
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -30,7 +30,8 @@ Requires-Dist: tifffile
 <p align="center">
   <a href="#Quick-Start">Quick Start</a> •
   <a href="#Overview">Overview</a> • 
-  <a href="#How-To-Run">How-To-Run</a><br>
+  <a href="#How-To-Run">How-To-Run</a> •
+  <a href="tutorials/FAQ.md">FAQ</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
   <a href="#Texture-schema">Texture schema</a> •
@@ -81,7 +82,7 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 ### 🚜 For most users
 **Option 1:** open the [maps4fs](https://maps4fs.streamlit.app) on StreamLit and generate a map template in a few clicks.<br>
 
-![Basic WebUI](https://github.com/user-attachments/assets/14620044-9e92-47ae-8531-d61460740f58)
+![Basic WebUI](https://github.com/user-attachments/assets/52f499cc-f28a-4da3-abef-0e818abe8dbe)
 
 ### 😎 For advanced users
 **Option 2:** run the Docker version in your browser. Launch the following command in your terminal:
@@ -409,7 +410,7 @@ The tool supports the custom size of the map. To use this feature select `Custom
 
 ⛔️ 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 a specific values for the map size.<br><br>
 
-![Advanced settings](https://github.com/user-attachments/assets/0446cdf2-f093-49ba-ba8f-9bef18a58b47)
+![Advanced settings](https://github.com/user-attachments/assets/e7406adf-6b82-41a0-838a-13dd8877bebf)
 
 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>
 
@@ -429,6 +430,9 @@ To create a basic map, you only need the Giants Editor. But if you want to creat
 2. [Blender](https://www.blender.org/download/) - the open-source 3D modeling software that you can use to create models for the Farming Simulator.
 3. [Blender Exporter Plugins](https://gdn.giants-software.com/downloads.php) - the official plugins for exporting models from Blender to i3d format (the format used in the Farming Simulator).
 4. [QGIS](https://qgis.org/download/) - the open-source GIS software that you can use to obtain high-resolution satellite images for your map.
+5. [CompressPngCom](https://www.compresspng.com/) - the online tool to compress the PNG images. May be useful to reduce the size of the satellite images.
+6. [AnyConv](https://anyconv.com/png-to-dds-converter/) - the online tool to convert the PNG images to the DDS format. You'll need this format for the textures, icons, overview and preview images.
 
 ## Bugs and feature requests
+➡️ Please, before creating an issue or asking some questions, check the [FAQ](tutorials/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`.

{maps4fs-0.9.4.dist-info → maps4fs-0.9.7.dist-info}/RECORD

@@ -1,19 +1,19 @@
 maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
 maps4fs/logger.py,sha256=8oZzAKJllilYrVp452LX0zx-dNFwpS6UngbTrI6KfwA,2148
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=6mN2xRg5XEqsLaXPUqdNGgDR1Ats60fBK93WlDeB8EI,13002
+maps4fs/generator/background.py,sha256=AP-Z3F-4I9achvA9xsaXAAoA6IHtmPLxb1RkUsVYdbg,14036
 maps4fs/generator/component.py,sha256=ZEDjChPnvqAsgnBu2f2YBOlwGOlfax4VaAYBcJerLIQ,10684
 maps4fs/generator/config.py,sha256=ZO5BWDU-S3p0-ndKDSFa8Oin3YcYy0iH8B4lqEA_07Q,4275
-maps4fs/generator/dem.py,sha256=p7THncPUdYWtNR2HrTXe0bCuJ8psUV8rRpYPJkzL2gA,15220
+maps4fs/generator/dem.py,sha256=XLpzjJMPZCxjrF-AhwTeEb-OQoCHEtYdK0b8z3Gb-is,15712
 maps4fs/generator/game.py,sha256=94HjPNOyy6XSSOnBp-uxrkBglKyC-X3ULIrrucfdlKw,6825
 maps4fs/generator/i3d.py,sha256=UuQiQRusPQ2f6PvGKxJ_UZeXsx3uG15efmy8Ysnm3F8,3597
 maps4fs/generator/map.py,sha256=v8OOLmhAkgqq64tQgEDbV6DmbgOVm3NXJBDDy0nJf60,4226
 maps4fs/generator/path_steps.py,sha256=yeN6hmOD8O2LMozUf4HcQMIy8WJ5sHF5pGQT_s2FfOw,3147
-maps4fs/generator/qgis.py,sha256=vhV-EwZKK-p1qEV-2H_yckuktx8ezlCMnmJJfUt1HGI,6091
+maps4fs/generator/qgis.py,sha256=R5Iv3ovyLXkhAL5Oy41u3ZLNOSEbc1byLetzPootO7o,6091
 maps4fs/generator/texture.py,sha256=CwaXZfAG4e3D3YR7yVR2MC677EHpbUWTboCS3G6jkhk,17723
 maps4fs/generator/tile.py,sha256=3vmfjQiPiiUZKPuIo5tg2rOKkgcP1NRVkMGK-Vo10-A,2138
-maps4fs-0.9.4.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.9.4.dist-info/METADATA,sha256=WVUjB4PmrCnuWZNIVurx3_1XPqS2oBEwWdVaU22uX2Y,24130
-maps4fs-0.9.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.9.4.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.9.4.dist-info/RECORD,,
+maps4fs-0.9.7.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.9.7.dist-info/METADATA,sha256=dhMICyAhvj7SiKMKyK_-ewOb07j38R574o9SMezErYE,24635
+maps4fs-0.9.7.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-0.9.7.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.9.7.dist-info/RECORD,,