Configuration

The main configuration file is located at plugins/AstralSync/config.yml. It is generated on first start with the defaults shown below.

Default config.yml

read-only: false
ignored-attributes:
  - minecraft:effect.*
  - minecraft:creative_mode_*
  - astraltower:*

Options

`read-only`

Field	Value
Type	`boolean`
Default	`false`

When true, AstralSync enters read-only mode:

All save operations are skipped — no new snapshots are written.
Data is still loaded from the database on join.
Deserialization continues even if an adapter key is not registered (the chunk is silently skipped instead of throwing an error).
Rollback operations via the /snapshots command are blocked.

Use this mode on maintenance servers or read-replica instances that share a database with the primary server but should never overwrite player data.

To reload this value without restarting, run /sync reload.

`ignored-attributes`

Field	Value
Type	`List<String>`
Default	`[minecraft:effect., minecraft:creative_mode_, astraltower:*]`

A list of attribute modifier key patterns to exclude when saving player attributes. This prevents transient modifiers — applied by server-side systems like game modes, active potion effects, or tower mechanics — from being persisted in snapshots.

Wildcard syntax: Patterns support * as a wildcard character matching any sequence. The match is applied to the full namespaced key (e.g. minecraft:effect.speed).

Examples:

Pattern	Matches
`minecraft:effect.*`	`minecraft:effect.speed`, `minecraft:effect.strength`, …
`minecraft:creative_mode_*`	`minecraft:creative_mode_block_reach`, …
`astraltower:*`	Any modifier in the `astraltower` namespace
`myplugin:temp_boost`	Exactly `myplugin:temp_boost` (no wildcard)

To apply changes, run /sync reload.

Reloading

/sync reload

Reloads config.yml and messages.yml at runtime without restarting the server. Requires the sync.command.reload permission.

24 April 2026