maps4fs 0.7.8__tar.gz

maps4fs-0.7.8/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright © [2024] [iwatkot]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

maps4fs-0.7.8/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.1
+Name: maps4fs
+Version: 0.7.8
+Summary: Generate map templates for Farming Simulator from real places.
+Author-email: iwatkot <iwatkot@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/iwatkot/maps4fs
+Project-URL: Repository, https://github.com/iwatkot/maps4fs
+Keywords: farmingsimulator,fs,farmingsimulator22,farmingsimulator25,fs22,fs25
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: opencv-python
+Requires-Dist: osmnx<2.0.0
+Requires-Dist: rasterio
+Requires-Dist: tqdm
+
+<div align="center" markdown>
+<img src="https://github.com/iwatkot/maps4fs/assets/118521851/ffd7f0a3-e317-4c3f-911f-2c2fb736fbfa">
+
+<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="#Supported-objects">Supported objects</a> • 
+  <a href="#For-advanced-users">For advanced users</a> • 
+  <a href="#Bugs-and-feature-requests">Bugs and feature requests</a>
+</p>
+
+
+[![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>
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b922fd0a7188d37e61de/test_coverage)](https://codeclimate.com/github/iwatkot/maps4fs/test_coverage)
+[![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)
+
+</div>
+
+🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
+🌍 Based on real-world data from OpenStreetMap<br>
+🏞️ Generates height using SRTM dataset<br>
+📦 Provides a ready-to-use map template for the Giants Editor<br>
+🚜 Supports Farming Simulator 22 and 25<br>
+
+## Quick Start
+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
+```
+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>
+
+The main goal of this project is to generate map templates, based on real-world data, for the Farming Simulator. It's important to mention that **templates are not maps**. They are just a starting point for creating a map. This tool just uses built-in textures to highlight different types of terrain and buildings with correct shapes and scales and to generate a height map. The rest of the work is up to you. So if you thought that you could just run this tool and get a playable map, then I'm sorry to disappoint you. But if you are a map maker, then this tool will save you a lot of time.<br>
+So, if you're new to map making, here's a quick overview of the process:
+1. Generate a map template using this tool.
+2. Download the Giants Editor.
+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.
+
+![16 km map](https://github.com/user-attachments/assets/82543bcc-1289-479e-bd13-85a8890f0485)<br>
+*Preview of a 16 km map with a 500-meter mountain in the middle of it.*<br>
+
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
+
+## 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:
+<a href="https://www.youtube.com/watch?v=ujwWKHVKsw8" target="_blank"><img src="https://github.com/user-attachments/assets/6dbbbc71-d04f-40b2-9fba-81e5e4857407"/></a>
+<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>
+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>
+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.
+2. Run the following command in your terminal:
+```bash
+docker run -d -p 8501:8501 iwatkot/maps4fs
+```
+3. Open your browser and go to [http://localhost:8501](http://localhost:8501).
+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.
+
+![WebUI](https://github.com/user-attachments/assets/581e1206-2abd-4b3c-ad31-80554ad92d99)
+
+### Option 3: Python package
+🔴 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.
+  height=1024,  # The height of the map in meters.
+  width=1024,  # The width of the map in meters.
+  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
+)
+```
+
+4. Generate the map:
+```python
+map.generate()
+```
+
+The map will be saved in the `map_directory` directory.
+
+## 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.
+- "building": True
+- "highway": ["motorway", "trunk", "primary"]
+- "highway": ["secondary", "tertiary", "road", "service"]
+- "highway": ["unclassified", "residential", "track"]
+- "natural": ["grassland", "scrub"]
+- "landuse": "farmland"
+- "natural": ["water"]
+- "waterway": True
+- "natural": ["wood", "tree_row"]
+- "railway": True
+
+The list will be updated as the project develops.
+
+## Info sequence
+The script will also generate the `generation_info.json` file in the `output` folder. It contains the following keys: <br>
+`"coordinates"` - the coordinates of the map center which you entered,<br>
+`"bbox"` - the bounding box of the map in lat and lon,<br>
+`"map_height"` - the height of the map in meters (this one is from the user input, e.g. 2048 and so on),<br>
+`"map_width"` - the width of the map in meters (same as above),<br>
+`"minimum_x"` - the minimum x coordinate of the map (UTM projection),<br>
+`"minimum_y"` - the minimum y coordinate of the map (UTM projection),<br>
+`"maximum_x"` - the maximum x coordinate of the map (UTM projection),<br>
+`"maximum_y"` - the maximum y coordinate of the map (UTM projection),<br>
+`"height"` - the height of the map in meters (it won't be equal to the parameters above since the Earth is not flat, sorry flat-earthers),<br>
+`"width"` - the width of the map in meters (same as above),<br>
+`"height_coef"` - since we need a texture of exact size, the height of the map is multiplied by this coefficient,<br>
+`"width_coef"` - same as above but for the width,<br>
+`"tile_name"` - the name of the SRTM tile which was used to generate the height map, e.g. "N52E013"<br>
+
+You can use this information to adjust some other sources of data to the map, e.g. textures, height maps, etc.
+
+## 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>
+
+⛔️ Do not use this feature, if you don't know what you're doing. In most cases the Giants Editor will just crash on opening the file, because you need to enter a specific values for the map size.<br><br>
+
+![Advanced settings and custom size](https://github.com/user-attachments/assets/327b6065-09ed-41d0-86a8-7d904025707c)
+
+You can also apply some advanced settings to the map generation process. Note that they're ADVANCED, so you don't need to use them if you're not sure what they do.<br>
+
+Here's the list of the advanced settings:
+
+- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. So, by default this value is set to 3. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the [heightScale](https://www.farming-simulator.org/19/terrain-heightscale.php) parameter on the [PMC Farming Simulator](https://www.farming-simulator.org/) website.
+
+- DEM Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result as a Minecraft-like 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>

maps4fs-0.7.8/README.md

@@ -0,0 +1,198 @@
+<div align="center" markdown>
+<img src="https://github.com/iwatkot/maps4fs/assets/118521851/ffd7f0a3-e317-4c3f-911f-2c2fb736fbfa">
+
+<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="#Supported-objects">Supported objects</a> • 
+  <a href="#For-advanced-users">For advanced users</a> • 
+  <a href="#Bugs-and-feature-requests">Bugs and feature requests</a>
+</p>
+
+
+[![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>
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b922fd0a7188d37e61de/test_coverage)](https://codeclimate.com/github/iwatkot/maps4fs/test_coverage)
+[![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)
+
+</div>
+
+🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
+🌍 Based on real-world data from OpenStreetMap<br>
+🏞️ Generates height using SRTM dataset<br>
+📦 Provides a ready-to-use map template for the Giants Editor<br>
+🚜 Supports Farming Simulator 22 and 25<br>
+
+## Quick Start
+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
+```
+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>
+
+The main goal of this project is to generate map templates, based on real-world data, for the Farming Simulator. It's important to mention that **templates are not maps**. They are just a starting point for creating a map. This tool just uses built-in textures to highlight different types of terrain and buildings with correct shapes and scales and to generate a height map. The rest of the work is up to you. So if you thought that you could just run this tool and get a playable map, then I'm sorry to disappoint you. But if you are a map maker, then this tool will save you a lot of time.<br>
+So, if you're new to map making, here's a quick overview of the process:
+1. Generate a map template using this tool.
+2. Download the Giants Editor.
+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.
+
+![16 km map](https://github.com/user-attachments/assets/82543bcc-1289-479e-bd13-85a8890f0485)<br>
+*Preview of a 16 km map with a 500-meter mountain in the middle of it.*<br>
+
+Parameters:
+- coordinates: 45.15, 19.71
+- size: 16 x 16 km
+
+## 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:
+<a href="https://www.youtube.com/watch?v=ujwWKHVKsw8" target="_blank"><img src="https://github.com/user-attachments/assets/6dbbbc71-d04f-40b2-9fba-81e5e4857407"/></a>
+<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>
+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>
+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.
+2. Run the following command in your terminal:
+```bash
+docker run -d -p 8501:8501 iwatkot/maps4fs
+```
+3. Open your browser and go to [http://localhost:8501](http://localhost:8501).
+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.
+
+![WebUI](https://github.com/user-attachments/assets/581e1206-2abd-4b3c-ad31-80554ad92d99)
+
+### Option 3: Python package
+🔴 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.
+  height=1024,  # The height of the map in meters.
+  width=1024,  # The width of the map in meters.
+  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
+)
+```
+
+4. Generate the map:
+```python
+map.generate()
+```
+
+The map will be saved in the `map_directory` directory.
+
+## 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.
+- "building": True
+- "highway": ["motorway", "trunk", "primary"]
+- "highway": ["secondary", "tertiary", "road", "service"]
+- "highway": ["unclassified", "residential", "track"]
+- "natural": ["grassland", "scrub"]
+- "landuse": "farmland"
+- "natural": ["water"]
+- "waterway": True
+- "natural": ["wood", "tree_row"]
+- "railway": True
+
+The list will be updated as the project develops.
+
+## Info sequence
+The script will also generate the `generation_info.json` file in the `output` folder. It contains the following keys: <br>
+`"coordinates"` - the coordinates of the map center which you entered,<br>
+`"bbox"` - the bounding box of the map in lat and lon,<br>
+`"map_height"` - the height of the map in meters (this one is from the user input, e.g. 2048 and so on),<br>
+`"map_width"` - the width of the map in meters (same as above),<br>
+`"minimum_x"` - the minimum x coordinate of the map (UTM projection),<br>
+`"minimum_y"` - the minimum y coordinate of the map (UTM projection),<br>
+`"maximum_x"` - the maximum x coordinate of the map (UTM projection),<br>
+`"maximum_y"` - the maximum y coordinate of the map (UTM projection),<br>
+`"height"` - the height of the map in meters (it won't be equal to the parameters above since the Earth is not flat, sorry flat-earthers),<br>
+`"width"` - the width of the map in meters (same as above),<br>
+`"height_coef"` - since we need a texture of exact size, the height of the map is multiplied by this coefficient,<br>
+`"width_coef"` - same as above but for the width,<br>
+`"tile_name"` - the name of the SRTM tile which was used to generate the height map, e.g. "N52E013"<br>
+
+You can use this information to adjust some other sources of data to the map, e.g. textures, height maps, etc.
+
+## 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>
+
+⛔️ Do not use this feature, if you don't know what you're doing. In most cases the Giants Editor will just crash on opening the file, because you need to enter a specific values for the map size.<br><br>
+
+![Advanced settings and custom size](https://github.com/user-attachments/assets/327b6065-09ed-41d0-86a8-7d904025707c)
+
+You can also apply some advanced settings to the map generation process. Note that they're ADVANCED, so you don't need to use them if you're not sure what they do.<br>
+
+Here's the list of the advanced settings:
+
+- DEM multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum avaiable value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. So, by default this value is set to 3. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the [heightScale](https://www.farming-simulator.org/19/terrain-heightscale.php) parameter on the [PMC Farming Simulator](https://www.farming-simulator.org/) website.
+
+- DEM Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result as a Minecraft-like 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>

maps4fs-0.7.8/maps4fs/__init__.py

@@ -0,0 +1,4 @@
+# pylint: disable=missing-module-docstring
+from maps4fs.generator.game import Game
+from maps4fs.generator.map import Map
+from maps4fs.logger import Logger

maps4fs-0.7.8/maps4fs/generator/__init__.py

@@ -0,0 +1 @@
+# pylint: disable=missing-module-docstring

maps4fs-0.7.8/maps4fs/generator/component.py

@@ -0,0 +1,101 @@
+"""This module contains the base class for all map generation components."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+import osmnx as ox  # type: ignore
+
+if TYPE_CHECKING:
+    from maps4fs.generator.game import Game
+
+
+# pylint: disable=R0801, R0903, R0902
+class Component:
+    """Base class for all map generation components.
+
+    Args:
+        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.
+    """
+
+    def __init__(
+        self,
+        game: Game,
+        coordinates: tuple[float, float],
+        map_height: int,
+        map_width: int,
+        map_directory: str,
+        logger: Any = None,
+        **kwargs,  # pylint: disable=W0613, R0913, R0917
+    ):
+        self.game = game
+        self.coordinates = coordinates
+        self.map_height = map_height
+        self.map_width = map_width
+        self.map_directory = map_directory
+        self.logger = logger
+        self.kwargs = kwargs
+
+        self.save_bbox()
+        self.preprocess()
+
+    def preprocess(self) -> None:
+        """Prepares the component for processing. Must be implemented in the child class.
+
+        Raises:
+            NotImplementedError: If the method is not implemented in the child class.
+        """
+        raise NotImplementedError
+
+    def process(self) -> None:
+        """Launches the component processing. Must be implemented in the child class.
+
+        Raises:
+            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
+
+    def get_bbox(self, 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.
+
+        Args:
+            project_utm (bool, optional): Whether to project the bounding box to UTM.
+
+        Returns:
+            tuple[int, int, int, int]: The bounding box of the map.
+        """
+        north, south, _, _ = ox.utils_geo.bbox_from_point(
+            self.coordinates, dist=self.map_height / 2, project_utm=project_utm
+        )
+        _, _, east, west = ox.utils_geo.bbox_from_point(
+            self.coordinates, dist=self.map_width / 2, project_utm=project_utm
+        )
+        bbox = north, south, east, west
+        self.logger.debug(
+            "Calculated bounding box for component: %s: %s, project_utm: %s",
+            self.__class__.__name__,
+            bbox,
+            project_utm,
+        )
+        return bbox
+
+    def save_bbox(self) -> None:
+        """Saves the bounding box of the map to the component instance from the coordinates and the
+        height and width of the map.
+        """
+        self.bbox = self.get_bbox(project_utm=False)
+        self.logger.debug("Saved bounding box: %s", self.bbox)

maps4fs-0.7.8/maps4fs/generator/config.py

@@ -0,0 +1,55 @@
+"""This module contains the Config class for map settings and configuration."""
+
+from __future__ import annotations
+
+import os
+from xml.etree import ElementTree as ET
+
+from maps4fs.generator.component import Component
+
+
+# pylint: disable=R0903
+class Config(Component):
+    """Component for map settings and configuration.
+
+    Args:
+        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.
+    """
+
+    def preprocess(self) -> None:
+        self._map_xml_path = self.game.map_xml_path(self.map_directory)
+        self.logger.debug("Map XML path: %s.", self._map_xml_path)
+
+    def process(self):
+        self._set_map_size()
+
+    def _set_map_size(self):
+        """Edits map.xml file to set correct map size."""
+        if not os.path.isfile(self._map_xml_path):
+            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)
+        root = tree.getroot()
+        for map_elem in root.iter("map"):
+            map_elem.set("width", str(self.map_width))
+            map_elem.set("height", str(self.map_height))
+            self.logger.debug(
+                "Map size set to %sx%s in Map XML file.", self.map_width, self.map_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 []