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-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for support of Minecraft Server Bedrock Edition (#29050)

Browse Source 
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
elmurato 2023-10-10 08:44:58 +02:00 committed by GitHub
parent 5ca2daee6e
commit 1d8955c250
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
source/_integrations/minecraft_server.markdown
View File

@ -17,7 +17,7 @@ ha_platforms:
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.
[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. Both **Java Edition** and **Bedrock Edition** servers are supported.
<div class='note'>
@ -25,12 +25,6 @@ Minecraft Java Edition servers must be version 1.7 or newer, since older version
</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.
@ -47,16 +41,18 @@ Default is `Minecraft 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** is used, if the port is omitted. Here are some server address examples:
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:25565` or `192.168.0.123`
- **IP address**: `192.168.0.123:19132` or `192.168.0.123`
<div class='note'>
Default is `localhost:25565`.
Bedrock Edition servers don't support SRV records.
</div>
## Binary sensors
@ -77,8 +73,14 @@ This integration provides sensors for the following information from a Minecraft
- 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
<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.
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.
</div>