ManhuntX Documentation

Main runtime settings, license, modules, limits, storage and feature behavior.

# ...
# Short documentation excerpt from config.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
license-key: contact the author
color-format: "legacy" # Options: "legacy" (& codes) or "minimessage" (<color> tags)

database:
  method: "SQLite" # Options: SQLite, MySQL
  data:
    host: "localhost"
    port: 3306
    database: "manhuntx"
    username: "root"
    password: ""
    ssl: false

# Queue settings
queue:
  required-runners: 1
  required-hunters: 2
  max-runners: 3
  max-hunters: 5
  auto-assign-role: true # Assign role if player didn't choose

# Game settings
game:
  countdown-seconds: 10
  headstart-seconds: 30
  delay-before-end: 5
  compass-tracking: true
  compass-update-interval: 20 # ticks
  runner-glow: false # Runners glow for hunters
  death-spectate: true # Dead runners spectate
  allow-hunter-pvp: false
  allow-runner-pvp: false

# Lobby
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/config.yml to review every setting.
# ...

Live display text, update intervals and PlaceholderAPI-rendered lines.

# ...
# Short documentation excerpt from scoreboard.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
scoreboard:
  update-time: 20 #ticks
  enabled: true
  color-format: "legacy" # Options: "legacy" (& codes) or "minimessage" (<color> tags)

  lobby:
    title: "&c&lManhuntX"
    lines:
      - ""
      - "&c&l%player_name%:"
      - "&7• &f⚔ Kills: &e<kills>"
      - "&7• &f☠ Deaths: &e<deaths>"
      - "&7• &f🏆 Wins: &e<wins>"
      - ""
      - "&c&lServer:"
      - "&7• &f🌐 Online: &e%server_online%"
      - ""
      - "&cplay.manhuntx.com"

  queue:
    title: "&c&lQueue"
    lines:
      - ""
      - "&fRole: &e<role>"
      - "&fTime: &e<time>"
      - ""
      - "&cplay.manhuntx.com"

  in-game:
    title: "&c&lManhuntX"
    lines:
      - ""
      - "&7• &eRole: &f<role>"
      - "&7• &aRunners: &f<alive_runners>"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/scoreboard.yml to review every setting.
# ...

# ...
# Short documentation excerpt from messages.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
prefix: "&7[&cManhunt&7] &r"

# Role names
role-runner: "&aRunner"
role-hunter: "&cHunter"
role-spectator: "&7Spectator"

# Queue messages
joined-queue: "&aYou joined the queue as <role>."
left-queue: "&cYou left the queue."
already-in-queue: "&cYou are already in the queue!"
already-in-game: "&cYou are already in a game!"
match-found: "&aMatch found! Preparing world..."
actionbar-queue: "&aYou are in queue! &7Type &b/manhunt leave &7to leave."

# Game messages
game-starting-countdown: "&eGame starts in &c<countdown>&e seconds!"
game-started-runners: "&aYou have &e<headstart>&a seconds of head start! RUN!"
game-started-hunters: "&cHunters will be released in &e<headstart>&c seconds!"
hunters-released: "&c&lHunters have been released!"
game-ended-runner-win: "&a&lRunners won! The Ender Dragon has been defeated!"
game-ended-hunter-win: "&c&lHunters won! All runners have been eliminated!"

# Death messages
runner-death: "&c<victim> &7has been eliminated by &e<killer>&7!"
runner-death-natural: "&c<victim> &7has been eliminated!"
runners-remaining: "&7Runners remaining: &a<alive_runners>"
hunter-death: "&e<victim> &7was killed but will respawn!"

# Private game
private-game-created: "&aPrivate game created!"
player-invited: "&aYou invited &e<player>&a to your game."
invite-received:
  - "&aYou have been invited to &e<player>&a's manhunt!"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/messages.yml to review every setting.
# ...

Purpose: Registers or consumes PlaceholderAPI values for scoreboards, formats and external displays.

Troubleshooting: If values stay blank, reload expansions and verify the identifier exactly matches the placeholder shown in this docs page.

1. Install PlaceholderAPI or the listed placeholder provider.
2. Install required expansions when the provider uses external expansions.
3. Use the exact placeholder identifiers documented in this page.
4. Reload the display plugin after changing scoreboard, tablist, menu or chat format files.

Purpose: Provides persistent storage for player data, stats, transactions, vaults or network state.

Troubleshooting: If storage fails, copy the first SQL error, then verify credentials, database permissions, driver availability and firewall access.

1. Create the database and user before enabling SQL storage.
2. Enter host, port, database, username and password in the storage config.
3. Restart and confirm the connection pool opens without authentication errors.
4. Run one write action, then verify the table or database file was updated.

1. Prepare world, spawns and protection.
2. Separate player, host and moderator permissions.
3. Configure announcements in messages.yml.
4. Run one dry match and record expected cleanup.

1. Check active state and affected players.
2. Use the configured admin recovery/end action.
3. Confirm lobby return and tracking cleanup before reopening queue.

Verify queue permissions, required player count, match mode name and available arena category. Also confirm players are not already in another match or queue.

Reproduce this issue on a clean test server, compare changed YAML files and include the first console error in the support report.

Reproduce this issue on a clean test server, compare changed YAML files and include the first console error in the support report.

Reproduce this issue on a clean test server, compare changed YAML files and include the first console error in the support report.

Check storage connection, write permissions and whether the match ends through the normal cleanup flow. Forced stops may skip stat writes.