maps4fs 0.6.7__py3-none-any.whl → 0.7.0__py3-none-any.whl

maps4fs/generator/component.py

@@ -53,3 +53,11 @@ class Component:
             NotImplementedError: If the method is not implemented in the child class.
         """
         raise NotImplementedError
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images. Must be implemented in the child class.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in the child class.
+        """
+        raise NotImplementedError

maps4fs/generator/config.py

@@ -42,3 +42,12 @@ class Config(Component):
             self.logger.debug("Map size set to %sx%s in Map XML file.", width, height)
         tree.write(self._map_xml_path)
         self.logger.debug("Map XML file saved to: %s.", self._map_xml_path)
+
+    def previews(self) -> list[str]:
+        """Returns a list of paths to the preview images (empty list).
+        The component does not generate any preview images so it returns an empty list.
+
+        Returns:
+            list[str]: An empty list.
+        """
+        return []

maps4fs/generator/dem.py

@@ -205,3 +205,43 @@ class DEM(Component):
             f"DEM data was normalized to {normalized_data.min()} - {normalized_data.max()}."
         )
         return normalized_data
+
+    def grayscale_preview(self) -> str:
+        """Converts DEM image to grayscale RGB image and saves it to the map directory.
+        Returns path to the preview image.
+
+        Returns:
+            str: Path to the preview image.
+        """
+        rgb_dem_path = self._dem_path.replace(".png", "_grayscale.png")
+        dem_data = cv2.imread(self._dem_path, cv2.IMREAD_GRAYSCALE)
+        dem_data_rgb = cv2.cvtColor(dem_data, cv2.COLOR_GRAY2RGB)
+        cv2.imwrite(rgb_dem_path, dem_data_rgb)
+        return rgb_dem_path
+
+    def colored_preview(self) -> str:
+        """Converts DEM image to colored RGB image and saves it to the map directory.
+        Returns path to the preview image.
+
+        Returns:
+            list[str]: List with a single path to the DEM file
+        """
+
+        colored_dem_path = self._dem_path.replace(".png", "_colored.png")
+        dem_data = cv2.imread(self._dem_path, cv2.IMREAD_GRAYSCALE)
+
+        # Normalize the DEM data to the range [0, 255]
+        # dem_data_normalized = cv2.normalize(dem_data, None, 0, 255, cv2.NORM_MINMAX)
+
+        dem_data_colored = cv2.applyColorMap(dem_data, cv2.COLORMAP_JET)
+
+        cv2.imwrite(colored_dem_path, dem_data_colored)
+        return colored_dem_path
+
+    def previews(self) -> list[str]:
+        """Get list of preview images.
+
+        Returns:
+            list[str]: List of preview images.
+        """
+        return [self.grayscale_preview(), self.colored_preview()]

maps4fs/generator/map.py

@@ -6,11 +6,12 @@ from typing import Any
 
 from tqdm import tqdm
 
+from maps4fs.generator.component import Component
 from maps4fs.generator.game import Game
 from maps4fs.logger import Logger
 
 
-# pylint: disable=R0913
+# pylint: disable=R0913, R0902
 class Map:
     """Class used to generate map using all components.
 
@@ -35,6 +36,7 @@ class Map:
         logger: Any = None,
     ):
         self.game = game
+        self.components: list[Component] = []
         self.coordinates = coordinates
         self.distance = distance
         self.map_directory = map_directory
@@ -84,7 +86,8 @@ class Map:
                         e,
                     )
                     raise e
-                setattr(self, game_component.__name__.lower(), component)
+                # setattr(self, game_component.__name__.lower(), component)
+                self.components.append(component)
 
                 pbar.update(1)
 
@@ -94,7 +97,13 @@ class Map:
         Returns:
             list[str]: List of preview images.
         """
-        return self.texture.previews()  # type: ignore # pylint: disable=no-member
+        # texture_previews = self.texture.previews()  # type: ignore # pylint: disable=no-member
+        # dem_previews = self.dem.previews()  # type: ignore # pylint: disable=no-member
+        # return texture_previews + dem_previews
+        previews = []
+        for component in self.components:
+            previews.extend(component.previews())
+        return previews
 
     def pack(self, archive_name: str) -> str:
         """Pack map directory to zip archive.

maps4fs/generator/texture.py

@@ -16,134 +16,6 @@ from shapely.geometry.base import BaseGeometry  # type: ignore
 
 from maps4fs.generator.component import Component
 
-# region constants
-# texture = {
-#     "name": "concrete",
-#     "count": 4,
-#     "tags": {"building": True},
-#     "width": 8,
-#     "color": (130, 130, 130),
-# }
-
-# textures = [
-#     {
-#         "name": "animalMud",
-#         "count": 4,
-#     },
-#     {
-#         "name": "asphalt",
-#         "count": 4,
-#         "tags": {"highway": ["motorway", "trunk", "primary"]},
-#         "width": 8,
-#         "color": (70, 70, 70),
-#     },
-#     {
-#         "name": "cobbleStone",
-#         "count": 4,
-#     },
-#     {
-#         "name": "concrete",
-#         "count": 4,
-#         "tags": {"building": True},
-#         "width": 8,
-#         "color": (130, 130, 130),
-#     },
-#     {
-#         "name": "concreteRubble",
-#         "count": 4,
-#     },
-#     {
-#         "name": "concreteTiles",
-#         "count": 4,
-#     },
-#     {
-#         "name": "dirt",
-#         "count": 4,
-#     },
-#     {
-#         "name": "dirtDark",
-#         "count": 2,
-#         "tags": {"highway": ["unclassified", "residential", "track"]},
-#         "width": 2,
-#         "color": (33, 67, 101),
-#     },
-#     {
-#         "name": "forestGround",
-#         "count": 4,
-#         "tags": {"landuse": "farmland"},
-#         "color": (47, 107, 85),
-#     },
-#     {
-#         "name": "forestGroundLeaves",
-#         "count": 4,
-#     },
-#     {
-#         "name": "grass",
-#         "count": 4,
-#         "tags": {"natural": "grassland"},
-#         "color": (34, 255, 34),
-#     },
-#     {
-#         "name": "grassDirt",
-#         "count": 4,
-#         "tags": {"natural": ["wood", "tree_row"]},
-#         "width": 2,
-#         "color": (0, 252, 124),
-#     },
-#     {
-#         "name": "gravel",
-#         "count": 4,
-#         "tags": {"highway": ["secondary", "tertiary", "road"]},
-#         "width": 4,
-#         "color": (140, 180, 210),
-#     },
-#     {
-#         "name": "groundBricks",
-#         "count": 4,
-#     },
-#     {
-#         "name": "mountainRock",
-#         "count": 4,
-#     },
-#     {
-#         "name": "mountainRockDark",
-#         "count": 4,
-#     },
-#     {
-#         "name": "riverMud",
-#         "count": 4,
-#     },
-#     {
-#         "name": "waterPuddle",
-#         "count": 0,
-#         "tags": {"natural": "water", "waterway": True},
-#         "width": 10,
-#         "color": (255, 20, 20),
-#     },
-# ]
-
-# TEXTURES = {
-# ?     "animalMud": 4,
-# ?     "asphalt": 4,
-# ?     "cobbleStone": 4,
-# ?     "concrete": 4,
-#     "concreteRubble": 4,
-#     "concreteTiles": 4,
-#     "dirt": 4,
-#     "dirtDark": 2,
-#     "forestGround": 4,
-#     "forestGroundLeaves": 4,
-#     "grass": 4,
-#     "grassDirt": 4,
-#     "gravel": 4,
-#     "groundBricks": 4,
-#     "mountainRock": 4,
-#     "mountainRockDark": 4,
-#     "riverMud": 4,
-#     "waterPuddle": 0,
-# }
-# endregion
-
 
 # pylint: disable=R0902
 class Texture(Component):
@@ -365,6 +237,9 @@ class Texture(Component):
     def draw(self) -> None:
         """Iterates over layers and fills them with polygons from OSM data."""
         for layer in self.layers:
+            if not layer.tags:
+                self.logger.debug("Layer %s has no tags, there's nothing to draw.", layer.name)
+                continue
             layer_path = layer.path(self._weights_dir)
             self.logger.debug("Drawing layer %s.", layer_path)
 
@@ -372,7 +247,7 @@ class Texture(Component):
             for polygon in self.polygons(layer.tags, layer.width):  # type: ignore
                 cv2.fillPoly(img, [polygon], color=255)  # type: ignore
             cv2.imwrite(layer_path, img)
-            self.logger.debug("Texture %s saved.", layer.path)
+            self.logger.debug("Texture %s saved.", layer_path)
 
     def get_relative_x(self, x: float) -> int:
         """Converts UTM X coordinate to relative X coordinate in map image.

{maps4fs-0.6.7.dist-info → maps4fs-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.6.7
+Version: 0.7.0
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -34,6 +34,7 @@ Requires-Dist: tqdm
 
 
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/releases)
+[![PyPI - Version](https://img.shields.io/pypi/v/maps4fs)](https://pypi.org/project/maps4fs)
 [![Docker Pulls](https://img.shields.io/docker/pulls/iwatkot/maps4fs)](https://hub.docker.com/repository/docker/iwatkot/maps4fs/general)
 [![GitHub issues](https://img.shields.io/github/issues/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/issues)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b922fd0a7188d37e61de/maintainability)](https://codeclimate.com/github/iwatkot/maps4fs/maintainability)<br>
@@ -50,8 +51,11 @@ Requires-Dist: tqdm
 🔃 Farming Simulator 25 (changes in the library are ready, waiting for the Giants to release the Giants Editor v10)<br>
 
 ## Quick Start
-For those, who don't want to read anything, here you go:<br>
-**Option 1:** open the [maps4fs](https://maps4fs.streamlit.app) on StreamLit a map template in a few clicks.<br>
+There are several ways to use the tool. You obviously need the **first one**, but you can choose any of the others depending on your needs.<br>
+### 🚜 For most users
+**Option 1:** open the [maps4fs](https://maps4fs.streamlit.app) on StreamLit and generate a map template in a few clicks.<br>
+
+### 😎 For advanced users
 **Option 2:** run the Docker version in your browser. Launch the following command in your terminal:
 ```bash
 docker run -d -p 8501:8501 iwatkot/maps4fs
@@ -59,6 +63,13 @@ docker run -d -p 8501:8501 iwatkot/maps4fs
 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>
 
+### 🤯 For developers
+**Option 3:** Python package. Install the package using the following command:
+```bash
+pip install maps4fs
+```
+And refer to the [Python package](#option-3-python-package) 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>
 
@@ -69,6 +80,24 @@ So, if you're new to map making, here's a quick overview of the process:
 3. Open the map template in the Giants Editor.
 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
 
+### Previews
+
+The generator also creates a multiple previews of the map. Here's the list of them:
+1. General preview - merging all the layers into one image with different colors.
+2. Grayscale DEM preview - a grayscale image of the height map (as it is).
+3. Colored DEM preview - a colored image of the height map (from blue to red). The blue color represents the lowest point, and the red color represents the highest point.
+
+So the colored DEM preview can be very handy when you're trying to find the best value for the `max_height` parameter. Learn more about it in the [Settings](#settings) section.
+
+![Previews](https://github.com/user-attachments/assets/69609169-834b-4269-ac6a-9a5c56b629dc)<br>
+In the second row of the image you can see the following images:<br>
+1. DEM preview with `max_height=200`.
+2. Colored DEM preview with `max_height=200`.
+3. Colored DEM preview with `max_height=50`.
+
+As you can see there's a huge difference between images 2 and 3. The third (with lower `max_height`) will have a higher terrain contrast, and the second one will have lower differences between the terrain heights.<br>
+There's no like "in real world" option, because FS system of coordinates does not work in meters or something like that when talking about DEM. So you need to experiment with the `max_height` parameter to get the desired result. To clarify: in the example above the difference on the platue is about 80 meters, so `max_height=50` made this like super mountainous terrain, and `max_height=200` made it like a plain.
+
 ## How-To-Run
 
 You'll find detailed instructions on how to run the project below. But if you prefer video tutorials, here's one for you:
@@ -78,14 +107,14 @@ You'll find detailed instructions on how to run the project below. But if you pr
 ### Option 1: StreamLit
 **🗺️ Supported map sizes:** 2x2, 4x4, 8x8, 16x16 km.<br>
 🟢 Recommended for all users, you don't need to install anything.<br>
-Using Telegram bot [@maps4fs](https://t.me/maps4fsbot).<br>
+Using the [StreamLit](https://maps4fs.streamlit.app) version of the tool 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>
 
 Using it is easy and doesn't require any guides. Enjoy!
 
 ### Option 2: Docker version
 **🗺️ Supported map sizes:** 2x2, 4x4, 8x8, 16x16 km.<br>
-🟢 Recommended for users who want faster processing, very simple installation.<br>
+🟠 Recommended for users who want faster processing, very simple installation.<br>
 You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:
 
 1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
@@ -99,6 +128,53 @@ docker run -d -p 8501:8501 iwatkot/maps4fs
 
 ![WebUI](https://github.com/user-attachments/assets/e3b48c9d-7b87-4ce7-8ad7-98332a558a88)
 
+### Option 3: Python package
+**🗺️ Supported map sizes:** 2x2, 4x4, 8x8, 16x16 km (and ANY other you may add).<br>
+🔴 Recommended for developers.<br>
+You can use the Python package to generate maps. Follow these steps:
+
+1. Install the package from PyPI:
+```bash
+pip install maps4fs
+```
+2. Import the Game class and create an instance of it:
+```python
+import maps4fs as mfs
+
+game = mfs.Game.from_code("FS25")
+```
+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>
+
+```text
+📁 data
+ ┣ 📄 fs22-map-template.zip
+ ┗ 📄 fs22-texture-schema.json
+```
+
+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.
+  distance=1024,  # The DISTANCE from the center to the edge of the map in meters. The map will be 2048x2048 meters.
+  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
+  blur_seed=5,  # The seed for the blur algorithm. The default value is 5, which means 5 meters.
+  max_height=400  # The maximum height of the map.
+)
+```
+
+4. Generate the map:
+```python
+map.generate()
+```
+
+The map will be saved in the `map_directory` directory.
+
 ## Settings
 Advanced settings are available in the tool's UI under the **Advanced Settings** tab. Here's the list of them:
 - `max_height` - the maximum height of the map. The default value is 400. Select smaller values for plain-like maps and bigger values for mountainous maps. You may need to experiment with this value to get the desired result.
@@ -143,4 +219,3 @@ You can use this information to adjust some other sources of data to the map, e.
 
 ## Bugs and feature requests
 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).<br>
-ℹ️ Please, don't bother me if the Telegram bot is down. As I said before this is related to the hosting limitations, if you want you can always run the tool locally or support the project by donating, so maybe I'll be able to afford better hosting.

maps4fs-0.7.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
+maps4fs/logger.py,sha256=CneeHxQywjNUJXqQrUUSeiDxu95FfrfyK_Si1v0gMZ8,1477
+maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/generator/component.py,sha256=Xq5yVFMqG1d1iHTtn2mn5RN-UntsutXIvV5eQYBuFLw,2046
+maps4fs/generator/config.py,sha256=wlGacB69fdcvggfEDvCpx5gzPRKq_4Sh6xuX-z-kwwE,2043
+maps4fs/generator/dem.py,sha256=xOKHvWIMD-7nIWGQNQi6Tan1Ovb1EPfHHVnUfUIC31k,10004
+maps4fs/generator/game.py,sha256=IyXjNEC5epJmDdqjsrl4wKL85T1F23km73pUkBiuDWU,4468
+maps4fs/generator/map.py,sha256=bqog38u2fltYdC1xgfeC0ehboL7Vp7V6nJq0NQOI9lA,4157
+maps4fs/generator/texture.py,sha256=f5dPD5q17CTg8aY6G3i33vFk9ckbpndVb1W3hbT1wL4,15318
+maps4fs-0.7.0.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.7.0.dist-info/METADATA,sha256=559aJEFn3HctVKqakqaBoTVA6xLY8WTNQsKTlFG-icE,12187
+maps4fs-0.7.0.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+maps4fs-0.7.0.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.7.0.dist-info/RECORD,,

{maps4fs-0.6.7.dist-info → maps4fs-0.7.0.dist-info}/WHEEL

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

maps4fs-0.6.7.dist-info/RECORD

@@ -1,14 +0,0 @@
-maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
-maps4fs/logger.py,sha256=CneeHxQywjNUJXqQrUUSeiDxu95FfrfyK_Si1v0gMZ8,1477
-maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/component.py,sha256=UmR6Gbs-uDld7897q_9hOOzqBXaIYD8svmw_a3IgC5g,1761
-maps4fs/generator/config.py,sha256=3X9E6luYh0dBlYcGvE4Exzp-ShAMCFjGB_8SK3qPBtM,1760
-maps4fs/generator/dem.py,sha256=_1d_TPMOGBgl2-R_CRMbKumzxCbQyb-hcpqsElhYbQ4,8546
-maps4fs/generator/game.py,sha256=IyXjNEC5epJmDdqjsrl4wKL85T1F23km73pUkBiuDWU,4468
-maps4fs/generator/map.py,sha256=Y7ERUB6ivxJilDAjE9UD0-vl0SKtzj6J2f8QPXM6i48,3712
-maps4fs/generator/texture.py,sha256=BUDDYIASk7lhYhJpEjZUTccKUI1GIfJIcPRgIgiUHAE,17938
-maps4fs-0.6.7.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.6.7.dist-info/METADATA,sha256=6LkFXz56KTpX5IbDAnDNMv00lhjFKhYb00n0yr8ATSA,8869
-maps4fs-0.6.7.dist-info/WHEEL,sha256=a7TGlA-5DaHMRrarXjVbQagU3Man_dCnGIWMJr5kRWo,91
-maps4fs-0.6.7.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.6.7.dist-info/RECORD,,