Skip to main content

​
First Run

Work through this checklist after installing the plugin and configuring your bot token and guild ID. It confirms the plugin loaded, the bot connected, the database initialized, and at least one feature end to end.

​
Step-by-Step

1

Confirm the plugin loaded

From console or in-game, run:
/xdiscord status
You should see the plugin version (1.2.0), the bot connection state, and the database state. If the command is unknown, the plugin failed to enable - check logs/latest.log for the reason.
2

Confirm the bot is online

In Discord, the bot should appear online in your member list. If it is offline:
  • Verify discord.bot-token is correct
  • Confirm the MESSAGE CONTENT, SERVER MEMBERS, and PRESENCE intents are enabled in the Developer Portal
  • See Bot Setup
3

Add your admin Discord ID

Find the adminIDs list in config.yml and add your Discord user ID (right-click your name > Copy ID, Developer Mode on):
adminIDs:
  - "123456789012345678"
Admins in this list receive admin alerts and DMs for critical events. Use string IDs, not integers.
4

Enable the modules you want

Under features.*, set enabled: true for each module you want. Start with the core pair:
features:
  chat-bridge:
    enabled: true
    chat-channel-id: "123456789012345678"
  server-logging:
    enabled: true
    log-channel-id: "123456789012345678"
  verification:
    enabled: true
See Features for the full catalog.
5

Set channel IDs

For every enabled module, fill in the channel ID it targets. See Bot Setup for the channel mapping.
6

Reload

Apply your changes without a full restart:
/xdiscord reload
7

Test verification end to end

  1. Join the server and run /verify in-game to get a code
  2. Use the /verify slash command in Discord and enter the code
  3. Confirm the link role is applied and the nickname resyncs
  4. (Optional) Test /unlink in-game or as an admin

​
Verifying It Works

Two commands give you a full picture of plugin state:
CommandShows
/xdiscord modulesEvery module and whether it is enabled
/xdiscord statusBot connection state, database state, version
If something is not behaving as expected, set general.debug: true in config.yml and run /xdiscord reload. Verbose logging writes to logs/latest.log and is invaluable for support requests. Turn it back off for production.

​
Next Steps

Configuration

Full reference for every setting.

Verification

Deep dive on account linking, codes, and /unlink.