GameplayConfig

← Back to Asset Types

Documentation for the GameplayConfig asset type.

Location

GameplayConfigs

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/GameplayConfig.schema.json" Copy

Schema

Tree

Gathering unknown

Any of

GatheringConfig

null

World unknown

Any of

WorldConfig

null

WorldMap unknown

Any of

WorldMapConfig

null

Death unknown

Any of

DeathConfig

null

Respawn unknown

Any of

RespawnConfig

null

ShowItemPickupNotifications boolean

Default:true

ItemDurability unknown

Any of

ItemDurabilityConfig

null

ItemEntity unknown

Any of

ItemEntityConfig

null

Combat unknown

Any of

CombatConfig

null

Plugin object

ForgottenTemple object

MinYRespawn number

The Y at which players are teleported back to spawn.

Default:5

RespawnSound stringnull

The sound ID to play when players respawn in the temple.

Memories object

MemoriesAmountPerLevel array

Array items: integer

MemoriesRecordParticles string

MemoriesCatchItemId string

MemoriesCatchEntityParticle ModelParticle

MemoriesCatchParticleViewDistance integer

Default:64

Min (exclusive): 16

Objective object

StarterObjectiveLinePerWorld objectnull

Additional properties: string

Portal object

VoidEvent unknown

Any of

VoidEventConfig

null

Reputation object

ReputationStorage stringnull

Enum:"PerPlayer""PerWorld"

Default:"PerPlayer"

Stamina object

SprintRegenDelay SprintRegenDelayConfig

The stamina regeneration delay applied after sprinting

Stash object

ClearContainerDropList boolean

Default:true

Player unknown

Any of

PlayerConfig

null

CameraEffects CameraEffectsConfig

Default:{}

CreativePlaySoundSet unknown

Any of

stringReference to SoundSet

SoundSet

null

Crafting unknown

Any of

CraftingConfig

null

Spawn unknown

Any of

SpawnConfig

null

MaxEnvironmentalNPCSpawns integer

The absolute maximum number of environmental NPC spawns. < 0 for infinite.

Default:500

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "GameplayConfig.json",
  "title": "GameplayConfig",
  "description": "GameplayConfig asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Gathering": {
      "anyOf": [
        {
          "default": {
            "UnbreakableBlock": {},
            "IncorrectTool": {}
          },
          "$ref": "common.schema.json#/$defs/GatheringConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "World": {
      "anyOf": [
        {
          "default": {
            "AllowBlockBreaking": true,
            "AllowBlockGathering": true,
            "AllowBlockPlacement": true,
            "BlockPlacementFragilityTimer": 0,
            "DaytimeDurationSeconds": 1728,
            "NighttimeDurationSeconds": 1728,
            "TotalMoonPhases": 5,
            "Sleep": {
              "WakeUpHour": 5.5
            }
          },
          "$ref": "common.schema.json#/$defs/WorldConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "WorldMap": {
      "anyOf": [
        {
          "default": {
            "DisplaySpawn": true,
            "DisplayHome": true,
            "DisplayWarps": true,
            "DisplayDeathMarker": true,
            "DisplayPlayers": true
          },
          "$ref": "common.schema.json#/$defs/WorldMapConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "Death": {
      "anyOf": [
        {
          "default": {
            "RespawnController": {
              "Type": "HomeOrSpawnPoint"
            },
            "ItemsLossMode": "None",
            "ItemsAmountLossPercentage": 10,
            "ItemsDurabilityLossPercentage": 10
          },
          "$ref": "common.schema.json#/$defs/DeathConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "Respawn": {
      "anyOf": [
        {
          "default": {
            "RadiusLimitRespawnPoint": 500,
            "MaxRespawnPointsPerPlayer": 3
          },
          "$ref": "common.schema.json#/$defs/RespawnConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "ShowItemPickupNotifications": {
      "type": "boolean",
      "default": true
    },
    "ItemDurability": {
      "anyOf": [
        {
          "default": {
            "BrokenPenalties": {}
          },
          "$ref": "common.schema.json#/$defs/ItemDurabilityConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "ItemEntity": {
      "anyOf": [
        {
          "default": {
            "Physics": {
              "Mass": 5,
              "DragCoefficient": 0.5,
              "InvertedGravity": false
            },
            "PickupRadius": 1.75,
            "ParticleSystemId": "Item",
            "ShowItemParticles": true
          },
          "$ref": "common.schema.json#/$defs/ItemEntityConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "Combat": {
      "anyOf": [
        {
          "default": {
            "OutOfCombatDelaySeconds": 5,
            "StaminaBrokenEffectId": "Stamina_Broken",
            "DisplayHealthBars": true,
            "DisplayCombatText": true,
            "DisableNPCIncomingDamage": false,
            "DisablePlayerIncomingDamage": false
          },
          "$ref": "common.schema.json#/$defs/CombatConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "Plugin": {
      "type": "object",
      "properties": {
        "ForgottenTemple": {
          "type": "object",
          "title": "ForgottenTempleConfig",
          "properties": {
            "MinYRespawn": {
              "type": "number",
              "description": "The Y at which players are teleported back to spawn.",
              "default": 5
            },
            "RespawnSound": {
              "type": [
                "string",
                "null"
              ],
              "description": "The sound ID to play when players respawn in the temple."
            }
          },
          "additionalProperties": false
        },
        "Memories": {
          "type": "object",
          "title": "MemoriesGameplayConfig",
          "properties": {
            "MemoriesAmountPerLevel": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "MemoriesRecordParticles": {
              "type": "string"
            },
            "MemoriesCatchItemId": {
              "type": "string"
            },
            "MemoriesCatchEntityParticle": {
              "$ref": "common.schema.json#/$defs/ModelParticle"
            },
            "MemoriesCatchParticleViewDistance": {
              "type": "integer",
              "exclusiveMinimum": 16,
              "default": 64
            }
          },
          "additionalProperties": false
        },
        "Objective": {
          "type": "object",
          "title": "ObjectiveGameplayConfig",
          "properties": {
            "StarterObjectiveLinePerWorld": {
              "type": [
                "object",
                "null"
              ],
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "Portal": {
          "type": "object",
          "title": "PortalGameplayConfig",
          "properties": {
            "VoidEvent": {
              "anyOf": [
                {
                  "$ref": "common.schema.json#/$defs/VoidEventConfig"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "additionalProperties": false
        },
        "Reputation": {
          "type": "object",
          "title": "ReputationGameplayConfig",
          "properties": {
            "ReputationStorage": {
              "type": [
                "string",
                "null"
              ],
              "title": "ReputationStorageType",
              "enum": [
                "PerPlayer",
                "PerWorld"
              ],
              "default": "PerPlayer"
            }
          },
          "additionalProperties": false
        },
        "Stamina": {
          "type": "object",
          "title": "StaminaGameplayConfig",
          "properties": {
            "SprintRegenDelay": {
              "description": "The stamina regeneration delay applied after sprinting",
              "$ref": "common.schema.json#/$defs/SprintRegenDelayConfig"
            }
          },
          "additionalProperties": false
        },
        "Stash": {
          "type": "object",
          "title": "StashGameplayConfig",
          "properties": {
            "ClearContainerDropList": {
              "type": "boolean",
              "default": true
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "Player": {
      "anyOf": [
        {
          "default": {
            "MovementConfig": "BuiltinDefault",
            "MaxDeployableEntities": -1,
            "ArmorVisibilityOption": "All"
          },
          "$ref": "common.schema.json#/$defs/PlayerConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "CameraEffects": {
      "default": {},
      "$ref": "common.schema.json#/$defs/CameraEffectsConfig"
    },
    "CreativePlaySoundSet": {
      "anyOf": [
        {
          "type": "string",
          "title": "Reference to SoundSet"
        },
        {
          "$ref": "SoundSet.json#"
        },
        {
          "type": "null"
        }
      ]
    },
    "Crafting": {
      "anyOf": [
        {
          "default": {
            "BenchMaterialChestHorizontalSearchRadius": 14,
            "BenchMaterialChestVerticalSearchRadius": 6,
            "BenchMaterialChestLimit": 100
          },
          "$ref": "common.schema.json#/$defs/CraftingConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "Spawn": {
      "anyOf": [
        {
          "default": {},
          "$ref": "common.schema.json#/$defs/SpawnConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "MaxEnvironmentalNPCSpawns": {
      "type": "integer",
      "description": "The absolute maximum number of environmental NPC spawns. < 0 for infinite.",
      "default": 500
    }
  }
}