From 4503991d371d7d40dc7f3e3a47f7730e0dd060d9 Mon Sep 17 00:00:00 2001
From: Cybornut <51033431+Cybornut@users.noreply.github.com>
Date: Mon, 27 Sep 2021 19:51:50 -0700
Subject: [PATCH] Added a couple of comments in config.yml for clarification
 (#2544)

* Update config.yml

Added commented clarifications on:
1. "remote: address: auto"
2. "remote: auth-type: online"

May need formatting checks to conform with correct annotation

* Update config.yml
---
 connector/src/main/resources/config.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/connector/src/main/resources/config.yml b/connector/src/main/resources/config.yml
index 04976adae..cc22dc4aa 100644
--- a/connector/src/main/resources/config.yml
+++ b/connector/src/main/resources/config.yml
@@ -38,12 +38,14 @@ remote:
   # The IP address of the remote (Java Edition) server
   # If it is "auto", for standalone version the remote address will be set to 127.0.0.1,
   # for plugin versions, it is recommended to keep this as "auto" so Geyser will automatically configure address, port, and auth-type.
+  # Leave as "auto" if floodgate is installed.
   address: auto
   # The port of the remote (Java Edition) server
   # For plugin versions, if address has been set to "auto", the port will also follow the server's listening port.
   port: 25565
   # Authentication type. Can be offline, online, or floodgate (see https://github.com/GeyserMC/Geyser/wiki/Floodgate).
   # For plugin versions, it's recommended to keep the `address` field to "auto" so Floodgate support is automatically configured.
+  # If Floodgate is installed and `address:` is set to "auto", then "auth-type: floodgate" will automatically be used.
   auth-type: online
   # Allow for password-based authentication methods through Geyser. Only useful in online mode.
   # If this is false, users must authenticate to Microsoft using a code provided by Geyser on their desktop.