diff --git a/.github/scripts/check_permalinks.py b/.github/scripts/check_permalinks.py index ff83004..2918b8a 100644 --- a/.github/scripts/check_permalinks.py +++ b/.github/scripts/check_permalinks.py @@ -32,7 +32,7 @@ for tocLine in tocLines: tocContents += tocLine.replace('- ', '').strip() + '\n' # Check the permalinks -directory = './docs/' +directory = './_docs/' files = glob.glob(os.path.join(directory, '**/*.md'), recursive=True) for file in files: contents = open(file, 'r', encoding='utf-8') diff --git a/_config.yml b/_config.yml index ac8c2ad..52b82ab 100644 --- a/_config.yml +++ b/_config.yml @@ -14,8 +14,7 @@ # You can create any custom variable you would like, and they will be accessible # in the templates via {{ site.myvariable }}. -title: GeyserMC Docs -email: your-email@domain.com +title: GeyserMC Wiki author: GeyserMC description: > # this means to ignore newlines until "baseurl:" Write an awesome description for your new site here. You can edit this @@ -26,7 +25,7 @@ description: > # this means to ignore newlines until "baseurl:" baseurl: "" # the subpath of your site, e.g. /blog # This is mostly for testing -url: "https://docs.geysermc.org" # the base hostname & protocol for your site +url: "https://wiki.geysermc.org" # the base hostname & protocol for your site # Social (First three Required) repo: "https://github.com/GeyserMC/GeyserDocs" @@ -59,10 +58,6 @@ markdown: kramdown # tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q= tag_color: primary # danger, success, warning, primary, info, secondary -accentColor: red # purple, green, etc. -themeColor: red # purple, green, blue, orange, purple, grey -fixedNav: 'true' # true or false - permalink: /:year/:title/ markdown: kramdown exclude: [_site, CHANGELOG.md, LICENSE, README.md, vendor] @@ -75,6 +70,12 @@ collections: # Defaults defaults: + - scope: + path: "_docs" + type: "docs" + values: + layout: page + - scope: path: "" type: "pages" diff --git a/_data/toc.yml b/_data/toc.yml index e12f967..adc639c 100644 --- a/_data/toc.yml +++ b/_data/toc.yml @@ -1,7 +1,7 @@ - title: Geyser Documentation url: "geyser/" links: - - title: "Geyser Setup" + - title: "Setup" url: "geyser/setup/" children: - title: Plugin Setup diff --git a/docs/floodgate/api.md b/_docs/floodgate/api.md similarity index 99% rename from docs/floodgate/api.md rename to _docs/floodgate/api.md index 91d7058..08e04a6 100644 --- a/docs/floodgate/api.md +++ b/_docs/floodgate/api.md @@ -63,4 +63,3 @@ Click [here](Forms) to get more information about Forms. ### Using the API on backend servers In order to successfully use the API on backend Spigot servers when using a proxy, `send-floodgate-data` must be set to `true` on the proxy Floodgate's config, and the `key.pem` file must be identical between all Floodgate instances. - diff --git a/docs/floodgate/commands.md b/_docs/floodgate/commands.md similarity index 93% rename from docs/floodgate/commands.md rename to _docs/floodgate/commands.md index 83749a9..6aa9f0f 100644 --- a/docs/floodgate/commands.md +++ b/_docs/floodgate/commands.md @@ -8,4 +8,4 @@ permalink: /floodgate/commands/ |:---:|:---:|:---:| | `fwhitelist` | `floodgate.command.whitelist` | Whitelist command for Floodgate players. See [here](https://github.com/GeyserMC/Floodgate/wiki/Features#whitelist-command) for details. | | `linkaccount` | `floodgate.command.linkaccount` | Link your account for local linking. | -| `unlinkaccount` | `floodgate.command.unlinkaccount` | Unlink your account for local linking. | \ No newline at end of file +| `unlinkaccount` | `floodgate.command.unlinkaccount` | Unlink your account for local linking. | diff --git a/docs/floodgate/features.md b/_docs/floodgate/features.md similarity index 100% rename from docs/floodgate/features.md rename to _docs/floodgate/features.md diff --git a/docs/floodgate/forms.md b/_docs/floodgate/forms.md similarity index 100% rename from docs/floodgate/forms.md rename to _docs/floodgate/forms.md diff --git a/docs/floodgate/issues.md b/_docs/floodgate/issues.md similarity index 100% rename from docs/floodgate/issues.md rename to _docs/floodgate/issues.md diff --git a/docs/floodgate/player.md b/_docs/floodgate/player.md similarity index 98% rename from docs/floodgate/player.md rename to _docs/floodgate/player.md index c11eab2..e49cf26 100644 --- a/docs/floodgate/player.md +++ b/_docs/floodgate/player.md @@ -7,4 +7,4 @@ permalink: /floodgate/player/ FloodgatePlayer is something that every player who's connect through Floodgate has.
It contains information about the Bedrock client which can be useful in various situations. -You can get a FloodgatePlayer by using the `FloodgateApi#getPlayer(uuid)` method (where uuid is the unique id of the connected player) \ No newline at end of file +You can get a FloodgatePlayer by using the `FloodgateApi#getPlayer(uuid)` method (where uuid is the unique id of the connected player) diff --git a/docs/floodgate/root.md b/_docs/floodgate/root.md similarity index 100% rename from docs/floodgate/root.md rename to _docs/floodgate/root.md diff --git a/docs/floodgate/setup.md b/_docs/floodgate/setup.md similarity index 95% rename from docs/floodgate/setup.md rename to _docs/floodgate/setup.md index d568706..9940aab 100644 --- a/docs/floodgate/setup.md +++ b/_docs/floodgate/setup.md @@ -75,4 +75,7 @@ Check your server logs, or use [this](https://floodgate-uuid.heathmitchell1.repl First, you'll need to get the XUID of the player. There are several third-party websites to find this, for example, this one (unaffiliated with Geyser). Make sure to choose "Hexidecimal." You'll need to enter the player's Xbox Gamertag, and, once submitted, and it should display the XUID in the format of `xxxxxxxxxxxxxxxx`. To turn the XUID into a UUID that Java Edition can recognize, you need to put the XUID in this format: `00000000-0000-0000-xxxx-xxxxxxxxxxxx`. If formatted right, Java Edition should accept it as a UUID. ## Using PlaceholderAPI -If you're using the Bukkit version of Floodgate, download the Placeholder plugin [here](https://github.com/rtm516/FloodgatePlaceholders/). Using the placeholders shouldn't require additional setup other than having [PlaceholderAPI](https://www.spigotmc.org/resources/place +If you're using the Bukkit version of Floodgate, download the Placeholder plugin [here](https://github.com/rtm516/FloodgatePlaceholders/). Using the placeholders shouldn't require additional setup other than having [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) installed. See the section above on installing Floodgate on backend servers if you wish to use this on BungeeCord. + +## Using Skript +If you're using the Bukkit version of Floodgate, there is an unofficial plugin that adds Skript support [here](https://github.com/Camotoy/floodgate-skript). diff --git a/_docs/geyser/anticheat-compatibility.md b/_docs/geyser/anticheat-compatibility.md new file mode 100644 index 0000000..6c6302b --- /dev/null +++ b/_docs/geyser/anticheat-compatibility.md @@ -0,0 +1,33 @@ +--- +layout: page +title: Anticheat Compatibility +permalink: /geyser/anticheat-compatibility/ +--- + +Do note that this is a community-compiled list and is incomplete! If you wish to update or add to this list, feel free. + +### AntiCheat compatibility reports + +Full Compatibility (Checks Bedrock Players Accurately) + +- [AntiAura](https://www.spigotmc.org/resources/1368/) - Last Updated on 8/19/21 +- [NESS Reloaded](https://www.spigotmc.org/resources/75887/) - Last Updated on 8/19/21 +- [Themis](https://www.spigotmc.org/resources/90766/) - Last Updated on 8/19/21 +- [LightAntiCheat](https://www.spigotmc.org/resources/96341/) - Last Updated on 12/4/21 + +Partially Compatible (Does not Check/Ignores Bedrock Players) + +- [AAC](https://www.spigotmc.org/resources/6442/) - Last Updated on 8/19/21 +- [Flappy Anticheat](https://www.spigotmc.org/resources/92180/) - Last Updated on 9/14/21 +- [Matrix](https://matrix.rip/) - Last updated on 9/2/21 +- [Spartan](https://www.spigotmc.org/resources/25638/) (Spartan Syn offers full Bedrock checks for an additional $43) - Last Updated on 8/19/21 +- [Vulcan](https://www.spigotmc.org/resources/83626/) - Last Updated on 8/19/21 + +Incompatible (False Positives on Bedrock Players, no Compatibility at All) + +- [AntiCheatReloaded](https://www.spigotmc.org/resources/23799/) - Last Updated on 8/19/21 +- [Negativity](https://www.spigotmc.org/resources/86874/) - Last Updated on 8/19/21 +- [NoCheatPlus](https://ci.codemc.io/job/Updated-NoCheatPlus/job/Updated-NoCheatPlus/) ([Compat NCP](https://github.com/Updated-NoCheatPlus/CompatNoCheatPlus/) is an addon that enables Partial Compatibility) - Last Updated on 8/19/21 +- [Reflex](https://www.spigotmc.org/resources/21122/) - Last Updated on 8/19/21 +- [SoaromaSAC](https://www.spigotmc.org/resources/87702/) - Last Updated on 8/19/21 +- [Wraith](https://www.spigotmc.org/resources/66887/) - Last Updated on 8/19/21 diff --git a/docs/geyser/commands.md b/_docs/geyser/commands.md similarity index 92% rename from docs/geyser/commands.md rename to _docs/geyser/commands.md index f3542b5..b486b8d 100644 --- a/docs/geyser/commands.md +++ b/_docs/geyser/commands.md @@ -19,4 +19,4 @@ permalink: /geyser/commands/ | `geyser statistics` | `geyser.command.statistics` | Open the Java statistics menu. | | `geyser version` | `geyser.command.version` | Shows the current Geyser version and checks for updates. | -For Floodgate com \ No newline at end of file +For Floodgate commands, see [here](https://github.com/GeyserMC/Floodgate/wiki/Commands). diff --git a/docs/geyser/common-issues.md b/_docs/geyser/common-issues.md similarity index 99% rename from docs/geyser/common-issues.md rename to _docs/geyser/common-issues.md index 875e9e8..412392d 100644 --- a/docs/geyser/common-issues.md +++ b/_docs/geyser/common-issues.md @@ -115,4 +115,4 @@ If you use floodgate ensure that it is installed on all of your Spigot backend s If your players can't connect from the lobby to another backend server, check console. ### Plugins that can cause issues -* `HamsterAPI` \ No newline at end of file +* `HamsterAPI` diff --git a/docs/geyser/creating-a-startup-script.md b/_docs/geyser/creating-a-startup-script.md similarity index 100% rename from docs/geyser/creating-a-startup-script.md rename to _docs/geyser/creating-a-startup-script.md diff --git a/docs/geyser/current-limitations.md b/_docs/geyser/current-limitations.md similarity index 98% rename from docs/geyser/current-limitations.md rename to _docs/geyser/current-limitations.md index 2d412f3..0ad8910 100644 --- a/docs/geyser/current-limitations.md +++ b/_docs/geyser/current-limitations.md @@ -32,4 +32,4 @@ The following changes **are supported** with the [GeyserOptionalPack](https://gi - Hit particles and other miscellaneous particles not natively in Bedrock - Offhand animations - Shulker invisibility -- Spectral arrow texture \ No newline at end of file +- Spectral arrow texture diff --git a/docs/geyser/faq.md b/_docs/geyser/faq.md similarity index 94% rename from docs/geyser/faq.md rename to _docs/geyser/faq.md index 251500a..bcdaed3 100644 --- a/docs/geyser/faq.md +++ b/_docs/geyser/faq.md @@ -23,12 +23,12 @@ Geyser should generally work fine with plugins, as we emulate a Java client. The Floodgate can cause issues with plugins as it modifies the login process. *Please note that any offline mode authenticator plugins are only here for documentation; Geyser does not support offline mode usage.* -* [DynamicBungeeAuth](https://www.spigotmc.org/resources/dynamicbungeeauth-premium-command-semi-premium-system-sessions.27480/) produces invalid credentials for Bedrock players. -* [FastLogin](https://www.spigotmc.org/resources/fastlogin.14153/) does not let floodgate add player prefix. -* [ExploitFixer](https://www.spigotmc.org/resources/2ls-exploitfixer-the-ultimate-antiexploit-plugin.62842/) thinks that Floodgate users are UUID spoofing - disable the `uuidspoof` setting in ExploitFixer's config. +* [DynamicBungeeAuth](https://www.spigotmc.org/resources/27480/) produces invalid credentials for Bedrock players. +* [FastLogin](https://www.spigotmc.org/resources/14153/) does not let floodgate add player prefix. +* [ExploitFixer](https://www.spigotmc.org/resources/62842/) thinks that Floodgate users are UUID spoofing - disable the `uuidspoof` setting in ExploitFixer's config. * [JPremium](https://www.spigotmc.org/resources/27766/) alters the UUID of a player, causing Floodgate not to be able to get the Bedrock data from its map. * [LibHatesMods](https://www.spigotmc.org/resources/78202/) causes authentication to fail with `com.github.steveice10.mc.auth.exception.request.InvalidCredentialsException` -* [ProtocolSupport](https://www.spigotmc.org/resources/7201/) ~~is currently incompatible with Floodgate.~~ Works with Floodgate, but we recommend using [ViaBackwards](https://www.spigotmc.org/resources/viabackwards.27448/) instead. +* [ProtocolSupport](https://www.spigotmc.org/resources/7201/) ~~is currently incompatible with Floodgate.~~ Works with Floodgate, but we recommend using [ViaBackwards](https://www.spigotmc.org/resources/27448/) instead. * [ProtocolSupportBungee](https://www.spigotmc.org/resources/8733/) changes how the login process works and therefore breaks the Floodgate injection code. * [SayNoToMcLeaks](https://www.spigotmc.org/resources/40906/) prevents Floodgate from finishing its login system. @@ -107,7 +107,7 @@ The long answer: currently, there is no way for Geyser to translate the features ## How can I auto-update Geyser? [Geyser MC Auto Updater](https://github.com/michaelwatne/geysermcupdater) is an option at this time to auto-update Geyser through the command line. Note that this project is unaffiliated with Geyser. -GeyserUpdater ([GitHub page](https://github.com/YHDiamond/GeyserUpdater)/[Spigot page](https://www.spigotmc.org/resources/geyserupdater.88555/)) is a Spigot/BungeeCord plugin option for auto-updating. Please note that this plugin is also unaffiliated and unsupported by Geyser, and users should redirect support for the plugin to its [Discord](https://discord.gg/U5MC2tcCz9). +GeyserUpdater ([GitHub page](https://github.com/YHDiamond/GeyserUpdater)/[Spigot page](https://www.spigotmc.org/resources/88555/)) is a Spigot/BungeeCord plugin option for auto-updating. Please note that this plugin is also unaffiliated and unsupported by Geyser, and users should redirect support for the plugin to its [Discord](https://discord.gg/U5MC2tcCz9). ## How can I make DiscordSRV show Floodgate 2.0 or GeyserSkinManager skins? Replace the `AvatarUrl` line in your DiscordSRV config with this: `AvatarUrl: https://mc-heads.net/avatar/{texture}/{size}.png` @@ -194,9 +194,7 @@ We aim to support any of the bedrock languages; see [here](https://translate.gey # Questions not related to gameplay ## What is the relationship between CubeCraft and Geyser? - Redned started Geyser in July 2019. In May 2020, CubeCraft acquired the GeyserMC brand. This means that they govern the project (though at this time, they govern lightly). CubeCraft does not own the code of Geyser. ## Does CubeCraft use Geyser? - -No. \ No newline at end of file +No. diff --git a/docs/geyser/root.md b/_docs/geyser/root.md similarity index 100% rename from docs/geyser/root.md rename to _docs/geyser/root.md diff --git a/docs/geyser/setup.md b/_docs/geyser/setup.md similarity index 98% rename from docs/geyser/setup.md rename to _docs/geyser/setup.md index f741b24..1d75c33 100644 --- a/docs/geyser/setup.md +++ b/_docs/geyser/setup.md @@ -17,7 +17,7 @@ And if you still have questions, feel free to join the [Discord](https://discord ## Prerequisites - The server you are connecting to has to support the latest version of Minecraft Java Edition (at this time this is Minecraft 1.18.0) - The server itself does not have to be the latest version but does have to allow connections. If you're running the server on an older version, you can use the plugin [ViaVersion](https://www.spigotmc.org/resources/viaversion.19254/), but do note that only **1.12.2 and any version above is officially supported**. + The server itself does not have to be the latest version but does have to allow connections. If you're running the server on an older version, you can use the plugin [ViaVersion](https://www.spigotmc.org/resources/19254/), but do note that only **1.12.2 and any version above is officially supported**. - The device running Geyser must support Java 16 or later. If you need help installing or updating, please see https://paper.readthedocs.io/en/latest/java-update/index.html. If you're running a version of Paper that does not support Java 16 or later, you can add the flag `-DPaper.ignoreJavaVersion=true` to your startup Java arguments to allow Paper to run on Java 16. You can run Geyser standalone on another device if a server software cannot be updated to use Java 16. - If you are connecting to an online mode Java server, a paid Java account is required. If you are running the server, you can bypass this requirement for your server with [Floodgate](https://github.com/GeyserMC/Floodgate/wiki). - Your Bedrock client has to be a supported version - at this time that is Bedrock version 1.17.30 - 1.18.0. diff --git a/docs/geyser/standalone-command-line-arguments.md b/_docs/geyser/standalone-command-line-arguments.md similarity index 99% rename from docs/geyser/standalone-command-line-arguments.md rename to _docs/geyser/standalone-command-line-arguments.md index e4aa383..673f0e1 100644 --- a/docs/geyser/standalone-command-line-arguments.md +++ b/_docs/geyser/standalone-command-line-arguments.md @@ -7,19 +7,16 @@ permalink: /geyser/standalone-command-line-arguments/ # General command-line arguments ### `--config [file]` - **Alias: `-c`** Points to an alternative config file to use. ### `--gui` / `--nogui` - **Alias: `gui` / `nogui`** Forces GUI or non-GUI usage, depending on context. # Overriding specific config values - Overriding a standard config option (e.g. `command-suggestions`): `--command-suggestions=false` @@ -27,4 +24,3 @@ Overriding a standard config option (e.g. `command-suggestions`): Overriding a nested config option(e.g. the `remote` section with `address`): `--remote.address=test.geysermc.org` - diff --git a/docs/geyser/supported-hosting-providers.md b/_docs/geyser/supported-hosting-providers.md similarity index 99% rename from docs/geyser/supported-hosting-providers.md rename to _docs/geyser/supported-hosting-providers.md index de47707..33c9504 100644 --- a/docs/geyser/supported-hosting-providers.md +++ b/_docs/geyser/supported-hosting-providers.md @@ -105,4 +105,4 @@ It should also be noted that these providers may not be verified by the Geyser t --- -**Warning: Using a *”Free Host”* may not give you the best experience *at all*. If you want better support, more freedom to control your server, and learn how to run one, PLEASE pay for a server.** \ No newline at end of file +**Warning: Using a *”Free Host”* may not give you the best experience *at all*. If you want better support, more freedom to control your server, and learn how to run one, PLEASE pay for a server.** diff --git a/_docs/geyser/understanding-the-config.md b/_docs/geyser/understanding-the-config.md new file mode 100644 index 0000000..4bd75a9 --- /dev/null +++ b/_docs/geyser/understanding-the-config.md @@ -0,0 +1,117 @@ +--- +layout: page +title: Understanding the Config +permalink: /geyser/understanding-the-config/ +--- + +This page covers basic information about the Geyser config and what each option does. Though they are explained in the configuration itself, this explains what each option does in more detail. + +## Bedrock Section +The options for Geyser on the bedrock-facing end. Mostly contains options for how bedrock edition will see the server. + +**`address`**: The address of Geyser on the bedrock end. In most all scenarios, this should not need to be changed. + +**`port`**: The port Geyser will run on. By default, it is 19132 in bedrock. + +**`clone-remote-port`**: Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock/UDP connections. This option makes the Bedrock port the same as the Java port every time you start the server. This option does not do anything on the Standalone version of Geyser. + +**`motd1`**: The first line of the MOTD for Geyser. + +**`motd2`**: The second line of the MOTD for Geyser. **Please keep in mind, this option will only work if Geyser is shown in the Friends tab!** + +**`server-name`**: The world name that is shown in the top-right area of the pause screen. + +**`compression-level`**: An number value that represents how much to compress outgoing traffic. Can be any number from -1 to 9; any other value will be replaced with the nearest acceptable value. The higher the number, the more CPU processing that is used but with less bandwidth used. + +## Remote Section +Options for the remote (java) server. + +**`address`**: The address of the Minecraft: Java Edition server you want to join. By default, this value is `auto`. By keeping it as `auto`, the address, port, and Floodgate support will be automatically configured. In standalone, keeping this as `auto` sets the remote address to 127.0.0.1. + +**`port`**: The port of the Minecraft: Java Edition server you specified in the `address` section. + +**`auth-type`**: The authentication type of the Minecraft: Java Edition server. Valid options are `online`, `offline`, and `floodgate`. + +**Please keep in mind, what you specify in the Geyser `auth-type` option MUST be the same as what the remote server has (with the exception of Geyser being in online mode and remote being in offline mode). You simply cannot join an online mode server without a genuine account. If you want to allow Minecraft: Bedrock Edition accounts to join without a Minecraft: Java Edition account, see the [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) wiki page.** + +**`use-proxy-protocol`**: Whether to enable PROXY/HAProxy protocol or not while connecting to the server. This is useful only when: +- Your server supports PROXY protocol (it probably doesn't) +- You run Velocity or BungeeCord with its respective option enabled. + +**`forward-hostname`**: Forwards the hostname/IP address that the Bedrock client used to connect over to the Java server. This is designed to be used for forced hosts on proxies. + +## General Options +General Geyser options that are mostly specific to Geyser itself. + +**`floodgate-key-file`**: The key file path for Floodgate. Requires that you have [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) installed and the `auth-type` set to `floodgate`. + +**`userAuths`**: A section where you can put the authentication information for your Minecraft: Java Edition account for immediate login when joining Geyser. **It is advised you ONLY use this option if you are running Geyser locally and that ONLY you have access to the config as it requires you put your Minecraft: Java Edition credentials in plain text!** + +If your Xbox account name was Notch, your Java email was `foobar2000@gmail.com` and your password was `hunter2`, you would fill this into the config: + +``` +userAuths: + Notch: # MCPE/Xbox username + email: foobar2000@gmail.com + password: "hunter2" + microsoft-account: true +``` + +Put two spaces before the username and four spaces before the email and password. + +**`command-suggestions`**: Bedrock clients freeze or crash when opening up the command prompt for the first time with a large amount of command suggestions. This config option disables command suggestions being sent to prevent any freezing. **Since 1.16.100:** command freezing and crashing has been largely reduced; you may no longer need this option disabled. + +**`passthrough-motd`**: If the MOTD should be relayed from the remote server. Causes the `motd1` and `motd2` options in the bedrock section to no longer have a use. + +**`passthrough-protocol-name`**: Relay the protocol name (e.g. BungeeCord [X.X], Paper 1.X) - this is only really useful when using a custom protocol name! This will also show up on sites like MCSrvStatus. + +**`passthrough-players`**: If the current and max player counts should be relayed from the remote server. + +**`legacy-ping-passthrough`**: If enabled, manually pings the server by impersonating a Minecraft client instead of using the server's API. **This option should *only* be enabled if your MOTD or player count is not accurate,** as it can cause errors especially on BungeeCord. This option does nothing on standalone. + +**`ping-passthrough-interval`**: How often the fake Minecraft client should attempt to ping the remote server to update information, in seconds (a setting of 1 will ping the server every second; a setting of 3 will ping the server every three seconds). Only relevant for standalone and legacy ping passthrough. Increase the number if you're getting timeout or BrokenPipe exceptions. + +**`max-players`**: The maximum amount of players shown when pinging the server. This does not actually cap how many players can join the Geyser instance at this time. The number will visually increase when pinging if the amount of players is greater, as Bedrock clients will not even attempt to join a full server. + +**`debug-mode`**: If debug messages should be printed in console. Useful if you run into an error and need more context. + +**`general-thread-pool`**: The amount of threads Geyser will be able to use. Higher is not always better :P. + +**`allow-third-party-capes`**: If third party (Optifine, 5zig, LabyMod, etc.) capes should be displayed to the bedrock player. + +**`allow-third-party-ears`**: If third party Deadmau5-style ears should be enabled. Currently only supports MinecraftCapes. + +**`show-cooldown`**: Bedrock Edition currently does not have Java Edition 1.9+ combat mechanics. In order to get around this, Geyser sends a fake cooldown by sending a title message. This cooldown should not show if 1.8 combat mechanics are in use. The options available for this setting are `false` (no cooldown is sent), `title`/`true` (a cooldown indication is shown in the title), or `actionbar` (a cooldown indication is shown in the action bar). All other options default to `false`. + +**`show-coordinates`**: Bedrock Edition has an option to show coordinates in the top-left part of your screen. This setting enables or disables this. + +**`emote-offhand-workaround`**: Since Java Edition 1.9, clients have had the ability to switch the item in their mainhand and offhand with a keybind. Bedrock Edition does not have this ability, so this config option makes up for it, If set, when a Bedrock player performs any emote, it will swap the offhand and mainhand items, just like the Java Edition keybind. There are three options this can be set to: +- `disabled` - the default/fallback, which doesn't apply this workaround +- `no-emotes` - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen. +- `emotes-and-offhand` - emotes will be sent to Bedrock clients and offhand will be swapped + +**`default-locale`**: The default locale to send to players if their locale could not be found. Check [this](https://github.com/GeyserMC/Geyser/wiki/FAQ#what-languages-does-geyser-support) page to find the code corresponding to your language. + +**`chunk-caching`**: Cache chunks for each Bedrock player, adds support for additional sounds and fixing movement issues at the expense of slightly more RAM usage. This option is always on for Spigot as we can use the server's API to get block information at no expense. *Geyser does not recommend disabling this option.* + +**`cache-images`**: Specify how many days images will be cached to disk to save downloading them from the internet. A value of 0 is disabled. (Default: 0) + +**`allow-custom-skulls`**: Allows custom skulls to be displayed when placed. Keeping them enabled may cause a performance decrease on older/weaker devices. + +**`above-nether-bedrock-building`**: Bedrock prevents building and displaying blocks above Y127 in the Nether - enabling this config option works around that by changing the Nether dimension ID to the End ID. The main downside to this is that the sky will resemble that of the End sky in the Nether, but ultimately it's the only way for this feature to work. + +**`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. + +## Advanced Options + +**`scoreboard-packet-threshold`**: Geyser updates the Scoreboard after every Scoreboard packet, but when Geyser tries to handle a lot of scoreboard packets per second can cause serious lag. This option allows you to specify after how many Scoreboard packets per seconds the Scoreboard updates will be then limited to four updates per second. + +**`enable-proxy-connections`**: Allow connections from ProxyPass and Waterdog. See https://www.spigotmc.org/wiki/firewall-guide/ for assistance - use UDP instead of TCP. **This option does not need to be enabled in instances like BungeeCord or Velocity**. + +**`mtu`**: https://en.wikipedia.org/wiki/Maximum_transmission_unit - The internet supports a maximum MTU of 1492 but could cause issues with packet fragmentation. 1400 is the default. + +**`use-direct-connection`**: Whether to connect directly into the Java server without creating a TCP connection. This should only be disabled if a plugin that interfaces with packets or the network does not work correctly with Geyser. If enabled on plugin versions, the remote address and port sections are ignored. If disabled on plugin versions, expect performance decrease and latency increase. + +Default Geyser Config: [config.yml](https://github.com/GeyserMC/Geyser/blob/master/core/src/main/resources/config.yml) diff --git a/docs/geyser/using-geyser-or-floodgate-as-a-dependency.md b/_docs/geyser/using-geyser-or-floodgate-as-a-dependency.md similarity index 99% rename from docs/geyser/using-geyser-or-floodgate-as-a-dependency.md rename to _docs/geyser/using-geyser-or-floodgate-as-a-dependency.md index 48e75b9..51ecb48 100644 --- a/docs/geyser/using-geyser-or-floodgate-as-a-dependency.md +++ b/_docs/geyser/using-geyser-or-floodgate-as-a-dependency.md @@ -63,4 +63,4 @@ Get the Floodgate API using: ```java FloodgateApi api = FloodgateApi.getInstance(); api.isFloodgatePlayer(uuid); -``` \ No newline at end of file +``` diff --git a/docs/geyser/using-geyser-with-consoles.md b/_docs/geyser/using-geyser-with-consoles.md similarity index 98% rename from docs/geyser/using-geyser-with-consoles.md rename to _docs/geyser/using-geyser-with-consoles.md index ff15506..342aad9 100644 --- a/docs/geyser/using-geyser-with-consoles.md +++ b/_docs/geyser/using-geyser-with-consoles.md @@ -49,4 +49,4 @@ If you have an Android device, you have several options: - [MC Server Connector](https://play.google.com/store/apps/details?id=com.smokiem.mcserverconnector) ### Using an iOS device -If you have an iOS 14+ device, you can use [BedrockTogether](https://apps.apple.com/app/bedrocktogether/id1534593376). \ No newline at end of file +If you have an iOS 14+ device, you can use [BedrockTogether](https://apps.apple.com/app/bedrocktogether/id1534593376). diff --git a/docs/other/community-geyser-projects.md b/_docs/other/community-geyser-projects.md similarity index 93% rename from docs/other/community-geyser-projects.md rename to _docs/other/community-geyser-projects.md index f20f54b..86ad60b 100644 --- a/docs/other/community-geyser-projects.md +++ b/_docs/other/community-geyser-projects.md @@ -27,14 +27,14 @@ Creator: [Camotoy](https://github.com/Camotoy) ## Bedrock Player Manager for Floodgate A Spigot plugin that is able to run certain commands when a Bedrock player joins, or have Bedrock players able to bypass the anticheat, etc. -* [Spigot page](https://www.spigotmc.org/resources/bedrock-player-managment-for-floodgate-geyser.82278/) +* [Spigot page](https://www.spigotmc.org/resources/82278/) Creator: ofunny ## CustomCommandPrefix A Spigot plugin that allows users to enter commands starting with `.`, to work around Xbox achievements being disabled. -* [Spigot page](https://www.spigotmc.org/resources/customcommandprefix.87224/) +* [Spigot page](https://www.spigotmc.org/resources/87224/) * [GitHub](https://github.com/ChewMC/CustomCommandPrefix) Creator: [Chew](https://github.com/Chew) @@ -98,7 +98,7 @@ Creator: [Camotoy](https://github.com/Camotoy) This is a Spigot/BungeeCord/Velocity plugin that can be used to automatically update Geyser. * [GitHub](https://github.com/ProjectG-Plugins/GeyserUpdater) -* [Spigot page](https://www.spigotmc.org/resources/geyserupdater.88555/) +* [Spigot page](https://www.spigotmc.org/resources/88555/) Creators: [Jens](https://github.com/Jens-Co), [YHDiamond](https://github.com/YHDiamond), [Konicai](https://github.com/Konicai) diff --git a/docs/other/developer-guide.md b/_docs/other/developer-guide.md similarity index 100% rename from docs/other/developer-guide.md rename to _docs/other/developer-guide.md diff --git a/docs/other/geyser-fabric.md b/_docs/other/geyser-fabric.md similarity index 100% rename from docs/other/geyser-fabric.md rename to _docs/other/geyser-fabric.md diff --git a/docs/other/geyserconnect.md b/_docs/other/geyserconnect.md similarity index 100% rename from docs/other/geyserconnect.md rename to _docs/other/geyserconnect.md diff --git a/docs/other/geyseroptionalpack.md b/_docs/other/geyseroptionalpack.md similarity index 100% rename from docs/other/geyseroptionalpack.md rename to _docs/other/geyseroptionalpack.md diff --git a/docs/other/root.md b/_docs/other/root.md similarity index 100% rename from docs/other/root.md rename to _docs/other/root.md diff --git a/docs/other/test-server.md b/_docs/other/test-server.md similarity index 100% rename from docs/other/test-server.md rename to _docs/other/test-server.md diff --git a/_includes/header.html b/_includes/header.html index f573318..2b54be2 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -4,10 +4,8 @@ {{ site.title }}