Config files#
| File | Contents |
|---|---|
config/main.lua |
Timers and the weather bridge |
config/worlds.lua |
The world definitions, including north_yankton and a commented kart_circuit template |
config/worlds.d/*.lua |
Extra world files, loaded after config/worlds.lua in alphabetical order |
The config files are open in the escrow (escrow_ignore), so you can edit them.
config/main.lua#
| Key | Default | What it does |
|---|---|---|
Config.PollMs |
1000 |
How often the server compares every player's bucket with the bucket worlds. Modes should call Sync(src) after moving a player, so this is only a safety net. |
Config.EmptyClearSeconds |
300 |
A bucket world that players have been in clears itself this many seconds after the last one left. |
Config.UnusedClearSeconds |
3600 |
A bucket world nobody entered clears after this many seconds. 0 turns it off. |
Config.WeatherBridge |
'renewed' |
'renewed' for Renewed-Weathersync, or 'none' to leave weather and time alone. |
Config.Debug |
false |
Prints each world change to the server console. |
World fields#
Each entry in Worlds is keyed by a world id.
| Field | What it does |
|---|---|
label |
Name shown in menus |
enabled |
false hides the world and makes SetBucketWorld refuse it |
spawn |
A safe vec4 inside the world |
ipls |
Base game IPLs to request. They are removed again on leave. |
ymaps |
Custom ymap names without the extension. They are hidden for everyone until the player enters the world. |
hide |
IPLs to switch off while inside |
props |
Local props: { model = 'prop_x', coords = vec4(x, y, z, h), freeze = true }. freeze defaults to on. |
weather, hour |
Weather type and hour while inside. Skipped when another script already holds the player's weather. |
prologue |
true adds the North Yankton minimap and road nodes |
racing |
'stunt' or 'street', passed through to ListWorlds for race creators that use it |
vrOnly |
Passed through to ListWorlds for race creators that use it |
extendBounds |
true keeps the world boundary open for maps far past the edge of the map |
Adding a custom map#
- Put the
.ymap,.ytypand.ybnfiles instream/<worldId>/, or keep them in their own map resource. - Add a world with
ymaps = { 'file_name_without_extension' }and aspawn. - Restart the resource.
Build custom maps away from the city, out at sea or high in the sky. If hiding a ymap ever fails, nobody in the city should see it.
Stuck on a step?Ask in the Discord →