Instances
Asset path: Server/Instances/*instance.bson
Configuration for a single world. Settings in here only affect the world this configuration belongs to.
Instances share this configuration but ignore certain parameters (e.g. UUID). In this case the configuration willbe cloned before loading the instance.
Version
Type information: Integer
UUID
Type information:
Either String or Map of the following:
| Key | Type |
|---|---|
any String | anything |
DisplayName
The player facing name of this world.
Type information: (Nullable) String
Seed
The seed of the world, used for world generation.
If a seed is not set then one will be randomly generated.
Type information: Integer
SpawnPoint
Deprecated: Please use SpawnProvider instead.
Type information:
(Nullable)
Transform with the following properties:
| Key | Type | Description |
|---|---|---|
| X | Number defaults to: 0.0 | |
| Y | Number defaults to: 0.0 | |
| Z | Number defaults to: 0.0 | |
| Pitch | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| Yaw | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| Roll | (Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$ |
SpawnProvider
Sets the spawn provider for the world.
This controls where new players will enter the world at. This can be provided by world generation in some cases.
Type information:
(Nullable) Any of these:
Key: Id | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FitToHeightMap | A spawn provider that takes a spawn point from another provider and, when its Y is the no-height sentinel, places it one block above the heightmap of the world.
FitToHeightMapSpawnProvider
| |||||||||
default case: Global | A spawn provider that provides a single static spawn point for all players.
GlobalSpawnProvider
| |||||||||
| Individual | A spawn provider that selects a spawn point from a list based on the player being spawned in. This gives random but consistent spawn points for players.
IndividualSpawnProvider
|
WorldGen
Sets the world generator that will be used by the world.
Type information:
(Nullable) Any of these:
Key: Type | Type | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CubicTest | A cubic-aware test generator that tiles the world into colour-coded feature regions to exercise the heightmap and other cubic-chunk paths. | |||||||||||||||
| Dummy | A dummy world generation provider that places a single layer of unknown blocks in each chunk.
DummyWorldGenProvider
| |||||||||||||||
| Flat | A world generation provider that generates a flat world with defined layers.
FlatWorldGenProvider
| |||||||||||||||
default case: Hytale | The standard generator for Hytale.
HytaleWorldGenProvider
| |||||||||||||||
| HytaleGenerator | The standard generator for Hytale.
HandleProvider
| |||||||||||||||
| Void | A world generation provider that does not generate any blocks.
VoidWorldGenProvider
|
WorldMap
Type information:
(Nullable) Either
DisabledWorldMapProvider with the following properties:
| Key | Type | Description |
|---|---|---|
| Type | Constant value: Disabled | This field controls the type, it must be set to the constant value "Disabled" to function as this type. |
or
WorldGenWorldMapProvider with the following properties:
| Key | Type | Description |
|---|---|---|
| Type | (Nullable) String | This field controls the type, it must be set to the constant value "WorldGen" to function as this type. |
WorldMapConfig
Optional per-world overrides for world map configuration and limits.
Type information:
(Nullable)
WorldWorldMapConfig with the following properties:
| Key | Type | Description |
|---|---|---|
| ViewRadiusMin | Integer | |
| ViewRadiusMax | Integer |
ChunkStorage
Sets the storage system that will be used by the world to store chunks.
Type information:
(Nullable) Any of these:
Key: Type | Type | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Empty | A chunk storage provider that discards any chunks to save and will always fail to find chunks.
EmptyChunkStorageProvider
| ||||||||||||
default case: Hytale | Selects the default recommended storage as decided by the server.
DefaultChunkStorageProvider
| ||||||||||||
| IndexedStorage | Uses the indexed storage file format to store chunks.
IndexedStorageChunkStorageProvider
| ||||||||||||
| Migration | A provider that combines multiple storage providers in a chain to assist with migrating worlds between storage formats. Can also be used to set storage to load chunks but block saving them if combined with the Empty storage provider
MigrationChunkStorageProvider
| ||||||||||||
| RocksDb | RocksDbChunkStorageProvider
|
ChunkConfig
Configuration for chunk related settings
Type information:
ChunkConfig with the following properties:
| Key | Type | Description |
|---|---|---|
| PregenerateRegion | (Nullable) | Sets the region that will be pregenerated for the world. If set, the specified region will be pregenerated when the world starts. |
| KeepLoadedRegion | (Nullable) | Sets a region of chunks that will never be unloaded. |
IsTicking
Sets whether chunks in this world are ticking or not.
Type information: Boolean defaults to: true
IsBlockTicking
Sets whether blocks in this world are ticking or not.
Type information: Boolean defaults to: true
IsPvpEnabled
Sets whether PvP is allowed in this world or not.
Type information: Boolean defaults to: false
IsFallDamageEnabled
Sets whether fall damage is allowed in this world or not.
Type information: Boolean defaults to: true
IsGameTimePaused
Sets whether the game time is paused.
This effects things like day/night cycles and things that rely on those.
Type information: Boolean defaults to: false
GameTime
The current time of day in the world.
Type information: (Nullable) String
ForcedWeather
Sets the type of weather that is being forced to be active in this world.
Type information: (Nullable) String
ClientEffects
Settings for the client's weather and post-processing effects in this world.
Type information:
(Nullable)
ClientEffectWorldSettings with the following properties:
| Key | Type | Description |
|---|---|---|
| SunHeightPercent | (Nullable) Either Number defaults to: 100.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| SunAngleDegrees | (Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| BloomIntensity | (Nullable) Either Number defaults to: 0.30000001192092896 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| BloomPower | (Nullable) Either Number defaults to: 8.0 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| SunIntensity | (Nullable) Either Number defaults to: 0.25 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| SunshaftIntensity | (Nullable) Either Number defaults to: 0.30000001192092896 or String that matches the pattern: ^(-?Infinity|NaN)$ | |
| SunshaftScaleFactor | (Nullable) Either Number defaults to: 4.0 or String that matches the pattern: ^(-?Infinity|NaN)$ |
PregenerateRegion
Type information:
(Nullable)
Box with the following properties:
| Key | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Min | (Nullable)
Vector3d
| |||||||||||||
| Max | (Nullable)
Vector3d
|
RequiredPlugins
Sets the plugins that are required to be enabled for this world to function.
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|---|
String | String |
GameMode
Sets the default gamemode for this world.
Type information:
(Nullable) Any one of the following String:
| Name | Description |
|---|---|
"Adventure" | The normal gamemode for players playing the game. |
"Creative" | Makes the player invulnerable and grants them the ability to fly. |
DefaultPermissionGroup
The default permission group assigned to new players joining this world.
Type information: (Nullable) String
IsSpawningNPC
Whether NPCs can spawn in this world or not.
Type information: Boolean defaults to: true
IsBlockSpawnersEnabled
Whether block spawners resolve into their target blocks in this world.
Type information: Boolean defaults to: true
IsSpawnMarkersEnabled
Whether spawn markers are enabled for this world.
Type information: Boolean defaults to: true
IsAllNPCFrozen
Whether all NPCs are frozen for this world
Type information: Boolean defaults to: false
GameplayConfig
The gameplay configuration being used by this world
Type information: (Nullable) String defaults to: Default
Reference to a GameplayConfig asset
Death
Inline death configuration overrides for this world. If set, these values take precedence over the referenced GameplayConfig.
Type information:
(Nullable)
MutableDeathConfig with the following properties:
| Key | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| RespawnController | Type Selector (2) | The respawn controller that determines where the player respawns. | ||||||||
| ItemsLossMode | (Nullable) Any one of the following String (defaults to None):
ItemsLossMode
| 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 | ||||||||
| ItemsDurabilityLossPercentage | Number defaults to: 10.0 | The amount of durability (in %) items lose upon death (applied to the entire inventory). | ||||||||
| GameModeTypeOnDeath | (Nullable) String | When set, dying players skip the respawn screen, respawn in place, and enter this GameModeType. When unset, normal death behavior applies. |
DaytimeDurationSeconds
Override for the duration of daytime in seconds. If set, takes precedence over the referenced GameplayConfig.
Type information: Integer
NighttimeDurationSeconds
Override for the duration of nighttime in seconds. If set, takes precedence over the referenced GameplayConfig.
Type information: Integer
IsCompassUpdating
Whether the compass is updating in this world
Type information: Boolean defaults to: true
IsSavingPlayers
Whether the configuration for player's is being saved for players in this world.
Type information: Boolean defaults to: true
IsSavingChunks
Whether the chunk data is allowed to be saved to the disk for this world.
Type information: Boolean defaults to: true
SaveNewChunks
Whether newly generated chunks should be marked for saving or not. Enabling this can prevent random chunks from being out of place if/when worldgen changes but will increase the size of the world on disk.
Type information: Boolean defaults to: true
IsUnloadingChunks
Whether the chunks should be unloaded like normally, or should be prevented from unloading at all.
Type information: Boolean defaults to: true
IsObjectiveMarkersEnabled
Whether objective markers are enabled for this world.
Type information: Boolean defaults to: true
DeleteOnUniverseStart
Whether this world should be deleted when loaded from Universe start. By default this is when going through the world folders in the universe directory.
Type information: Boolean defaults to: false
DeleteOnRemove
Whether this world should be deleted once its been removed from the server
Type information: Boolean defaults to: false
CrashRecovery
Recovery policy for this world when its thread crashes. Overrides the server default.
Type information:
(Nullable)
CrashRecoveryConfig with the following properties:
| Key | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Mode | (Nullable) Any one of the following String:
WorldCrashRecovery
| The action taken when the world crashes. One of None, Reload or Shutdown. If unset, the default world uses the singleplayer or dedicated default. Any other world with this block reloads. | ||||||||
| MaxAttempts | Integer | The number of reload attempts before the fallback runs. Reload only. | ||||||||
| RetryDelaySeconds | Integer | The delay in seconds before a reload attempt. Reload only. | ||||||||
| Fallback | (Nullable) Any one of the following String:
WorldCrashRecovery
| The action after the reload attempts run out. One of None or Shutdown. Reload only. |
Instance
Instance specific configuration.
Type information:
(Nullable) Map of the following:
| Key | Type |
|---|---|
any String | anything |
DisabledFluidTickers
A set of fluid tag strings (e.g. "Fluid=Water", "Fire=Fire") whose tickers should be disabled in this world. Fluids matching any of these tags will not tick.
Type information: (Nullable) Array of String
ResourceStorage
Sets the storage system that will be used to store resources.
Type information:
(Nullable) Any of these:
Key: Type | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Disk | DiskResourceStorageProvider
| |||||||||
| Empty | EmptyResourceStorageProvider
| |||||||||
default case: Hytale | DefaultResourceStorageProvider
|
Plugin
Type information:
Object with the following properties:
| Key | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CreativeHub | CreativeHubWorldConfig
| |||||||||||||||||||||||||||||||
| Instance | InstanceWorldConfig
| |||||||||||||||||||||||||||||||
| PortalWorldConfig | PortalWorldConfig
| Marks a world as a portal world without a summoning device. | ||||||||||||||||||||||||||||||
| WorldEvents | WorldEventsWorldConfig
|
Notes:
Types referenced by this type
Type Selector
Any of these:
Key: Id | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| FitToHeightMap | A spawn provider that takes a spawn point from another provider and, when its Y is the no-height sentinel, places it one block above the heightmap of the world.
FitToHeightMapSpawnProvider
| |||||||||
default case: Global | A spawn provider that provides a single static spawn point for all players.
GlobalSpawnProvider
| |||||||||
| Individual | A spawn provider that selects a spawn point from a list based on the player being spawned in. This gives random but consistent spawn points for players.
IndividualSpawnProvider
|
Type Selector (1)
Any of these:
Key: Type | Type | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Empty | A chunk storage provider that discards any chunks to save and will always fail to find chunks.
EmptyChunkStorageProvider
| ||||||||||||
default case: Hytale | Selects the default recommended storage as decided by the server.
DefaultChunkStorageProvider
| ||||||||||||
| IndexedStorage | Uses the indexed storage file format to store chunks.
IndexedStorageChunkStorageProvider
| ||||||||||||
| Migration | A provider that combines multiple storage providers in a chain to assist with migrating worlds between storage formats. Can also be used to set storage to load chunks but block saving them if combined with the Empty storage provider
MigrationChunkStorageProvider
| ||||||||||||
| RocksDb | RocksDbChunkStorageProvider
|
Type Selector (2)
Any of these:
Key: Type | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ExitInstance | ExitInstance
| |||||||||
| HomeOrSpawnPoint | HomeOrSpawnPoint
| |||||||||
| WorldSpawnPoint | WorldSpawnPoint
|
Type Selector (3)
Any of these:
Key: Type | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ExitInstance | ExitInstance
| |||||||||
| HomeOrSpawnPoint | HomeOrSpawnPoint
| |||||||||
| WorldSpawnPoint | WorldSpawnPoint
|
Type Selector (4)
Any of these:
Key: Type | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| IdleTimeout | A condition that triggers after the world has be idle (without players) for a set time.
IdleTimeoutCondition
| |||||||||
| Portal | A condition for temporary portal worlds.
PortalRemovalCondition
| |||||||||
| Timeout | A condition that triggers after a set time limit.
TimeoutCondition
| |||||||||
| WorldEmpty | A condition that triggers when the world is empty. It will only trigger after at least one player has joined. As a safety measure it provides a timeout for waiting for a player to join in case the player disconnected before entering the world.
WorldEmptyCondition
|
