Minecraft Server

Minecraft is a sandbox video game developed by Mojang Studios. Minecraft servers allow players to play the game online or via a local area network with other players. The Minecraft Server integration lets you retrieve information from a Minecraft server within Home Assistant. Both Java Edition and Bedrock Edition servers are supported.

Prerequisites

  • Minecraft Java Edition servers must be version 1.7 or newer, since older versions don’t expose any information.
  • The configuration parameter enable-status must be set to true in the server configuration file (server.properties).

配置

要将 Minecraft Server integration 添加到您的 Home Assistant 实例中,请使用此 My 按钮:

手动配置步骤

如果上述 My 按钮不起作用,您也可以手动执行以下步骤:

During setup you will be prompted to enter the address of the server.

Server address

The server address is a combination of the hostname and the port, where the port is optional. For SRV records, the port is automatically extracted. For all other cases the default port (25565 for Java Edition and 19132 for Bedrock Edition) is used, if the port is omitted. Here are some server address examples:

  • SRV record: hypixel.net
  • Hostname: mc.hypixel.net:25565 or mc.hypixel.net
  • IP address: 192.168.0.123:19132 or 192.168.0.123

Note

Default is localhost:25565.

Bedrock Edition servers don’t support SRV records.

Binary sensors

This integration provides a binary sensor for the following information from a Minecraft server:

  • Connection status

Sensors

This integration provides sensors for the following information from a Minecraft server:

  • Latency
  • Version
  • Protocol version
  • Number of online players
    • Including player names list in the state attributes, if available (see note below).
  • Number of maximum players
  • World Message / Message of the Day (MOTD)

For Bedrock Edition servers following sensors are provided additionally:

  • Edition: Minecraft Pocket Edition (MCPE) or Minecraft Education Edition (MCEE)
  • Game mode
  • Map name

Note

Player names are only available on Java Edition servers. Depending on the server, the player names list may not be shown completely. Some servers and plugins limit or completely hide this list or even replace the player names with fake ones to show some custom messages there.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

从Home Assistant中移除集成实例

  1. 前往 设置 > 设备与服务 并选择集成卡片。
  2. 从设备列表中,选择要删除的集成实例。
  3. 在条目旁边,选择三个点 菜单。然后,选择 删除