GameplayConfigs

Asset path: Server/GameplayConfigs/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another GameplayConfig most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Key	Type
any `String`	Array of `String`

Gathering

Type information:

(Nullable)

GatheringConfig with the following properties:

Key Type Description

UnbreakableBlock

(Nullable)

GatheringEffectsConfig

GatheringEffectsConfig with the following properties:

Key	Type	Description
ParticleSystemId	(Nullable) `String` Reference to a ParticleSystem asset
SoundEventId	(Nullable) `String` Reference to a SoundEvent asset

IncorrectTool

(Nullable)

GatheringEffectsConfig

GatheringEffectsConfig with the following properties:

Key	Type	Description
ParticleSystemId	(Nullable) `String` Reference to a ParticleSystem asset
SoundEventId	(Nullable) `String` Reference to a SoundEvent asset

World

Type information:

(Nullable)

WorldConfig with the following properties:

Key Type Description

AllowBlockBreaking Boolean defaults to: true

BlockBreakingBypassTag (Nullable) String

AllowBlockGathering Boolean defaults to: true

AllowBlockPlacement Boolean defaults to: true

BlockedRootInteractionTags

(Nullable) Array of String

Root interactions with any of these tags (for example "Type=Bed") cannot run in this world and show no interaction hint

BlockPlacementFragilityTimer

Number defaults to: 0.0

The timer, in seconds, that blocks have after placement during which they are fragile and can be broken instantly

DaytimeDurationSeconds

Integer defaults to: 1728

The number of real-world seconds it takes for the day to pass (from sunrise to sunset)

NighttimeDurationSeconds

Integer defaults to: 1151

The number of real-world seconds it takes for the night to pass (from sunset to sunrise)

TotalMoonPhases Integer defaults to: 5

Sleep

(Nullable)

SleepConfig

SleepConfig with the following properties:

Key	Type	Description
WakeUpHour	(Nullable) Either `Number` defaults to: `5.5` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The in-game hour at which players naturally wake up from sleep.
AllowedSleepHoursRange	(Nullable) Array of `Number`	The in-game hours during which players can sleep to skip to the WakeUpHour. If missing, there is no restriction.
Sounds	(Nullable) SleepSoundsConfig

Configurations related to sleeping in this world (in beds)

WorldMap

Type information:

(Nullable)

WorldMapConfig with the following properties:

Key Type Description

DisplaySpawn Boolean defaults to: true

DisplayHome Boolean defaults to: true

DisplayWarps Boolean defaults to: true

DisplayDeathMarker Boolean defaults to: true

DisplayPlayers Boolean defaults to: true

PlayersMarkersConfig

(Nullable)

PlayersMapMarkerConfig

PlayersMapMarkerConfig with the following properties:

Key	Type	Description
IconSwapHeightDelta	`Integer` defaults to: `12`	When seeing other players' icons on the map, what the Y difference between you and them need to be in order to swap their icon.
BelowIcon	(Nullable) `String` defaults to: `PlayerBelow.png`	The icon when a player is below you. Find Player.png in the assets for the folder where to see/add available icons.
AboveIcon	(Nullable) `String` defaults to: `PlayerAbove.png`	The icon when a player is above you. Find Player.png in the assets for the folder where to see/add available icons.

CanTrackPlayersInCompass

Boolean defaults to: true

Whether the client functionality to toggle tracking other players in compass is enabled

CanTogglePlayersInMap

Boolean defaults to: true

Whether the client functionality to toggle other players visibility on the world map is enabled

UserMapMarkers

(Nullable)

UserMapMarkerConfig

UserMapMarkerConfig with the following properties:

Key	Type	Description
AllowCreatingMarkers	`Boolean` defaults to: `true`	Whether players can create new map markers. This will also make the option invisible from the client.
MaxPersonalMarkersPerPlayer	`Integer` defaults to: `12`
MaxSharedMarkersPerPlayer	`Integer` defaults to: `12`
AllowDeletingOtherPlayersSharedMarkers	`Boolean` defaults to: `true`	Whether a player can delete another player's shared marker. Beware of marker pvp.

Death

Type information:

(Nullable)

DeathConfig with the following properties:

Key Type Description

RespawnController

Type Selector

The respawn controller that determines where the player respawns.

ItemsLossMode

(Nullable) Any one of the following String (defaults to None):

ItemsLossMode

Name	Description
`"None"`
`"All"`
`"Configured"`

The mode used to compute what the entity will lose upon death.

ItemsAmountLossPercentage

Number defaults to: 10.0

The amount (in %) of items lost for an ItemStack upon death (applied to the entire inventory). Used ONLY if ItemsLossMode is set to 'Configuredand applied to items that haveDropOnDeathset totrue`.

ItemsDurabilityLossPercentage

Number defaults to: 10.0

The amount of durability (in %) items lose upon death (applied to the entire inventory).

GameModeTypeOnDeath

(Nullable) String

Reference to a GameModeType asset

When set, dying players skip the respawn screen, respawn in place, and enter this GameModeType. When unset, normal death behavior applies.

Respawn

Type information:

(Nullable)

RespawnConfig with the following properties:

Key	Type	Description
RadiusLimitRespawnPoint	`Integer` defaults to: `500`
MaxRespawnPointsPerPlayer	`Integer` defaults to: `3`

ShowItemPickupNotifications

Type information: Boolean defaults to: true

ItemDurability

Type information:

(Nullable)

ItemDurabilityConfig with the following properties:

Key Type Description

BrokenPenalties

BrokenPenalties with the following properties:

Key	Type	Description
Tool	`Number`
Armor	`Number`
Weapon	`Number`

ItemEntity

Type information:

(Nullable)

ItemEntityConfig with the following properties:

Key Type Description

Physics

(Nullable)

PhysicsValues

PhysicsValues with the following properties:

Key	Type	Description
Mass	`Number` defaults to: `1.0`
DragCoefficient	`Number` defaults to: `0.5`
InvertedGravity	`Boolean` defaults to: `false`

PickupRadius (Nullable) Either Number defaults to: 1.75 or String that matches the pattern: ^(-?Infinity|NaN)$

MergeRadius (Nullable) Either Number defaults to: 2.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Lifetime (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$

ParticleSystemId

(Nullable) String defaults to: Item

Reference to a ParticleSystem asset

ParticleColor

(Nullable) A color in the form:

#RRGGBB
rgb(rrr, ggg, bbb)

ShowItemParticles Boolean defaults to: true

Combat

Type information:

(Nullable)

CombatConfig with the following properties:

Key	Type	Description
OutOfCombatDelaySeconds	(Nullable) `Number`	Delay before an entity is considered out of combat. Expressed in seconds.
StaminaBrokenEffectId	`String` defaults to: `Stamina_Broken` Reference to a EntityEffect asset	The id of the EntityEffect to apply upon stamina being depleted due to damage.
DisplayHealthBars	`Boolean` defaults to: `true`	Whether to display health bars above entities. Clients can still disable this in their settings.
DisplayCombatText	`Boolean` defaults to: `true`	Whether to display combat text (damage numbers) on entities. Clients can still disable this in their settings.
DisableNPCIncomingDamage	`Boolean` defaults to: `false`	Whether NPCs can take damage.
DisablePlayerIncomingDamage	`Boolean` defaults to: `false`	Whether players can take damage.

Plugin

Type information:

Object with the following properties:

Key Type Description

ForgottenTemple

ForgottenTempleConfig

ForgottenTempleConfig with the following properties:

Key	Type	Description
MinYRespawn	`Number` defaults to: `5.0`	The Y at which players are teleported back to spawn.
RespawnSound	(Nullable) `String`	The sound ID to play when players respawn in the temple.

Memories

MemoriesGameplayConfig

MemoriesGameplayConfig with the following properties:

Key	Type	Description
MemoriesAmountPerLevel	Array of `Integer`	The recorded memory count that each level above the base level needs, in level order. Level 1 is the base level and needs no memories. The first entry gives level 2, the second entry gives level 3.
MemoriesRecordParticles	`String`
MemoriesCatchItemId	`String` Reference to a Item asset
MemoriesCatchEntityParticle	ModelParticle
MemoriesCatchParticleViewDistance	`Integer` defaults to: `64`
MemoriesRestoreSoundEventId	`String` Reference to a SoundEvent asset
MemoriesCatchSoundEventId	`String` Reference to a SoundEvent asset

Objective

ObjectiveGameplayConfig

ObjectiveGameplayConfig with the following properties:

Key	Type	Description
StarterObjectiveLinePerWorld	(Nullable) Map

Portal

PortalGameplayConfig

PortalGameplayConfig with the following properties:

Key	Type	Description
VoidEvent	(Nullable) VoidEventConfig

PortalOrigin

FragmentOriginGameplayConfig

FragmentOriginGameplayConfig with the following properties:

Key	Type	Description
MaxConcurrentFragments	`Integer` defaults to: `4`	The max number of portal fragments which can be open at the same time. Note that while the fragment count is shared across the server, the limit is enforced by the world's GameplayConfig.

PortalUpgrades

PortalUpgradesConfig

PortalUpgradesConfig with the following properties:

Key	Type	Description
UpgradeFlagKey	`String` that matches the pattern: `[^\s]` and is at least 1 characters long	Name of the game flag that holds the upgrade level of this portal type. Game flags are universe-wide, so the level applies to every portal world of this type. Level 0 is the base level and adds no upgrade. Player progression raises the flag.
UpgradeLevels	Array of the type: PortalUpgrade	One portal upgrade for each level above the base level, in level order. The first entry applies at level 1, the second at level 2. Level 0 is the base level and uses no entry. Add an entry for every level the flag can reach, because a higher level adds no upgrade.

Reputation

ReputationGameplayConfig

ReputationGameplayConfig with the following properties:

Key	Type	Description
ReputationStorage	(Nullable) ReputationStorageType

Stamina

StaminaGameplayConfig

StaminaGameplayConfig with the following properties:

Key	Type	Description
SprintRegenDelay	SprintRegenDelayConfig	The stamina regeneration delay applied after sprinting

Stash

StashGameplayConfig

StashGameplayConfig with the following properties:

Key	Type	Description
ClearContainerDropList	`Boolean` defaults to: `true`

Wilderness

WildernessConfig

WildernessConfig with the following properties:

Key	Type	Description
Enabled	`Boolean` defaults to: `false`	Enable wilderness tracking in a world.
OwnedHomeChunkRadius	`Integer` defaults to: `8`	The horizontal chunk radius around an owned player home marker. Set to -1 to disable the radius.
OwnedHomeChunkRadiusY	`Integer` defaults to: `2`	The vertical chunk radius around an owned player home marker. Set to -1 to disable the radius.
UnownedHomeChunkRadius	`Integer` defaults to: `2`	The horizontal chunk radius around an unowned player home marker. Set to -1 to disable the radius.
UnownedHomeChunkRadiusY	`Integer` defaults to: `1`	The vertical chunk radius around an unowned player home marker. Set to -1 to disable the radius.
PlayerTrackerChunkRadius	`Integer` defaults to: `2`	The horizontal chunk radius around a player to track wilderness in.
PlayerTrackerChunkRadiusY	`Integer` defaults to: `1`	The horizontal chunk radius around a player to track wilderness in.

Configuration for wilderness tracking.

WorldEvents

WorldEventsConfig

WorldEventsConfig with the following properties:

Key	Type	Description
ExclusionRadius	`Integer` defaults to: `512`	The minimum distance that a world-event location must be from other world-event locations. Set to 0 to disable proximity filtering.
Events	(Nullable) Array of the type: WorldEventRecord	List of world events to run when the world loads.
GlobalEvents	(Nullable) Array of the type: WorldEventRecord	List of global world events to run when triggered by an action in-game such as an interaction.

Player

Type information:

(Nullable)

PlayerConfig with the following properties:

Key Type Description

HitboxCollisionConfig

(Nullable) String

Reference to a HitboxCollisionConfig asset

The HitboxCollision config to apply to all players.

RepulsionConfig

(Nullable) String

Reference to a RepulsionConfig asset

The Repulsion to apply to all players.

MovementConfig

(Nullable) String defaults to: BuiltinDefault

Reference to a MovementConfig asset

The maximum number of simultaneous deployable entities players are allowed to own.

MaxDeployableEntities Integer defaults to: -1

ArmorVisibilityOption

(Nullable) Any one of the following String (defaults to All):

ArmorVisibilityOption

Name	Description
`"All"`
`"HelmetOnly"`
`"None"`

CameraEffects

Type information:

CameraEffectsConfig with the following properties:

Key Type Description

DamageEffects

(Nullable) Map of the following:

Map

Key	Type
`String` Reference to a DamageCause asset	Either `String` or CameraEffect Reference to a CameraEffect asset

The default damage camera effects

CreativePlaySoundSet

Type information:

(Nullable) Either String or SoundSet

Reference to a SoundSet asset

CreativeEraserInteraction

The root interaction run for Primary while a Creative player has the eraser enabled, regardless of the held item. Unset disables the eraser toggle.

Type information:

(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

Crafting

Type information:

(Nullable)

CraftingConfig with the following properties:

Key	Type	Description
BenchMaterialChestHorizontalSearchRadius	`Integer` defaults to: `14`	The horizontal radius of search around a bench to use materials from the chests
BenchMaterialChestVerticalSearchRadius	`Integer` defaults to: `6`	The vertical radius of search around a bench to use materials from the chests
BenchMaterialChestLimit	`Integer` defaults to: `100`	The maximum number of chests a crafting bench will draw materials from

Spawn

Type information:

(Nullable)

SpawnConfig with the following properties:

Key Type Description

FirstSpawnParticles

(Nullable) Array of the type:

WorldParticle

WorldParticle with the following properties:

Key	Type	Description
SystemId	`String` Reference to a ParticleSystem asset	The id of the particle system.
Color	(Nullable) A color in the form: `#RRGGBB` `rgb(rrr, ggg, bbb)`	The colour used if none was specified in the particle settings.
Scale	(Nullable) Either `Number` defaults to: `1.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The scale of the particle system.
PositionOffset	(Nullable) Vector3f	The position offset from the spawn position.
RotationOffset	(Nullable) Direction	The rotation offset from the spawn rotation.

SpawnParticles

(Nullable) Array of the type:

WorldParticle

WorldParticle with the following properties:

Key	Type	Description
SystemId	`String` Reference to a ParticleSystem asset	The id of the particle system.
Color	(Nullable) A color in the form: `#RRGGBB` `rgb(rrr, ggg, bbb)`	The colour used if none was specified in the particle settings.
Scale	(Nullable) Either `Number` defaults to: `1.0` or `String` that matches the pattern: `^(-?Infinity\|NaN)$`	The scale of the particle system.
PositionOffset	(Nullable) Vector3f	The position offset from the spawn position.
RotationOffset	(Nullable) Direction	The rotation offset from the spawn rotation.

FirstSpawnItems

(Nullable) Array of the type:

MaterialQuantity

MaterialQuantity with the following properties:

Key	Type	Description
ItemId	(Nullable) `String` Reference to a Item asset
ResourceTypeId	(Nullable) `String`
ItemTag	(Nullable) `String`
Quantity	`Integer` defaults to: `1`
Metadata	(Nullable) Type 0

The items to place in a players inventory the first time they spawn in the world.

ExitInstance

ExitInstance with the following properties:

Key	Type	Description
Type	Constant value: `ExitInstance`	This field controls the type, it must be set to the constant value "ExitInstance" to function as this type.
Fallback	Type Selector (1)

HomeOrSpawnPoint

HomeOrSpawnPoint with the following properties:

Key	Type	Description
Type	Constant value: `HomeOrSpawnPoint`	This field controls the type, it must be set to the constant value "HomeOrSpawnPoint" to function as this type.

WorldSpawnPoint

WorldSpawnPoint with the following properties:

Key	Type	Description
Type	Constant value: `WorldSpawnPoint`	This field controls the type, it must be set to the constant value "WorldSpawnPoint" to function as this type.

Type Selector (1)

Any of these:

Key: Type Type

ExitInstance

ExitInstance with the following properties:

Key	Type	Description
Type	Constant value: `ExitInstance`	This field controls the type, it must be set to the constant value "ExitInstance" to function as this type.
Fallback	Type Selector (1)

HomeOrSpawnPoint

HomeOrSpawnPoint with the following properties:

Key	Type	Description
Type	Constant value: `HomeOrSpawnPoint`	This field controls the type, it must be set to the constant value "HomeOrSpawnPoint" to function as this type.

WorldSpawnPoint

WorldSpawnPoint with the following properties:

Key	Type	Description
Type	Constant value: `WorldSpawnPoint`	This field controls the type, it must be set to the constant value "WorldSpawnPoint" to function as this type.

Map

(Nullable) Map of the following:

Key	Type
any `String`	`String` Reference to a ObjectiveLineAsset asset

ReputationStorageType

(Nullable) Any one of the following String (defaults to PerPlayer):

Name	Description
`"PerPlayer"`
`"PerWorld"`

Type 0

(Nullable) Map of the following:

Key	Type
any `String`	`anything`

Parent

Tags

Gathering

World

WorldMap

Death

Respawn

ShowItemPickupNotifications

ItemDurability

ItemEntity

Combat

Plugin

Player

CameraEffects

CreativePlaySoundSet

CreativeEraserInteraction

Crafting

Spawn

MaxEnvironmentalNPCSpawns

Notes:

Type Selector

Type Selector (1)

Map

ReputationStorageType

Type 0

On this page