Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HostInfo

HostInfo is a permission-protected Minecraft server plugin that reports the host and runtime information visible to the Java process. It supports Paper and Velocity and uses LuckPerms for player authorization.

Highlights

  • CPU, memory, disks, file systems, network interfaces, JVM and Minecraft platform reports.
  • Optional public egress IP lookup (disabled unless sensitive output is enabled).
  • Safe allow-lists for server.properties and velocity.toml; secrets and unrelated keys are never read.
  • Reports are collected asynchronously where possible, while Paper/Velocity state is captured on the platform thread.
  • OSHI is shaded and relocated inside the plugin to avoid class conflicts with other plugins.
  • The console can run every command. Players, command blocks and other non-console senders require LuckPerms permissions.

Compatibility

Platform Support in 1.1.1
Paper Minecraft 1.21.x (verified on Paper 1.21.11)
Velocity 3.5.x API
Java Java 21 or newer, subject to the platform's own requirements
LuckPerms 5.5 API or newer compatible 5.x release

The build targets the Paper 1.21 API and uses defensive/reflection-based access for optional Paper methods. Other Minecraft releases may work when their APIs remain compatible, but they should be tested before production use. Paper 26.x is not claimed as verified by this release.

Installation

  1. Install LuckPerms on the Paper server or Velocity proxy.

  2. Download HostInfo-1.1.1.jar from the GitHub Releases page.

  3. Put the JAR in plugins/ (Paper) or the proxy's plugin directory (Velocity).

  4. Restart the platform.

  5. Grant a player access, for example:

    /lp user <player> permission set hostinfo.admin true
    

HostInfo disables itself on Paper when LuckPerms is not available. On Velocity, the command is not registered until LuckPerms can be obtained.

Commands

/hostinfo
/hostinfo summary
/hostinfo system
/hostinfo cpu
/hostinfo memory
/hostinfo disks
/hostinfo network
/hostinfo jvm
/hostinfo minecraft
/hostinfo full
/hostinfo reload

Aliases are hi and serverinfo on Paper. The command may also be entered from the server console without a leading slash.

Command Report
summary Short host, memory, CPU and platform overview
system Operating system, hardware, firmware and motherboard
cpu Processor model, frequency, load, sensors and counters
memory Physical memory, swap and memory modules
disks Physical disks, partitions and file systems
network Interfaces, traffic, safe platform settings and optional public IP
jvm Java runtime, heap, threads, collectors and safe JVM flags
minecraft Paper/Velocity version, players, TPS/MSPT and platform state
full All sections above
reload Reload the configuration

LuckPerms permissions

Every player command requires hostinfo.use and the permission for the requested section. All nodes default to false, including operators.

hostinfo.use
hostinfo.system
hostinfo.cpu
hostinfo.memory
hostinfo.disks
hostinfo.network
hostinfo.jvm
hostinfo.minecraft
hostinfo.full
hostinfo.reload
hostinfo.admin   (parent: grants every HostInfo node above)

The local server console is treated as a trusted administrative sender and is not a LuckPerms user. This does not grant players any access.

Configuration and privacy

Paper creates plugins/HostInfo/config.yml. Velocity creates plugins/hostinfo/config.properties with the equivalent settings.

Sensitive values are hidden by default. This includes hostnames, serial numbers, MAC addresses, local IP addresses, DNS servers, gateways, bind addresses and public IP output. To opt in for a controlled diagnostic on Paper:

show-sensitive-data: true
public-ip:
  enabled: true

The public IP request is sent only to the fixed HTTPS endpoint api64.ipify.org, is time-limited and cached. The result is the process's egress address; NAT, a proxy or DDoS protection can make it different from the address players use to connect.

Network configuration output is restricted to a documented allow-list. HostInfo never reads RCON passwords, tokens or arbitrary configuration values.

Building from source

Requirements: Git, Maven and JDK 21 (or a newer JDK that supports --release 21).

mvn clean verify

The shaded plugin is written to target/HostInfo-1.1.1.jar. Build output, IDE metadata, logs and server files are excluded by .gitignore.

Release layout

The repository contains the source code, build files and documentation. The installable JAR is attached to a GitHub Release; it is intentionally not committed under src/ or target/.

License

HostInfo is released under the MIT License. See LICENSE.

About

Paper and Velocity plugin for inspecting CPU, memory, disks, network, JVM and server metrics.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages