maps4fs 1.9.3__py3-none-any.whl → 1.9.5__py3-none-any.whl

maps4fs/generator/component/background.py

@@ -224,6 +224,8 @@ class Background(MeshComponent, ImageComponent):
         save_path = os.path.join(self.background_directory, f"{filename}.obj")
         self.logger.debug("Generating obj file in path: %s", save_path)
 
+        self.assets.background_mesh = save_path
+
         dem_data = cv2.imread(self.output_path, cv2.IMREAD_UNCHANGED)
 
         if self.map.output_size is not None:
@@ -279,6 +281,8 @@ class Background(MeshComponent, ImageComponent):
         cv2.imwrite(main_dem_path, resized_dem_data)
         self.logger.debug("DEM cutout saved: %s", main_dem_path)
 
+        self.assets.dem = main_dem_path
+
         return main_dem_path
 
     def plane_from_np(
@@ -321,8 +325,11 @@ class Background(MeshComponent, ImageComponent):
         self.logger.debug("Obj file saved: %s", save_path)
 
         if create_preview:
-            mesh.apply_scale([0.5, 0.5, 0.5])
-            self.mesh_to_stl(mesh, save_path=self.stl_preview_path)
+            try:
+                mesh.apply_scale([0.5, 0.5, 0.5])
+                self.mesh_to_stl(mesh, save_path=self.stl_preview_path)
+            except Exception as e:
+                self.logger.error("Could not create STL preview: %s", e)
 
     def update_mesh_info(self, save_path: str, mesh: Trimesh) -> None:
         """Updates the mesh info with the data from the mesh.
@@ -587,4 +594,6 @@ class Background(MeshComponent, ImageComponent):
         elevated_water = np.where(mask, background_dem, elevated_water)
         elevated_save_path = os.path.join(self.water_directory, "elevated_water.obj")
 
+        self.assets.water_mesh = elevated_save_path
+
         self.plane_from_np(elevated_water, elevated_save_path, include_zeros=False)

maps4fs/generator/component/base/component.py

@@ -20,6 +20,16 @@ if TYPE_CHECKING:
     from maps4fs.generator.map import Map
 
 
+class AttrDict(dict):
+    """A dictionary that allows attribute-style access to its keys."""
+
+    def __getattr__(self, name):
+        return self[name]
+
+    def __setattr__(self, name, value):
+        self[name] = value
+
+
 class Component:
     """Base class for all map generation components.
 
@@ -72,6 +82,8 @@ class Component:
         self.save_bbox()
         self.preprocess()
 
+        self.assets = AttrDict()
+
     def preprocess(self) -> None:
         """Prepares the component for processing. Must be implemented in the child class."""
         return

maps4fs/generator/component/grle.py

@@ -263,6 +263,8 @@ class GRLE(ImageComponent, XMLComponent):
 
         cv2.imwrite(info_layer_farmlands_path, image)
 
+        self.assets.farmlands = info_layer_farmlands_path
+
         self.preview_paths["farmlands"] = info_layer_farmlands_path
 
     def _add_plants(self) -> None:
@@ -362,6 +364,9 @@ class GRLE(ImageComponent, XMLComponent):
         # Ensure that order of channels is correct because CV2 uses BGR and we need RGB.
         density_map_fruits = cv2.cvtColor(density_map_fruits, cv2.COLOR_BGR2RGB)
         cv2.imwrite(density_map_fruit_path, density_map_fruits)
+
+        self.assets.plants = density_map_fruit_path
+
         self.logger.debug("Updated density map for fruits saved in %s.", density_map_fruit_path)
 
     def create_island_of_plants(self, image: np.ndarray, count: int) -> np.ndarray:

maps4fs/generator/component/i3d.py

@@ -222,6 +222,8 @@ class I3d(XMLComponent):
         tree.write(splines_i3d_path)  # type: ignore
         self.logger.debug("Splines I3D file saved to: %s.", splines_i3d_path)
 
+        self.assets.splines = splines_i3d_path
+
     def _add_fields(self) -> None:
         """Adds fields to the map I3D file."""
         tree = self.get_tree()
@@ -285,6 +287,8 @@ class I3d(XMLComponent):
 
         self.save_tree(tree)
 
+        self.assets.fields = self.xml_path
+
     def _get_field_xml_entry(
         self, field_id: int, field_ccs: list[tuple[int, int]], node_id: int
     ) -> tuple[ET.Element, int] | tuple[None, int]:
@@ -559,6 +563,8 @@ class I3d(XMLComponent):
             scene_node.append(trees_node)
             self.save_tree(tree)
 
+        self.assets.forests = self.xml_path
+
     @staticmethod
     def randomize_coordinates(
         coordinates: tuple[int, int], density: int, shift_percent: int

maps4fs/generator/component/satellite.py

@@ -59,9 +59,13 @@ class Satellite(ImageComponent):
         overview_size = (self.map_size + margin) * 2
         overwiew_path = os.path.join(self.satellite_directory, "satellite_overview.png")
 
+        self.assets.overview = overwiew_path
+
         background_size = self.map_size + (Parameters.BACKGROUND_DISTANCE + margin) * 2
         background_path = os.path.join(self.satellite_directory, "satellite_background.png")
 
+        self.assets.background = background_path
+
         sizes = [overview_size, background_size]
         self.image_paths = [overwiew_path, background_path]
 

maps4fs/generator/component/texture.py

@@ -149,6 +149,9 @@ class Texture(ImageComponent):
             self.dissolve()
         self.copy_procedural()
 
+        for layer in self.layers:
+            self.assets[layer.name] = layer.path(self._weights_dir)
+
     def add_borders(self) -> None:
         """Iterates over all the layers and picks the one which have the border propety defined.
         Borders are distance from the edge of the map on each side (top, right, bottom, left).
@@ -504,7 +507,7 @@ class Texture(ImageComponent):
 
             # Randomly assign non-zero values to sublayers.
             for coord in non_zero_coords:
-                sublayers[np.random.randint(0, layer.count)][coord[0], coord[1]] = 255
+                sublayers[np.random.randint(0, layer.count)][coord[0], coord[1]] = 255  # type: ignore
 
             # Save the sublayers.
             for sublayer, sublayer_path in zip(sublayers, layer_paths):

maps4fs/generator/game.py

@@ -49,6 +49,14 @@ class Game:
         if map_template_path:
             self._map_template_path = map_template_path
 
+    def set_components_by_names(self, component_names: list[str]) -> None:
+        """Sets the components used for map generation by their names.
+
+        Arguments:
+            component_names (list[str]): List of component names to be used.
+        """
+        self.components = [comp for comp in self.components if comp.__name__ in component_names]
+
     def map_xml_path(self, map_directory: str) -> str:
         """Returns the path to the map.xml file.
 

maps4fs/generator/map.py

@@ -58,7 +58,7 @@ class Map:
         **kwargs,
     ):
         if not logger:
-            logger = Logger(to_stdout=True, to_file=False)
+            logger = Logger()
         self.logger = logger
         self.size = size
 

maps4fs/generator/settings.py

@@ -145,6 +145,13 @@ class BackgroundSettings(SettingsModel):
         generate_water (bool): generate obj files for the water.
         resize_factor (int): resize factor for the background terrain and water.
             It will be used as 1 / resize_factor of the original size.
+        water_blurriness (int): blurriness of the water.
+        remove_center (bool): remove the center of the background terrain.
+            It will be used to remove the center of the map where the player starts.
+        apply_decimation (bool): apply decimation to the background terrain.
+        decimation_percent (int): percentage of the decimation.
+        decimation_agression (int): agression of the decimation.
+            It will be used to control the amount of decimation applied to the background terrain.
     """
 
     generate_background: bool = False

maps4fs/logger.py

@@ -3,7 +3,6 @@
 import logging
 import os
 import sys
-from datetime import datetime
 from typing import Literal
 
 LOGGER_NAME = "maps4fs"
@@ -12,35 +11,18 @@ os.makedirs(log_directory, exist_ok=True)
 
 
 class Logger(logging.Logger):
-    """Handles logging to the file and stroudt with timestamps."""
+    """Handles logging to stdout with timestamps."""
 
     def __init__(
         self,
         level: Literal["DEBUG", "INFO", "WARNING", "ERROR"] = "INFO",
         to_stdout: bool = True,
-        to_file: bool = True,
     ):
         super().__init__(LOGGER_NAME)
         self.setLevel(level)
         self.stdout_handler = logging.StreamHandler(sys.stdout)
-        self.file_handler = logging.FileHandler(
-            filename=self.log_file(), mode="a", encoding="utf-8"
-        )
         formatter = "%(name)s | %(levelname)s | %(asctime)s | %(message)s"
         self.fmt = formatter
         self.stdout_handler.setFormatter(logging.Formatter(formatter))
-        self.file_handler.setFormatter(logging.Formatter(formatter))
         if to_stdout:
             self.addHandler(self.stdout_handler)
-        if to_file:
-            self.addHandler(self.file_handler)
-
-    def log_file(self) -> str:
-        """Returns the path to the log file.
-
-        Returns:
-            str: The path to the log file.
-        """
-        today = datetime.now().strftime("%Y-%m-%d")
-        log_file = os.path.join(log_directory, f"{today}.txt")
-        return log_file

{maps4fs-1.9.3.dist-info → maps4fs-1.9.5.dist-info}/METADATA

@@ -1,22 +1,21 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 1.9.3
+Version: 1.9.5
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
-License: MIT License
+License: Apache License 2.0
 Project-URL: Homepage, https://github.com/iwatkot/maps4fs
 Project-URL: Repository, https://github.com/iwatkot/maps4fs
 Keywords: farmingsimulator,fs,farmingsimulator22,farmingsimulator25,fs22,fs25
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: License :: OSI Approved :: MIT License
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: opencv-python
 Requires-Dist: osmnx>=2.0.0
 Requires-Dist: rasterio
-Requires-Dist: folium
 Requires-Dist: geopy
 Requires-Dist: trimesh
 Requires-Dist: imageio
@@ -29,7 +28,7 @@ Requires-Dist: tqdm
 Requires-Dist: scipy
 Dynamic: license-file
 
-⚠️ Learn more about the upcoming 2.0.0 changes in the [migration guide](docs/migration.md).  
+⚠️ Learn more about the upcoming 2.0 changes in the [migration guide](docs/migration.md).  
 ⚠️ Some components are deprecated and there are major changes in the project structure.
 
 
@@ -52,7 +51,7 @@ Dynamic: license-file
   <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="docs/map_structure.md">Map Structure</a> •
   <a href="#Schemas-Editor">Schemas Editor</a> •
   <a href="#Main-Settings">Main Settings</a><br>
   <a href="#Supported-objects">Supported objects</a> •
@@ -85,7 +84,8 @@ Dynamic: license-file
 </div>
 
 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
-✂️ Supports map scaling 🆕<br>
+🔗 Generate maps using an [API](https://github.com/iwatkot/maps4fsapi) 🆕<br>
+✂️ Supports map scaling<br>
 🔄 Support map rotation<br>
 🌐 Supports custom [DTM Providers](#DTM-Providers)<br>
 🌾 Automatically generates fields<br>
@@ -156,7 +156,7 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 **Option 2:** Run the Docker version in your browser. Launch the following command in your terminal:
 
 ```bash
-docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
+docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
 ```
 
 And open [http://localhost:8501](http://localhost:8501) in your browser.<br>
@@ -238,21 +238,13 @@ You can launch the project with minimalistic UI in your browser using Docker. Fo
 2. Run the following command in your terminal:
 
 ```bash
-docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
+docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
 ```
 
 3. Open your browser and go to [http://localhost:8501](http://localhost:8501).
 4. Fill in the required fields and click on the `Generate` button.
 5. When the map is generated click on the `Download` button to get the map.
 
-➡️ If you don't need Blender backend, you can use the **lite** version of the Docker image.
-
-```bash
-docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs:*.*.*_lite
-```
-
-Remember to replace `*.*.*` with the version you want to use, e.g. `iwatkot/maps4fs:1.8.202_lite`. Also, pay attention that some features will not work in the lite version, such as removing the center part of the background mesh.
-
 ### Option 3: Python package or source code
 
 🔴 Recommended for developers.  

{maps4fs-1.9.3.dist-info → maps4fs-1.9.5.dist-info}/RECORD

@@ -1,22 +1,22 @@
 maps4fs/__init__.py,sha256=EGvLVoRpSt4jITswsGbe1ISVmGAZAMQJcBmTwtyuVxI,335
-maps4fs/logger.py,sha256=HQrDyj72mUjVYo25aR_-_SxVn2rfFjDCNbj-JKJdSnE,1488
+maps4fs/logger.py,sha256=WDfR14hxqy8b6xtwL6YIu2LGzFO1sbt0LxMgfsDTOkA,865
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/game.py,sha256=NZaxj5z7WzMiHzAvQyr-TvVjGoHgqGldM6ZsItuYyzA,11292
-maps4fs/generator/map.py,sha256=CaRfesYIZa801cKbTEwb-WdUYZcFQ_9dn_j1ij6VmhE,13928
+maps4fs/generator/game.py,sha256=g8lMHuuRRmJLSDsQTAMv8p_-qntYMiZKnAqn7ru96i0,11645
+maps4fs/generator/map.py,sha256=7-nx27M-VwTocPor8BCkkpthYBJYe_B-pe5_Dcsijaw,13899
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
-maps4fs/generator/settings.py,sha256=E5sfkfJgcjh9QHpa7ILlV_jnrF6USpsOFxkooVnxrbs,6968
+maps4fs/generator/settings.py,sha256=E_M47X2QhbBqgiNraBDQd62lAQlNWHYLq30HQ59_4k4,7490
 maps4fs/generator/statistics.py,sha256=aynS3zbAtiwnU_YLKHPTiiaKW98_suvQUhy1SGBA6mc,2448
 maps4fs/generator/component/__init__.py,sha256=s01yVVVi8R2xxNvflu2D6wTd9I_g73AMM2x7vAC7GX4,490
-maps4fs/generator/component/background.py,sha256=kt_RaLrj6hZeZaaFNT36jJyp9IofiN9CFsO8EYY7F7A,23756
+maps4fs/generator/component/background.py,sha256=AfbgNUai3tvpMe8lYmfiaM1n51ssunECy4gRglihumU,24032
 maps4fs/generator/component/config.py,sha256=IP530sapLofFskSnBEB96G0aUSd6Sno0G9ET3ca0ZOQ,3696
 maps4fs/generator/component/dem.py,sha256=Bvm3ViA6PpR7RXRAHBj5rgYB9PWy55Qj6PhTMv6dJRI,11953
-maps4fs/generator/component/grle.py,sha256=zzQsTrSoGE8hIESRIMJMHggVJzohUzCgaFlCBl7k58Q,19500
-maps4fs/generator/component/i3d.py,sha256=OvcvRnsLjqo059R3nClJ4PNGaCyh7-1aFyGFmC8Jivo,23777
+maps4fs/generator/component/grle.py,sha256=ao3-4B4QUVl0XgOmYAj9L48KGaZtCZRTB1BqYgdAJIc,19613
+maps4fs/generator/component/i3d.py,sha256=xTiZYQRahYBsVALxmnsBygzTHJLE54ucXvHK8LWCYAs,23914
 maps4fs/generator/component/layer.py,sha256=-br4gAGcGeBNb3ldch9XFEK0lhXqb1IbArhFB5Owu54,6186
-maps4fs/generator/component/satellite.py,sha256=oZBHjP_QY0ik1-Vk7JqMS__zIG8ffw2voeozB7-HUQc,4946
-maps4fs/generator/component/texture.py,sha256=tCMuuNcRwgdPkPVmNA7BCbnsTBnwkUXOrdlJJUoYAMU,33273
+maps4fs/generator/component/satellite.py,sha256=47V9aPbv7k-2C-PsoXd33EO92yavFzB6_MRCd7fLP6k,5042
+maps4fs/generator/component/texture.py,sha256=Nc_oOHX3b4vJm8FnNOn3W4EQGFkW0zW0rGzO_0nTJMM,33392
 maps4fs/generator/component/base/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/component/base/component.py,sha256=13ZjIatyxmxfcpE89cqlpQ6IBppJTeUisIEVa344eqM,21833
+maps4fs/generator/component/base/component.py,sha256=HeNDaToKrS6OLeJepKZA7iQzZQDYy-9QRtv1A73Ire0,22090
 maps4fs/generator/component/base/component_image.py,sha256=2NYJgCU8deHl7O2FYFYk38WKZVJygFoc2gjBXwH6vjM,5970
 maps4fs/generator/component/base/component_mesh.py,sha256=BsxS5NlUK2hLhksgCwSoMK-00GNAwK2fYGpgb3R4n1w,9396
 maps4fs/generator/component/base/component_xml.py,sha256=V9pGUvHh6UF6BP0qFARqDq9vquoAgq1zJqhOgBoeS_Y,3983
@@ -54,8 +54,8 @@ maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,4
 maps4fs/toolbox/background.py,sha256=RB0pHuRyfnDuqYtO2gUypfPm4G5cYRFdT2W-DG49zy0,2427
 maps4fs/toolbox/custom_osm.py,sha256=fjVSl9Ztc8_q0DxgNkhM7tE0Y-XpX8xcGGW-Tunp0R8,2518
 maps4fs/toolbox/dem.py,sha256=mbn3ZqMRhhYmzgssm2CGvg6aa89MUBOJPq6QyE54OLY,4191
-maps4fs-1.9.3.dist-info/licenses/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.9.3.dist-info/METADATA,sha256=a4q4ZRFsuBGoiARtZHJurqD06CO4GHmPgFEdIoMKME0,49704
-maps4fs-1.9.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maps4fs-1.9.3.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.9.3.dist-info/RECORD,,
+maps4fs-1.9.5.dist-info/licenses/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.9.5.dist-info/METADATA,sha256=XD5fgbYz1HyY35sFP_JpZB16jBHRwwO0h8bo8bDgsCM,49396
+maps4fs-1.9.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maps4fs-1.9.5.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.9.5.dist-info/RECORD,,