maps4fs 0.9.99__py3-none-any.whl → 1.0.0__py3-none-any.whl

maps4fs/generator/tile.py

@@ -36,10 +36,10 @@ class Tile(DEM):
 
         self.logger.debug("Generating tile for code %s", self.code)
 
-        tiles_directory = os.path.join(self.map_directory, "objects", "tiles")
-        os.makedirs(tiles_directory, exist_ok=True)
+        background_directory = os.path.join(self.map_directory, "background")
+        os.makedirs(background_directory, exist_ok=True)
 
-        self._dem_path = os.path.join(tiles_directory, f"{self.code}.png")
+        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]:

maps4fs/toolbox/background.py

@@ -0,0 +1,63 @@
+"""This module contains functions to work with the background terrain of the map."""
+
+import cv2
+import numpy as np
+import trimesh  # type: ignore
+
+
+# pylint: disable=R0801, R0914
+def plane_from_np(
+    dem_data: np.ndarray,
+    resize_factor: float,
+    simplify_factor: int,
+    save_path: str,
+) -> None:
+    """Generates a 3D obj file based on DEM data.
+
+    Arguments:
+        dem_data (np.ndarray) -- The DEM data as a numpy array.
+        resize_factor (float) -- The factor by which the DEM data will be resized. Bigger values
+            will result in a bigger mesh.
+        simplify_factor (int) -- The factor by which the mesh will be simplified. Bigger values
+            will result in a simpler mesh.
+        save_path (str) -- The path to save the obj file.
+    """
+    dem_data = cv2.resize(  # pylint: disable=no-member
+        dem_data, (0, 0), fx=resize_factor, fy=resize_factor
+    )
+
+    # Invert the height values.
+    dem_data = dem_data.max() - dem_data
+
+    rows, cols = dem_data.shape
+    x = np.linspace(0, cols - 1, cols)
+    y = np.linspace(0, rows - 1, rows)
+    x, y = np.meshgrid(x, y)
+    z = dem_data
+
+    vertices = np.column_stack([x.ravel(), y.ravel(), z.ravel()])
+    faces = []
+
+    for i in range(rows - 1):
+        for j in range(cols - 1):
+            top_left = i * cols + j
+            top_right = top_left + 1
+            bottom_left = top_left + cols
+            bottom_right = bottom_left + 1
+
+            faces.append([top_left, bottom_left, bottom_right])
+            faces.append([top_left, bottom_right, top_right])
+
+    faces = np.array(faces)  # type: ignore
+    mesh = trimesh.Trimesh(vertices=vertices, faces=faces)
+
+    # Apply rotation: 180 degrees around Y-axis and Z-axis
+    rotation_matrix_y = trimesh.transformations.rotation_matrix(np.pi, [0, 1, 0])
+    rotation_matrix_z = trimesh.transformations.rotation_matrix(np.pi, [0, 0, 1])
+    mesh.apply_transform(rotation_matrix_y)
+    mesh.apply_transform(rotation_matrix_z)
+
+    # Simplify the mesh to reduce the number of faces.
+    mesh = mesh.simplify_quadric_decimation(face_count=len(faces) // simplify_factor)
+
+    mesh.export(save_path)

{maps4fs-0.9.99.dist-info → maps4fs-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.99
+Version: 1.0.0
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -31,8 +31,10 @@ Requires-Dist: pympler
 <p align="center">
   <a href="#Quick-Start">Quick Start</a> •
   <a href="#Overview">Overview</a> • 
-  <a href="#How-To-Run">How-To-Run</a> •
+  <a href="#Step-by-step">Create a map in 10 steps</a> •
+  <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="#Modder-Toolbox">Modder Toolbox</a><br>
   <a href="#Supported-objects">Supported objects</a> •
   <a href="#Generation-info">Generation info</a> •
@@ -129,6 +131,9 @@ Parameters:
 - coordinates: 45.15, 19.71
 - size: 16 x 16 km
 
+## Step by step
+Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
+
 ## 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:
@@ -205,12 +210,15 @@ The map will be saved in the `map_directory` directory.
 ## 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>
 
-![Modder Toolbox](https://github.com/user-attachments/assets/18f169e9-1a5b-474c-b488-6becfffadcea)
+![Modder Toolbox](https://github.com/user-attachments/assets/dffb252f-f5c0-4021-9d45-31e5bccc0d9b)
 
 ### Tool categories
 Tools are divided into categories, which are listed below.
 #### Textures and DEM
-- **GeoTIFF windowing** - allows you to upload your GeoTIFF file and select the region of interest to extract it from the image.
+- **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 the height map using it.
+
+#### Background terrain
+- **Convert image to obj model** - allows you to convert the image to the obj model. You can use this tool to create the background terrain for your map. It can be extremely useful if you have access to the sources of high-resolution DEM data and want to create the background terrain using it.
 
 ## Supported objects
 The project is based on the [OpenStreetMap](https://www.openstreetmap.org/) data. So, refer to [this page](https://wiki.openstreetmap.org/wiki/Map_Features) to understand the list below.
@@ -379,7 +387,7 @@ Let's have a closer look at the fields:
 
 ## Background terrain
 The tool now supports the generation of the background terrain. If you don't know what it is, here's a brief explanation. The background terrain is the world around the map. It's important to create it, because if you don't, the map will look like it's floating in the void. The background terrain is a simple plane which can (and should) be texture to look fine.<br>
-So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `objects/tiles` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
+So, the tool generates the background terrain in the form of the 8 tiles, which surround the map. The tiles are named as the cardinal points, e.g. "N", "NE", "E" and so on. All those tiles will be saved in the `background` directory with corresponding names: `N.obj`, `NE.obj`, `E.obj` and so on.<br>
 If you don't want to work with separate tiles, the tool also generates the `FULL.obj` file, which includes everything around the map and the map itself. It may be a convinient approach to work with one file, one texture and then just cut the map from it.<br>
 
 ![Complete background terrain in Blender](https://github.com/user-attachments/assets/7266b8f1-bfa2-4c14-a740-1c84b1030a66)

{maps4fs-0.9.99.dist-info → maps4fs-1.0.0.dist-info}/RECORD

@@ -12,11 +12,12 @@ maps4fs/generator/map.py,sha256=1EJfq5928xbV7v9vBBuoC3VpD5gC1SMDBTQ7geH6yaA,4678
 maps4fs/generator/path_steps.py,sha256=yeN6hmOD8O2LMozUf4HcQMIy8WJ5sHF5pGQT_s2FfOw,3147
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
 maps4fs/generator/texture.py,sha256=uSuqJyZom861_BO-3aUqU8_OkroExmN25PsRBjdddkw,23799
-maps4fs/generator/tile.py,sha256=6zUpDidPcPRTGzQvYSNw-0Pj-if2WiakU2qb-40vyOk,2151
+maps4fs/generator/tile.py,sha256=_UZ-iHGPghUfpYcG0OboquNczpZ1FaCVYpBgNLd72eo,2160
 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-0.9.99.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-0.9.99.dist-info/METADATA,sha256=e23P4VVbfJ9L9OvW0k1j9ppNIRDGAMUBW623o1n9-zM,25393
-maps4fs-0.9.99.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.9.99.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.9.99.dist-info/RECORD,,
+maps4fs-1.0.0.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.0.0.dist-info/METADATA,sha256=x6wxcTW4FKrS_F7hrak7CcnB8aXCQ06MPkeR18YpjCM,26085
+maps4fs-1.0.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-1.0.0.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.0.0.dist-info/RECORD,,