maps4fs 1.0.9__py3-none-any.whl → 1.1.1__py3-none-any.whl

maps4fs/generator/map.py

@@ -18,8 +18,7 @@ class Map:
     Arguments:
         game (Type[Game]): Game for which the map is generated.
         coordinates (tuple[float, float]): Coordinates of the center of the map.
-        height (int): Height of the map in pixels.
-        width (int): Width of the map in pixels.
+        size (int): Height and width of the map in pixels (it's a square).
         map_directory (str): Path to the directory where map files will be stored.
         logger (Any): Logger instance
     """
@@ -28,22 +27,30 @@ class Map:
         self,
         game: Game,
         coordinates: tuple[float, float],
-        height: int,
-        width: int,
+        size: int,
+        rotation: int,
         map_directory: str,
         logger: Any = None,
         **kwargs,
     ):
+        if not logger:
+            logger = Logger(to_stdout=True, to_file=False)
+        self.logger = logger
+        self.size = size
+
+        if rotation:
+            rotation_multiplier = 1.5
+        else:
+            rotation_multiplier = 1
+
+        self.rotation = rotation
+        self.rotated_size = int(size * rotation_multiplier)
+
         self.game = game
         self.components: list[Component] = []
         self.coordinates = coordinates
-        self.height = height
-        self.width = width
         self.map_directory = map_directory
 
-        if not logger:
-            logger = Logger(to_stdout=True, to_file=False)
-        self.logger = logger
         self.logger.info("Game was set to %s", game.code)
 
         self.kwargs = kwargs
@@ -68,8 +75,9 @@ class Map:
             component = game_component(
                 self.game,
                 self.coordinates,
-                self.height,
-                self.width,
+                self.size,
+                self.rotated_size,
+                self.rotation,
                 self.map_directory,
                 self.logger,
                 **self.kwargs,

maps4fs/generator/texture.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 
 import json
 import os
+import re
 from collections import defaultdict
 from typing import Any, Callable, Generator, Optional
 
@@ -151,10 +152,22 @@ class Texture(Component):
                 list[str]: List of paths to the textures.
             """
             weight_files = os.listdir(weights_directory)
+
+            # Inconsistent names are the name of textures that are not following the pattern
+            # of texture_name{idx}_weight.png.
+            inconsistent_names = ["forestRockRoot", "waterPuddle"]
+
+            if self.name in inconsistent_names:
+                return [
+                    os.path.join(weights_directory, weight_file)
+                    for weight_file in weight_files
+                    if weight_file.startswith(self.name)
+                ]
+
             return [
                 os.path.join(weights_directory, weight_file)
                 for weight_file in weight_files
-                if weight_file.startswith(self.name)
+                if re.match(rf"{self.name}\d{{2}}_weight.png", weight_file)
             ]
 
     def preprocess(self) -> None:
@@ -203,6 +216,31 @@ class Texture(Component):
         self._prepare_weights()
         self._read_parameters()
         self.draw()
+        self.rotate_textures()
+
+    def rotate_textures(self) -> None:
+        """Rotates textures of the layers which have tags."""
+        if self.rotation:
+            # Iterate over the layers which have tags and rotate them.
+            for layer in self.layers:
+                if layer.tags:
+                    self.logger.debug("Rotating layer %s.", layer.name)
+                    layer_paths = layer.paths(self._weights_dir)
+                    layer_paths += [layer.path_preview(self._weights_dir)]
+                    for layer_path in layer_paths:
+                        if os.path.isfile(layer_path):
+                            self.rotate_image(
+                                layer_path,
+                                self.rotation,
+                                output_height=self.map_size,
+                                output_width=self.map_size,
+                            )
+                        else:
+                            self.logger.warning("Layer path %s not found.", layer_path)
+                else:
+                    self.logger.debug(
+                        "Skipping rotation of layer %s because it has no tags.", layer.name
+                    )
 
     # pylint: disable=W0201
     def _read_parameters(self) -> None:
@@ -249,7 +287,7 @@ class Texture(Component):
         Arguments:
             layer (Layer): Layer with textures and tags.
         """
-        size = (self.map_height, self.map_width)
+        size = (self.map_rotated_size, self.map_rotated_size)
         postfix = "_weight.png" if not layer.exclude_weight else ".png"
         if layer.count == 0:
             filepaths = [os.path.join(self._weights_dir, layer.name + postfix)]
@@ -396,12 +434,6 @@ class Texture(Component):
             for coord in non_zero_coords:
                 sublayers[np.random.randint(0, layer.count)][coord[0], coord[1]] = 255
 
-            # # ! Debug test if the sublayers are correct.
-            # if True:
-            #     combined = cv2.bitwise_or(*sublayers)
-            #     # Match the original image with the combined sublayers.
-            #     assert np.array_equal(layer_image, combined), "Sublayers are not correct."
-
             # Save the sublayers.
             for sublayer, sublayer_path in zip(sublayers, layer_paths):
                 cv2.imwrite(sublayer_path, sublayer)
@@ -435,7 +467,7 @@ class Texture(Component):
         Returns:
             int: Relative X coordinate in map image.
         """
-        return int(self.map_width * (x - self.minimum_x) / (self.maximum_x - self.minimum_x))
+        return int(self.map_rotated_size * (x - self.minimum_x) / (self.maximum_x - self.minimum_x))
 
     def get_relative_y(self, y: float) -> int:
         """Converts UTM Y coordinate to relative Y coordinate in map image.
@@ -446,7 +478,9 @@ class Texture(Component):
         Returns:
             int: Relative Y coordinate in map image.
         """
-        return int(self.map_height * (1 - (y - self.minimum_y) / (self.maximum_y - self.minimum_y)))
+        return int(
+            self.map_rotated_size * (1 - (y - self.minimum_y) / (self.maximum_y - self.minimum_y))
+        )
 
     def np_to_polygon_points(self, np_array: np.ndarray) -> list[tuple[int, int]]:
         """Converts numpy array of polygon points to list of tuples.
@@ -597,13 +631,11 @@ class Texture(Component):
         Returns:
             str: Path to the preview.
         """
-        scaling_factor = min(
-            PREVIEW_MAXIMUM_SIZE / self.map_width, PREVIEW_MAXIMUM_SIZE / self.map_height
-        )
+        scaling_factor = PREVIEW_MAXIMUM_SIZE / self.map_size
 
         preview_size = (
-            int(self.map_width * scaling_factor),
-            int(self.map_height * scaling_factor),
+            int(self.map_size * scaling_factor),
+            int(self.map_size * scaling_factor),
         )
         self.logger.debug(
             "Scaling factor: %s. Preview size: %s.",

{maps4fs-1.0.9.dist-info → maps4fs-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.0.9
+Version: 1.1.1
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -63,15 +63,17 @@ Requires-Dist: pympler
 </div>
 
 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
+🔄 Support map rotation 🆕<br>
+🌾 Automatically generates fields 🆕<br>
+🌽 Automatically generates farmlands 🆕<br>
 🌍 Based on real-world data from OpenStreetMap<br>
-🏞️ Generates height using SRTM dataset<br>
+🏞️ Generates height map using SRTM dataset<br>
 📦 Provides a ready-to-use map template for the Giants Editor<br>
 🚜 Supports Farming Simulator 22 and 25<br>
 🔷 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>
-🌾 Automatically generates fields 🆕<br>
-🌽 Automatically generates farmlands 🆕<br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -467,10 +469,6 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Plateau height: this value will be added to each pixel of the DEM image, making it "higher". It's useful when you want to add some negative heights on the map, that appear to be in a "low" place. By default, it's set to 0.
 
-### Background Terrain Advanced settings
-
-- Background Terrain Generate only full tiles: if checked (by default) the small tiles (N, NE, E, and so on) will not be generated, only the full tile will be created. It's useful when you don't want to work with separate tiles, but with one big file. Since the new method of cutting the map from the background terrain added to the documentation, and now it's possible to perfectly align the map with the background terrain, this option will remain just as a legacy one.
-
 ### Texture Advanced settings
 
 - Fields padding - this value (in meters) will be applied to each field, making it smaller. It's useful when the fields are too close to each other and you want to make them smaller. By default, it's set to 0.

maps4fs-1.1.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
+maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
+maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/generator/background.py,sha256=dnUkS1atEqqz_ryKkcfP_K9ZcwMHZVs97y-twZMpD44,15881
+maps4fs/generator/component.py,sha256=iYQgw2l_rvVpZ-VIhoZELdAe8rPVBwCVKwRsYejDCb0,17094
+maps4fs/generator/config.py,sha256=b7qY0luC-_WM_c72Ohtlf4FrB37X5cALInbestSdUsw,4382
+maps4fs/generator/dem.py,sha256=rc7ADzjvlZzStOqagsWW0Vrm9-X86aPpoR1RhBF_-OE,16025
+maps4fs/generator/game.py,sha256=H4msVHoDlJD5_9KoRvr3lCv2ZbLqJPqPDCEAEIDaCB4,7407
+maps4fs/generator/grle.py,sha256=HFOH07RZfkCkIpSj2VSMoBUjhmYDVCFWQQYd4tn6O5o,7162
+maps4fs/generator/i3d.py,sha256=GcGyawpE70yVjH9WdgpbNXESZoHYHmCKncl7pp5G1zo,11741
+maps4fs/generator/map.py,sha256=7UqLjDZgoY6M0ZxX5Q4Rjee2UGWZ64a3tGyr8B24UO0,4863
+maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
+maps4fs/generator/texture.py,sha256=uSt563KomSVUndl25IgEIi0YuhBQbnhPIoQKa-4A3_E,26016
+maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
+maps4fs/toolbox/background.py,sha256=9BXWNqs_n3HgqDiPztWylgYk_QM4YgBpe6_ZNQAWtSc,2154
+maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
+maps4fs-1.1.1.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.1.1.dist-info/METADATA,sha256=V59zXt_h8KNG1R6KssJ8ZMDiQOt5stAwsYbjvzJaY9U,27907
+maps4fs-1.1.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-1.1.1.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.1.1.dist-info/RECORD,,

maps4fs/generator/path_steps.py

@@ -1,97 +0,0 @@
-"""This module contains functions and clas for generating path steps."""
-
-from typing import NamedTuple
-
-from geopy.distance import distance  # type: ignore
-
-DEFAULT_DISTANCE = 2048
-PATH_FULL_NAME = "FULL"
-PATH_FULL_PREVIEW_NAME = "FULL_PREVIEW"
-
-
-class PathStep(NamedTuple):
-    """Represents parameters of one step in the path.
-
-    Attributes:
-        code {str} -- Tile code (N, NE, E, SE, S, SW, W, NW).
-        angle {int} -- Angle in degrees (for example 0 for North, 90 for East).
-            If None, the step is a full map with a center at the same coordinates as the
-            map itself.
-        distance {int} -- Distance in meters from previous step.
-            If None, the step is a full map with a center at the same coordinates as the
-            map itself.
-        size {tuple[int, int]} -- Size of the tile in pixels (width, height).
-    """
-
-    code: str
-    angle: int | None
-    distance: int | None
-    size: tuple[int, int]
-
-    def get_destination(self, origin: tuple[float, float]) -> tuple[float, float]:
-        """Calculate destination coordinates based on origin and step parameters.
-
-        Arguments:
-            origin {tuple[float, float]} -- Origin coordinates (latitude, longitude)
-
-        Returns:
-            tuple[float, float] -- Destination coordinates (latitude, longitude)
-        """
-        destination = distance(meters=self.distance).destination(origin, self.angle)
-        return destination.latitude, destination.longitude
-
-
-def get_steps(map_height: int, map_width: int, only_full_tiles: bool = True) -> list[PathStep]:
-    """Return a list of PathStep objects for each tile, which represent a step in the path.
-    Moving from the center of the map to North, then clockwise.
-
-    Arguments:
-        map_height {int} -- Height of the map in pixels
-        map_width {int} -- Width of the map in pixels
-        only_full_tiles {bool} -- Whether to return only full tiles or all tiles
-
-    Returns:
-        list[PathStep] -- List of PathStep objects
-    """
-    # Move clockwise from N and calculate coordinates and sizes for each tile.
-    half_width = int(map_width / 2)
-    half_height = int(map_height / 2)
-
-    half_default_distance = int(DEFAULT_DISTANCE / 2)
-
-    tiles = [
-        PathStep("N", 0, half_height + half_default_distance, (map_width, DEFAULT_DISTANCE)),
-        PathStep(
-            "NE", 90, half_width + half_default_distance, (DEFAULT_DISTANCE, DEFAULT_DISTANCE)
-        ),
-        PathStep("E", 180, half_height + half_default_distance, (DEFAULT_DISTANCE, map_height)),
-        PathStep(
-            "SE", 180, half_height + half_default_distance, (DEFAULT_DISTANCE, DEFAULT_DISTANCE)
-        ),
-        PathStep("S", 270, half_width + half_default_distance, (map_width, DEFAULT_DISTANCE)),
-        PathStep(
-            "SW", 270, half_width + half_default_distance, (DEFAULT_DISTANCE, DEFAULT_DISTANCE)
-        ),
-        PathStep("W", 0, half_height + half_default_distance, (DEFAULT_DISTANCE, map_height)),
-        PathStep(
-            "NW", 0, half_height + half_default_distance, (DEFAULT_DISTANCE, DEFAULT_DISTANCE)
-        ),
-    ]
-    full_tiles = [
-        PathStep(
-            PATH_FULL_NAME,
-            None,
-            None,
-            (map_width + DEFAULT_DISTANCE * 2, map_height + DEFAULT_DISTANCE * 2),
-        ),
-        PathStep(
-            PATH_FULL_PREVIEW_NAME,
-            None,
-            None,
-            (map_width + DEFAULT_DISTANCE * 2, map_height + DEFAULT_DISTANCE * 2),
-        ),
-    ]
-
-    if only_full_tiles:
-        return full_tiles
-    return tiles + full_tiles

maps4fs/generator/tile.py

@@ -1,51 +0,0 @@
-"""This module contains the Tile component, which is used to generate a tile of DEM data around
-the map."""
-
-import os
-
-from maps4fs.generator.dem import DEM
-
-
-class Tile(DEM):
-    """Component for creating a tile of DEM data around the map.
-
-    Arguments:
-        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
-        map_height (int): The height of the map in pixels.
-        map_width (int): The width of the map in pixels.
-        map_directory (str): The directory where the map files are stored.
-        logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
-            info, warning. If not provided, default logging will be used.
-
-    Keyword Arguments:
-        tile_code (str): The code of the tile (N, NE, E, SE, S, SW, W, NW).
-
-    Public Methods:
-        get_output_resolution: Return the resolution of the output image.
-        process: Launch the component processing.
-        make_copy: Override the method to prevent copying the tile.
-    """
-
-    def preprocess(self) -> None:
-        """Prepares the component for processing. Reads the tile code from the kwargs and sets the
-        DEM path for the tile."""
-        super().preprocess()
-        self.code = self.kwargs.get("tile_code")
-        if not self.code:
-            raise ValueError("Tile code was not provided")
-
-        self.logger.debug("Generating tile for code %s", self.code)
-
-        background_directory = os.path.join(self.map_directory, "background")
-        os.makedirs(background_directory, exist_ok=True)
-
-        self._dem_path = os.path.join(background_directory, f"{self.code}.png")
-        self.logger.debug("DEM path for tile %s is %s", self.code, self._dem_path)
-
-    def get_output_resolution(self) -> tuple[int, int]:
-        """Return the resolution of the output image.
-
-        Returns:
-            tuple[int, int]: The width and height of the output image.
-        """
-        return self.map_width, self.map_height

maps4fs-1.0.9.dist-info/RECORD

@@ -1,23 +0,0 @@
-maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
-maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
-maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=ogd5TmAWL5zhZtTCOH8YHGKqc0SGQqOsWuVg3AaZO0I,14015
-maps4fs/generator/component.py,sha256=ac0l1nUeRnMejNgJ26PO0Jjb2ELYSaagM0mzNjM_w5o,14582
-maps4fs/generator/config.py,sha256=kspXIT2o-_28EU0RQsROHCjkgQdqQnvreAKP5QAC5Ws,4279
-maps4fs/generator/dem.py,sha256=cCJLE20-XKaQx5lwIFNEgmQ5kfhE24QmVrAyMVwsU_A,16459
-maps4fs/generator/game.py,sha256=4I6edxTeZf41Vgvx6BaucEflMEHomRRvdMZRJAPm0d4,7450
-maps4fs/generator/grle.py,sha256=5Ck44CKI-yxnxgy8K_18L0pFAfln5e9e7DVkpNZVwC0,6404
-maps4fs/generator/i3d.py,sha256=CPscvhuoBRfGJSmcCGHyjM5FKlDXAbYALJkvhGv4UrA,11091
-maps4fs/generator/map.py,sha256=gDZUZ2wimoeA8mHVOCnZvrIBeK7b99OIWFd_LjruqBc,4677
-maps4fs/generator/path_steps.py,sha256=twhoP0KOYWOpOJfYrSWPHygtIeM-r5cIlePg1SHVyHk,3589
-maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
-maps4fs/generator/texture.py,sha256=2c2x99xnqKZoXDB4fdQBESFMPMiGrbx_fADFTdx4ZGY,24638
-maps4fs/generator/tile.py,sha256=z1-xEVjgFNf2WzLkgwoGGq8nREJpjPljeC9lmb5xPKA,1997
-maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/toolbox/background.py,sha256=9BXWNqs_n3HgqDiPztWylgYk_QM4YgBpe6_ZNQAWtSc,2154
-maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.0.9.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.0.9.dist-info/METADATA,sha256=2cnIMdJN45eVlg9tBVPAwJsoBWVz1qavS6U9B4-iVAU,28327
-maps4fs-1.0.9.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-1.0.9.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.0.9.dist-info/RECORD,,