Installation
Requirements
- FiveM server with
lua54 'yes' oxmysql- One of:
qbx_core,qb-core,es_extended, or standalone
Steps
-
Drop the
awoken_spawnfolder intoresources/. The folder must be named exactlyawoken_spawn. -
Add to
server.cfg:If you use a multichar resource,ensureit beforeawoken_spawn. -
Open
config.lua, set your brand, and customiseConfig.locations. -
Start the server. The DB table (
awoken_spawn_lastchoiceby default) is created automatically on first run.
How the selector opens
Config.open.autoOpenOnFrameworkLoad = true (default) auto-opens the selector when the framework fires its player-loaded event:
A short de-dupe guard keeps repeated events from opening it twice.
Third-party multichar
If a standalone multichar doesn’t emit the framework’s normal player-loaded event, list its “character chosen” event inconfig.lua:
Config.open.autoOpenOnFrameworkLoad = false so only the multichar drives it.
awoken_multicharacter
Built-in integration — leaveConfig.open.awokenMultichar.enabled = true (default). New characters get the selector after their clothing menu closes and, if awaitIntroCinematic = true, only after any intro cutscene finishes.
Verify
SetConfig.debug = true, restart, join. Server console should log:
Config.debug = false for production.