maps4fs 1.0.1__tar.gz → 1.0.4__tar.gz

{maps4fs-1.0.1 → maps4fs-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.0.1
+Version: 1.0.4
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -89,6 +89,13 @@ Requires-Dist: pympler
 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>
+<i>Note, that StreamLit community hosting has some limitations, such as:  <br>
+1. Maximum map size is 4096x4096 meters.  <br>
+2. Advanced settings are disabled.  <br>
+3. Texure dissolving is disabled (they will look worse).  </i><br>
+
+If you run the application locally, you won't have any of these limitations and will be able to generate maps of any size with any settings you want and nice looking textures.<br>
+So, jump to [Docker version](#option-2-docker-version) to launch the tool with one command and get the full experience.<br>
 
 ![Basic WebUI](https://github.com/user-attachments/assets/52f499cc-f28a-4da3-abef-0e818abe8dbe)
 
@@ -141,14 +148,22 @@ You'll find detailed instructions on how to run the project below. But if you pr
 <i>Video tutorial: How to generate a Farming Simulator 22 map from real-world data.</i>
 
 ### Option 1: StreamLit
-🟢 Recommended for all users, you don't need to install anything.<br>
+🟢 Recommended for all users.
+🛠️ Don't need to install anything.  
+🗺️ Supported map sizes: 2x2, 4x4 km.  
+⚙️ Advanced settings: disabled.  
+🖼️ Texture dissolving: disabled.  
 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
-🟠 Recommended for users who want faster processing, very simple installation.<br>
+🟠 Recommended for users who want bigger maps, fast generation, nice looking textures and advanced settings.  
+🛠️ Launch with one single command.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+⚙️ Advanced settings: enabled.   
+🖼️ Texture dissolving: enabled.  
 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.
@@ -161,7 +176,10 @@ docker run -d -p 8501:8501 iwatkot/maps4fs
 5. When the map is generated click on the `Download` button to get the map.
 
 ### Option 3: Python package
-🔴 Recommended for developers.<br>
+🔴 Recommended for developers.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+⚙️ Advanced settings: enabled.   
+🖼️ Texture dissolving: enabled.  
 You can use the Python package to generate maps. Follow these steps:
 
 1. Install the package from PyPI:

{maps4fs-1.0.1 → maps4fs-1.0.4}/README.md

@@ -64,6 +64,13 @@
 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>
+<i>Note, that StreamLit community hosting has some limitations, such as:  <br>
+1. Maximum map size is 4096x4096 meters.  <br>
+2. Advanced settings are disabled.  <br>
+3. Texure dissolving is disabled (they will look worse).  </i><br>
+
+If you run the application locally, you won't have any of these limitations and will be able to generate maps of any size with any settings you want and nice looking textures.<br>
+So, jump to [Docker version](#option-2-docker-version) to launch the tool with one command and get the full experience.<br>
 
 ![Basic WebUI](https://github.com/user-attachments/assets/52f499cc-f28a-4da3-abef-0e818abe8dbe)
 
@@ -116,14 +123,22 @@ You'll find detailed instructions on how to run the project below. But if you pr
 <i>Video tutorial: How to generate a Farming Simulator 22 map from real-world data.</i>
 
 ### Option 1: StreamLit
-🟢 Recommended for all users, you don't need to install anything.<br>
+🟢 Recommended for all users.
+🛠️ Don't need to install anything.  
+🗺️ Supported map sizes: 2x2, 4x4 km.  
+⚙️ Advanced settings: disabled.  
+🖼️ Texture dissolving: disabled.  
 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
-🟠 Recommended for users who want faster processing, very simple installation.<br>
+🟠 Recommended for users who want bigger maps, fast generation, nice looking textures and advanced settings.  
+🛠️ Launch with one single command.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+⚙️ Advanced settings: enabled.   
+🖼️ Texture dissolving: enabled.  
 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.
@@ -136,7 +151,10 @@ docker run -d -p 8501:8501 iwatkot/maps4fs
 5. When the map is generated click on the `Download` button to get the map.
 
 ### Option 3: Python package
-🔴 Recommended for developers.<br>
+🔴 Recommended for developers.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+⚙️ Advanced settings: enabled.   
+🖼️ Texture dissolving: enabled.  
 You can use the Python package to generate maps. Follow these steps:
 
 1. Install the package from PyPI:

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/background.py

@@ -143,7 +143,7 @@ class Background(Component):
                 self.logger.warning("DEM file not found, generation will be stopped: %s", dem_path)
                 return
 
-            self.logger.info("DEM file for tile %s found: %s", tile.code, dem_path)
+            self.logger.debug("DEM file for tile %s found: %s", tile.code, dem_path)
 
             base_directory = os.path.dirname(dem_path)
             save_path = os.path.join(base_directory, f"{tile.code}.obj")
@@ -164,7 +164,6 @@ class Background(Component):
         if tile_code == PATH_FULL_NAME:
             resize_factor = FULL_RESIZE_FACTOR
             simplify_factor = FULL_SIMPLIFY_FACTOR
-            self.logger.info("Generating a full map obj file")
         else:
             resize_factor = RESIZE_FACTOR
             simplify_factor = SIMPLIFY_FACTOR
@@ -214,7 +213,7 @@ class Background(Component):
         mesh.apply_transform(rotation_matrix_y)
         mesh.apply_transform(rotation_matrix_z)
 
-        self.logger.info("Mesh generated with %s faces, will be simplified", len(mesh.faces))
+        self.logger.debug("Mesh generated with %s faces, will be simplified", len(mesh.faces))
 
         # Simplify the mesh to reduce the number of faces.
         mesh = mesh.simplify_quadric_decimation(face_count=len(faces) // simplify_factor)
@@ -224,7 +223,7 @@ class Background(Component):
             self.mesh_to_stl(mesh)
 
         mesh.export(save_path)
-        self.logger.info("Obj file saved: %s", save_path)
+        self.logger.debug("Obj file saved: %s", save_path)
 
     def mesh_to_stl(self, mesh: trimesh.Trimesh) -> None:
         """Converts the mesh to an STL file and saves it in the previews directory.

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/config.py

@@ -36,7 +36,7 @@ class Config(Component):
             self.logger.warning("Map XML file not found: %s.", self._map_xml_path)
             return
         tree = ET.parse(self._map_xml_path)
-        self.logger.debug("Map XML file loaded from: %s.", self._map_xml_path)
+        self.logger.info("Map XML file loaded from: %s.", self._map_xml_path)
         root = tree.getroot()
         for map_elem in root.iter("map"):
             map_elem.set("width", str(self.map_width))

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/dem.py

@@ -103,7 +103,7 @@ class DEM(Component):
         north, south, east, west = self.bbox
 
         dem_output_resolution = self.get_output_resolution()
-        self.logger.debug("DEM output resolution: %s.", dem_output_resolution)
+        self.logger.info("DEM output resolution: %s.", dem_output_resolution)
 
         tile_path = self._srtm_tile()
         if not tile_path:
@@ -223,7 +223,7 @@ class DEM(Component):
             )
 
         cv2.imwrite(self._dem_path, resampled_data)
-        self.logger.debug("DEM data was saved to %s.", self._dem_path)
+        self.logger.info("DEM data was saved to %s.", self._dem_path)
 
         if self.game.additional_dem_name is not None:
             self.make_copy(self.game.additional_dem_name)
@@ -239,7 +239,7 @@ class DEM(Component):
         additional_dem_path = os.path.join(dem_directory, dem_name)
 
         shutil.copyfile(self._dem_path, additional_dem_path)
-        self.logger.debug("Additional DEM data was copied to %s.", additional_dem_path)
+        self.logger.info("Additional DEM data was copied to %s.", additional_dem_path)
 
     def _tile_info(self, lat: float, lon: float) -> tuple[str, str]:
         """Returns latitude band and tile name for SRTM tile from coordinates.
@@ -260,7 +260,7 @@ class DEM(Component):
         else:
             tile_name = f"{latitude_band}E{abs(tile_longitude):03d}"
 
-        self.logger.debug(
+        self.logger.info(
             "Detected tile name: %s for coordinates: lat %s, lon %s.", tile_name, lat, lon
         )
         return latitude_band, tile_name
@@ -421,14 +421,18 @@ class DEM(Component):
 
         scaling_factor = self._get_scaling_factor(max_dev)
         adjusted_max_height = int(65535 * scaling_factor)
-        self.logger.debug(
-            f"Maximum deviation: {max_dev}. Scaling factor: {scaling_factor}. "
-            f"Adjusted max height: {adjusted_max_height}."
+        self.logger.info(
+            "Maximum deviation: %s. Scaling factor: %s. Adjusted max height: %s.",
+            max_dev,
+            scaling_factor,
+            adjusted_max_height,
         )
         normalized_data = (
             (data - data.min()) / (data.max() - data.min()) * adjusted_max_height
         ).astype("uint16")
         self.logger.debug(
-            f"DEM data was normalized to {normalized_data.min()} - {normalized_data.max()}."
+            "DEM data was normalized to %s - %s.",
+            normalized_data.min(),
+            normalized_data.max(),
         )
         return normalized_data

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/grle.py

@@ -59,9 +59,8 @@ class GRLE(Component):
 
                 # Create the InfoLayer PNG file with zeros.
                 info_layer_data = np.zeros((height, width), dtype=data_type)
-                print(info_layer_data.shape)
                 cv2.imwrite(file_path, info_layer_data)  # pylint: disable=no-member
-                self.logger.info("InfoLayer PNG file %s created.", file_path)
+                self.logger.debug("InfoLayer PNG file %s created.", file_path)
             else:
                 self.logger.warning("Invalid InfoLayer schema: %s.", info_layer)
 

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/i3d.py

@@ -89,7 +89,7 @@ class I3d(Component):
                 self.logger.debug("TerrainTransformGroup element updated in I3D file.")
 
         tree.write(self._map_i3d_path)  # type: ignore
-        self.logger.debug("Map I3D file saved to: %s.", self._map_i3d_path)
+        self.logger.info("Map I3D file saved to: %s.", self._map_i3d_path)
 
     def previews(self) -> list[str]:
         """Returns a list of paths to the preview images (empty list).
@@ -120,13 +120,11 @@ class I3d(Component):
             self.logger.warning("Fields data not found in textures info layer.")
             return
 
-        self.logger.debug("Found %s fields in textures info layer.", len(fields))
+        self.logger.info("Found %s fields in textures info layer.", len(fields))
 
         root = tree.getroot()
         gameplay_node = root.find(".//TransformGroup[@name='gameplay']")
         if gameplay_node is not None:
-            self.logger.debug("Found the gameplay node.")
-
             fields_node = gameplay_node.find(".//TransformGroup[@name='fields']")
             user_attributes_node = root.find(".//UserAttributes")
 
@@ -194,7 +192,7 @@ class I3d(Component):
                     node_id += 1
 
             tree.write(self._map_i3d_path)  # type: ignore
-            self.logger.debug("Map I3D file saved to: %s.", self._map_i3d_path)
+            self.logger.info("Map I3D file saved to: %s.", self._map_i3d_path)
 
     def get_name_indicator_node(self, node_id: int, field_id: int) -> tuple[ET.Element, int]:
         """Creates a name indicator node with given node ID and field ID.

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/map.py

@@ -44,17 +44,17 @@ class Map:
         if not logger:
             logger = Logger(to_stdout=True, to_file=False)
         self.logger = logger
-        self.logger.debug("Game was set to %s", game.code)
+        self.logger.info("Game was set to %s", game.code)
 
         self.kwargs = kwargs
-        self.logger.debug("Additional arguments: %s", kwargs)
+        self.logger.info("Additional arguments: %s", kwargs)
 
         os.makedirs(self.map_directory, exist_ok=True)
         self.logger.debug("Map directory created: %s", self.map_directory)
 
         try:
             shutil.unpack_archive(game.template_path, self.map_directory)
-            self.logger.info("Map template unpacked to %s", self.map_directory)
+            self.logger.debug("Map template unpacked to %s", self.map_directory)
         except Exception as e:
             raise RuntimeError(f"Can not unpack map template due to error: {e}") from e
 

{maps4fs-1.0.1 → maps4fs-1.0.4}/maps4fs/generator/texture.py

@@ -239,7 +239,7 @@ class Texture(Component):
 
         for layer in self.layers:
             self._generate_weights(layer)
-        self.logger.debug("Prepared weights for %s layers.", len(self.layers))
+        self.logger.info("Prepared weights for %s layers.", len(self.layers))
 
     def _generate_weights(self, layer: Layer) -> None:
         """Generates weight files for textures. Each file is a numpy array of zeros and
@@ -339,7 +339,7 @@ class Texture(Component):
             cumulative_image = cv2.bitwise_or(cumulative_image, output_image)
 
             cv2.imwrite(layer_path, output_image)
-            self.logger.debug("Texture %s saved.", layer_path)
+            self.logger.info("Texture %s saved.", layer_path)
 
         # Save info layer data.
         with open(self.info_layer_path, "w", encoding="utf-8") as f:
@@ -351,7 +351,7 @@ class Texture(Component):
         if not self.light_version:
             self.dissolve()
         else:
-            self.logger.info("Skipping dissolve in light version of the map.")
+            self.logger.debug("Skipping dissolve in light version of the map.")
 
     def dissolve(self) -> None:
         """Dissolves textures of the layers with tags into sublayers for them to look more
@@ -423,7 +423,7 @@ class Texture(Component):
             self.logger.debug("Drawing base layer %s.", layer_path)
             img = cv2.bitwise_not(cumulative_image)
             cv2.imwrite(layer_path, img)
-            self.logger.debug("Base texture %s saved.", layer_path)
+            self.logger.info("Base 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-1.0.1 → maps4fs-1.0.4}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.0.1
+Version: 1.0.4
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -89,6 +89,13 @@ Requires-Dist: pympler
 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>
+<i>Note, that StreamLit community hosting has some limitations, such as:  <br>
+1. Maximum map size is 4096x4096 meters.  <br>
+2. Advanced settings are disabled.  <br>
+3. Texure dissolving is disabled (they will look worse).  </i><br>
+
+If you run the application locally, you won't have any of these limitations and will be able to generate maps of any size with any settings you want and nice looking textures.<br>
+So, jump to [Docker version](#option-2-docker-version) to launch the tool with one command and get the full experience.<br>
 
 ![Basic WebUI](https://github.com/user-attachments/assets/52f499cc-f28a-4da3-abef-0e818abe8dbe)
 
@@ -141,14 +148,22 @@ You'll find detailed instructions on how to run the project below. But if you pr
 <i>Video tutorial: How to generate a Farming Simulator 22 map from real-world data.</i>
 
 ### Option 1: StreamLit
-🟢 Recommended for all users, you don't need to install anything.<br>
+🟢 Recommended for all users.
+🛠️ Don't need to install anything.  
+🗺️ Supported map sizes: 2x2, 4x4 km.  
+⚙️ Advanced settings: disabled.  
+🖼️ Texture dissolving: disabled.  
 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
-🟠 Recommended for users who want faster processing, very simple installation.<br>
+🟠 Recommended for users who want bigger maps, fast generation, nice looking textures and advanced settings.  
+🛠️ Launch with one single command.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+⚙️ Advanced settings: enabled.   
+🖼️ Texture dissolving: enabled.  
 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.
@@ -161,7 +176,10 @@ docker run -d -p 8501:8501 iwatkot/maps4fs
 5. When the map is generated click on the `Download` button to get the map.
 
 ### Option 3: Python package
-🔴 Recommended for developers.<br>
+🔴 Recommended for developers.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+⚙️ Advanced settings: enabled.   
+🖼️ Texture dissolving: enabled.  
 You can use the Python package to generate maps. Follow these steps:
 
 1. Install the package from PyPI:

{maps4fs-1.0.1 → maps4fs-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "1.0.1"
+version = "1.0.4"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "MIT License"}