# Map Editor

The **Map Editor** is a comprehensive suite of tools for map creation.

**Functionalities of the Map Editor include:**

* **Creating and modifying the mesh of the ground surface**\
  Adjust the size and geometric shape of the terrain to suit the map’s design.
* **Painting the mesh of the ground surface**\
  Apply materials, colors, and grass to enhance the visual appeal of the terrain.
* **Placing entities**\
  Add various elements such as buildings, flora, decor, special effects, sound effects, and interactive game entities to the map.
* **Creating and customizing water surfaces**\
  Use special water materials to create and brush rivers, lakes, and seas.
* **Configuring properties**\
  Set properties of the ground surface and objects to dictate their behavior and interaction within the game environment.

Upon launching, users default to the **Map Editor** and can return to it from other editors by pressing the `F2` key.

## **Map Editor interface**

<figure><img src="/files/Bt1lkiTTHMNNDzzXhrz8" alt=""><figcaption><p><strong>The Map Editor's Tool Window</strong></p></figcaption></figure>

<table><thead><tr><th width="75">№</th><th width="164">Name</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td><a href="#main-menu">MAP button</a></td><td>Opens the <strong>Main menu</strong> of the <strong>Map Editor</strong></td></tr><tr><td>2</td><td><a href="#side-menu">Side menu</a></td><td>Tabs for the <strong>Map Editor</strong>'s tool groups</td></tr><tr><td>3</td><td>Editor panel</td><td>Settings and properties of the selected tool</td></tr><tr><td>4</td><td>Hints window</td><td>The window displays hints for the selected element in the <strong>Editor</strong> panel.</td></tr><tr><td>5</td><td>Vewport</td><td>A real-time editable canvas for map interaction</td></tr><tr><td>6</td><td>Player indicator</td><td>Displays color-coded group numbers of units controlled by the player in the editor</td></tr></tbody></table>

## Main menu&#x20;

The **Main menu** of the **Map Editor** (**Map editor menu**) contains basic functions.

The **Main menu** can be called in two ways:

1. **By clicking the MAP button**\
   This button is located at the top of the Editor panel.
2. **By pressing the `Esc` key on the keyboard**\
   By pressing the `Esc` key on the keyboard, users can quickly access the **Map editor menu** window from anywhere within the **Map Editor**.

<figure><img src="/files/3ecEhe3shGCPqtLQxZdx" alt="" width="563"><figcaption><p>The main menu window</p></figcaption></figure>

<table><thead><tr><th width="182">Menu item</th><th width="292">Description</th><th>Keyboard shortcut</th></tr></thead><tbody><tr><td><code>New</code></td><td>Initiates the process to create a new map</td><td></td></tr><tr><td><code>Save</code></td><td>Allows users to save the current map</td><td><code>Ctrl + S</code></td></tr><tr><td><code>Save As...</code></td><td>Enables saving the current map under a new name or location</td><td><code>Ctrl +  Shift + S</code></td></tr><tr><td><code>Reload</code></td><td>Refreshes the current map. <br>Map reverts to the last saved state</td><td></td></tr><tr><td><code>Load</code></td><td>Provides options to open a previously saved map</td><td><code>Ctrl + O</code></td></tr><tr><td><code>Load recent</code></td><td>Allows users to quickly access and load maps that were recently edited or opened</td><td></td></tr><tr><td><code>Exit</code></td><td>Closes the Map Editor and exits the application</td><td><code>Alt + X</code></td></tr></tbody></table>

## **Side menu**

The **Side menu** contains groups of tools for map editing, displayed as tabs on the left side of the editor panel. \
The active tab, which shows the currently selected group of tools, is highlighted for easy identification

<figure><img src="/files/UU3aVlG7gD5Jfas4qyDj" alt=""><figcaption><p><strong>Side menu of the Map Editor</strong></p></figcaption></figure>

<table><thead><tr><th width="199">Tab name</th><th width="194">Editor name</th><th>Description</th></tr></thead><tbody><tr><td><code>scene [1]</code></td><td><a href="/pages/Q8OlDIXzlrg7ayqjPCr7">Scene Editor</a></td><td>Tools for managing entities placed on the map and their structuring, which speeds up access to entities and simplifies the map editing process</td></tr><tr><td><code>entity [2]</code></td><td><a href="/pages/wlcUkRtlEP3mM8XAzOx9">Entity Editor</a></td><td>This tool is used for placing and adjusting the placement of various elements on the map, including decor, flora, visual and sound effects, and other entities. <br>It provides tools and options necessary for precisely positioning and configuring these elements within the game environment.</td></tr><tr><td><code>land [3]</code></td><td><a href="/pages/mQDjtc7Qg9oa0PKaCe9s">Landscape Editor</a></td><td>A comprehensive tool within the <strong>Map Editor</strong> designed for terrain customization. It offers brushes and settings for modifying terrain elevation, applying materials, adjusting colors, resizing mesh, and defining landscape properties, enabling detailed and precise landscape design.</td></tr><tr><td><code>water [4]</code></td><td><a href="/pages/e9Te29MtFEEklmJouzCm">Water Editor</a></td><td>This tab features the <strong>Water Editor</strong>, which allows for the creation and editing of water bodies such as rivers, lakes, and seas.</td></tr><tr><td><code>edifice [5]</code></td><td>Edifice Editor</td><td></td></tr></tbody></table>

**The Side menu tabs can be switched in two ways**:

* by clicking on the respective tab icon;
* using the keyboard keys 1, 2, 3, 4, 5, 6

## **Simulation mode**

* **`Start` button**\
  Initiates a safe simulation mode for testing the map. \
  Upon activation, this button changes to the `Finish` button.
* **`Finish` button**\
  Used to exit simulation mode. \
  Exiting simulation mode triggers a map reload process, restoring the map to its original state. Any changes made during the test, such as destruction or other consequences, are not saved.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bestway-1.gitbook.io/documentation/editor/map-editor.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
