Fix: Outdated config documentation (#23)

* Update understanding-the-config.md

* Update understanding-the-config.md
This commit is contained in:
chris authored and GitHub committed 2024-08-08 05:49:06 -07:00
1 parent b722f8bd69
commit 6e8b2af5d6
1 file changed
+5 -5
+5 -5
View File
@@ -50,11 +50,11 @@ General Geyser options that are mostly specific to Geyser itself.
**`floodgate-key-file`**: Floodgate uses encryption to ensure use from authorised sources. This should point to the public key generated by Floodgate (BungeeCord, Spigot or Velocity). You can ignore this when not using Floodgate. If you're using a plugin version of Floodgate on the same server, the key will automatically be picked up from Floodgate.The key file path for Floodgate. Requires that you have [Floodgate](/wiki/floodgate/) installed and the `auth-type` set to `floodgate`.
**`saved-user-logins`**: For online mode authentication type only.
Stores a list of Bedrock players that should have their Java Edition account saved after login.
This saves a token that can be reused to authenticate the player later. This does not save emails or passwords,
Stores a list of Bedrock player usernames that should have their Java Edition account saved after login.
This saves an auth chain token that can be reused to authenticate the player later. This does not save emails or passwords,
but you should still be cautious when adding to this list and giving others access to this Geyser instance's files.
Removing a name from this list will delete its cached login information on the next Geyser startup.
The file that tokens will be saved in is in the same folder as this config, named `saved-refresh-tokens.json`.
The file that tokens will be saved in is in the same folder as this config, named `saved-auth-chains.json`.
Format:
@@ -113,13 +113,13 @@ saved-user-logins:
**`force-resource-packs`**: Force clients to load all resource packs if there are any. If set to false, it allows the user to disconnect from the server if they don't want to download the resource packs.
**`xbox-achievements-enabled`**: Allows Xbox achievements to be unlocked. **This disables certain commands so the Bedrock client can't "cheat" to get them; this cannot be worked around if you want to enable this**. Commands such as /gamemode and /give will not work from Bedrock with this enabled.
**`xbox-achievements-enabled`**: Allows Xbox achievements to be unlocked.
**`log-player-ip-addresses`**: Whether player IP addresses will be logged by the server.
**`notify-on-new-bedrock-update`**: Whether to alert the console and operators that a new Geyser version is available that supports a Bedrock version that this Geyser version does not support. It's recommended to keep this option enabled, as many Bedrock platforms auto-update.
**`unusable-space-block`**: Which item to use to mark unavailable slots in a Bedrock player inventory. Examples of this are the 2x2 crafting grid while in creative, or custom inventory menus with sizes different from the usual 3x9. A barrier block is the default item (minecraft:barrier is therefore the default value). Takes any Minecraft Bedrock identifier, e.g. `minecraft:apple`. To set this to a custom item, you will need to add the `geyser_custom:` namespace.
**`unusable-space-block`**: Which item to use to mark unavailable slots in a Bedrock player inventory. Examples of this are the 2x2 crafting grid while in creative, or custom inventory menus with sizes different from the usual 3x9. A barrier block is the default item (minecraft:barrier is therefore the default value). Takes any Minecraft Bedrock item identifier, e.g. `minecraft:apple`. To set this to a custom item, you will need to add the `geyser_custom:` namespace.
## Metrics {#metrics}