Instance Configuration

Define an instance — a named collection of mods that a server or client loads together.

An instance is a named collection of mods loaded together — similar to a modpack. Every install ships one instance, original_copy, containing the base Creation mod; a server operator (or anyone distributing a modded setup) creates additional instances by copying that folder structure and adding or disabling mods.

File Location

instances/<InstanceName>/<InstanceName>.yaml

The file name must match its parent folder name exactly — instances/original_copy/original_copy.yaml is scanned as the original_copy instance; a folder without a matching YAML file inside it is skipped (logged as a warning) when instances are listed.

Minimal Example

name: My Modpack
version: 1.0.0

Fields

name: My Modpack           # Required
description: >               # Optional
  A short description shown wherever this instance is listed.
version: 1.0.0                # Required
disabled-mods:                 # Optional
  - SomeMod

Field	Required	Default	Description
`name`	Yes	—	Display name for this instance.
`description`	No	(empty)	Shown wherever the instance is listed.
`version`	Yes	—	Instance version string.
`disabled-mods`	No	(none)	Mod names present in `instances/<InstanceName>/mods/` that should not be loaded. `Creation` itself can’t be disabled this way — it’s always filtered back out even if listed.

Every mod folder under instances/<InstanceName>/mods/ loads automatically unless named in disabled-mods — there’s no separate “enabled mods” allow-list to maintain.

Complete Example

Based on the real shipped original_copy instance:

name: Original Copy
description: >
  This is the original copy of the instance. It is used as a template for
  creating new instances.
version: 1.0.0
disabled-mods: [TestModCompatibility]