> For the complete documentation index, see [llms.txt](https://maps4fs.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maps4fs.gitbook.io/docs/setup-and-installation/get_help.md).

# Getting Help

## 🆕 Interactive Help Tool (Recommended)

**The easiest way to get help is using our interactive help page:**

* **Local Deployment:** `http://localhost:3000/help`
* **Public App:** <http://maps4fs.xyz/help>

This interactive tool will:

* 🔍 **Diagnose local deployment issues** - Docker, containers, port conflicts, etc.
* 🛠️ **Guide through troubleshooting** step-by-step
* 📋 **Help you fill out** all required information
* 📄 **Generate a shareable markdown file** for support requests
* 🎯 **Ensure you include** all necessary details

**The interactive tool now covers all local deployment troubleshooting scenarios and provides the same markdown format as the manual process.**

***

## 📋 Quick Reference Guide

| 🎯 Scenario                    | 🔄 Action                                                                                                                                                       |
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🆕 **Any issue**               | 🎯 **Use Interactive Help Tool first** (`/help` page)                                                                                                           |
| 🌐 Public app down             | ⛔ No support provided                                                                                                                                           |
| 🏠 Local deployment issues     | 🎯 **Use Interactive Help Tool first** (`/help` page) → 📖 [Manual troubleshooting](/docs/setup-and-installation/local_deployment.md#troubleshooting) if needed |
| 🐛 Tool works but has problems | ✅ Interactive Help Tool → OR → ✅ FAQ → ✅ SRTM30 → ✅ Manual checklist → 💬 Discord/🐛 GitHub                                                                     |
| 🗺️ Non-SRTM30 DTM issues      | 👤 Contact DTM provider author at [PyDTMDL](https://github.com/iwatkot/pydtmdl)                                                                                 |

* 📋 Help you fill out all required information
* 📄 Generate a shareable markdown file for support requests
* 🎯 Ensure you include all necessary details

**If the interactive tool doesn't solve your issue, it will prepare everything you need for manual support below.**

***

## Manual Support Process

If you prefer manual support or the interactive tool isn't available, follow the decision tree below step by step.

## 🚀 Step 1: Which version are you using?

| <h4>🌐 Public App</h4><p><strong><https://maps4fs.xyz/></strong></p><p><a href="#step-2a-public-app---is-the-tool-working">👉 Go to Step 2A</a></p> | <h4>🏠 Local Deployment</h4><p><strong>Docker/Python on your machine</strong></p><p><a href="#step-2b-local-deployment---is-the-tool-working">👉 Go to Step 2B</a></p> |
| :-------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

## Step 2A: Public App - Is the tool working?

| <h4>✅ YES</h4><p><strong>Tool loads and responds</strong></p><p><a href="#step-3-tool-works-but-has-issues">👉 Go to Step 3</a></p> | <h4>❌ NO</h4><p><strong>Tool is down/not loading</strong></p><p>⛔ <strong>STOP HERE</strong></p><p>I do not accept any reports or questions related to the public app when it's not working. The public app is provided as-is without support guarantees.</p> |
| :---------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

## Step 2B: Local Deployment - Is the tool working?

| <h4>✅ YES</h4><p><strong>Tool loads and responds</strong></p><p><a href="#step-3-tool-works-but-has-issues">👉 Go to Step 3</a></p> | <h4>❌ NO</h4><p><strong>Tool won't start/deploy</strong></p><p>🎯 <strong>RECOMMENDED: Use Interactive Help Tool</strong></p><p><strong>Try the Interactive Help Tool first:</strong></p><ul><li><strong>Local:</strong> <code><http://localhost:3000/help></code> (if containers are running)</li><li><strong>Public:</strong> <a href="https://maps4fs.xyz/help">maps4fs.xyz/help</a> (if local isn't accessible)</li></ul><p><strong>OR if interactive tool doesn't work:</strong></p><p>📋 <strong>Manual troubleshooting process:</strong></p><p><strong>Before asking for help, you MUST:</strong></p><ol><li>✅ Read the <a href="/pages/Dn8NahoNSXDSAzhImT84#troubleshooting">Local Deployment Troubleshooting</a></li><li>✅ Complete ALL troubleshooting steps</li><li>✅ Include ALL outputs in your help request</li></ol><p>💡 <strong>Note:</strong> The Interactive Help Tool now covers local deployment issues and provides the same markdown format for support requests.</p> |
| :---------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

## Step 3: Tool works but has issues

> Tool loads but crashes during generation or produces unexpected results

### 📚 Have you checked the FAQ?

| <h4>✅ YES</h4><p><strong>I've read the FAQ</strong></p><p><a href="#dtm-provider-check">👉 Continue to DTM Check</a></p> | <h4>❌ NO</h4><p><strong>Haven't read it yet</strong></p><p><strong>📖 Read the</strong> <a href="/pages/rci6ft2tCcdC8qWzn6RO"><strong>FAQ</strong></a> <strong>first</strong></p><p>Your issue might already be solved there!</p> |
| :----------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

### 🗺️ DTM Provider Check

**Which DTM provider are you using?**

| <h4>✅ SRTM30 Provider</h4><p><strong>The default/supported provider</strong></p><p><a href="#step-4-pre-submission-checklist">👉 Go to Pre-submission Checklist</a></p> | <h4>❌ Other DTM Provider</h4><p><strong>Any provider except SRTM30</strong></p><p>⛔ <strong>STOP HERE</strong></p><p><strong>I only support SRTM30 DTM provider.</strong></p><p>For other DTM providers:</p><ol><li>🔗 Visit <a href="https://github.com/iwatkot/pydtmdl">PyDTMDL repository</a></li><li>👤 Find the author of your DTM provider</li><li>📧 Contact them directly</li></ol><p><strong>I do not provide help or accept reports for non-SRTM30 DTM providers.</strong></p> |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

## Step 4: Pre-submission Checklist

**Before submitting your issue, you MUST confirm ALL of the following:**

### ✅ Knowledge Check

* [ ] 📚 I have read the [FAQ](/docs/getting-started/faq.md)
* [ ] 🗺️ I understand that map data comes from [OpenStreetMap](https://www.openstreetmap.org/)
* [ ] 🔍 I have verified that the required data exists on OpenStreetMap for my area
* [ ] 🎨 I understand what a [texture schema](/docs/understanding-the-basics/texture_schema.md) is
* [ ] 🏷️ I have verified that my texture schema contains the OSM tags for the objects I'm missing *(if texture-related)*

### 🎯 Ready to Submit?

| <h4>✅ All Confirmed</h4><p><strong>I've checked everything above</strong></p><p><a href="#step-5-information-checklist">👉 Go to Step 5: Information Checklist</a></p> | <h4>❌ Not Ready</h4><p><strong>Still need to check some items</strong></p><p>⬆️ <strong>Go back and complete the missing items</strong></p><p>This helps ensure you get the best possible help.</p> |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

## Step 5: Information Checklist

**Before contacting support, prepare the following information:**

### 📍 Basic Information

* [ ] **Map coordinates** (latitude, longitude) - *Example: 45.2841, 20.2370*
* [ ] **Map size** - *Example: 4x4 km*
* [ ] **Game version** - *FS25*
* [ ] **Maps4FS version** - *Check in app footer or about section*

### 📁 Required Files

Gather these files from your map generation:

* [ ] **`generation_info.json`** - *Contains technical details about your map*
* [ ] **`main_settings.json`** - *Main configuration settings*
* [ ] **`generation_settings.json`** - *Your map generation settings*
* [ ] **Error logs** (if available) - *Any error messages or crash logs*
* [ ] **Screenshots** of the issue - *Show what's wrong vs what's expected*

### 📝 Issue Description

Prepare answers to these questions:

* [ ] **What exactly is wrong?** - *Describe the specific issue*
* [ ] **What did you expect to happen?** - *What should the correct behavior be*
* [ ] **Steps to reproduce** - *How can someone else reproduce this issue*
* [ ] **When did it start happening?** - *Was it working before? What changed?*

### 🔍 Additional Details (if applicable)

* [ ] **Custom settings used** - *Any non-default settings you applied*
* [ ] **Custom OSM file** - *If you used a custom OpenStreetMap file*
* [ ] **Custom texture schema** - *If you modified the texture schema*
* [ ] **Specific objects missing** - *Which roads/buildings/fields are missing*

### 📞 Choose Your Support Channel

**💡 TIP: If you used the** [**Interactive Help Tool**](#-interactive-help-tool-recommended)**, you already have a formatted markdown file ready to share!**

| <h4>💬 Discord (Recommended)</h4><p><strong>For most users</strong></p><p>✅ <strong>Pros:</strong></p><ul><li>Fast community help</li><li>Easy to share files</li><li>No GitHub account needed</li></ul><p><a href="https://discord.gg/wemVfUUFRA"><img src="https://img.shields.io/badge/join-discord-blue" alt="Join Discord"></a></p><p><strong>Post in #support channel with:</strong></p><ul><li>Your interactive help output (if available)</li><li>Or your manual checklist information</li></ul> | <h4>🐛 GitHub Issues</h4><p><strong>For technical users</strong></p><p>✅ <strong>Pros:</strong></p><ul><li>Detailed issue tracking</li><li>Better for complex bugs</li><li>Public record for others</li></ul><p><strong>Requirements:</strong></p><ul><li>GitHub account</li><li>Familiar with issue templates</li></ul><p>🐛 <a href="https://github.com/iwatkot/maps4fs/issues/new/choose"><strong>Create GitHub Issue</strong></a></p><p><strong>Paste your interactive help output or manual information</strong></p> |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

### 📋 Final Checklist

Before contacting support, confirm:

* [ ] ✅ I have ALL the information from the checklists above
* [ ] 📁 I have prepared all required files
* [ ] 📝 I can clearly describe my issue
* [ ] 🎯 I know which support channel to use

**Ready to get help!** 🚀

## 📋 Quick Reference Guide

| 🎯 Scenario                    | 🔄 Action                                                                                                 |
| ------------------------------ | --------------------------------------------------------------------------------------------------------- |
| 🌐 Public app down             | ⛔ No support provided                                                                                     |
| 🏠 Local deployment issues     | 📖 Follow [troubleshooting guide](/docs/setup-and-installation/local_deployment.md#troubleshooting) first |
| 🐛 Tool works but has problems | ✅ FAQ → ✅ SRTM30 → ✅ Checklist → � Gather info → 💬 Discord/🐛 GitHub                                     |
| 🗺️ Non-SRTM30 DTM issues      | 👤 Contact DTM provider author at [PyDTMDL](https://github.com/iwatkot/pydtmdl)                           |

***