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.

The lobby generated by the plugin is a barrier-enclosed 19x19 (size currently not configurable) area in the sky centered around 0, 0, where all participants will wait until the event is started. Health is automatically tracked in the server's list of players (accessed by hitting TAB by default) during the entire event. The border is centered around 0, 0 as well (currently also not configurable). Players are automatically respawned and put into spectator mode upon death when the game is active. Once the border begins to shrink, the day will be set to high noon permanently and weather will not occur (currently not configurable). If the border is shrinking, players will be able how far out the border is via a display above their hotbar.

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

Game Flow: /uhcstart and /uhcreset

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. 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

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.