diff --git a/docs/step_by_step.md b/docs/step_by_step.md index 20daed8..72c89c0 100644 --- a/docs/step_by_step.md +++ b/docs/step_by_step.md @@ -1,5 +1,7 @@ ## Create a Farming Simulator map in 10 steps +📹 WIP: Check out the complete playlist of video turorials on [YouTube](https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕
+ 📹 A complete step-by-step video tutorial is on [YouTube](https://www.youtube.com/watch?v=Nl_aqXJ5nAk&)! Hey, farmer! @@ -13,6 +15,8 @@ Let's roll! ### 1. 📍 Get the coordinates of the center of your map It should be easy to do with [Google Maps](https://www.google.com/maps) or [OpenStreetMap](https://www.openstreetmap.org). The coordinates are latitude and longitude values, for example, `51.5074, -0.1278` for London. ℹī¸ This point will be the center of your map, not the top, not the bottom, but the center. +*ī¸âƒŖ Note, that the coordinates should not include any additional and should be decimal, not degrees-minutes-seconds. For example, these coordinates are wrong: `45°16'02.3"N 19°47'32.9"E`, but these are correct: `45.2673, 19.7925`. + ### 2. 📏 Decide the size of your map The default built-in maps in Farming Simulator are 2048x2048 meters, but you can choose any size you want as long as it's a power of 2 (e.g. 1024x1024, 2048x2048, 4096x4096, etc.). @@ -23,16 +27,18 @@ The default built-in maps in Farming Simulator are 2048x2048 meters, but you can Yeah, a 16-kilometer map sounds cool, but probably you'll never gonna make it to the end. So, if you're a beginner I strongly recommend starting with a 2kx2k map, or at least 4kx4k. +*ī¸âƒŖ Note, that at the moment Giants Editor 10 does not support 16-kilometer maps, and will crash if you try to open it. + ### 3. 🚀 Run the generator Now all you need to do is just click on the `Generate` button and wait a little bit. -ℹī¸ There are also some advanced settings you can tweak, but from their name, you should get the idea that they are for the advanced users. Learn more about them in the [For advanced users](https://github.com/iwatkot/maps4fs?tab=readme-ov-file#For-advanced-users) section of the README. +ℹī¸ There are also some advanced settings you can tweak, but from their name, you should get the idea that they are for the advanced users. Learn more about them in the [For advanced users](https://github.com/iwatkot/maps4fs?tab=readme-ov-file#For-advanced-users) section of the README. For experts the tool also offers a set of [Expert Settings](https://github.com/iwatkot/maps4fs?tab=readme-ov-file#Expert-settings) to fine-tune the map generation process and use some additional features. ### 4. đŸ“Ĩ Download and unpack the generated map The generator will provide you with a `.zip` file that contains the map. Unpack it somewhere on your computer. ℹī¸ Learn more about what's inside of the archive in the [Map Structure](https://github.com/iwatkot/maps4fs/blob/main/docs/map_structure.md) document. ### 5. 🌎 Download and align the satellite images -Now, you need to obtain and align the satellite images to use them as textures for the background terrain (and also for the overview.dds file). +The tool can automatically download satellite images for the background terrain (and also for the overview.dds file). Refer to the Satellite Settings section in the generator. ℹī¸ There's a detailed tutorial about it in the [How to download satellite images](https://github.com/iwatkot/maps4fs/blob/main/docs/download_satellite_images.md) document. ### 6. ⛰ī¸ Create a background terrain diff --git a/webui/generator/generator.py b/webui/generator/generator.py index 4cb5e15..21e7a6c 100644 --- a/webui/generator/generator.py +++ b/webui/generator/generator.py @@ -99,6 +99,9 @@ def add_left_widgets(self) -> None: self._show_version() st.write(Messages.MAIN_PAGE_DESCRIPTION) + if self.public: + with st.expander("How to launch the tool locally", icon="ℹī¸"): + st.markdown(Messages.LOCAL_VERSION) st.markdown("---") self.main_settings = MainSettings( diff --git a/webui/generator/main_settings.py b/webui/generator/main_settings.py index d9aa912..d1a4632 100644 --- a/webui/generator/main_settings.py +++ b/webui/generator/main_settings.py @@ -26,6 +26,9 @@ def __init__(self, public: bool, **kwargs): label_visibility="collapsed", ) + if self.game_code == "FS22": + st.warning(Messages.FS22_NOTES, icon="💡") + st.write("Enter latitude and longitude of the center point of the map:") self.lat_lon_input = st.text_input( "Latitude and Longitude", diff --git a/webui/templates.py b/webui/templates.py index 518f48a..ab47f51 100644 --- a/webui/templates.py +++ b/webui/templates.py @@ -8,11 +8,27 @@ class Messages: "maps, or just chat. \n" "🤗 If you like the project, consider supporting it on [Buy Me a Coffee](https://www.buymeacoffee.com/iwatkot) or " "[Patreon](https://www.patreon.com/iwatkot). \n" + "🐙 Visit the [GitHub repository](https://github.com/iwatkot/maps4fs) for more information. \n" "📹 A complete step-by-step video tutorial is on [YouTube](https://www.youtube.com/watch?v=Nl_aqXJ5nAk&)! \n" "📹 WIP: Check out the complete playlist of video turorials on [YouTube]" "(https://www.youtube.com/watch?v=hPbJZ0HoiDE&list=PLug0g7UYHX8D1Jik6NkJjQhdxqS-NOtB9). 🆕" ) + LOCAL_VERSION = ( + "Right now you're using a public version of the app, which has some limitations. \n" + "You can also run the app locally, it will work faster, has no limitations, and " + "have some additional features. \n" + "If you have Docker installed it's just one command: \n" + "```bash \ndocker run -p 8501:8501 iwatkot/maps4fs \n``` \n" + "Detailed instuctions are available in the [README](https://github.com/iwatkot/maps4fs" + "?tab=readme-ov-file#option-2-docker-version)." + ) + + FS22_NOTES = ( + "Support for the Farming Simulator 22 is discontinued. \nSome of the features are not " + "available for this game." + ) + MOVED = "The app has moved to ➡ī¸âžĄī¸âžĄī¸ [maps4fs.xyz](https://maps4fs.xyz)" MAIN_PAGE_COMMUNITY_WARNING = ( "🚜 Hey, farmer! \n"