maps4fs 1.7.1__tar.gz → 1.7.5__tar.gz

{maps4fs-1.7.1 → maps4fs-1.7.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.7.1
+Version: 1.7.5
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -36,7 +36,6 @@ Requires-Dist: pydantic
   <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/tips_and_hints.md">Tips and Hints</a> •
   <a href="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -141,7 +140,7 @@ Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 ```bash
 pip install maps4fs
 ```
-And refer to the [Python package](#option-3-python-package) section to learn how to use it.<br>
+And refer to the [Python package or run from the source](#option-3-python-package-or-source-code) section to learn how to use it.<br>
 
 ## Overview
 The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
@@ -201,7 +200,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
 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.
 
-### Option 3: Python package
+### Option 3: Python package or source code
 🔴 Recommended for developers.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
 ⚙️ Advanced settings: enabled.   
@@ -212,11 +211,50 @@ You can use the Python package to generate maps. Follow these steps:
 ```bash
 pip install maps4fs
 ```
+
+Or clone the repository and install the package from the source code:
+```bash
+git clone https://github.com/iwatkot/maps4fs.git
+cd maps4fs
+dev/create_venv.ps1 # for Windows
+sh dev/create_venv.sh # for Linux
+
+# Activate the virtual environment.
+./venv/scripts/activate # for Windows
+source venv/bin/activate # for Linux
+
+# Edit the demo.py file to set the parameters.
+python demo.py
+```
+
+
 2. Import the Game class and create an instance of it:
 ```python
 import maps4fs as mfs
 
-game = mfs.Game.from_code("FS25")
+game_code = "fs25"
+game = mfs.Game.from_code(game_code)
+
+dtm_provider = mfs.SRTM30Provider
+dtm_provider_settings = mfs.SRTM30ProviderSettings(easy_mode=True, power_factor=0)
+
+lat, lon = 45.28, 20.23
+coordinates = (lat, lon)
+size = 2048
+rotation = 25
+
+map_directory = "map_directory"
+os.makedirs(map_directory, exist_ok=True)
+
+mp = mfs.Map(
+    game,
+    dtm_provider,
+    dtm_provider_settings,
+    coordinates,
+    size,
+    rotation,
+    map_directory,
+)
 ```
 In this case, the library will use the default templates, which should be present in the `data` directory, which should be placed in the current working directory.<br>
 Structure example:<br>
@@ -229,28 +267,17 @@ Structure example:<br>
 
 So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
 
-3. Create an instance of the Map class:
-```python
-import maps4fs as mfs
-
-map = mfs.Map(
-  game,
-  (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  height=1024,  # The height of the map in meters.
-  width=1024,  # The width of the map in meters.
-  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-)
-```
-
-4. Generate the map:
+3. Launch the generation process.  
 The `generate` method returns a generator, which yields the active component of the map. You can use it to track the progress of the generation process.
 ```python
-for active_component in map.generate():
-    print(active_component)
+for component_name in mp.generate():
+    print(f"Generating {component_name}...")
 ```
 
 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>
 
@@ -265,6 +292,9 @@ Tools are divided into categories, which are listed below.
 - **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

{maps4fs-1.7.1 → maps4fs-1.7.5}/README.md

@@ -10,7 +10,6 @@
   <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/tips_and_hints.md">Tips and Hints</a> •
   <a href="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -115,7 +114,7 @@ Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 ```bash
 pip install maps4fs
 ```
-And refer to the [Python package](#option-3-python-package) section to learn how to use it.<br>
+And refer to the [Python package or run from the source](#option-3-python-package-or-source-code) section to learn how to use it.<br>
 
 ## Overview
 The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
@@ -175,7 +174,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
 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.
 
-### Option 3: Python package
+### Option 3: Python package or source code
 🔴 Recommended for developers.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
 ⚙️ Advanced settings: enabled.   
@@ -186,11 +185,50 @@ You can use the Python package to generate maps. Follow these steps:
 ```bash
 pip install maps4fs
 ```
+
+Or clone the repository and install the package from the source code:
+```bash
+git clone https://github.com/iwatkot/maps4fs.git
+cd maps4fs
+dev/create_venv.ps1 # for Windows
+sh dev/create_venv.sh # for Linux
+
+# Activate the virtual environment.
+./venv/scripts/activate # for Windows
+source venv/bin/activate # for Linux
+
+# Edit the demo.py file to set the parameters.
+python demo.py
+```
+
+
 2. Import the Game class and create an instance of it:
 ```python
 import maps4fs as mfs
 
-game = mfs.Game.from_code("FS25")
+game_code = "fs25"
+game = mfs.Game.from_code(game_code)
+
+dtm_provider = mfs.SRTM30Provider
+dtm_provider_settings = mfs.SRTM30ProviderSettings(easy_mode=True, power_factor=0)
+
+lat, lon = 45.28, 20.23
+coordinates = (lat, lon)
+size = 2048
+rotation = 25
+
+map_directory = "map_directory"
+os.makedirs(map_directory, exist_ok=True)
+
+mp = mfs.Map(
+    game,
+    dtm_provider,
+    dtm_provider_settings,
+    coordinates,
+    size,
+    rotation,
+    map_directory,
+)
 ```
 In this case, the library will use the default templates, which should be present in the `data` directory, which should be placed in the current working directory.<br>
 Structure example:<br>
@@ -203,28 +241,17 @@ Structure example:<br>
 
 So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
 
-3. Create an instance of the Map class:
-```python
-import maps4fs as mfs
-
-map = mfs.Map(
-  game,
-  (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  height=1024,  # The height of the map in meters.
-  width=1024,  # The width of the map in meters.
-  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-)
-```
-
-4. Generate the map:
+3. Launch the generation process.  
 The `generate` method returns a generator, which yields the active component of the map. You can use it to track the progress of the generation process.
 ```python
-for active_component in map.generate():
-    print(active_component)
+for component_name in mp.generate():
+    print(f"Generating {component_name}...")
 ```
 
 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>
 
@@ -239,6 +266,9 @@ Tools are divided into categories, which are listed below.
 - **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

{maps4fs-1.7.1 → maps4fs-1.7.5}/maps4fs/__init__.py

@@ -1,7 +1,8 @@
 # pylint: disable=missing-module-docstring
 from maps4fs.generator.dtm.dtm import DTMProvider
-from maps4fs.generator.dtm.srtm import SRTM30Provider
-from maps4fs.generator.dtm.usgs import USGSProvider
+from maps4fs.generator.dtm.srtm import SRTM30Provider, SRTM30ProviderSettings
+from maps4fs.generator.dtm.usgs import USGSProvider, USGSProviderSettings
+from maps4fs.generator.dtm.nrw import NRWProvider, NRWProviderSettings
 from maps4fs.generator.game import Game
 from maps4fs.generator.map import Map
 from maps4fs.generator.settings import (
@@ -9,6 +10,7 @@ from maps4fs.generator.settings import (
     DEMSettings,
     GRLESettings,
     I3DSettings,
+    SatelliteSettings,
     SettingsModel,
     SplineSettings,
     TextureSettings,