maps4fs 2.5.1__tar.gz → 2.5.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. maps4fs-2.5.2/PKG-INFO +160 -0
  2. maps4fs-2.5.2/README.md +130 -0
  3. maps4fs-2.5.2/maps4fs.egg-info/PKG-INFO +160 -0
  4. {maps4fs-2.5.1 → maps4fs-2.5.2}/pyproject.toml +1 -1
  5. maps4fs-2.5.1/PKG-INFO +0 -627
  6. maps4fs-2.5.1/README.md +0 -597
  7. maps4fs-2.5.1/maps4fs.egg-info/PKG-INFO +0 -627
  8. {maps4fs-2.5.1 → maps4fs-2.5.2}/LICENSE.md +0 -0
  9. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/__init__.py +0 -0
  10. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/__init__.py +0 -0
  11. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/__init__.py +0 -0
  12. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/background.py +0 -0
  13. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/base/__init__.py +0 -0
  14. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/base/component.py +0 -0
  15. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/base/component_image.py +0 -0
  16. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/base/component_mesh.py +0 -0
  17. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/base/component_xml.py +0 -0
  18. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/config.py +0 -0
  19. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/dem.py +0 -0
  20. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/grle.py +0 -0
  21. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/i3d.py +0 -0
  22. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/layer.py +0 -0
  23. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/satellite.py +0 -0
  24. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/component/texture.py +0 -0
  25. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/config.py +0 -0
  26. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/game.py +0 -0
  27. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/map.py +0 -0
  28. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/qgis.py +0 -0
  29. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/settings.py +0 -0
  30. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/statistics.py +0 -0
  31. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/generator/utils.py +0 -0
  32. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs/logger.py +0 -0
  33. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs.egg-info/SOURCES.txt +0 -0
  34. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs.egg-info/dependency_links.txt +0 -0
  35. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs.egg-info/requires.txt +0 -0
  36. {maps4fs-2.5.1 → maps4fs-2.5.2}/maps4fs.egg-info/top_level.txt +0 -0
  37. {maps4fs-2.5.1 → maps4fs-2.5.2}/setup.cfg +0 -0
  38. {maps4fs-2.5.1 → maps4fs-2.5.2}/tests/test_generator.py +0 -0
maps4fs-2.5.2/PKG-INFO ADDED
@@ -0,0 +1,160 @@
1
+ Metadata-Version: 2.4
2
+ Name: maps4fs
3
+ Version: 2.5.2
4
+ Summary: Generate map templates for Farming Simulator from real places.
5
+ Author-email: iwatkot <iwatkot@gmail.com>
6
+ License: GNU Affero General Public License v3.0
7
+ Project-URL: Homepage, https://github.com/iwatkot/maps4fs
8
+ Project-URL: Repository, https://github.com/iwatkot/maps4fs
9
+ Keywords: farmingsimulator,fs,farmingsimulator22,farmingsimulator25,fs22,fs25
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: License :: OSI Approved :: GNU Affero General Public License v3
13
+ Classifier: Operating System :: OS Independent
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE.md
16
+ Requires-Dist: opencv-python
17
+ Requires-Dist: osmnx>=2.0.0
18
+ Requires-Dist: rasterio
19
+ Requires-Dist: geopy
20
+ Requires-Dist: trimesh
21
+ Requires-Dist: pydantic
22
+ Requires-Dist: pygmdl
23
+ Requires-Dist: owslib
24
+ Requires-Dist: tqdm
25
+ Requires-Dist: scipy
26
+ Requires-Dist: pydtmdl
27
+ Requires-Dist: manifold3d
28
+ Requires-Dist: fast-simplification
29
+ Dynamic: license-file
30
+
31
+ <p align="center">
32
+ <a href="https://github.com/iwatkot/maps4fs">maps4fs</a> •
33
+ <a href="https://github.com/iwatkot/maps4fsui">maps4fs UI</a> •
34
+ <a href="https://github.com/iwatkot/maps4fsdata">maps4fs Data</a> •
35
+ <a href="https://github.com/iwatkot/maps4fsapi">maps4fs API</a> •
36
+ <a href="https://github.com/iwatkot/maps4fsstats">maps4fs Stats</a> •
37
+ <a href="https://github.com/iwatkot/maps4fsbot">maps4fs Bot</a><br>
38
+ <a href="https://github.com/iwatkot/pygmdl">pygmdl</a> •
39
+ <a href="https://github.com/iwatkot/pydtmdl">pydtmdl</a>
40
+ </p>
41
+
42
+ <div align="center" markdown>
43
+ <a href="https://discord.gg/Sj5QKKyE42">
44
+ <img src="https://github.com/user-attachments/assets/37043333-d6ef-4ca3-9f3c-81323d9d0b71">
45
+ </a>
46
+
47
+ <p align="center">
48
+ <a href="#overview">Overview</a> •
49
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/how_to_launch">How to Launch</a> •
50
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/step_by_step_guide">Step-by-Step Guide</a> •
51
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/workflow_optimizations">Workflow Optimizations</a><br>
52
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/faq">FAQ</a> •
53
+ <a href="https://maps4fs.gitbook.io/docs/setup-and-installation/get_help">Get Help</a> •
54
+ <a href="#Resources">Resources</a> •
55
+ <a href="#Bugs-and-feature-requests">Bugs and feature requests</a><br>
56
+ <a href="#Special-thanks">Special thanks</a>
57
+ </p>
58
+
59
+ [![Join Discord](https://img.shields.io/badge/join-discord-blue)](https://discord.gg/Sj5QKKyE42)
60
+ [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/releases)
61
+ [![PyPI - Version](https://img.shields.io/pypi/v/maps4fs)](https://pypi.org/project/maps4fs)
62
+ [![Docker Pulls](https://img.shields.io/docker/pulls/iwatkot/maps4fs)](https://hub.docker.com/repository/docker/iwatkot/maps4fs/general)
63
+ [![GitHub issues](https://img.shields.io/github/issues/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/issues)<br>
64
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/maps4fs)](https://pypi.org/project/maps4fs)
65
+ [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
66
+ [![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
67
+ [![codecov](https://codecov.io/gh/iwatkot/maps4fs/graph/badge.svg?token=NSKPFSKJXI)](https://codecov.io/gh/iwatkot/maps4fs)
68
+ [![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)<br>
69
+
70
+ </div>
71
+
72
+ 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
73
+ 🔗 Generate maps using an [API](https://github.com/iwatkot/maps4fsapi)<br>
74
+ ✂️ Supports map scaling<br>
75
+ 🔄 Support map rotation<br>
76
+ 🌐 Supports custom [DTM Providers](https://github.com/iwatkot/pydtmdl)<br>
77
+ 🌾 Automatically generates fields<br>
78
+ 🌽 Automatically generates farmlands<br>
79
+ 🌿 Automatically generates decorative foliage<br>
80
+ 🌲 Automatically generates forests<br>
81
+ 🌊 Automatically generates water planes<br>
82
+ 📈 Automatically generates splines<br>
83
+ 🛰️ Automatically downloads high resolution satellite images<br>
84
+ 🌍 Based on real-world data from OpenStreetMap<br>
85
+ 🗺️ Supports [custom OSM maps](/docs/008_customosm.md)<br>
86
+ 🏞️ Generates height map using SRTM dataset<br>
87
+ 📦 Provides a ready-to-use map template for the Giants Editor<br>
88
+ 🚜 Supports Farming Simulator 22 and 25<br>
89
+ 🔷 Generates \*.obj files for background terrain based on the real-world height map<br>
90
+ 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
91
+ 📕 Detailed [documentation](/docs) and tutorials <br>
92
+
93
+ <p align="center">
94
+ <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
95
+ 🌎 Detailed terrain based on real-world data.<br><br>
96
+ <img src="https://github.com/user-attachments/assets/dc40d0bb-c20b-411c-8833-9925d0389452"><br>
97
+ 🛰️ Realistic background terrain with satellite images.<br><br>
98
+ <img src="https://github.com/user-attachments/assets/6e3c0e99-2cce-46ac-82db-5cb60bba7a30"><br>
99
+ 📐 Perfectly aligned background terrain.<br><br>
100
+ <img src="https://github.com/user-attachments/assets/5764b2ec-e626-426f-9f5d-beb12ba95133"><br>
101
+ 🌿 Automatically generates decorative foliage.<br><br>
102
+ <img src="https://github.com/user-attachments/assets/27a5e541-a9f5-4504-b8d2-64aae9fb3e52"><br>
103
+ 🌲 Automatically generates forests.<br><br>
104
+ <img src="https://github.com/user-attachments/assets/cce7d4e0-cba2-4dd2-b22d-03137fb2e860"><br>
105
+ 🌊 Automatically generates water planes.<br><br>
106
+ <img src="https://github.com/user-attachments/assets/0b05b511-a595-48e7-a353-8298081314a4"><br>
107
+ 📈 Automatically generates splines.<br><br>
108
+ <img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
109
+ 🌾 Field generation with one click.<br><br>
110
+ <img width="480" src="https://github.com/user-attachments/assets/4d1fa879-5d60-438b-a84e-16883bcef0ec"><br>
111
+ 🌽 Automatic farmlands generation based on the fields.<br><br>
112
+
113
+ 📹 Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕<br>
114
+
115
+ ![Map example](https://github.com/user-attachments/assets/c46a3581-dd17-462f-b815-e36d4f724947)
116
+
117
+ <p align="center"><i>Map example generated with maps4fs.</i></p>
118
+
119
+ ## Overview
120
+
121
+ The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
122
+
123
+ 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>
124
+ So, if you're new to map making, here's a quick overview of the process:
125
+
126
+ 1. Generate a map template using this tool.
127
+ 2. Download the Giants Editor.
128
+ 3. Open the map template in the Giants Editor.
129
+ 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
130
+
131
+ ## Resources
132
+
133
+ In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
134
+ To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
135
+
136
+ 1. [Giants Editor](https://gdn.giants-software.com/downloads.php) - the official tool for creating maps for the Farming Simulator.
137
+ 2. [Blender](https://www.blender.org/download/) - the open-source 3D modeling software that you can use to create models for the Farming Simulator.
138
+ 3. [Blender Exporter Plugins](https://gdn.giants-software.com/downloads.php) - the official plugins for exporting models from Blender to i3d format (the format used in the Farming Simulator).
139
+
140
+ ## Bugs and feature requests
141
+
142
+ ➡️ Please, before creating an issue or asking some questions, check the [FAQ](docs/FAQ.md) section and the follow the [docs/get_help.md](Get Help) instructions.
143
+
144
+ ## Special thanks
145
+
146
+ Of course, first of all, thanks to the direct [contributors](https://github.com/iwatkot/maps4fs/graphs/contributors) of the project.
147
+
148
+ But also, I want to thank the people who helped me with the project in some way, even if they didn't contribute directly. Here's the list of them:
149
+
150
+ - [Ka5tis](https://github.com/Ka5tis) - for investigating the issue with a "spiky terrain" and finding a solution - changing the `DisplacementLayer` size to a higher value.
151
+ - [Kalderone](https://www.youtube.com/@Kalderone_FS22) - for useful feedback, suggestions, expert advice on the map-making process and highlihting some important settings in the Giants Editor.
152
+ - [OneSunnySunday](https://www.artstation.com/onesunnysunday) - for expert advice on Blender, help in processing background terrain, and compiling detailed tutorials on how to prepare the OBJ files for use in Giants Editor.
153
+ - [BFernaesds](https://github.com/BFernaesds) - for the manual tests of the app.
154
+ - [gamerdesigns](https://github.com/gamerdesigns) - for the manual tests of the app.
155
+ - [Tox3](https://github.com/Tox3) - for the manual tests of the app.
156
+ - [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
157
+ - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
158
+ - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
159
+ - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
160
+ - [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
maps4fs-2.5.2/README.md ADDED
@@ -0,0 +1,130 @@
1
+ <p align="center">
2
+ <a href="https://github.com/iwatkot/maps4fs">maps4fs</a> •
3
+ <a href="https://github.com/iwatkot/maps4fsui">maps4fs UI</a> •
4
+ <a href="https://github.com/iwatkot/maps4fsdata">maps4fs Data</a> •
5
+ <a href="https://github.com/iwatkot/maps4fsapi">maps4fs API</a> •
6
+ <a href="https://github.com/iwatkot/maps4fsstats">maps4fs Stats</a> •
7
+ <a href="https://github.com/iwatkot/maps4fsbot">maps4fs Bot</a><br>
8
+ <a href="https://github.com/iwatkot/pygmdl">pygmdl</a> •
9
+ <a href="https://github.com/iwatkot/pydtmdl">pydtmdl</a>
10
+ </p>
11
+
12
+ <div align="center" markdown>
13
+ <a href="https://discord.gg/Sj5QKKyE42">
14
+ <img src="https://github.com/user-attachments/assets/37043333-d6ef-4ca3-9f3c-81323d9d0b71">
15
+ </a>
16
+
17
+ <p align="center">
18
+ <a href="#overview">Overview</a> •
19
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/how_to_launch">How to Launch</a> •
20
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/step_by_step_guide">Step-by-Step Guide</a> •
21
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/workflow_optimizations">Workflow Optimizations</a><br>
22
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/faq">FAQ</a> •
23
+ <a href="https://maps4fs.gitbook.io/docs/setup-and-installation/get_help">Get Help</a> •
24
+ <a href="#Resources">Resources</a> •
25
+ <a href="#Bugs-and-feature-requests">Bugs and feature requests</a><br>
26
+ <a href="#Special-thanks">Special thanks</a>
27
+ </p>
28
+
29
+ [![Join Discord](https://img.shields.io/badge/join-discord-blue)](https://discord.gg/Sj5QKKyE42)
30
+ [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/releases)
31
+ [![PyPI - Version](https://img.shields.io/pypi/v/maps4fs)](https://pypi.org/project/maps4fs)
32
+ [![Docker Pulls](https://img.shields.io/docker/pulls/iwatkot/maps4fs)](https://hub.docker.com/repository/docker/iwatkot/maps4fs/general)
33
+ [![GitHub issues](https://img.shields.io/github/issues/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/issues)<br>
34
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/maps4fs)](https://pypi.org/project/maps4fs)
35
+ [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
36
+ [![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
37
+ [![codecov](https://codecov.io/gh/iwatkot/maps4fs/graph/badge.svg?token=NSKPFSKJXI)](https://codecov.io/gh/iwatkot/maps4fs)
38
+ [![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)<br>
39
+
40
+ </div>
41
+
42
+ 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
43
+ 🔗 Generate maps using an [API](https://github.com/iwatkot/maps4fsapi)<br>
44
+ ✂️ Supports map scaling<br>
45
+ 🔄 Support map rotation<br>
46
+ 🌐 Supports custom [DTM Providers](https://github.com/iwatkot/pydtmdl)<br>
47
+ 🌾 Automatically generates fields<br>
48
+ 🌽 Automatically generates farmlands<br>
49
+ 🌿 Automatically generates decorative foliage<br>
50
+ 🌲 Automatically generates forests<br>
51
+ 🌊 Automatically generates water planes<br>
52
+ 📈 Automatically generates splines<br>
53
+ 🛰️ Automatically downloads high resolution satellite images<br>
54
+ 🌍 Based on real-world data from OpenStreetMap<br>
55
+ 🗺️ Supports [custom OSM maps](/docs/008_customosm.md)<br>
56
+ 🏞️ Generates height map using SRTM dataset<br>
57
+ 📦 Provides a ready-to-use map template for the Giants Editor<br>
58
+ 🚜 Supports Farming Simulator 22 and 25<br>
59
+ 🔷 Generates \*.obj files for background terrain based on the real-world height map<br>
60
+ 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
61
+ 📕 Detailed [documentation](/docs) and tutorials <br>
62
+
63
+ <p align="center">
64
+ <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
65
+ 🌎 Detailed terrain based on real-world data.<br><br>
66
+ <img src="https://github.com/user-attachments/assets/dc40d0bb-c20b-411c-8833-9925d0389452"><br>
67
+ 🛰️ Realistic background terrain with satellite images.<br><br>
68
+ <img src="https://github.com/user-attachments/assets/6e3c0e99-2cce-46ac-82db-5cb60bba7a30"><br>
69
+ 📐 Perfectly aligned background terrain.<br><br>
70
+ <img src="https://github.com/user-attachments/assets/5764b2ec-e626-426f-9f5d-beb12ba95133"><br>
71
+ 🌿 Automatically generates decorative foliage.<br><br>
72
+ <img src="https://github.com/user-attachments/assets/27a5e541-a9f5-4504-b8d2-64aae9fb3e52"><br>
73
+ 🌲 Automatically generates forests.<br><br>
74
+ <img src="https://github.com/user-attachments/assets/cce7d4e0-cba2-4dd2-b22d-03137fb2e860"><br>
75
+ 🌊 Automatically generates water planes.<br><br>
76
+ <img src="https://github.com/user-attachments/assets/0b05b511-a595-48e7-a353-8298081314a4"><br>
77
+ 📈 Automatically generates splines.<br><br>
78
+ <img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
79
+ 🌾 Field generation with one click.<br><br>
80
+ <img width="480" src="https://github.com/user-attachments/assets/4d1fa879-5d60-438b-a84e-16883bcef0ec"><br>
81
+ 🌽 Automatic farmlands generation based on the fields.<br><br>
82
+
83
+ 📹 Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕<br>
84
+
85
+ ![Map example](https://github.com/user-attachments/assets/c46a3581-dd17-462f-b815-e36d4f724947)
86
+
87
+ <p align="center"><i>Map example generated with maps4fs.</i></p>
88
+
89
+ ## Overview
90
+
91
+ The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
92
+
93
+ 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>
94
+ So, if you're new to map making, here's a quick overview of the process:
95
+
96
+ 1. Generate a map template using this tool.
97
+ 2. Download the Giants Editor.
98
+ 3. Open the map template in the Giants Editor.
99
+ 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
100
+
101
+ ## Resources
102
+
103
+ In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
104
+ To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
105
+
106
+ 1. [Giants Editor](https://gdn.giants-software.com/downloads.php) - the official tool for creating maps for the Farming Simulator.
107
+ 2. [Blender](https://www.blender.org/download/) - the open-source 3D modeling software that you can use to create models for the Farming Simulator.
108
+ 3. [Blender Exporter Plugins](https://gdn.giants-software.com/downloads.php) - the official plugins for exporting models from Blender to i3d format (the format used in the Farming Simulator).
109
+
110
+ ## Bugs and feature requests
111
+
112
+ ➡️ Please, before creating an issue or asking some questions, check the [FAQ](docs/FAQ.md) section and the follow the [docs/get_help.md](Get Help) instructions.
113
+
114
+ ## Special thanks
115
+
116
+ Of course, first of all, thanks to the direct [contributors](https://github.com/iwatkot/maps4fs/graphs/contributors) of the project.
117
+
118
+ But also, I want to thank the people who helped me with the project in some way, even if they didn't contribute directly. Here's the list of them:
119
+
120
+ - [Ka5tis](https://github.com/Ka5tis) - for investigating the issue with a "spiky terrain" and finding a solution - changing the `DisplacementLayer` size to a higher value.
121
+ - [Kalderone](https://www.youtube.com/@Kalderone_FS22) - for useful feedback, suggestions, expert advice on the map-making process and highlihting some important settings in the Giants Editor.
122
+ - [OneSunnySunday](https://www.artstation.com/onesunnysunday) - for expert advice on Blender, help in processing background terrain, and compiling detailed tutorials on how to prepare the OBJ files for use in Giants Editor.
123
+ - [BFernaesds](https://github.com/BFernaesds) - for the manual tests of the app.
124
+ - [gamerdesigns](https://github.com/gamerdesigns) - for the manual tests of the app.
125
+ - [Tox3](https://github.com/Tox3) - for the manual tests of the app.
126
+ - [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
127
+ - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
128
+ - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
129
+ - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
130
+ - [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
maps4fs-2.5.2/maps4fs.egg-info/PKG-INFO ADDED
@@ -0,0 +1,160 @@
1
+ Metadata-Version: 2.4
2
+ Name: maps4fs
3
+ Version: 2.5.2
4
+ Summary: Generate map templates for Farming Simulator from real places.
5
+ Author-email: iwatkot <iwatkot@gmail.com>
6
+ License: GNU Affero General Public License v3.0
7
+ Project-URL: Homepage, https://github.com/iwatkot/maps4fs
8
+ Project-URL: Repository, https://github.com/iwatkot/maps4fs
9
+ Keywords: farmingsimulator,fs,farmingsimulator22,farmingsimulator25,fs22,fs25
10
+ Classifier: Programming Language :: Python :: 3.11
11
+ Classifier: Programming Language :: Python :: 3.12
12
+ Classifier: License :: OSI Approved :: GNU Affero General Public License v3
13
+ Classifier: Operating System :: OS Independent
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE.md
16
+ Requires-Dist: opencv-python
17
+ Requires-Dist: osmnx>=2.0.0
18
+ Requires-Dist: rasterio
19
+ Requires-Dist: geopy
20
+ Requires-Dist: trimesh
21
+ Requires-Dist: pydantic
22
+ Requires-Dist: pygmdl
23
+ Requires-Dist: owslib
24
+ Requires-Dist: tqdm
25
+ Requires-Dist: scipy
26
+ Requires-Dist: pydtmdl
27
+ Requires-Dist: manifold3d
28
+ Requires-Dist: fast-simplification
29
+ Dynamic: license-file
30
+
31
+ <p align="center">
32
+ <a href="https://github.com/iwatkot/maps4fs">maps4fs</a> •
33
+ <a href="https://github.com/iwatkot/maps4fsui">maps4fs UI</a> •
34
+ <a href="https://github.com/iwatkot/maps4fsdata">maps4fs Data</a> •
35
+ <a href="https://github.com/iwatkot/maps4fsapi">maps4fs API</a> •
36
+ <a href="https://github.com/iwatkot/maps4fsstats">maps4fs Stats</a> •
37
+ <a href="https://github.com/iwatkot/maps4fsbot">maps4fs Bot</a><br>
38
+ <a href="https://github.com/iwatkot/pygmdl">pygmdl</a> •
39
+ <a href="https://github.com/iwatkot/pydtmdl">pydtmdl</a>
40
+ </p>
41
+
42
+ <div align="center" markdown>
43
+ <a href="https://discord.gg/Sj5QKKyE42">
44
+ <img src="https://github.com/user-attachments/assets/37043333-d6ef-4ca3-9f3c-81323d9d0b71">
45
+ </a>
46
+
47
+ <p align="center">
48
+ <a href="#overview">Overview</a> •
49
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/how_to_launch">How to Launch</a> •
50
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/step_by_step_guide">Step-by-Step Guide</a> •
51
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/workflow_optimizations">Workflow Optimizations</a><br>
52
+ <a href="https://maps4fs.gitbook.io/docs/getting-started/faq">FAQ</a> •
53
+ <a href="https://maps4fs.gitbook.io/docs/setup-and-installation/get_help">Get Help</a> •
54
+ <a href="#Resources">Resources</a> •
55
+ <a href="#Bugs-and-feature-requests">Bugs and feature requests</a><br>
56
+ <a href="#Special-thanks">Special thanks</a>
57
+ </p>
58
+
59
+ [![Join Discord](https://img.shields.io/badge/join-discord-blue)](https://discord.gg/Sj5QKKyE42)
60
+ [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/releases)
61
+ [![PyPI - Version](https://img.shields.io/pypi/v/maps4fs)](https://pypi.org/project/maps4fs)
62
+ [![Docker Pulls](https://img.shields.io/docker/pulls/iwatkot/maps4fs)](https://hub.docker.com/repository/docker/iwatkot/maps4fs/general)
63
+ [![GitHub issues](https://img.shields.io/github/issues/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/issues)<br>
64
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/maps4fs)](https://pypi.org/project/maps4fs)
65
+ [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
66
+ [![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
67
+ [![codecov](https://codecov.io/gh/iwatkot/maps4fs/graph/badge.svg?token=NSKPFSKJXI)](https://codecov.io/gh/iwatkot/maps4fs)
68
+ [![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)<br>
69
+
70
+ </div>
71
+
72
+ 🗺️ Supports 2x2, 4x4, 8x8, 16x16 and any custom size maps<br>
73
+ 🔗 Generate maps using an [API](https://github.com/iwatkot/maps4fsapi)<br>
74
+ ✂️ Supports map scaling<br>
75
+ 🔄 Support map rotation<br>
76
+ 🌐 Supports custom [DTM Providers](https://github.com/iwatkot/pydtmdl)<br>
77
+ 🌾 Automatically generates fields<br>
78
+ 🌽 Automatically generates farmlands<br>
79
+ 🌿 Automatically generates decorative foliage<br>
80
+ 🌲 Automatically generates forests<br>
81
+ 🌊 Automatically generates water planes<br>
82
+ 📈 Automatically generates splines<br>
83
+ 🛰️ Automatically downloads high resolution satellite images<br>
84
+ 🌍 Based on real-world data from OpenStreetMap<br>
85
+ 🗺️ Supports [custom OSM maps](/docs/008_customosm.md)<br>
86
+ 🏞️ Generates height map using SRTM dataset<br>
87
+ 📦 Provides a ready-to-use map template for the Giants Editor<br>
88
+ 🚜 Supports Farming Simulator 22 and 25<br>
89
+ 🔷 Generates \*.obj files for background terrain based on the real-world height map<br>
90
+ 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
91
+ 📕 Detailed [documentation](/docs) and tutorials <br>
92
+
93
+ <p align="center">
94
+ <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
95
+ 🌎 Detailed terrain based on real-world data.<br><br>
96
+ <img src="https://github.com/user-attachments/assets/dc40d0bb-c20b-411c-8833-9925d0389452"><br>
97
+ 🛰️ Realistic background terrain with satellite images.<br><br>
98
+ <img src="https://github.com/user-attachments/assets/6e3c0e99-2cce-46ac-82db-5cb60bba7a30"><br>
99
+ 📐 Perfectly aligned background terrain.<br><br>
100
+ <img src="https://github.com/user-attachments/assets/5764b2ec-e626-426f-9f5d-beb12ba95133"><br>
101
+ 🌿 Automatically generates decorative foliage.<br><br>
102
+ <img src="https://github.com/user-attachments/assets/27a5e541-a9f5-4504-b8d2-64aae9fb3e52"><br>
103
+ 🌲 Automatically generates forests.<br><br>
104
+ <img src="https://github.com/user-attachments/assets/cce7d4e0-cba2-4dd2-b22d-03137fb2e860"><br>
105
+ 🌊 Automatically generates water planes.<br><br>
106
+ <img src="https://github.com/user-attachments/assets/0b05b511-a595-48e7-a353-8298081314a4"><br>
107
+ 📈 Automatically generates splines.<br><br>
108
+ <img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
109
+ 🌾 Field generation with one click.<br><br>
110
+ <img width="480" src="https://github.com/user-attachments/assets/4d1fa879-5d60-438b-a84e-16883bcef0ec"><br>
111
+ 🌽 Automatic farmlands generation based on the fields.<br><br>
112
+
113
+ 📹 Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕<br>
114
+
115
+ ![Map example](https://github.com/user-attachments/assets/c46a3581-dd17-462f-b815-e36d4f724947)
116
+
117
+ <p align="center"><i>Map example generated with maps4fs.</i></p>
118
+
119
+ ## Overview
120
+
121
+ The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
122
+
123
+ 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>
124
+ So, if you're new to map making, here's a quick overview of the process:
125
+
126
+ 1. Generate a map template using this tool.
127
+ 2. Download the Giants Editor.
128
+ 3. Open the map template in the Giants Editor.
129
+ 4. Now you can start creating your map (adding roads, fields, buildings, etc.).
130
+
131
+ ## Resources
132
+
133
+ In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
134
+ To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
135
+
136
+ 1. [Giants Editor](https://gdn.giants-software.com/downloads.php) - the official tool for creating maps for the Farming Simulator.
137
+ 2. [Blender](https://www.blender.org/download/) - the open-source 3D modeling software that you can use to create models for the Farming Simulator.
138
+ 3. [Blender Exporter Plugins](https://gdn.giants-software.com/downloads.php) - the official plugins for exporting models from Blender to i3d format (the format used in the Farming Simulator).
139
+
140
+ ## Bugs and feature requests
141
+
142
+ ➡️ Please, before creating an issue or asking some questions, check the [FAQ](docs/FAQ.md) section and the follow the [docs/get_help.md](Get Help) instructions.
143
+
144
+ ## Special thanks
145
+
146
+ Of course, first of all, thanks to the direct [contributors](https://github.com/iwatkot/maps4fs/graphs/contributors) of the project.
147
+
148
+ But also, I want to thank the people who helped me with the project in some way, even if they didn't contribute directly. Here's the list of them:
149
+
150
+ - [Ka5tis](https://github.com/Ka5tis) - for investigating the issue with a "spiky terrain" and finding a solution - changing the `DisplacementLayer` size to a higher value.
151
+ - [Kalderone](https://www.youtube.com/@Kalderone_FS22) - for useful feedback, suggestions, expert advice on the map-making process and highlihting some important settings in the Giants Editor.
152
+ - [OneSunnySunday](https://www.artstation.com/onesunnysunday) - for expert advice on Blender, help in processing background terrain, and compiling detailed tutorials on how to prepare the OBJ files for use in Giants Editor.
153
+ - [BFernaesds](https://github.com/BFernaesds) - for the manual tests of the app.
154
+ - [gamerdesigns](https://github.com/gamerdesigns) - for the manual tests of the app.
155
+ - [Tox3](https://github.com/Tox3) - for the manual tests of the app.
156
+ - [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
157
+ - [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.
158
+ - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
159
+ - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
160
+ - [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
{maps4fs-2.5.1 → maps4fs-2.5.2}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "maps4fs"
7
- version = "2.5.1"
7
+ version = "2.5.2"
8
8
  description = "Generate map templates for Farming Simulator from real places."
9
9
  authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
10
10
  license = {text = "GNU Affero General Public License v3.0"}