home-assistant.io/source/_integrations/minecraft_server.markdown
elmurato 6530eb675d
Minecraft Server: Add notes about player names list and compatible server versions (#28451)
* Add notes about player names list and compatible server versions

* Apply suggestions from code review

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
2023-08-07 08:05:52 +02:00

1.6 KiB

title, description, ha_release, ha_category, ha_iot_class, ha_quality_scale, ha_config_flow, ha_codeowners, ha_domain, ha_platforms, ha_integration_type
title description ha_release ha_category ha_iot_class ha_quality_scale ha_config_flow ha_codeowners ha_domain ha_platforms ha_integration_type
Minecraft Server Instructions on how to integrate a Minecraft server into Home Assistant. 0.106
Binary Sensor
Sensor
Local Polling silver true
@elmurato
minecraft_server
binary_sensor
sensor
integration

Minecraft servers allow players to play the sandbox video game Minecraft by Mojang Studios 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.

Minecraft Java edition servers must be version 1.7 or newer, since older versions don't expose any information.
Minecraft Bedrock edition servers are not supported yet.

{% include integrations/config_flow.md %}

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