Guide

If you have purchased the plugin, please leave a feedback on our BuiltByBit page!

STEP ONE: Install the plugin 1. Purchase the plugin on BuiltByBit or Polymart 2. Put he gDiscordSync.jar the plugins folder 3. Restart the server! (Do not use PlugMan or any plugin loader)

If you are stuck on something or have a specific problem, join our Discord server!

STEP TWO: Configure the plugin 0. If there was a problem with the config file, you can find the default configuration here! 1. Set the bot token so the plugin can create a connection between your Discord server.

discord:
  token: "your-discord-bot-token"
  guild-id: "your-guild-id"
  change-nickname: true
  restrict-to-channel: true
  target-channel-id: "your-channel-id"

2. You need to select the final database type that the plugin will operate with.

#  recommended: mysql
storage:
  driver: "sqlite"
  mysql:
    host: "localhost"
    port: 3306
    database: "discordsync_database"
    username: "username"
    password: "password"

STEP THREE: Plugin customization From now on, the plugin can operate stably since the Discord BOT Token, Database, and a Discord Server ID have been set up. Customization can now proceed.

1. Customize the slash command.

give-role:

You can give role the players for sync, add the role id to discord-roles

sync-roles:

You can synchronize the player's LuckPerms ranks on Discord (Only if you have the LuckPerms rank set to the Discord rank equivalent)

execute-commands:

This is a boolean option. (true/false) If "true" then the commands under server-commands will be executed if the player is synchronizing.

slash-command:
  command: "link"
  description: "Generate an activation code to sync!"
  give-role: true
  discord-role: "your-role-id"
  sync-roles: true
  execute-commands: true
  server-commands:
    - "eco give %player% 150"
    - "say %player% sync"
  messages:
    generated-code: "On the server, enter this command: **/gdiscordsync link %code%** If you don't activate it within 15 minutes, the code will be deleted."
    already-generated: "You have already linked your account, or you have an unactivated activation code!"
    wrong-channel: "This command can only be used on the specified channel."
    database-error: "An unknown error occurred during communication with the database, please wait.."