Settings

Level

level controls how much Socialismus writes to the logger.

level: 3

{
  "level": 3
}

Use 2 for normal operation and 3 when you are actively debugging chat routing, listeners, or synchronization behavior.

serialization

serialization controls how Socialismus turns configured message strings into components.

type

• Takes: "MINIMESSAGE", "GSON", "LEGACY_AMPERSAND", "LEGACY_SECTION", or "PLAIN"
• Current default: "MINIMESSAGE"
• Affects: the default serializer adapter used by Socialismus message rendering

MINIMESSAGE is the normal choice for modern Socialismus configuration. Use a legacy adapter only when you intentionally want older color-code conventions to be your primary format.

enableLegacyColors

• Takes: true or false
• Current default: false
• Affects: whether legacy & and § color codes are converted during serialization

This is useful when you want to keep MINIMESSAGE as the main format but still accept legacy color codes in input or migrated config content. It is marked as a warning because this translation adds extra work during message serialization, so each serialized message becomes slightly more expensive.

serialization:
  type: "MINIMESSAGE"
  enableLegacyColors: true

{
  "serialization": {
    "type": "MINIMESSAGE",
    "enableLegacyColors": true
  }
}

synchronization

synchronization controls whether this Socialismus instance participates in network synchronization and what identifier it uses when it does.

enabled

• Takes: true or false
• Current default: false
• Affects: whether Socialismus starts synchronization bridges at all

Leave this disabled on standalone setups. Enable it only when you intentionally run Socialismus with synchronization-capable infrastructure and matching companion components.

server

• Takes: a non-empty string
• Current default: a generated random UUID string
• Affects: the identifier Socialismus uses as this instance's synchronization origin

This value is used to tag synchronized chat, history, and player-state events so Socialismus can tell local and remote traffic apart. For real synchronized networks, set this to a stable, explicit identifier per node instead of relying on the generated default.

useRealServerName

• Takes: true or false
• Current default: false
• Affects: whether synchronized player server-state keeps the real backend server name instead of the configured synchronization identifier

This is mainly relevant on proxy-style synchronized setups. When it is enabled and Socialismus knows the player's actual server name, Socialismus stores that real server name on the synchronized player state. When it is disabled, Socialismus stores the configured synchronization identifier instead.

crossPlayerSync

• Takes: true or false
• Current default: true
• Affects: whether cross-player synchronization starts when synchronization itself is enabled

This matters only when synchronization.enabled is already true.

synchronization:
  enabled: true
  server: "proxy-1"
  useRealServerName: false
  crossPlayerSync: true

{
  "synchronization": {
    "enabled": true,
    "server": "proxy-1",
    "useRealServerName": false,
    "crossPlayerSync": true
  }
}

updater

updater controls release and development-build update checks for the core Socialismus plugin.

checkForUpdates

• Takes: true or false
• Current default: true
• Affects: whether the updater scheduler runs at all

warnAboutUpdates

• Takes: true or false
• Current default: true
• Affects: whether release builds warn when a newer published release exists

warnAboutLocalBuilds

• Takes: true or false
• Current default: true
• Affects: whether Socialismus warns when it detects a local DEV build

warnAboutDevBuilds

• Takes: true or false
• Current default: true
• Affects: whether branch-style development builds warn when they are behind newer dev builds

interval

• Takes: a positive number
• Current default: 1
• Affects: how often Socialismus reruns the updater scheduler

The current runtime code treats this value as hours when scheduling checks, even though the field comment in the model still says minutes. Document and tune it as hours unless the runtime behavior changes.

updater:
  checkForUpdates: true
  warnAboutUpdates: true
  warnAboutLocalBuilds: true
  warnAboutDevBuilds: true
  interval: 6

{
  "updater": {
    "checkForUpdates": true,
    "warnAboutUpdates": true,
    "warnAboutLocalBuilds": true,
    "warnAboutDevBuilds": true,
    "interval": 6
  }
}

commands

commands controls command-manager behavior rather than command definitions themselves.

useBrigadier

• Takes: true or false
• Current default: false
• Affects: whether the legacy Paper command manager registers native Brigadier support when that capability exists

This is mainly relevant on Paper-side setups where the underlying Cloud command manager exposes Brigadier support.

useAsyncCompletions

• Takes: true or false
• Current default: true
• Affects: whether asynchronous command completions are registered when the current command manager supports them

commands:
  useBrigadier: false
  useAsyncCompletions: true

{
  "commands": {
    "useBrigadier": false,
    "useAsyncCompletions": true
  }
}

misc

misc contains general runtime toggles that do not fit better in serialization, synchronization, commands, or listeners.

disableJoinNotification

• Takes: true or false
• Current default: true
• Affects: whether Socialismus suppresses join-notification behavior tied to its player lifecycle handling

disableQuitNotification

• Takes: true or false
• Current default: true
• Affects: whether Socialismus suppresses quit-notification behavior tied to its player lifecycle handling

vanillaSending

• Takes: true or false
• Current default: true
• Affects: whether formatted chat messages start in vanilla-sending mode

This setting influences whether Bukkit or Paper chat handling continues through the platform's vanilla message path or is treated as fully custom Socialismus broadcast handling.

misc:
  disableJoinNotification: true
  disableQuitNotification: true
  vanillaSending: true

{
  "misc": {
    "disableJoinNotification": true,
    "disableQuitNotification": true,
    "vanillaSending": true
  }
}

listeners

Listener settings control whether selected platform listeners are registered and what priority they use. Platform-specific listener classes and registration details depend on the platform integration in use.

events

• Takes: a map keyed by fully qualified event class name
• Affects: registration and priority for matching listeners

listeners:
  events:
    com.velocitypowered.api.event.player.PlayerChatEvent:
      register: true
      priority: "LOWEST"

{
  "listeners": {
    "events": {
      "com.velocitypowered.api.event.player.PlayerChatEvent": {
        "register": true,
        "priority": "LOWEST"
      }
    }
  }
}

register

• Takes: true or false
• Affects: whether that event listener is registered at all

If you set this to false, Socialismus skips registration for that specific listener. That can be useful for advanced integration experiments, but it can also break chat, join, quit, world-change, or synchronization-related behavior depending on the event.

priority

• Takes: "LOWEST", "LOW", "NORMAL", "HIGH", or "HIGHEST"
• Affects: the Socialismus listener priority used for that listener, which is then mapped onto the current platform's event-priority model

If the event entry exists but no priority is set, the current code falls back to NORMAL.