Skip to content

Config Migration

TheCommandCraft edited this page Apr 19, 2026 · 3 revisions

Config Migration

Vanish++ automatically migrates your configuration when you update to a new version. You never need to delete and recreate your config files.

How It Works

On startup, the plugin reads the config-version key in config.yml. If it is lower than the current version, a smart-merge migration runs:

  1. Your existing custom values are read and preserved
  2. New keys introduced in the new version are added with their defaults
  3. Removed or renamed keys are handled gracefully
  4. The config-version is updated to the new value

Language Files (messages.yml)

messages.yml is automatically migrated on every startup. The plugin compares your file against the built-in defaults and writes any missing keys back to disk with their default values. Your existing customizations are never overwritten.

This means:

  • Upgrading to a new version never leaves a key undefined — new messages added in the update appear immediately with sensible defaults.
  • You can safely edit any existing value; only missing keys are added.
  • No manual diff or copy-paste required when updating.

scoreboards.yml and config.yml follow the same pattern — missing keys are filled from defaults and existing values are preserved.

Migration Report

After a migration, a report is shown in-chat to staff with vanishpp.see on their next login, listing what changed. The report can be permanently dismissed with /vack.

Backup Recommendation

Although migration is designed to be safe, it is good practice to back up your plugins/Vanishpp/ folder before updating on production servers.

Clone this wiki locally