Solifex Studios
DiscordSynthesisWiki
Browse the wiki

Getting started

Configuration overview

Four config files, one job each. How they fit together and how to reload.

On first run DiscordSynthesis generates its files into plugins/DiscordSynthesis/. Each has a clear job:

plugins/DiscordSynthesis/
config.yml
Bot identity and presence, the module on/off toggles, database, linking, and network settings. Start here.
channels.yml
The Discord channel ID for each feature — plus optional per-server overrides for networks.
features.yml
The detailed settings for each module: how chat looks, report behaviour, sync rules, voice, and so on.
messages.yml
The text of every message and embed the plugin sends — fully rewordable and translatable.

Note

A working setup only needs bot.token, your module toggles in config.yml, and the matching channel IDs in channels.yml. Everything in features.yml and messages.yml ships with sensible defaults — tune later, or never.

The workflow

  1. 1.In config.yml, turn features on or off under modules:.
  2. 2.In channels.yml, paste the Discord channel ID for each feature you enabled.
  3. 3.In features.yml, adjust behaviour for those features if you want to.
  4. 4.In messages.yml, reword any message or embed.
  5. 5.Run /ds reload to apply — no restart required.

Enabling a feature

Every feature is a single boolean under modules: in config.yml. Flip it to true, give it a channel in channels.yml, reload.

yamlconfig.yml
modules:
  chatSync: true          # Sync Minecraft and Discord chat
  commandLog: true        # Log commands players run
  serverStatus: true      # Announce server on/off
  console: true           # Run console commands from Discord
  playerLeaveAndJoin: true
  deathLog: true
  synchronization: false  # Role / group sync
  reporting: false        # In-game /report
  banSync: false          # Sync bans both ways
  # ...20 modules in total

Color codes and formatting

In-game text supports legacy & codes (&a, &l, &x hex) and MiniMessage. Chat sync translates these to and from Discord Markdown automatically. See Placeholders for the tokens you can drop into messages and embeds.

Prefer a guided setup?

The web configurator walks you through goals and features and generates all four files, ready to drop into plugins/DiscordSynthesis/.