Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #198

Merged
merged 4 commits into from
Feb 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/step_by_step.md
Original file line number Diff line number Diff line change
@@ -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). 🆕<br>

📹 A complete step-by-step video tutorial is on [YouTube](https://www.youtube.com/watch?v=Nl_aqXJ5nAk&)!

Hey, farmer!
Expand All @@ -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.).
Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions webui/generator/generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
3 changes: 3 additions & 0 deletions webui/generator/main_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
16 changes: 16 additions & 0 deletions webui/templates.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down