From b368ad9f55c352962198a34e9078420bb84b6ab6 Mon Sep 17 00:00:00 2001
From: elmurato <1382097+elmurato@users.noreply.github.com>
Date: Wed, 27 Sep 2023 12:13:09 +0300
Subject: [PATCH] Add configuration hints in Minecraft Server documentation
(#29000)
---
.../_integrations/minecraft_server.markdown | 40 +++++++++++++++++--
1 file changed, 36 insertions(+), 4 deletions(-)
diff --git a/source/_integrations/minecraft_server.markdown b/source/_integrations/minecraft_server.markdown
index fedf5c1f1a6..a2fe53b797b 100644
--- a/source/_integrations/minecraft_server.markdown
+++ b/source/_integrations/minecraft_server.markdown
@@ -17,18 +17,48 @@ ha_platforms:
ha_integration_type: integration
---
-Minecraft servers allow players to play the sandbox video game [Minecraft](https://www.minecraft.net/en-us) 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](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 Java edition servers must be version 1.7 or newer, since older versions don't expose any information.
+
+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.
+
+
+Minecraft Bedrock Edition servers are not supported yet.
+
{% 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.
+
+
+
+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:
+
+- **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`
+
+
+
+Default is `localhost:25565`.
+
+
+
## Binary sensors
This integration provides a binary sensor for the following information from a Minecraft server:
@@ -48,5 +78,7 @@ This integration provides sensors for the following information from a Minecraft
- 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.
+