maps4fs 2.1.9__py3-none-any.whl → 2.2.1__py3-none-any.whl

maps4fs/generator/config.py

@@ -1,15 +1,55 @@
 """This module contains configuration files for the maps4fs generator."""
 
 import os
+import shutil
 import subprocess
 
 from osmnx import settings as ox_settings
 
+from maps4fs.logger import Logger
+
+logger = Logger()
+
+DEFAULT_TEMPLATES_DIR = os.path.join(os.getcwd(), "data")
+MFS_TEMPLATES_DIR = os.getenv("MFS_TEMPLATES_DIRECTORY")
+if MFS_TEMPLATES_DIR is None:
+    logger.info("MFS_TEMPLATES_DIRECTORY is not set. Using default templates directory.")
+    MFS_TEMPLATES_DIR = DEFAULT_TEMPLATES_DIR
+else:
+    logger.info("MFS_TEMPLATES_DIRECTORY is set to: %s", MFS_TEMPLATES_DIR)
+    if not os.path.isdir(MFS_TEMPLATES_DIR):
+        logger.info("Templates directory %s does not exist. Creating it.", MFS_TEMPLATES_DIR)
+        os.makedirs(MFS_TEMPLATES_DIR, exist_ok=True)
+
+    # Check if there any files (directory is empty).
+    if not os.listdir(MFS_TEMPLATES_DIR):
+        logger.info("Templates directory %s is empty. Copying default files.", MFS_TEMPLATES_DIR)
+        for item in os.listdir(DEFAULT_TEMPLATES_DIR):
+            s = os.path.join(DEFAULT_TEMPLATES_DIR, item)
+            d = os.path.join(MFS_TEMPLATES_DIR, item)
+            if os.path.isdir(s):
+                shutil.copytree(s, d, False, None)
+            else:
+                shutil.copy2(s, d)
+        logger.info("Default files copied to %s.", MFS_TEMPLATES_DIR)
+    else:
+        logger.warning(
+            "Templates directory %s is not empty. Will not copy default files. "
+            "Ensure that the directory contains the necessary template files.",
+            MFS_TEMPLATES_DIR,
+        )
+
 MFS_ROOT_DIR = os.getenv("MFS_ROOT_DIRECTORY", os.path.join(os.getcwd(), "mfsrootdir"))
 MFS_CACHE_DIR = os.path.join(MFS_ROOT_DIR, "cache")
 MFS_DATA_DIR = os.path.join(MFS_ROOT_DIR, "data")
 os.makedirs(MFS_CACHE_DIR, exist_ok=True)
 os.makedirs(MFS_DATA_DIR, exist_ok=True)
+logger.info(
+    "MFS_ROOT_DIR: %s. MFS_CACHE_DIR: %s. MFS_DATA_DIR: %s.",
+    MFS_ROOT_DIR,
+    MFS_CACHE_DIR,
+    MFS_DATA_DIR,
+)
 
 DTM_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "dtm")
 SAT_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "sat")
@@ -50,3 +90,4 @@ def get_package_version(package_name: str) -> str:
 
 
 PACKAGE_VERSION = get_package_version("maps4fs")
+logger.info("maps4fs version: %s", PACKAGE_VERSION)

maps4fs/generator/game.py

@@ -6,6 +6,7 @@ from __future__ import annotations
 
 import os
 
+import maps4fs.generator.config as mfscfg
 from maps4fs.generator.component.background import Background
 from maps4fs.generator.component.config import Config
 from maps4fs.generator.component.grle import GRLE
@@ -13,8 +14,6 @@ from maps4fs.generator.component.i3d import I3d
 from maps4fs.generator.component.satellite import Satellite
 from maps4fs.generator.component.texture import Texture
 
-working_directory = os.getcwd()
-
 
 class Game:
     """Class used to define different versions of the game for which the map is generated.
@@ -34,10 +33,10 @@ class Game:
     code: str | None = None
     dem_multipliyer: int = 2
     _additional_dem_name: str | None = None
-    _map_template_path: str | None = None
-    _texture_schema: str | None = None
-    _grle_schema: str | None = None
-    _tree_schema: str | None = None
+    _map_template_file: str | None = None
+    _texture_schema_file: str | None = None
+    _grle_schema_file: str | None = None
+    _tree_schema_file: str | None = None
     _i3d_processing: bool = True
     _plants_processing: bool = True
     _environment_processing: bool = True
@@ -50,6 +49,27 @@ class Game:
     def __init__(self, map_template_path: str | None = None):
         if map_template_path:
             self._map_template_path = map_template_path
+        else:
+            if not self._map_template_file:
+                raise ValueError("Map template file not set.")
+            self._map_template_path = os.path.join(
+                mfscfg.MFS_TEMPLATES_DIR, self._map_template_file  # type: ignore
+            )
+
+        if not self._texture_schema_file:
+            self._texture_schema = None
+        else:
+            self._texture_schema = os.path.join(mfscfg.MFS_TEMPLATES_DIR, self._texture_schema_file)  # type: ignore
+
+        if not self._grle_schema_file:
+            self._grle_schema = None
+        else:
+            self._grle_schema = os.path.join(mfscfg.MFS_TEMPLATES_DIR, self._grle_schema_file)  # type: ignore
+
+        if not self._tree_schema_file:
+            self._tree_schema = None
+        else:
+            self._tree_schema = os.path.join(mfscfg.MFS_TEMPLATES_DIR, self._tree_schema_file)  # type: ignore
 
     def set_components_by_names(self, component_names: list[str]) -> None:
         """Sets the components used for map generation by their names.
@@ -297,8 +317,8 @@ class FS22(Game):
     """Class used to define the game version FS22."""
 
     code = "FS22"
-    _map_template_path = os.path.join(working_directory, "data", "fs22-map-template.zip")
-    _texture_schema = os.path.join(working_directory, "data", "fs22-texture-schema.json")
+    _map_template_file = "fs22-map-template.zip"
+    _texture_schema_file = "fs22-texture-schema.json"
     _i3d_processing = False
     _environment_processing = False
     _fog_processing = False
@@ -342,10 +362,10 @@ class FS25(Game):
     code = "FS25"
     dem_multipliyer: int = 2
     _additional_dem_name = "unprocessedHeightMap.png"
-    _map_template_path = os.path.join(working_directory, "data", "fs25-map-template.zip")
-    _texture_schema = os.path.join(working_directory, "data", "fs25-texture-schema.json")
-    _grle_schema = os.path.join(working_directory, "data", "fs25-grle-schema.json")
-    _tree_schema = os.path.join(working_directory, "data", "fs25-tree-schema.json")
+    _map_template_file = "fs25-map-template.zip"
+    _texture_schema_file = "fs25-texture-schema.json"
+    _grle_schema_file = "fs25-grle-schema.json"
+    _tree_schema_file = "fs25-tree-schema.json"
 
     def dem_file_path(self, map_directory: str) -> str:
         """Returns the path to the DEM file.

maps4fs/generator/map.py

@@ -96,6 +96,7 @@ class Map:
                 "longitude": coordinates[1],
                 "country": self.get_country_by_coordinates(),
                 "size": size,
+                "output_size": self.output_size,
                 "rotation": rotation,
                 "dtm_provider": dtm_provider.name(),
                 "custom_osm": bool(custom_osm),

maps4fs/generator/settings.py

@@ -307,6 +307,7 @@ class MainSettings(NamedTuple):
     longitude: float
     country: str
     size: int
+    output_size: int | None
     rotation: int
     dtm_provider: str
     custom_osm: bool
@@ -342,6 +343,7 @@ class MainSettings(NamedTuple):
             "longitude": self.longitude,
             "country": self.country,
             "size": self.size,
+            "output_size": self.output_size,
             "rotation": self.rotation,
             "dtm_provider": self.dtm_provider,
             "custom_osm": self.custom_osm,

{maps4fs-2.1.9.dist-info → maps4fs-2.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.9
+Version: 2.2.1
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -45,7 +45,7 @@ Dynamic: license-file
 
 <div align="center" markdown>
 <a href="https://discord.gg/Sj5QKKyE42">
-<img src="https://github.com/user-attachments/assets/37043333-d6ef-4ca3-9f3c-81323d9d0b71">
+<img src="https://github.com/iwatkot/maps4fs/releases/download/2.2.0/maps4fs-poster-discord-mymaps.png">
 </a>
 
 <p align="center">
@@ -85,8 +85,10 @@ Dynamic: license-file
 
 </div>
 
+🔥🔥🔥🗂️ Track, store and organize all your maps using the [My Maps](docs/my_maps.md) feature. 🔥🔥🔥<br>
+<br>
 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
-🔗 Generate maps using an [API](https://github.com/iwatkot/maps4fsapi) 🆕<br>
+🔗 Generate maps using an [API](https://github.com/iwatkot/maps4fsapi)<br>
 ✂️ Supports map scaling<br>
 🔄 Support map rotation<br>
 🌐 Supports custom [DTM Providers](https://github.com/iwatkot/pydtmdl)<br>
@@ -158,6 +160,14 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
 ```
 
+If you want to persist your data, you can mount a directory to the container: 
+
+```bash
+docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
+```
+
+Learn more in the [My Maps](docs/my_maps.md) documentation.
+
 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>
@@ -212,8 +222,8 @@ Don't know where to start? Don't worry, just follow this [step-by-step guide](do
 🛠️ Don't need to install anything.  
 🗺️ Supported map sizes: 2x2, 4x4.  
 ✂️ Map scaling: not supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
+⚙️ Advanced settings: partial.  
+🖼️ Texture dissolving: disabled.  
 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.
 Note: due to CPU and RAM limitations of the hosting, the generation may take some time. If you need faster processing, use the [Docker version](#option-2-docker-version).<br>
 
@@ -240,6 +250,12 @@ You can launch the project with minimalistic UI in your browser using Docker. Fo
 docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
 ```
 
+If you want to persist your data, you can mount a directory to the container:
+
+```bash
+docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir 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.

{maps4fs-2.1.9.dist-info → maps4fs-2.2.1.dist-info}/RECORD

@@ -1,11 +1,11 @@
 maps4fs/__init__.py,sha256=Fy521EmVAWnhu6OvOInc97yrtJotFzcV0YfRB2b9O4s,314
 maps4fs/logger.py,sha256=6sem0aFKQqtVjQ_yNu9iGcc-hqzLQUhfxco05K6nqow,763
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/config.py,sha256=hBJqCay6mzV2h32EqTCFYywvrOuMpkvOCF9IDBBtO2U,1572
-maps4fs/generator/game.py,sha256=Qqeh1rg0RFghhu9uhBMn_XKXYkTkg7fsjY1xO2eIZRw,13777
-maps4fs/generator/map.py,sha256=VOJJYQYzSkk-ed38R__SoYpi50YUYWO8kpLeZ2TB6tM,19024
+maps4fs/generator/config.py,sha256=H63HqgpZG6M2wt2DnS-m44cDPiy_hd3qJubX8WZz5Ys,3185
+maps4fs/generator/game.py,sha256=nf6iuYNA5NJc-ir_WOgkw-MdJVgetVHeEtxbWJYt3Vo,14462
+maps4fs/generator/map.py,sha256=ATTRrsxvwao3kW1M-AGeFpyJGG3h-LuTDZjC5v1MDMY,19073
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
-maps4fs/generator/settings.py,sha256=8dN96L5Ueb5LxgJaKNv8-zH2Yym627o4Uj8zJYHfT8g,11312
+maps4fs/generator/settings.py,sha256=NukAt1s4CS0HEWmUcBPc8OiqkWqjts3AvvkX0APZKes,11385
 maps4fs/generator/statistics.py,sha256=aynS3zbAtiwnU_YLKHPTiiaKW98_suvQUhy1SGBA6mc,2448
 maps4fs/generator/component/__init__.py,sha256=s01yVVVi8R2xxNvflu2D6wTd9I_g73AMM2x7vAC7GX4,490
 maps4fs/generator/component/background.py,sha256=JANbVgcBXpaQ0HB1eeV16KkFgpU-Txj5kB5eJNEDAv0,34473
@@ -21,8 +21,8 @@ maps4fs/generator/component/base/component.py,sha256=AP7b6rmYV_HdyyHlCTo9s6fyBXy
 maps4fs/generator/component/base/component_image.py,sha256=WTGC6v1KuS5sLNCC95Z48nCspvATKKNOuhTNYzTWXr4,8315
 maps4fs/generator/component/base/component_mesh.py,sha256=3hC-qDT8Vde6SmRMqs9USAkrF-gL2dDTYW71ATpxUS4,9130
 maps4fs/generator/component/base/component_xml.py,sha256=MT-VhU2dEckLFxAgmxg6V3gnv11di_94Qq6atfpOLdc,5342
-maps4fs-2.1.9.dist-info/licenses/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-2.1.9.dist-info/METADATA,sha256=uoLUuvoiQTBBCtNxjsclHKtZ17gw3gmwLenCs8a1H6k,45431
-maps4fs-2.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maps4fs-2.1.9.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-2.1.9.dist-info/RECORD,,
+maps4fs-2.2.1.dist-info/licenses/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-2.2.1.dist-info/METADATA,sha256=cMaMkvanQQIYGtV3u0BV5CXZ9t4Jlm64ngl9DqVUf5w,46032
+maps4fs-2.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maps4fs-2.2.1.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-2.2.1.dist-info/RECORD,,