Pixel Dream StudiosWiki

Config reference

Every option in the config file, section by section.

dimensionRequirements

Type: list of strings

Defines every dimension gate.

dimensionRequirements = [
  "minecraft:the_nether | ALL | minecraft:story/mine_diamond"
]

An empty list disables all individual gates even when the master switch remains enabled:

dimensionRequirements = []

[dimensionGating]

enabled

Type: boolean
Default: true

Master switch for all dimension gating.

enabled = true

When false, players may travel without Advancement Portals evaluating configured gates.

creativePlayersBypassGates

Type: boolean
Default: true

Allows Creative-mode players to ignore all gates.

creativePlayersBypassGates = true

Set to false when Creative players should be tested against the same advancement requirements.

spectatorPlayersBypassGates

Type: boolean
Default: true

Allows Spectator-mode players to ignore all gates.

spectatorPlayersBypassGates = true

operatorsBypassGates

Type: boolean
Default: true

Allows operators with the configured permission level to ignore all gates.

operatorsBypassGates = true

operatorBypassPermissionLevel

Type: integer
Default: 2
Allowed range: 1 through 4

Controls the permission level required by operatorsBypassGates.

operatorBypassPermissionLevel = 2

This setting has no effect when operatorsBypassGates = false.

warningCooldownSeconds

Type: integer
Default: 2
Allowed range: 0 through 60

Controls how often the full locked-travel message may be sent while a player repeatedly triggers the gate.

warningCooldownSeconds = 2

Set to 0 to allow a warning on every blocked event. This can produce chat spam while a player remains in a portal.

blockedPortalRetryDelayTicks

Type: integer
Default: 20
Allowed range: 0 through 200

Applies a short portal cooldown after blocked travel.

Twenty ticks is approximately one second:

blockedPortalRetryDelayTicks = 20

This is separate from warningCooldownSeconds.

  • The retry delay reduces repeated travel events.
  • The warning cooldown reduces repeated chat messages.

Set to 0 to disable the added retry delay.

showAdvancementDescriptions

Type: boolean
Default: true

Shows the advancement description below its title in the locked-travel message.

showAdvancementDescriptions = true

Set to false for a shorter message.

Advancements without display data use their resource ID instead of a title and description.

showDimensionUnlockMessages

Type: boolean
Default: true

Shows a chat and action-bar notification when an earned advancement finishes a gate.

showDimensionUnlockMessages = true

This setting does not affect the actual unlock. It controls only the notification.

[ftbTeams]

shareAdvancementsWithTeam

Type: boolean
Default: true

Master switch for FTB Teams advancement sharing.

shareAdvancementsWithTeam = true

The option is ignored safely when FTB Teams is not installed.

Dimension gating itself does not require FTB Teams.

shareOnlyPortalAdvancements

Type: boolean
Default: false

Controls the scope of newly earned advancement sharing.

shareOnlyPortalAdvancements = false

When false:

  • Newly earned eligible non-recipe advancements can be shared.
  • Portal requirements are also synchronized from existing progress.

When true:

  • Only advancement IDs referenced by dimensionRequirements are shared.
  • This is the recommended option when team sharing exists specifically to support gated dimensions.

shareRecipeAdvancements

Type: boolean
Default: false

Controls sharing for advancements whose path is inside a recipe folder.

shareRecipeAdvancements = false

Recipe advancement paths are detected when the path begins with recipes/ or contains /recipes/.

Recipe advancements can be extremely numerous and are often invisible, so they are disabled by default.

An advancement explicitly used by a dimension gate remains shareable even when this option is false. This prevents a recipe-based gate from breaking team progression.

syncTeamAdvancementsOnLogin

Type: boolean
Default: true

Synchronizes stored team advancement progress when a player joins.

syncTeamAdvancementsOnLogin = true

This is what allows an offline teammate to receive progress after returning.

When disabled, newly earned progress can still be shared immediately to online teammates, and gate-scoped synchronization can still occur during a portal attempt.

notifySharedAdvancements

Type: boolean
Default: true

Shows a small system message when a player receives an advancement through team sharing.

notifySharedAdvancements = true

Set to false to share silently.

On this page