Skip to content

Configuration Reference

RAFIN edited this page Oct 29, 2026 · 1 revision

Configuration Reference

Edit plugins/ModSeeker/config.yml, then run /modseeker reload. Reload also refreshes policy files and client-list.yml, and closes any active Web GUI session.

Keys are case-sensitive. In particular, use ModVerification with its capital M and V.

Verification

Key Default Effect
ModVerification true Requests a signed mod report and evaluates the chosen mod policy.
advancedModVerification false Selects hash allowlisting instead of mod-ID blacklisting when mod verification is enabled.
handshakeTimeoutSeconds 10 Presence timeout and, when enabled, the launcher challenge deadline.
modlistTimeoutSeconds 15 Time allowed for each mod-report request attempt.

Timeouts accept 1–120 seconds. Out-of-range values fall back to their defaults. Mod-report requests allow up to three attempts, so modlistTimeoutSeconds is not the total connection deadline.

Keep at least one of ModVerification and launcherVerification.enabled enabled. Turning both off denies non-bypassed players. See Verification Modes for the combinations.

Messages

Key Default or purpose
kickMessages.missingHidder Please install Hidder to join this server. followed by the Hidder Modrinth link on a new line.
kickMessages.blacklistedMods Please Remove {mods} Illegal Mod{plural} To Join The Server
kickMessages.modlistTimeout Player Verification Failed
kickMessages.modlistRequestFailed Player verification failed - unable to send mod list request.
kickMessages.modCountExceeded You have too many mods installed. Maximum allowed: {maxMods}
enablePlayerNotifications true; sends the configured welcome message after approval.
welcomeMessage Welcome To The Server

See Kick Messages for the supported placeholders and messages with fixed wording.

Report display and mod count

Key Default Effect
showModList true Logs reported top-level mod IDs to the server console.
oneModPerLine false Logs each ID on a separate line when console reporting is enabled.
enableModCountThreshold false Applies the reported top-level mod-count limit in either mod mode.
maxModCount 50 Limit when enabled; accepts 1–512. Invalid values fall back to 50.

The count uses reported top-level mod IDs, so it can differ from the number of JAR files in a folder. Nested IDs are still checked by the blacklist. Console logging does not control verification or command access to cached reports.

Launcher verification

Key Default Effect
launcherVerification.enabled false Requests the signed launcher check.
launcherVerification.kickMessage Please use an approved launcher to join this server Message used for a denied launcher.
launcherVerification.allowUnknownClients false Accepts an empty or unknown launcher label when true.

Edit allowed launcher entries separately in client-list.yml. See Launcher Verification.

Floodgate and Discord

allowFloodgate defaults to true. It bypasses verification only for connections identified by the Floodgate API. See Floodgate and Bedrock.

Discord delivery is off by default: discord.enabled: false. Its four event switches default to true but send nothing until delivery is enabled with a valid webhook URL. See Discord Alerts for the event contents and settings.

Web GUI

Key Default Effect
gui.port 0 Selects a free port for local access. Use a fixed, separate TCP port for external access.
gui.externalUrl "" Local access when blank; otherwise the browser-facing HTTP or HTTPS origin.

There is no bindAddress or GUI enable switch. Binding follows externalUrl, and modseeker gui starts the listener. See Web GUI for working local, public-IP and HTTPS examples.

Default configuration

The following lists the generated settings without the explanatory comments:

Show default config.yml
ModVerification: true

advancedModVerification: false

handshakeTimeoutSeconds: 10
modlistTimeoutSeconds: 15

kickMessages:
  missingHidder: "Please install Hidder to join this server.\nhttps://modrinth.com/mod/hidder"
  blacklistedMods: "Please Remove {mods} Illegal Mod{plural} To Join The Server"
  modlistTimeout: "Player Verification Failed"
  modlistRequestFailed: "Player verification failed - unable to send mod list request."
  modCountExceeded: "You have too many mods installed. Maximum allowed: {maxMods}"
enablePlayerNotifications: true
welcomeMessage: "Welcome To The Server"

enableModCountThreshold: false
maxModCount: 50
showModList: true
oneModPerLine: false

allowFloodgate: true

discord:
  enabled: false
  webhookUrl: "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL_HERE"
  events:
    playerJoin: true
    modListReceived: true
    blacklistViolation: true
    verificationFailed: true

launcherVerification:
  enabled: false
  kickMessage: "Please use an approved launcher to join this server"
  allowUnknownClients: false

gui:
  port: 0
  externalUrl: ""

Apply and check changes

Run /modseeker reload, read any warnings before its completion message, and inspect /modseeker status. Reconnect a test player for changes to connection policy. Commands and GUI list mutations save directly and do not need a reload.

If a policy file is malformed, a reload completion message does not mean the policy loaded successfully. Restore the file from a known-good backup and check again. See Troubleshooting.

Clone this wiki locally