> For the complete documentation index, see [llms.txt](https://docs.sollumz.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sollumz.org/documentation/maps.md).

# Maps (.ymap)

Map data such as object locations, car generators, occlusions, and LOD lights are stored in the .ymap file format.

<figure><img src="https://4252508569-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcRAM9lBHCqq3QodZ420I%2Fuploads%2FMuEbd3f9vHGj6J9oPLXE%2Fsm_1.png?alt=media&amp;token=6311023c-d8f3-42a8-80f3-1cb7c50b9d7b" alt=""><figcaption></figcaption></figure>

### Basic Concepts

Maps are managed through the `Sollumz Tools > Maps` panel in the sidebar.

<figure><img src="https://4252508569-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcRAM9lBHCqq3QodZ420I%2Fuploads%2FcgwmFco536CfiD04sCxD%2Fimage.png?alt=media&amp;token=86c21408-e453-4b12-8e75-e3c3499befbe" alt="" width="375"><figcaption></figcaption></figure>

The first list contains **map groups**. A map group holds a set of **containers** and the\
**map items** assigned to them.

Maps marked as "Scripted" will not be loaded automatically by the game. A script will be needed to load and unload them.

#### Containers

Containers are organized in a hierarchy: each container can have a parent container,\
which corresponds to the YMAP LOD hierarchy in the game. On export, each container\
becomes one YMAP file, named after the container.

<figure><img src="https://4252508569-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcRAM9lBHCqq3QodZ420I%2Fuploads%2FO1feZpp7Sdk0If67mzp6%2Fimage.png?alt=media&amp;token=ccbc4397-4e27-4357-9c2d-27d85ddc9efc" alt="" width="374"><figcaption><p>Containers list</p></figcaption></figure>

The hierarchy can be partially generated using Auto partioning. See [Partitioning](/documentation/maps/partitioning.md).

#### Map Items

There are six types of map items: [entities](/documentation/maps/entities.md), [car generators](/documentation/maps/car-generators.md), [timecycle modifiers](/documentation/maps/timecycle-modifiers.md), [grass batches](/documentation/maps/grass-batches.md), [occluders](/documentation/maps/occluders.md), and [LOD lights](/documentation/maps/lod-lights.md). Each map item is assigned to a container, which determines the YMAP file it is exported to. Items not assigned to any container are skipped on export with a warning.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sollumz.org/documentation/maps.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
