> For the complete documentation index, see [llms.txt](https://wiki.qfdevelopers.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.qfdevelopers.com/scripts/editor-17/configuration.md).

# Configuration

## Languages

You can set the language of the script in the configuration file.

* `en`: English
* `fr`: French
* `pl`: Polish
* `de`: German
* `es`: Spanish

<figure><img src="/files/ig9o7wm8oX8fWWbPFHXs" alt=""><figcaption></figcaption></figure>

## Weather

Defines the required weather condition for displaying the spawn selector scene:

* `WeatherState`:\
  Set to `'CLEAR'` to ensure the scene appears only during clear weather.\
  If you're using `renewed-weathersync` or a similar weather system, you can replace `'CLEAR'` with `GlobalState.weather.weather` for dynamic synchronization.

<figure><img src="/files/10OBUeWP5IkitzqKPLYn" alt=""><figcaption></figcaption></figure>

## Events

Defines whether the Spawn Selector can be triggered via events:

* `useEvents`:\
  Set to `true` if you want to open the Spawn Selector using an external event (e.g., `TriggerEvent`).\
  If `false`, the selector must be triggered using predefined methods (command, export, etc.).

<figure><img src="/files/fgeLCEDOzXtfh5Zl1Wi7" alt=""><figcaption></figcaption></figure>

### Server-Side to Client-Side

<figure><img src="/files/tEKMQbx76LKUeXyJYEMa" alt=""><figcaption></figcaption></figure>

• `true`: Opens the spawn selector with the "Last Location" option.\
• `false`: Opens the spawn selector without the "Last Location" option.

***

### Client-Side to Server-Side

<figure><img src="/files/g2ICf15YZzagrwoyMp0s" alt=""><figcaption></figcaption></figure>

• `source`: The player's server ID.\
• `true`: Opens with "Last Location" option.\
• `false`: Opens without it.

> 📌 These events are useful if you're integrating the spawn selector with login systems, multicharacter scripts, or custom logic.

## Exports - Open NUI

Triggers the Spawn Selector UI manually from another script:

* `true`: Opens the spawn selector **with** the "Last Location" option.
* `false`: Opens the spawn selector **without** the "Last Location" option.

> 💡 Useful for custom login flows, character selectors, or admin tools.

<figure><img src="/files/P41vuDmjWn3BDhkoUO3b" alt=""><figcaption></figcaption></figure>

## Command

Defines command settings for opening the Spawn Selector:

* `Command.use`:\
  Set to `true` to enable the command for opening the spawn selector.
* `Command.useLastLocation`:\
  If `true`, the selector will include an option to spawn at the player's last known location.
* `Command.name`:\
  Name of the command (e.g., `/spawnselector`) that triggers the spawn selection menu.

<figure><img src="/files/HYVYmyUx283Achko3NSM" alt=""><figcaption></figcaption></figure>

## Locations

Defines the available spawn points displayed in the Spawn Selector map:

Each location entry includes the following fields:

* `coords`:\
  A table containing X, Y, Z coordinates and heading (e.g., `{x, y, z, h}`) where the player will spawn.
* `title`:\
  Name displayed on the map marker (e.g., `"Los Santos"`).
* `iconUrl`:\
  Path to the icon image shown on the map when not hovered.
* `iconHoverUrl`:\
  Path to the icon image shown when hovered over with the mouse.
* `iconSize`:\
  Size of the icon in pixels (e.g., `{40, 40}`).
* `iconAnchor`:\
  Anchor point of the icon (center reference for placement), typically half of `iconSize`.
* `popupAnchor`:\
  Offset position for the text popup tooltip relative to the marker.

> 📌 You can freely add or remove locations by copying the format shown above.

<figure><img src="/files/ug4S39bJS2nF6Thqp822" alt=""><figcaption></figcaption></figure>


---

# 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 dynamically by asking a question.

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

```
GET https://wiki.qfdevelopers.com/scripts/editor-17/configuration.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.
