jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-04-25 22:07:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/minecraft_server.markdown
Franck Nijhof cb6c735dd5
2025.3: Beta release notes (#37717) 
* 2025.3: Beta release notes

* 2025.3: Sync with codebase

* 2025.3: Tweaks

* tiny tweaks

* tweaks

* some more tweaks

* Update 2025-03-05-release-20253.markdown

* update

* missing breaking change

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: Bram Kragten <mail@bramkragten.nl>
2025-02-26 19:18:13 +01:00

2.8 KiB
Raw Blame History

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

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

{% include integrations/config_flow.md %}

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. {% endnote %}

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. {% endnote %}

Removing the integration

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

{% include integrations/remove_device_service.md %}