Home

Welcome to the UHC Automation wiki!

First off, what is UHC Automation anyways? UHC Automation is a Spigot plugin that aims to be a lightweight wrapper to automate the execution of UHC-style events. In English, this plugin helps server admins run Minecraft events.

This plugin supports both solo mode and team mode, hooking into the vanilla scoreboard teams to do so. Time elapsed can be displayed to all players via 3 modes that each player chooses for themselves via /uhctime [option]: chat (on request) or scoreboard or subtitle (continuous display). All options are configurable in-game, including optional episode markers and an optional shrinking border. In the event of a server crash, the plugin will automatically attempt to resume the game on restart. Players who disconnect can be prevented from rejoining by an admin (/uhcunreg).

How To Use

These notes are things that the admin running the event should take note of before using this plugin. There are four major categories of commands:
Game Flow: /uhcstart, /uhcreset and /uhcprep
Game Options: /uhcoptions
Player Registration: /uhcreg and /uhcunreg
Info Commands: /uhctime and /uhcstatus

If you'd just like to get started immediately with the default settings, simply run /uhcreset to prep the world, then run /uhcstart to start the game.

Game Flow: /uhcstart and /uhcreset

Requires uhca.admin permission

The commands are fairly self explanatory. /uhcstart works as a command to start the game immediately, but if you would like to have a countdown before the start, /uhcstart <secs> will count down to the start over X seconds. If you would like to skip the countdown once it has been initiated, running /uhcstart again will instantly start the game. Running /uhcstart <secs> while a countdown is active will reset the countdown to X seconds.

/uhcreset or its alias /uhcstop will halt the game if it is running, and reset the game to its lobby state. Nothing more.

/uhcprep needs to be run before starting the UHC. The plugin will automatically prep the world when loaded, but if scoreboard objectives are deleted or the worldborder is changed, /uhcprep will need to be run again. Since /uhcreset actually does re-prepare the world, it is acceptable to reset the game before starting it in lieu of running /uhcprep

Game Options: /uhcoptions

Requires uhca.admin permission

The format of this command is /uhcoptions [option] [value]. Alterable options are:

• init-size: The initial width (not radius) of the worldborder, also defines the max range in which players/teams (depending on if team mode is active) will be spread. Value must be an integer. Accepts values greater than or equal to zero. Values greater than 60,000,000 or equal to 0 are set to 60,000,000. Default 4001.
• final-size: The final width (not radius) of the worldborder, to be reached after the border starts to shrink. Accepts values greater than or equal to zero. Values greater than 59,999,999 are set to 59,999,999. Default 101.
• mins-to-shrink: Time, in minutes, from the start of the game until the border starts to shrink. Value must be an integer greater than -2. If set to -1, the border will not shrink. Default 120.
• team-mode: Self-explanatory. Accepts boolean values (true or false). The win condition when team mode is active changes from last player standing to last vanilla scoreboard team with members alive. Default false.
• spread-distance: The minimum distance the game will try to establish between players/teams (depending on if team mode is active) when initially spreading out players. Accepts integer values greater than or equal to zero. Default 150.
• uhc-mode: Whether or not players will naturally regenerate health. Accepts boolean values (true or false). Default true.
• respect-teams: Whether the plugin will keep players on the same team together when initially spreading players across the map. Accepts boolean values (true or false). This value has no effect if team mode is false. Default true.
• episode-length: The length of time between episode markers. Accepts integer values greater than or equal to zero. Setting episode length to 0 will disable the episode markers. Default 20.
• event-name: The name used to identify the game in log output and shown to players as they join the game. Accepts any string. Default Event Name.

Player Registration: /uhcreg and /uhcunreg

Requires uhca.admin permission

Players are automatically registered upon joining the UHC world. However, they will not be considered an active participant unless they are in survival mode. If a player switches into survival mode after joining the world, they will need to be manually registered with /uhcreg [playername].

A player who loses connection will not be considered in the game until they rejoin, however, no checks for whether a win condition has been met will be made when they log out (i.e. if there are two players remaining in solo mode and one disconnects, the other player will not automatically be crowned the winner). If an admin is sure the player is not returning, they can run /uhcunreg [playername] to inform the plugin that the person has dropped out, and that even if they do rejoin, they will not be considered a live player again until they are manually re-registered with /uhcreg.

Info Commands: /uhctime and /uhcstatus

/uhcstatus requires the uhca.admin permission

/uhctime is a command that can be run by everybody. While the game is active, it will display how much time has elapsed to the user. Alternatively, any player can also type /uhctime [option] to change how the time elapsed is displayed to them. [option] can be replaced with: toggle, chat, scoreboard, subtitle.

/uhcstatus will dump information about the game to the admin who requested it. A-mei-zing.

Important Notes:

• /uhcprep or /uhcreset needs to be run before starting the game.
• A player who has been unregistered by /uhcunreg can only be re-registered with /uhreg
• Ensure team mode is off if playing solos, else ensure it is on for proper functionality.