Welcome to the Hangar Open Beta. Please report any issue you encounter on GitHub!
Avatar for lerokko

Allows players to get server metrics like mspt as a redstone signal from an item frame.

Report RedOut?

RedOut

A Paper plugin that maps server metrics to item frame comparator outputs. Giving a non-invasive way to players to shut off their redstone contraptions and farms when the server gets too laggy or before shutdown. Made for Minecraft 1.21.11 and above.

How it works

Rename an item in an anvil to one of the trackers available and place it in an item frame.
The frame's rotation (and therefore its comparator output, signals 1–8) will update automatically.

Built-in trackers:

Item name Metric
mspt By default 10ms per redstone level
daily restart Countdown to next shutdown (daily or one-time). By default 1m per redstone level.

Commands

All subcommands require the matching permission listed below.

/redout reload

Reloads config.yml without restarting the server.

/redout status

Shows one-time shutdown countdown (if scheduled) and daily restart time with countdown.

/redout trackers list <#all|trackerId>

Lists all currently loaded tracked item frames for a specific tracker or all trackers.
Output includes world name and block coordinates. Frames in unloaded chunks are not shown.

/redout schedule shutdown set <time> [--force]

Schedules a one-time server shutdown. RedOut will run the configured pre-shutdown commands and then call shutdown.
Do not persist trough restarts.

/redout schedule shutdown unset

Cancels the current one-time shutdown schedule.

/redout schedule shutdown status

Shows time remaining until the next shutdown (one-time or daily).

/redout schedule shutdown daily <HH:mm|disable>

Updates the daily restart time in config.yml. Use disable to turn off the daily restart entirely. The tracker will still function as expected for one-time shutdowns.

Accepted time formats for set:

Format Example Meaning
Ns 90s N seconds from now
Nm 10m N minutes from now
Nh 2h N hours from now
HH:mm 23:00 Wall-clock time (next occurrence)
HH:mm:ss 23:00:00 Wall-clock time with seconds

Minimum allowed time = max(signal-interval-seconds × 8, largest pre-shutdown command key).
Use --force to bypass the minimum. The minimum exists to ensure that the shutdown signal can reach 8 before shutdown, giving players a chance to react and shut off their contraptions.


Permissions

Permission Default Description
redout.reload op /redout reload
redout.status op /redout status
redout.trackers op /redout trackers list
redout.schedule op /redout schedule shutdown *

Configuration

config.yml is created automatically on first run.

Key Default Description
update-interval-ticks 20 How often frames are updated (ticks). 20 = 1 s.
signal-interval-seconds 60 Seconds per comparator signal step for the daily restart tracker.
trackers.mspt.max-value 50.0 MSPT value that maps to signal 8.
trackers.daily restart.time 03:00 Daily restart time (24-hour HH:mm, server local time). Set to "disabled" to disable the daily countdown.
shutdown-commands see below Commands run before a one-time shutdown. Keys are time offsets before shutdown.
daily-restart-commands see below Commands run before the daily restart time. No shutdown is issued by RedOut.

%player% in a command value causes it to run once per online player with the player name substituted.

Example config.yml:

update-interval-ticks: 20
signal-interval-seconds: 60

trackers:
  mspt:
    max-value: 50.0
  daily restart:
    time: "03:00"

shutdown-commands:
  5m: "say Server shutting down in 5 minutes!"
  1m: "say Server shutting down in 1 minute!"
  10s: "kick %player% Server is shutting down for maintenance."

daily-restart-commands:
  5m: "say Daily restart in 5 minutes!"
  1m: "say Daily restart in 1 minute!"

Information

CategoryGameplay
Published onJune 3, 2026
LicenseCC BY-NC-SA 4.0
Downloads0
Stars0
Watchers0

Pinned Versions

Members

Avatar for lerokko

lerokko

Owner