Configuration

Page dedicated to how to configure our Spawn Selector

Languages

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

  • en: English

  • fr: French

  • pl: Polish

  • de: German

  • es: Spanish

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.

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.).

Server-Side to Client-Side

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

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.

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.

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.

Last updated