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

[Minecraft](https://www.minecraft.net/en-us) 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.

<div class='note'>

Minecraft Java Edition servers must be version 1.7 or newer, since older versions don't expose any information.

</div>

<div class='note warning'>

Minecraft Bedrock Edition servers are not supported yet.

</div>

{% include integrations/config_flow.md %}

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

### Server name

The **server name** can be chosen freely.

<div class='note'>

Default is `Minecraft Server`.

</div>

### 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** 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:25565` or `192.168.0.123`

<div class='note'>

Default is `localhost:25565`.

</div>

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

<div class='note'>

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.

</div>