Set up the spawn selector

The spawn selector is part of the Mechanics module. When a player joins your server, a list of places shows on the left of the screen and the camera hangs high above whichever one is picked. They browse with the arrow keys or the mouse, and press Enter or Spawn here to start there.

Before you start#

• The spawn selector is in beta, so it's only switched on for some communities for now. If you'd like to try it, ask us in support.
• The Mechanics module needs to be installed. It also holds your loading screen.
• Your game server needs the LonexOne FiveM resource, version 0.8.0 or newer. Your colour, logo and the glass style need 0.8.6 or newer. See Install the LonexOne FiveM resource.
• To change it, you need the Set up the spawn selector and its locations, and add locations in game permission.

Add your locations#

The easiest way is in game:

1. Stand where you want players to appear, facing the way they should face.
2. Type /spawnpoint and a name, like /spawnpoint Legion Square.
3. You'll see Spawn location "Legion Square" added.

Then finish it off in the panel:

1. Click Spawn selector under Mechanics in the sidebar.
2. Click Edit next to the location in the Locations list. Its details open in the form beside the list.
3. Fill in:
   • Under the name: a short line shown below it, like Downtown Los Santos.
   • Group: locations with the same group are listed together under that heading, like Around the city.
   • Icon: the picture beside it.
   • Who sees it: leave every department unticked to show it to everyone. Tick departments to show it only to people on those rosters, like a police station for officers.
4. Click Save.

You can also add a location in the panel by typing its coordinates in Add a location, beside the list. Use the arrows to change the order players see them in. Untick Show it in the spawn selector to hide a location without removing it.

Turn it on#

The Settings card is at the top of the same page. Under In game:

1. Tick Use the spawn selector.
2. Choose When it opens:
   • When they join the server for servers without a framework.
   • After they pick a character for ESX, QBCore, QBox, ox_core and ND_Core.
3. Click Save settings at the top right of the card.

Players see it the next time they join. You don't need to restart anything.

Make it look like your community#

The spawn selector uses the accent colour from your website's branding for the selected place and the Spawn here button. To change it, change your website colour. See Brand your site: logo, colours and home page.

Under Top of the screen in Settings:

• Show your logo: puts your website logo above the heading. It's on to start with, and does nothing until you've uploaded a logo for your website.
• Logo height: how tall the logo is, from 30 to 200 pixels. A wide logo stops at the width of the list.
• Heading and Under the heading: the text at the top of the list.
• Style: Dark gives solid dark panels. Glass makes the list see-through with a light edge, so more of the place shows behind it.

Click Save settings. Players see the change the next time they join.

Last location#

With Offer their last location on, under Last location in Settings, the top of the list is the place they were when they last left the server. With a framework, it's where their character was. You can change its name, the line under it and its group.

With a framework#

Pick After they pick a character, then stop the framework's own spawn screen so players don't see two:

• QBCore: remove ensure qb-spawn from your server.cfg. The spawn selector takes its place after character selection and tells QBCore the character has loaded.
• QBox: remove ensure qbx_spawn.
• ESX, ox_core and ND_Core: these put the character where they last were, then the spawn selector opens.

Camera height#

Camera height is how high above each place the camera hangs, from 40 to 300 metres. Lower shows the street, higher shows more of the area around it.

For developers#

Another resource can open the selector with exports.lonexone:openSpawnSelector(). When a player has spawned, the client event lonexone:spawned fires with where they went.

Something not working?#

Nothing shows when players join. Check Use the spawn selector is ticked and that there's at least one location, or Offer their last location is on. Check When it opens matches your server: with a framework, pick After they pick a character.

Players see two spawn screens. Your framework's spawn screen is still running. Remove qb-spawn or qbx_spawn from your server.cfg.

"Only people who set up the spawn selector can add spawn locations." Your role needs the spawn selector permission, under Mechanics in Roles.

A department's location doesn't show for someone. They need to be on that department's roster, with the same Discord account they use in FiveM.

My logo or colour doesn't show in game. Check Show your logo is ticked and your website has a logo under its branding. Your server also needs the resource 0.8.6 or newer.