Skip to content

Kivo Spawn

Kivo Spawn lets players choose where to appear in the world. The screen opens on a high overhead view of the map. When the player hovers a location card, the camera glides over that location. When the player picks one, the screen fades and the player is placed there.

Documented version: 1.5.0.

  1. A fade in on the overhead hub camera, with a panel of location cards.
  2. Each card shows an image, a name, a description, and the time, weather, wind and temperature.
  3. Hovering a card moves the camera above that location.
  4. A Spawn Location button on the card places the player and ends the selector.
  5. Returning characters also get a Last Location card, if you leave it enabled.
  • Hub camera and per location camera glide.
  • Last Location card for returning characters (Config.spawnbehavior.allowLastSpawnLocation).
  • Option to skip the selector for brand-new characters (Config.newCharSkipSelector).
  • Custom spawn functions per location, so a location can pick or adjust coordinates in code.
  • Exports to open the selector from another script and to check whether it is open.
  • Title, subtitle and default image are configurable.
Requirement Notes
A framework qbx_core, qb-core or es_extended.
ox_lib, oxmysql Not needed. Kivo Spawn declares no dependencies.
Kivo Multichar Optional. With it, Multichar hands the player over after login. Without it, Kivo Spawn opens by itself once your framework reports the character as loaded.

Start Kivo Spawn after your framework.

ensure qbx_core # or qb-core, or es_extended
ensure kivo-multi-char # if you use the Kivo Character Suite
ensure kivo-spawn

Kivo Spawn recognises Kivo Multichar whatever its folder is called, and the other way round: each resource announces its own name when it starts. The full block with the other required resources is on the suite installation page.

Mode When How it opens
With Kivo Multichar kivo-multi-char is started and Config.spawnSelector = 'kivo-spawn' there Multichar fires kivo:client:readyForSpawn after a character is chosen. Kivo Spawn waits for it and does not open on its own.
Without Kivo Multichar Multichar is not started Kivo Spawn opens on its own when your framework reports the character as loaded. You can also open it yourself with the openSpawnUI export.