MinecraftManhunt

View on Bukkit • View on SpigotMC • View on PaperMC

Having issues? Check the FAQ Issues page, or report a problem on the Issues tab!

Made by Eric (yoonicode.com)
Github: ericyoondotcom
Minecraft: TildeTildeTilde

Inspired by Dream on YouTube

How It Works

Three teams: Hunters, Runners, and Spectators Hunters try to kill the runners before they beat the enderdragon. Runners must beat the enderdragon before they get killed once!

Features

• Compass tracking: Right-click with your compass to choose who to track, then the compass will point to that runner!
• Portal tracking: If a runner is in the nether, the compass will track their last-used portal!
• Teams assignment: Automatically assigns in-game /team to distinguish between players with colors!
• Discord integration: Optionally integrate with Discord for extra features!
  • Auto role assignment: Automatically assign Discord roles according to teams
  • Music player: Automatically (or manually) play music in your Discord voice channel that mirrors the action happening!

Instructions For Use

• Move the .jar from the Releases tab to your plugins folder.
• Make sure your config file is up to date and has all the required options.
• Assign roles with /speedrunner, /hunter, and /spectator.
• If you want automatic music, type /music auto now.
• Type /start!
• After the headstart period is over, hunters should be able to start tracking runners by selecting someone to track by right-clicking with their compass.

Note: teams are not persistent between server sessions— if you shut down the server you'll have to re-assign teams and type /start again. Have players put their items in chests before typing /start if you're doing this, since the command clears inventories.

Discord Setup Instructions

• Create a Discord app from the Developer Portal.
• Add a Bot under the bots tab.
• Scroll down and enable the toggles under "server members intent" and "message content intent".
• Take note of your Client ID (in the General Information tab) and your Token (under the Bot tab).
• Go to the following link, replacing 123YourClientID456 with your client ID: https://discord.com/oauth2/authorize?scope=bot&client_id=123YourClientID456&permissions=8
• Select the Discord server to add your bot to.
• Add your Client ID and Token to the respective fields in the config file.
• Go to your Discord server, and add the following values to the config file, in accordance with the table above (you can Right Click > Copy ID if you turn on Developer Mode in Discord settings!)
  • the ID of your server
  • the ID of the voice channel you want your music to play in
  • the ID of the hunter, runner, and spectator Discord roles you want to be automatically assigned

    Note: For auto-role-assignment to work, each Discord user's nickname for your Server must be set to their Minecraft username.

Commands

• /speedrunner <username>: Assign speedrunner role
• /hunter <username>: Assign hunter role
• /spectator <username>: Assign spectator role
• /start: Start the match
• /end: End the match
• /compass: Give yourself a compass
• /music: Controls the Discord music
  • /music list: Gets a list of available tracks to play.
  • /music <trackname>: Plays a specific track by nickname and turns off auto-music.
  • /music stop: Stops all music playing and turns off auto-music.
  • /music auto: Turns on auto-music, which plays different tracks based on game events and hunter/runner distance.
  • /music forceupdate: Forces the music to update to match the current hunter/runner distance. Use /music stop first if a special event track is playing.

• /setheadstart <duration>: Sets the headstart duration, in seconds.

  Configuration Options

  Edit the plugins/MinecraftManhunt/config.yml file with the following options:

  Game Options

  Key	Description	Type	Required?
  headStartDuration	How long the hunters should get blindness and slowness when the match starts, in secs.	int	Required
  compassEnabledInNether	Set to true to allow the compass to work in the nether.	boolean	Optional, defaults to true
  sendUsageData	Set to true to send anonymized, aggregated usage data to help improve the plugin.	boolean	Optional, defaults to false
  uuid	Randomized id that is automatically assigned if sendUsageData is enabled. Please do not touch this field.	string	Do not set manually

  Extra Options

  Key	Description	Type	Required?
  setRunnersToSpecOnDeath	Set to true to set runners' gamemodes to spectator when they die.	boolean	Optional, defaults to true
  huntersColor	The color to give to the hunters team.	string	Optional
  runnersColor	The color to give to the runners team.	string	Optional
  spectatorsColor	The color to give to the spectators team.	string	Optional
  clearRunnerInvOnStart	Set to true to clear the runners' inventories and experience when the game starts.	boolean	Optional, defaults to false
  clearHunterInvOnStart	Set to true to clear the hunters' inventories and experience when the game starts.	boolean	Optional, defaults to false
  clearItemDropsOnStart	Set to true to clear all Item entities when the game starts.	boolean	Optional, defaults to false
  setTimeToZero	Set to true to reset the game time when the game starts.	boolean	Optional, defaults to true
  startGameByHit	Set to true to start the game when a runner hits a hunter, instead of when the /start command is used.	boolean	Optional, defaults to false
  preGameWorldBorder	Set to true to enforce a world border before the game starts (useful to keep players from running too far).	boolean	Optional, defaults to false
  preGameBorderSize	States how big the pre-game world border would be, if enabled.	int	Optional, defaults to 100; ignored when preGameWorldBorder is false

  Discord Integration

  Key	Description	Type	Required?
  enableDiscord	Set to true to turn on Discord integration. Read below for more information.	boolean	Required
  discordToken	Enter the token of your Discord bot here.	string	Required if enableDiscord is true
  ip	The Discord status message portion. Will display as Playing {value} so it's recommended that you make this your server's IP.	string	Optional
  parseDiscordCommands	Set to true if you want music commands to be run by sending a message in Discord text channels. This allows anyone in your Discord server to run music commands, however.	Optional, defaults to false
  discordServerId	The ID of your Discord server that the bot is on.	string	Required if enableDiscord is true
  musicChannelId	The ID of the voice channel that the bot should play music on.	string	Required if enableDiscord is true
  hunterRoleId	The ID of the role to assign to Hunters.	string	Optional
  runnnerRoleId	The ID of the role to assign to Runners.	string	Optional
  spectatorRoleId	The ID of the role to assign to Spectators.	string	Optional

Note: if any of the role IDs are missing or invalid, no roles will be assigned.

Permissions

Music Queues

Part of the fun of this plugin is learning what each music queue means to get a competitive advantage. Here's a list of what causes each track to play.

Distance

The intensity of the music depends on the distance between the runners and the hunters. Tracks are selected at random from the following categories:

• < 50 blocks away: Chasing
• < 150 blocks away: In Sight
• < 300 blocks away: Stealth
• < 450 blocks away: Approaching
• >= 450 blocks away: Far away

Additionally, there is a set of tracks that play if the runners, but not the hunters, are in the Nether.

Special Events

Special tracks play when events related to the game occur. Some events are:

• The runners mine their first iron ore
• The runners mine a diamond ore
• The hunters craft their first piece of iron armor
• The hunters and runners damage each other
  • "Chase" music plays if the fighters have a combined total of less than two pieces of armor
  • "Fight" music plays if they have more than two pieces of armor
• A hunter dies
• A runner dies
• Both players are in boats
• A runner trades with a Piglin for the first time
• A runner teleports to the end

Troubleshooting

• online-mode in server.properties must be set to true as of version 1.2.4.
• If you are using Discord integration, make sure your server's system clock is set correctly.
• Check the FAQ Issues page, or report a problem on the Issues tab!

Advanced: Developing

• This project uses Maven. To build, run the package script.
• Pull requests and Issues are welcome!

Made With

• Bukkit/Spigot plugin library
• JDA: Java Discord Library
• LavaPlayer: Audio Player for Discord