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

maps4fs/generator/component/base/component_xml.py

@@ -35,7 +35,7 @@ class XMLComponent(Component):
         if not os.path.isfile(xml_path):
             raise FileNotFoundError(f"XML file {xml_path} does not exist.")
 
-        return ET.parse(xml_path)
+        return ET.parse(xml_path)  # type: ignore
 
     def save_tree(self, tree: ET.ElementTree, xml_path: str | None = None) -> None:
         """Saves the XML tree to the file.

maps4fs/generator/component/config.py

@@ -40,7 +40,7 @@ class Config(XMLComponent):
             "height": str(self.scaled_size),
         }
 
-        for element in root.iter("map"):
+        for element in root.iter("map"):  # type: ignore
             self.update_element(element, data)
             break
         self.save_tree(tree)

maps4fs/generator/component/grle.py

@@ -204,7 +204,7 @@ class GRLE(ImageComponent, XMLComponent):
 
         tree = self.get_tree()
         root = tree.getroot()
-        farmlands_node = root.find("farmlands")
+        farmlands_node = root.find("farmlands")  # type: ignore
         if farmlands_node is None:
             raise ValueError("Farmlands XML element not found in the farmlands XML file.")
 

maps4fs/generator/component/i3d.py

@@ -85,8 +85,8 @@ class I3d(XMLComponent):
 
         data = {"heightScale": str(value)}
 
-        self.get_and_update_element(root, path, data)
-        self.save_tree(tree)
+        self.get_and_update_element(root, path, data)  # type: ignore
+        self.save_tree(tree)  # type: ignore
 
     def _update_parameters(self) -> None:
         """Updates the map I3D file with the  sun bounding box and displacement layer size."""
@@ -101,11 +101,11 @@ class I3d(XMLComponent):
             "lastShadowMapSplitBboxMax": f"{distance},148,{distance}",
         }
 
-        self.get_and_update_element(root, sun_element_path, data)
+        self.get_and_update_element(root, sun_element_path, data)  # type: ignore
 
         displacement_layer_path = ".//Scene/TerrainTransformGroup/Layers/DisplacementLayer"
         data = {"size": str(int(self.map_size * 8))}
-        self.get_and_update_element(root, displacement_layer_path, data)
+        self.get_and_update_element(root, displacement_layer_path, data)  # type: ignore
 
         self.save_tree(tree)
 
@@ -125,9 +125,9 @@ class I3d(XMLComponent):
 
         root = tree.getroot()
         # Find <Shapes> element in the I3D file.
-        shapes_node = root.find(".//Shapes")
+        shapes_node = root.find(".//Shapes")  # type: ignore
         # Find <Scene> element in the I3D file.
-        scene_node = root.find(".//Scene")
+        scene_node = root.find(".//Scene")  # type: ignore
 
         if shapes_node is None or scene_node is None:
             self.logger.warning("Shapes or Scene node not found in I3D file.")
@@ -145,7 +145,7 @@ class I3d(XMLComponent):
                 interpolation=cv2.INTER_NEAREST,
             )
 
-        user_attributes_node = root.find(".//UserAttributes")
+        user_attributes_node = root.find(".//UserAttributes")  # type: ignore
         if user_attributes_node is None:
             self.logger.warning("UserAttributes node not found in I3D file.")
             return
@@ -240,12 +240,12 @@ class I3d(XMLComponent):
         self.logger.debug("Starging to add fields to the I3D file.")
 
         root = tree.getroot()
-        gameplay_node = root.find(".//TransformGroup[@name='gameplay']")
+        gameplay_node = root.find(".//TransformGroup[@name='gameplay']")  # type: ignore
 
         if gameplay_node is None:
             return
         fields_node = gameplay_node.find(".//TransformGroup[@name='fields']")
-        user_attributes_node = root.find(".//UserAttributes")
+        user_attributes_node = root.find(".//UserAttributes")  # type: ignore
 
         if fields_node is None or user_attributes_node is None:
             return
@@ -497,7 +497,7 @@ class I3d(XMLComponent):
 
             tree = self.get_tree()
             root = tree.getroot()
-            scene_node = root.find(".//Scene")
+            scene_node = root.find(".//Scene")  # type: ignore
             if scene_node is None:
                 self.logger.warning("Scene element not found in I3D file.")
                 return

maps4fs/generator/map.py

@@ -226,8 +226,8 @@ class Map:
                 self.rotation,
                 self.map_directory,
                 self.logger,
-                texture_custom_schema=self.texture_custom_schema,
-                tree_custom_schema=self.tree_custom_schema,
+                texture_custom_schema=self.texture_custom_schema,  # type: ignore
+                tree_custom_schema=self.tree_custom_schema,  # type: ignore
             )
             self.components.append(component)
 

maps4fs/toolbox/background.py

@@ -1,5 +1,7 @@
 """This module contains functions to work with the background terrain of the map."""
 
+import warnings
+
 import cv2
 import numpy as np
 import trimesh  # type: ignore
@@ -22,6 +24,13 @@ def plane_from_np(
             will result in a simpler mesh.
         save_path (str) -- The path to save the obj file.
     """
+    warnings.warn(
+        "The 'plane_from_np' function is deprecated and will be removed in maps4fs 2.0. "
+        "Use 'trimesh' directly instead or maps4fs.generator.component.base.component_mesh."
+        "MeshComponent.mesh_from_np' instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     dem_data = cv2.resize(dem_data, (0, 0), fx=resize_factor, fy=resize_factor)
 
     # Invert the height values.

maps4fs/toolbox/custom_osm.py

@@ -1,6 +1,7 @@
 """This module contains functions to work with custom OSM files."""
 
 import json
+import warnings
 from xml.etree import ElementTree as ET
 
 import osmnx as ox
@@ -19,6 +20,13 @@ def check_osm_file(file_path: str) -> bool:
     Returns:
         bool: True if the file is valid, False otherwise.
     """
+    warnings.warn(
+        "The 'check_osm_file' function is deprecated and will be removed in maps4fs 2.0. "
+        "The feature will be directly integrated into the maps4fs generator. "
+        "And will not be available as a separate function.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     with open(FS25().texture_schema, encoding="utf-8") as f:
         schema = json.load(f)
 
@@ -50,6 +58,13 @@ def fix_osm_file(input_file_path: str, output_file_path: str) -> tuple[bool, int
         tuple[bool, int]: A tuple containing the result of the check_osm_file function
             and the number of fixed errors.
     """
+    warnings.warn(
+        "The 'fix_osm_file' function is deprecated and will be removed in maps4fs 2.0. "
+        "The feature will be directly integrated into the maps4fs generator. "
+        "And will not be available as a separate function.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     broken_entries = ["relation", ".//*[@action='delete']"]
 
     tree = ET.parse(input_file_path)

maps4fs/toolbox/dem.py

@@ -1,6 +1,7 @@
 """This module contains functions for working with Digital Elevation Models (DEMs)."""
 
 import os
+import warnings
 
 import rasterio  # type: ignore
 from pyproj import Transformer
@@ -21,6 +22,12 @@ def read_geo_tiff(file_path: str) -> DatasetReader:
     Returns:
         DatasetReader: The DatasetReader object for the GeoTIFF file.
     """
+    warnings.warn(
+        "The 'read_geo_tiff' function is deprecated and will be removed in maps4fs 2.0. "
+        "Use 'rasterio.open' directly instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     if not os.path.isfile(file_path):
         raise FileNotFoundError(f"File not found: {file_path}")
 
@@ -51,6 +58,12 @@ def get_geo_tiff_bbox(
         tuple[float, float, float, float]: The bounding box in the destination CRS
             as (north, south, east, west).
     """
+    warnings.warn(
+        "The 'get_geo_tiff_bbox' function is deprecated and will be removed in maps4fs 2.0. "
+        "Use 'rasterio' methods directly instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     left, bottom, right, top = src.bounds
 
     transformer = Transformer.from_crs(src.crs, dst_crs, always_xy=True)
@@ -76,6 +89,12 @@ def extract_roi(file_path: str, bbox: tuple[float, float, float, float]) -> str:
     Returns:
         str: The path to the new GeoTIFF file containing the extracted ROI.
     """
+    warnings.warn(
+        "The 'extract_roi' function is deprecated and will be removed in maps4fs 2.0. "
+        "Use 'rasterio' methods directly instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
     with rasterio.open(file_path) as src:
         transformer = Transformer.from_crs("EPSG:4326", src.crs, always_xy=True)
         north, south, east, west = bbox

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 1.9.2
+Version: 1.9.3
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -29,6 +29,18 @@ 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).  
+⚠️ Some components are deprecated and there are major changes in the project structure.
+
+
+<p align="center">
+<a href="https://github.com/iwatkot/maps4fs">maps4fs</a> •
+<a href="https://github.com/iwatkot/maps4fsui">maps4fs UI</a> •
+<a href="https://github.com/iwatkot/maps4fsapi">maps4fs API</a> •
+<a href="https://github.com/iwatkot/maps4fsstats">maps4fs Stats</a> •
+<a href="https://github.com/iwatkot/maps4fsbot">maps4fs Bot</a>
+</p>
+
 <div align="center" markdown>
 <a href="https://discord.gg/Sj5QKKyE42">
 <img src="https://github.com/user-attachments/assets/37043333-d6ef-4ca3-9f3c-81323d9d0b71">
@@ -41,7 +53,7 @@ Dynamic: license-file
   <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> •
+  <a href="#Schemas-Editor">Schemas Editor</a> •
   <a href="#Main-Settings">Main Settings</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -69,7 +81,6 @@ Dynamic: license-file
 [![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/b922fd0a7188d37e61de/test_coverage)](https://codeclimate.com/github/iwatkot/maps4fs/test_coverage)
 [![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)<br>
-[![Lines of code](https://tokei.rs/b1/github/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs)
 
 </div>
 
@@ -92,7 +103,6 @@ Dynamic: license-file
 🔷 Generates \*.obj files for background terrain based on the real-world height map<br>
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 📕 Detailed [documentation](/docs) and tutorials <br>
-🧰 Modder Toolbox to help you with various tasks <br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -326,32 +336,12 @@ The map will be saved in the `map_directory` directory.
 
 ➡️ Check out the [demo.py](demo.py) file for a complete example.
 
-## Modder Toolbox
-
-The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
-
-![Modder Toolbox](https://github.com/user-attachments/assets/dffb252f-f5c0-4021-9d45-31e5bccc0d9b)
-
-### Tool Categories
-
-Tools are divided into categories, which are listed below.
-
-#### For custom schemas
+## Schemas Editor
 
 - **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.
 
 - **Texture Schema Editor** - allows you to view all the supported textures and edit their parameters, such as priority, OSM tags and so on. After editing, 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 updated textures.
 
-#### For Textures and DEM
-
-- **Fix custom OSM file** - this tool fixes the most common errors in the custom OSM file, but it can not guarantee that the file will be fixed completely if some non-common errors are present.
-
-- **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.
-
-#### For Background terrain
-
-- **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

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

@@ -2,16 +2,16 @@ maps4fs/__init__.py,sha256=EGvLVoRpSt4jITswsGbe1ISVmGAZAMQJcBmTwtyuVxI,335
 maps4fs/logger.py,sha256=HQrDyj72mUjVYo25aR_-_SxVn2rfFjDCNbj-JKJdSnE,1488
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/generator/game.py,sha256=NZaxj5z7WzMiHzAvQyr-TvVjGoHgqGldM6ZsItuYyzA,11292
-maps4fs/generator/map.py,sha256=XYKzhr2SuC3ILty1RYfaWkxUr9VJF3FkpWJ6-dTwzB8,13896
+maps4fs/generator/map.py,sha256=CaRfesYIZa801cKbTEwb-WdUYZcFQ_9dn_j1ij6VmhE,13928
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
 maps4fs/generator/settings.py,sha256=E5sfkfJgcjh9QHpa7ILlV_jnrF6USpsOFxkooVnxrbs,6968
 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/config.py,sha256=dEezqrDJ9ghEvJ1Y2jdL-v7ezgeeTN415Fcr_vBQmqg,3680
+maps4fs/generator/component/config.py,sha256=IP530sapLofFskSnBEB96G0aUSd6Sno0G9ET3ca0ZOQ,3696
 maps4fs/generator/component/dem.py,sha256=Bvm3ViA6PpR7RXRAHBj5rgYB9PWy55Qj6PhTMv6dJRI,11953
-maps4fs/generator/component/grle.py,sha256=xwuwkqVDvxQL6r9E5pytIcPH0HsgHI7ZYGmCcyfd8Pc,19484
-maps4fs/generator/component/i3d.py,sha256=432LJWfOcY4rPXc2tb3okCRJ_DD9wgIHt0u0nqJBhJI,23617
+maps4fs/generator/component/grle.py,sha256=zzQsTrSoGE8hIESRIMJMHggVJzohUzCgaFlCBl7k58Q,19500
+maps4fs/generator/component/i3d.py,sha256=OvcvRnsLjqo059R3nClJ4PNGaCyh7-1aFyGFmC8Jivo,23777
 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
@@ -19,7 +19,7 @@ maps4fs/generator/component/base/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX5
 maps4fs/generator/component/base/component.py,sha256=13ZjIatyxmxfcpE89cqlpQ6IBppJTeUisIEVa344eqM,21833
 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=6OO1dKoceO1ACk7-k1oGtnkfNud8ZN3u3ZNjdNMpTqw,3967
+maps4fs/generator/component/base/component_xml.py,sha256=V9pGUvHh6UF6BP0qFARqDq9vquoAgq1zJqhOgBoeS_Y,3983
 maps4fs/generator/dtm/__init__.py,sha256=CzK8ZdLU5Iv7DrwK5hIQ41zVsLRFgZO-IuRxf-NCVqg,1516
 maps4fs/generator/dtm/arctic.py,sha256=LSivLLjtd6TJUaPYvgSYQ4KalMTaY58zFvwivSh45uM,2587
 maps4fs/generator/dtm/baden.py,sha256=PQTMEPm9hrO3nKbv_DXA9oNYnGK_0ei41Q_DhtethX0,1041
@@ -51,11 +51,11 @@ maps4fs/generator/dtm/utils.py,sha256=I-wUSA_J85Xbt8sZCZAVKHSIcrMj5Ng-0adtPVhVmk
 maps4fs/generator/dtm/base/wcs.py,sha256=lQAp_gVz9_XUmtyobJkskiefQpuJH4o1Vwb3CSQ0lQA,2510
 maps4fs/generator/dtm/base/wms.py,sha256=6Va2UMhg_s0TMOfMhxrPbsiAPiw6-vXBglnaij032I0,2264
 maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/toolbox/background.py,sha256=RclEqxEWLbMxuEkkegQP8jybzugwQ1_R3rdfDe0s21U,2104
-maps4fs/toolbox/custom_osm.py,sha256=X6ZlPqiOhNjkmdD_qVroIfdOl9Rb90cDwVSLDVYgx80,1892
-maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.9.2.dist-info/licenses/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.9.2.dist-info/METADATA,sha256=JbEQlBdtwmVmxgKqAX18yn6PFBwmyQrFGOo4ZJLa8iI,50476
-maps4fs-1.9.2.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-maps4fs-1.9.2.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.9.2.dist-info/RECORD,,
+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.2.dist-info → maps4fs-1.9.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any