maps4fs 0.8.3__py3-none-any.whl → 0.8.4__py3-none-any.whl

maps4fs/generator/background.py

@@ -8,7 +8,6 @@ import os
 import cv2
 import numpy as np
 import trimesh  # type: ignore
-from pyproj import Transformer
 
 from maps4fs.generator.component import Component
 from maps4fs.generator.path_steps import DEFAULT_DISTANCE, get_steps
@@ -83,17 +82,7 @@ class Background(Component):
         data = {}
         for tile in self.tiles:
             north, south, east, west = tile.bbox
-
-            # The default CMS in library is EPSG:4326.
-            # It needed to be converted to EPSG:3857 for convinient usage in QGIS.
-
-            transformer = Transformer.from_crs("epsg:4326", "epsg:3857")
-            epsg3857_north, epsg3857_west = transformer.transform(north, west)
-            epsg3857_south, epsg3857_east = transformer.transform(south, east)
-
-            epsg3857_string = (
-                f"{epsg3857_north},{epsg3857_south},{epsg3857_east},{epsg3857_west} [EPSG:3857]"
-            )
+            epsg3857_string = tile.get_epsg3857_string()
 
             tile_entry = {
                 "center_latitude": tile.coordinates[0],

maps4fs/generator/component.py

@@ -8,6 +8,7 @@ from copy import deepcopy
 from typing import TYPE_CHECKING, Any
 
 import osmnx as ox  # type: ignore
+from pyproj import Transformer
 
 if TYPE_CHECKING:
     from maps4fs.generator.game import Game
@@ -134,21 +135,34 @@ class Component:
 
         self.logger.debug("Saved updated generation info to %s", self.generation_info_path)
 
-    def get_bbox(self, project_utm: bool = False) -> tuple[int, int, int, int]:
+    def get_bbox(
+        self,
+        coordinates: tuple[float, float] | None = None,
+        distance: int | None = None,
+        project_utm: bool = False,
+    ) -> tuple[int, int, int, int]:
         """Calculates the bounding box of the map from the coordinates and the height and
         width of the map.
+        If coordinates and distance are not provided, the instance variables are used.
 
         Args:
+            coordinates (tuple[float, float], optional): The latitude and longitude of the center of
+                the map. Defaults to None.
+            distance (int, optional): The distance from the center of the map to the edge of the
+                map. Defaults to None.
             project_utm (bool, optional): Whether to project the bounding box to UTM.
 
         Returns:
             tuple[int, int, int, int]: The bounding box of the map.
         """
+        coordinates = coordinates or self.coordinates
+        distance = distance or int(self.map_height / 2)
+
         north, south, _, _ = ox.utils_geo.bbox_from_point(
-            self.coordinates, dist=self.map_height / 2, project_utm=project_utm
+            coordinates, dist=distance, project_utm=project_utm
         )
         _, _, east, west = ox.utils_geo.bbox_from_point(
-            self.coordinates, dist=self.map_width / 2, project_utm=project_utm
+            coordinates, dist=distance, project_utm=project_utm
         )
         bbox = north, south, east, west
         self.logger.debug(
@@ -165,3 +179,21 @@ class Component:
         """
         self.bbox = self.get_bbox(project_utm=False)
         self.logger.debug("Saved bounding box: %s", self.bbox)
+
+    def get_epsg3857_string(self, bbox: tuple[int, int, int, int] | None = None) -> str:
+        """Converts the bounding box to EPSG:3857 string.
+        If the bounding box is not provided, the instance variable is used.
+
+        Args:
+            bbox (tuple[int, int, int, int], optional): The bounding box to convert.
+
+        Returns:
+            str: The bounding box in EPSG:3857 string.
+        """
+        bbox = bbox or self.bbox
+        north, south, east, west = bbox
+        transformer = Transformer.from_crs("epsg:4326", "epsg:3857")
+        epsg3857_north, epsg3857_west = transformer.transform(north, west)
+        epsg3857_south, epsg3857_east = transformer.transform(south, east)
+
+        return f"{epsg3857_north},{epsg3857_south},{epsg3857_east},{epsg3857_west} [EPSG:3857]"

maps4fs/generator/config.py

@@ -55,3 +55,34 @@ class Config(Component):
             list[str]: An empty list.
         """
         return []
+
+    def info_sequence(self) -> dict[str, dict[str, str | float | int]]:
+        """Returns information about the component.
+        Overview section is needed to create the overview file (in-game map).
+
+        Returns:
+            dict[str, dict[str, str | float | int]]: Information about the component.
+        """
+        # The overview file is exactly 2X bigger than the map size, does not matter
+        # if the map is 2048x2048 or 4096x4096, the overview will be 4096x4096
+        # and the map will be in the center of the overview.
+        # That's why the distance is set to the map height not as a half of it.
+        bbox = self.get_bbox(distance=self.map_height)
+        south, west, north, east = bbox
+        epsg3857_string = self.get_epsg3857_string(bbox=bbox)
+
+        overview_data = {
+            "epsg3857_string": epsg3857_string,
+            "south": south,
+            "west": west,
+            "north": north,
+            "east": east,
+            "height": self.map_height * 2,
+            "width": self.map_width * 2,
+        }
+
+        data = {
+            "Overview": overview_data,
+        }
+
+        return data  # type: ignore

maps4fs/generator/map.py

@@ -6,7 +6,6 @@ import os
 import shutil
 from typing import Any, Generator
 
-# from maps4fs.generator.background import Background
 from maps4fs.generator.component import Component
 from maps4fs.generator.game import Game
 from maps4fs.logger import Logger

{maps4fs-0.8.3.dist-info → maps4fs-0.8.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.8.3
+Version: 0.8.4
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -19,6 +19,8 @@ Requires-Dist: rasterio
 Requires-Dist: folium
 Requires-Dist: geopy
 Requires-Dist: trimesh
+Requires-Dist: imageio
+Requires-Dist: tifffile
 
 <div align="center" markdown>
 <img src="https://github.com/iwatkot/maps4fs/assets/118521851/ffd7f0a3-e317-4c3f-911f-2c2fb736fbfa">
@@ -30,9 +32,11 @@ Requires-Dist: trimesh
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
   <a href="#Texture-schema">Texture schema</a> •
-  <a href="Background-terrain">Background terrain</a><br>
+  <a href="#Background-terrain">Background terrain</a> •
+  <a href="#Overview-image">Overview image</a><br>
+  <a href="#DDS-conversion">DDS conversion</a> •
   <a href="#For-advanced-users">For advanced users</a> •
-  <a jref="#Resources">Resources</a> •
+  <a href="#Resources">Resources</a> •
   <a href="#Bugs-and-feature-requests">Bugs and feature requests</a>
 </p>
 
@@ -63,6 +67,8 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 ### 🚜 For most users
 **Option 1:** open the [maps4fs](https://maps4fs.streamlit.app) on StreamLit and generate a map template in a few clicks.<br>
 
+![Basic WebUI](https://github.com/user-attachments/assets/14620044-9e92-47ae-8531-d61460740f58)
+
 ### 😎 For advanced users
 **Option 2:** run the Docker version in your browser. Launch the following command in your terminal:
 ```bash
@@ -128,8 +134,6 @@ docker run -d -p 8501:8501 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.
 
-![Basic WebUI](https://github.com/user-attachments/assets/14620044-9e92-47ae-8531-d61460740f58)
-
 ### Option 3: Python package
 🔴 Recommended for developers.<br>
 You can use the Python package to generate maps. Follow these steps:
@@ -205,6 +209,31 @@ List of components:
 Below you'll find descriptions of the components and the fields that they contain.<br>
 ℹ️ If there's no information about the component, it means that at the moment it does not store any data in the `generation_info.json` file.
 
+### Config
+Example of the `Config` component:
+```json
+"Config": {
+    "Overview": {
+        "epsg3857_string": "2249906.6679576184,2255734.9033189337,5663700.389039194,5669528.6247056825 [EPSG:3857]",
+        "south": 45.304132173367165,
+        "west": 45.267296012425376,
+        "north": 20.263611405732693,
+        "east": 20.211255476687537,
+        "height": 4096,
+        "width": 4096
+    }
+},
+```
+The `Overview` section contains information to create an overview image, which represents the in-game map. You can use the `epsg3857_string` to obtain the satellite images in the QGIS. So this section describes the region of the map plus the borders. Usually, it's exact 2X the size of the map.<br>
+And here's the list of the fields:
+- `"epsg3857_string"` - the string representation of the bounding box in the EPSG:3857 projection, it's required to obtain the satellite images in the QGIS,<br>
+- `"south"` - the southern border of overview region,<br>
+- `"west"` - the western border of overview region,<br>
+- `"north"` - the northern border of overview region,<br>
+- `"east"` - the eastern border of overview region,<br>
+- `"height"` - the height of the overview region in meters (2X the size of the map),<br>
+- `"width"` - the width of the overview region in meters,<br>
+
 ### Texture
 
 Example of the `Texture` component:
@@ -337,6 +366,34 @@ If you're afraid of this task, please don't be. It's really simple and I've prep
 2. [Prepare the i3d files](README_i3d.md).
 3. [Import the i3d files to Giants Editor](README_giants_editor.md).
 
+## Overview image
+The overview image is an image that is used as in-game map. No matter what the size of the map, this file is always `4096x4096 pixels`, while the region of your map is `2048x2048 pixels` in center of this file. The rest of the image is just here for nice view, but you still may add satellite pictures to this region.<br>
+
+<img width="400" src="https://github.com/user-attachments/assets/ede9ea81-ef97-4914-9dbf-9761ef1eb7ca">
+
+Cool image by [@ZenJakey](https://github.com/ZenJakey).
+
+So, the same way you've downloaded the satellite images for the background terrain, you can download them for the overview image. Just use the `epsg3857_string` from the `generation_info.json` file. You'll find the needed string in the `Config` component in the `Overview` section:
+
+```json
+"Config": {
+    "Overview": {
+        "epsg3857_string": "2249906.6679576184,2255734.9033189337,5663700.389039194,5669528.6247056825 [EPSG:3857]",
+    }
+},
+```
+
+After it you need to resize the image to 4096x4096 pixels and convert it to the `.dds` format.
+
+## DDS conversion
+The `.dds` format is the format used in the Farming Simulator for the textures, icons, overview and preview images. There's a plenty of options to convert the images to the `.dds` format, you can just google something like `png to dds` and the first link probably will help you with it.<br>
+But if you prefer using scripts, you'll find Python converters in the `scripts` directory in this repository.<br>
+
+List of the important DDS files:
+- `icon.dds` - 256x256 pixels, the icon of the map,
+- `preview.dds` - 2048x2048 pixels, the preview image of the map on loading screen,
+- `mapsUS/overview.dds` - 4096x4096 pixels, the overview image of the map (in-game map)
+
 ## For advanced users
 The tool supports the custom size of the map. To use this feature select `Custom` in the `Map size` dropdown and enter the desired size. The tool will generate a map with the size you entered.<br>
 
@@ -362,4 +419,4 @@ To create a basic map, you only need the Giants Editor. But if you want to creat
 4. [QGIS](https://qgis.org/download/) - the open-source GIS software that you can use to obtain high-resolution satellite images for your map.
 
 ## 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>
+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) or on Discord: `iwatkot`.

{maps4fs-0.8.3.dist-info → maps4fs-0.8.4.dist-info}/RECORD

@@ -1,18 +1,18 @@
 maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
 maps4fs/logger.py,sha256=CneeHxQywjNUJXqQrUUSeiDxu95FfrfyK_Si1v0gMZ8,1477
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=KsErhYERWXzMedGLg1H7wO94OXyaqw_XQYnotKNTStE,11267
-maps4fs/generator/component.py,sha256=w5hUttO8m5bXcujLxB0pZjf25hxMnMPP4yPikQyoOkQ,6010
-maps4fs/generator/config.py,sha256=ln_XGUdiPnc4zzhMVEueZRf-FGljeHtCHUnJ6FRlE4w,2264
+maps4fs/generator/background.py,sha256=YZbTSijKgNQOvpWJHqCJNHeoV5GxUjp79b8PoQwRQH0,10778
+maps4fs/generator/component.py,sha256=9uGWSIVQzxO_u0yZ3luQJOrpg9x61uBcAHdIr_SaNlw,7402
+maps4fs/generator/config.py,sha256=RIqRCPS-ki23JmiFRyt98DVocf-ZaxMsa6yFvoOcHes,3425
 maps4fs/generator/dem.py,sha256=FsYcaf0IQSYykKdbkHxAN5-Rc_PZZEBJfdZA2Z-b8AU,14514
 maps4fs/generator/game.py,sha256=yry1tJYQi-tNLHlEY85Vz71KN_o2PVjxrAc4HDNB_Sg,6837
 maps4fs/generator/i3d.py,sha256=UuQiQRusPQ2f6PvGKxJ_UZeXsx3uG15efmy8Ysnm3F8,3597
-maps4fs/generator/map.py,sha256=2MXOIQxj7mDxhp76uh7EXqLP-v3T4TbiKQdx6my7GFc,4290
+maps4fs/generator/map.py,sha256=BS8ylTCRlHRmbImg73wnHMpBB2ODckVyVZq5KJhCMfM,4236
 maps4fs/generator/path_steps.py,sha256=rKslIiG9mriCVL9_0i8Oet2p0DITrpBWi0pECpvuyUM,2707
 maps4fs/generator/texture.py,sha256=0gkohGmamZbmqc9VpPqt8pli_x9w9SnUh2JjYGaiI3I,18170
 maps4fs/generator/tile.py,sha256=3vmfjQiPiiUZKPuIo5tg2rOKkgcP1NRVkMGK-Vo10-A,2138
-maps4fs-0.8.3.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.8.3.dist-info/METADATA,sha256=UbKREWFL9CnOpTHk1I76Q-4S5DEGOGbWoNro-qREB9c,20081
-maps4fs-0.8.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.8.3.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.8.3.dist-info/RECORD,,
+maps4fs-0.8.4.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.8.4.dist-info/METADATA,sha256=EqgOR_tsHQI7XHc0oM_tDRguhV6mmTFWIvH7cs877ek,23266
+maps4fs-0.8.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-0.8.4.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.8.4.dist-info/RECORD,,