957 lines
242 KiB
HTML
957 lines
242 KiB
HTML
<!doctype html>
|
||
<html lang="en" data-bs-theme="dark">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv='X-UA-Compatible' content='IE=edge'>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
||
<title>GeyserMC Wiki: Search</title>
|
||
|
||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
|
||
<link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.3/font/bootstrap-icons.css" rel="stylesheet">
|
||
<link href="https://fonts.googleapis.com/css?family=Montserrat&display=swap" rel="stylesheet">
|
||
<link rel="stylesheet" href="/css/style.css">
|
||
<link rel="stylesheet" href="/css/darcula.css">
|
||
|
||
<meta name="author" content="GeyserMC">
|
||
<meta name="description" content="This is the wiki for all of GeyserMC's projects.">
|
||
<meta name="theme-color" content="#2b3035">
|
||
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:url" content="http://localhost:4000">
|
||
<meta property="og:title" content="GeyserMC Wiki: Search">
|
||
<meta property="og:description" content="This is the wiki for all of GeyserMC's projects.">
|
||
<meta property="og:image" content="/android-chrome-192x192.png">
|
||
|
||
<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico">
|
||
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
||
|
||
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
|
||
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
|
||
<link rel="icon" type="image/png" sizes="192x192" href="/android-chrome-192x192.png">
|
||
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
|
||
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#248f00">
|
||
</head>
|
||
<body>
|
||
<header>
|
||
<nav class="navbar navbar-expand-lg bg-body-tertiary fixed-top">
|
||
<div class="container-fluid">
|
||
<a class="navbar-brand" href="/"><img src="/android-chrome-512x512.png" alt="geyser logo" height="32"> GeyserMC Wiki</a>
|
||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarLinks" aria-controls="navbarLinks" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
<div class="collapse navbar-collapse" id="navbarLinks">
|
||
<ul class="navbar-nav ms-auto mb-2 mb-lg-0">
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="https://geysermc.org/"><i class="bi bi-house pe-1"></i> Home</a>
|
||
</li>
|
||
<li class="nav-item">
|
||
<a class="nav-link" href="https://geysermc.org/download"><i class="bi bi-download pe-1"></i> Download</a>
|
||
</li>
|
||
</ul>
|
||
<form class="d-flex" role="search" action="/search/">
|
||
<div class="input-group">
|
||
<button class="btn btn-outline-secondary" type="submit" id="button-search"><i class="bi bi-search"></i></button>
|
||
<input type="text" name="q" class="form-control" placeholder="Search the site..." aria-label="Search the site..." aria-describedby="button-search">
|
||
</div>
|
||
</form>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</header>
|
||
<div id="page-content" class="container-fluid">
|
||
<div class="row">
|
||
<div class="col-12 col-md-3 col-xl-2">
|
||
<div class="sticky-top">
|
||
<div class="sidebar py-2 text-break">
|
||
<nav class="navbar navbar-expand-md">
|
||
<div class="container-fluid">
|
||
<div class="d-block d-md-none">Wiki Navigation</div>
|
||
<button class="navbar-toggler mb-2" type="button" data-bs-toggle="collapse" data-bs-target="#sidebarNav" aria-controls="sidebarNav" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
<div class="collapse navbar-collapse flex-column align-items-start" id="sidebarNav">
|
||
|
||
|
||
|
||
|
||
<div class="nav-item dropdown">
|
||
<a class="nav-link dropdown-toggle fw-bold" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">Geyser Documentation</a>
|
||
<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc">
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/setup/">Setting up Geyser</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/supported-hosting-providers/">Supported Hosting Providers</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/using-geyser-with-consoles/">Using Geyser with Consoles</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/playit-gg/">Using playit.gg with Geyser</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/creating-a-startup-script/">Creating a Startup Script</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/common-issues/">Common Issues</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/fixing-unable-to-connect-to-world/">Fixing 'Unable to Connect to World'</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/understanding-the-config/">Configuring Geyser</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/commands/">Commands</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/geyser-command-line-arguments-and-system-properties/">Geyser Command Line Arguments and System Properties</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/faq/">FAQ</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/anticheat-compatibility/">Anticheat Compatibility</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/current-limitations/">Current Limitations</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/custom-items/">Custom items with Geyser</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-items/#json-mappings">JSON mappings</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-items/#geyser-extensions">Geyser extensions</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-items/#resource-pack">Resource pack</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/custom-blocks/">Custom blocks with Geyser</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-blocks/#enabling-custom-blocks">Enabling custom blocks</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-blocks/#json-mappings">JSON mappings</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-blocks/#geyser-extensions">Geyser extensions</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/custom-skulls/">Custom skulls with Geyser</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-skulls/#enabling-custom-skulls">Enabling custom skulls</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/custom-skulls/#custom-skullsyml">custom-skulls.yml</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/api/">Geyser API</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/getting-started-with-the-api/">Getting Started</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/api/#short-overview-of-the-geyser-api">Overview</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/events/">Events</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/forms/">Forms and Cumulus</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/extensions/">Geyser Extensions</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/geyser/extensions/#creating-the-main-class">Main class</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/extensions/#creating-commands-with-geyser-extensions">Creating Commands</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/geyser/global-api/">Global API</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="nav-item dropdown">
|
||
<a class="nav-link dropdown-toggle fw-bold" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">Floodgate Documentation</a>
|
||
<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc">
|
||
|
||
<li class="ms-4">
|
||
<a href="/floodgate/setup/">Setup</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/floodgate/issues/">Issues</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/floodgate/faq/">FAQ</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/floodgate/features/">Features</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/floodgate/features/#whitelist-command">Whitelist command</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/floodgate/commands/">Commands</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/floodgate/features/#what-is-skin-uploading">Skin Uploading</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/floodgate/api/">Floodgate API</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/floodgate/player/">FloodgatePlayer</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/geyser/forms/">Forms and Cumulus</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/floodgate/linking/">Linking</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/floodgate/linking/#what-is-global-linking">Global Linking</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/floodgate/linking/#local-linking">Local Linking</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="nav-item dropdown">
|
||
<a class="nav-link dropdown-toggle fw-bold" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">Other</a>
|
||
<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc">
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/geyseroptionalpack/">GeyserOptionalPack</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/hurricane/">Hurricane</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/geyserconnect/">GeyserConnect</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/community-geyser-projects/">Community Geyser Projects</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/test-server/">Test Server</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/developer-guide/">Developer Guide</a>
|
||
|
||
</li>
|
||
|
||
<li class="ms-4">
|
||
<a href="/other/discord-bot-usage/">Geyser Discord Bot Usage</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<main class="col-12 col-md-9 col-xl-8" role="main">
|
||
<nav aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
|
||
|
||
|
||
|
||
<li class="breadcrumb-item active" aria-current="page">Search</li>
|
||
|
||
|
||
</ol>
|
||
</nav>
|
||
|
||
<form class="d-flex" role="search" action="/search/">
|
||
<div class="input-group">
|
||
<button class="btn btn-outline-secondary" type="submit" id="button-search"><i class="bi bi-search"></i></button>
|
||
<input type="text" name="q" class="form-control" placeholder="Search the site..." aria-label="Search the site..." aria-describedby="button-search">
|
||
</div>
|
||
</form>
|
||
|
||
<br />
|
||
|
||
<p><span id="search-process">Loading</span> results <span id="search-query-container" style="display: none;">for "<strong id="search-query"></strong>"</span></p>
|
||
|
||
<ul id="search-results"></ul>
|
||
|
||
<script>
|
||
window.data = {
|
||
|
||
|
||
|
||
|
||
"floodgate-api": {
|
||
"id": "floodgate-api",
|
||
"title": "Floodgate API",
|
||
"url": "/floodgate/api/",
|
||
"content": "Floodgate has an API to extend what is possible and allow servers to get information about the Bedrock client. It also allows other plugins access to Cumulus\n\nThis page will contain information about class FloodgateApi.\nSee the sidebar for more information about other parts of the API.\n\nAccessing the Floodgate API\nSee here for how to include the Floodgate API in your project.\n\nThe Floodgate API has changed in Floodgate 2.0. The most important change is that the API methods are no longer static and instead instance-based, as shown below.\n\nThe class FloodgateApi is the base class of the API and you need to use it to access any part of the API.\nTo access it, you simply type:\nFloodgateApi.getInstance();\n\n\nAfter you got the instance, you have access to all the methods.\nUse the documentation in the API module to see (and get info about) every single method available.\nMost API methods have a simple explanation.\n\n\n Note: To see full, detailed documentation, see the javadocs.\n\n\nWe’ll highlight a few to get you started quickly:\nFloodgateApi#isFloodgatePlayer(UUID)\nUsed to check if the given UUID of an online player is a Bedrock player.\n\nFloodgateApi#getPlayer(UUID)\nUsed to get the FloodgatePlayer instance of an online player.\nClick here to get more information about the FloodgatePlayer class.\n\nNote: You don’t need to wait until the Bedrock player is online to use the getPlayer and isFloodgatePlayer methods.\nYou can even use them in the pre-login events.\n\nFloodgateApi#getPlayerLink()\nUsed to get the PlayerLink instance used by Floodgate to check for linked accounts.\nClick here to get more information about the PlayerLink class\n\nFloodgateApi#sendForm(UUID, Form(Builder))\nUsed to send a form to the Bedrock player with the given UUID.\nClick here to get more information about Forms.\n\nUsing the API on backend servers\nIn 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."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-commands": {
|
||
"id": "floodgate-commands",
|
||
"title": "Commands",
|
||
"url": "/floodgate/commands/",
|
||
"content": "Command\n Permission\n Description\n \n \n \n \n fwhitelist\n floodgate.command.fwhitelist\n Whitelist command for Floodgate players. See here for details.\n \n \n linkaccount\n floodgate.command.linkaccount\n Link your account for local linking.\n \n \n unlinkaccount\n floodgate.command.unlinkaccount\n Unlink your account for local linking."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-faq": {
|
||
"id": "floodgate-faq",
|
||
"title": "FAQ",
|
||
"url": "/floodgate/faq/",
|
||
"content": "FAQ\n\nChanging/disabling the prefix\n\nPlease note: we do not recommend removing the prefix unless you are certain that no one will share a username between a Java and Bedrock player. Duplicated usernames will cause weird situations, like being unable to teleport to one of the players.\n\nIn your Floodgate config, change username-prefix to whichever prefix you desire - you can set it to \"\" and there will be no prefix.\n\nOn some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your usercache.json file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See this issue for more information.\n\nObtaining UUIDs for Floodgate players\nCheck your server logs, or use this page. If this doesn’t work, then try this method:\n\nFirst, 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.\n\nUsing PlaceholderAPI\nIf you’re using the Spigot version of Floodgate, download the Placeholder plugin here. Using the placeholders shouldn’t require additional setup other than having PlaceholderAPI installed. See the section above on installing Floodgate on backend servers if you wish to use this on BungeeCord.\n\nUsing Skript\nIf you’re using the Spigot version of Floodgate, there is an unofficial plugin that adds Skript support here."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-features": {
|
||
"id": "floodgate-features",
|
||
"title": "Features",
|
||
"url": "/floodgate/features/",
|
||
"content": "Whitelist command\n\nFloodgate 2.0 has a whitelist command, fwhitelist, that should be used for adding or removing Floodgate players to whitelist.json. The username prefix doesn’t need to be included.\nfwhitelist add Tim203\nfwhitelist remove Tim203\n\nYou can also specify a UUID: fwhitelist add 00000000-0000-0000-0009-01f64f65c7c3\n\nThe permission node is floodgate.command.fwhitelist.\n\nWhat is skin uploading?\nSkins of Bedrock player should be visible to Java players on servers with Floodgate 2.0 installed.\nIf they aren’t, it’s most likely that the skin uploading queue has grown too large and can take a while to upload your skin.\n\nSkin uploading is also a part of the Global Api. It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition.\n\nWe’re using MineSkin internally. MineSkin is running on accounts donated by the community. So if you want to support MineSkin and make the upload times faster, feel free to look at this page for more info."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-issues": {
|
||
"id": "floodgate-issues",
|
||
"title": "Issues",
|
||
"url": "/floodgate/issues/",
|
||
"content": "Known Issues & Caveats\nIf an issue you’re experiencing is not listed here, please consider joining the Geyser Discord.\n\nRunning commands\nIn some instances, like if you have the username-prefix set to *, you may need to wrap the Bedrock player’s username in quotes; for example: /tp \"*BedrockPlayer\". Setting the prefix to . should also fix this.\n\nIf you wish to use IP forwarding, please enable it in your BungeeCord config as well!\nIt is likely you have enabled send-floodgate-data in your Floodgate config but either Floodgate isn’t installed on the target server, or your floodgate key isn’t the same between the installs of the plugin (please copy them so they all use the same key).\n\njava.lang.IllegalStateException: Cannot reply to EncryptionRequestPacket without profile and access token.\n\nMake sure the server has Floodgate installed and started up correctly. Otherwise, see if the next line fixes your error.\n\njavax.crypto.AEADBadTagException: Tag mismatch!\n\nIf Geyser and Floodgate are on the same server, shut down your server, delete the floodgate plugin folder, delete any key file in the Geyser folder, and restart your server.\nIf Geyser and Floodgate are not on the same server and you had to copy the key file, this could also be an error related to uploading through FTP. Using ASCII will not work here, and you need to make sure you’re on binary when uploading. We recommend using WinSCP if you need to use FTP.\n\njava.lang.NumberFormatException: For input string: “”\n\nYou’re trying to log in without an Xbox account. Floodgate requires an Xbox account to authenticate the Bedrock player.\n\nGeyser-Floodgate:51777 lost connection: Internal Exception: java.lang.NumberFormatException: For input string: “SfqdXv36” (or a similar error)\n\nSet ip-forwarding in your BungeeCord to true.\n\n“Please connect through the official Geyser” disconnect message\n\nEnsure that Floodgate and Geyser are both up-to-date.\n\nPrefix is not changing on the server after changing it in the config.\n\nBetween the Paper builds of 1.15.2-355 and 1.16.5-505, there was a bug where Floodgate players who had already connected to the server would not have their prefixed changed. Paper builds 1.16.5-506 and later fix this issue.\n\nEnsure that you removed the usercache.json file from the server root directory and restart your server.\n\nIssues with LuckPerms and prefixes\n\nSet allow-invalid-usernames to true in LuckPerms’ config.\n\nFailed to verify username! (with Paper)\n\nTo completely mitigate this issue, disable perform-username-validation in the unsupported settings of the config/paper-global.yml file (paper.yml in the root server folder on servers below 1.19). Using Floodgate on the backend servers will also mitigate this issue.\n\nError with Forge or Fabric Bukkit Hybrid\n\nAt this time, there is no way to run Floodgate on servers that mix Forge and Bukkit or Fabric and Bukkit (For example: Magma, Mohist, and Cardboard/Bukkit4Fabric) - most hybrids do not support the complicated procedures we need to do in order to allow Bedrock players to connect (for the technically minded: these server softwares typically don’t support NMS).\n\nIf you wish to use Floodgate in combination with hybrid servers, we recommend putting these servers behind a BungeeCord or Velocity proxy, and running Floodgate on the proxy.\n\nAfter enabling global linking in offline mode, player data is not synced between Java and Bedrock players.\n\nThis occurs in offline mode because the UUID of the Java account linked to the Bedrock account does not match the online mode UUID returned by Floodgate’s global linking server.\n\nWhen using global linking, ensure online-mode in server.properties is set to true. Otherwise, Bedrock players will not be authenticated with the same UUID they receive when playing on Java Edition, resulting in lost progress. This does not occur with local linking."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-linking": {
|
||
"id": "floodgate-linking",
|
||
"title": "Linking",
|
||
"url": "/floodgate/linking/",
|
||
"content": "What is Global Linking?\nInstructions and information about how to link can also be found here: https://link.geysermc.org/\n\nBefore we introduced Global Linking, you always had to link your Java and Bedrock account on every individual server you visited (that has Floodgate). Global Linking is here to fix that problem. Link once, join everywhere.\n\nKeep in mind: While having your accounts linked, you will use the Java account’s location, inventory data, and achievements etc. regardless of which platform you sign in from (therefore, “synchronising” the player data). The player data from the Bedrock account will not be accessible until you unlink again. As a result, you should transfer everything (ender chest contents, items, armor) to the Java account before linking to not “lose” your Bedrock progress. If you forgot to do this, you can unlink, transfer everything over, and link again.\n\nGlobal Linking is part of the Global Api and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following:\n\n Join the GlobalLinkServer with both your Java and Bedrock account\n(IP: link.geysermc.org, Java port: 25565, Bedrock port: 19132)\n Start the linking process by typing /linkaccount on your Java or Bedrock account\n You’ll get a message with a random number that you have to enter on the account that you did not start the linking process on.\n Enter the random number on the other account by typing /linkaccount <code>\n You should get kicked from the server on both your Bedrock and Java account with the message that it had successfully linked your accounts.\n\n\nTo unlink your globally linked accounts, join the GlobalLinkServer (as described above for linking) on either Java or Bedrock, and use the /unlinkaccount command.\n\nGlobal Linking should be enabled by default on every server running Floodgate 2.0, but in the case that you disabled it, you can enable it again by opening your Floodgate config and make sure that the player-link section looks similar to this:\n# Configuration for player linking\nplayer-link:\n # Whether to enable the linking system. Turning this off will prevent\n # players from using the linking feature even if they are already linked.\n enabled: true\n # Whether to use global linking. Global linking uses a central server to request link\n # accounts, allowing people to link once, join everywhere (on servers with global linking).\n use-global-linking: true\n\n(see the default config)\n\nOnce you saved the config and restarted your server you should be using Global Linking.\n\nIf you don’t want to use Global Linking, you can disable enable-global-linking in the Floodgate config.\n\nLocal Linking\nYou can also set up a local linking database on your server. Local linking can work with Global Linking at the same time. Link entries in your local database will override entries in the Global Linking Server.\n\nNote that you only have to follow these steps on your proxy (BungeeCord or Velocity), if you have one.\n\n\n Download one of the linking databases extensions here.\nIf you need help picking the right one: choose mysql if you already have a database or want to have a multi-proxy setup. For anything else choose sqlite. The full name should be floodgate-*type*-database.jar.\n Copy the database extension jar you just downloaded into the floodgate 2.0 plugin folder (e.g. /plugins/floodgate/).\n Enable enable-own-linking in the player-link section of Floodgate.\n Set type in the player-link section to your database type (currently either mysql or sqlite). (If you used Floodgate 1.0 and had linking enabled back then; the database type was sqlite).\n Restart your server\n\n\nIf you have selected mysql a new data folder for the database should be generated inside the Floodgate data folder. You can enter your database credentials in there. After you did that restart your server once more.\n\nThat should be it. You can then link your accounts by following the instructions you get when typing /linkaccount."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-player": {
|
||
"id": "floodgate-player",
|
||
"title": "FloodgatePlayer",
|
||
"url": "/floodgate/player/",
|
||
"content": "FloodgatePlayer is something that every player who’s connect through Floodgate has.\nIt contains information about the Bedrock client which can be useful in various situations.\n\nYou can get a FloodgatePlayer by using the FloodgateApi#getPlayer(uuid) method (where uuid is the unique id of the connected player)"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate": {
|
||
"id": "floodgate",
|
||
"title": "Floodgate",
|
||
"url": "/floodgate/",
|
||
"content": "Floodgate\nWhat is Floodgate?\nFloodgate is a hybrid mode plugin that allows Minecraft: Bedrock Accounts to join Minecraft: Java Edition servers without needing a Minecraft: Java Edition account. \nThis is something you install in addition to Geyser. Unlike Geyser, Floodgate can only be installed as a plugin on Spigot (including Paper and forks), Bungeecord, Velocity, and as a mod on Fabric servers, and can only be utilized on servers that have it installed.\n\nWhat has Floodgate 2.0 to offer?\nFloodgate 2.0 is a rewrite of Floodgate 1.0, with various bugfixes and improvements. It also introduces new features: being able to see Bedrock player skins on Java edition,\nbeing able to use Bedrock forms, link your account once and login on every server that has Global Linking enabled,\nand the Global Api."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"floodgate-setup": {
|
||
"id": "floodgate-setup",
|
||
"title": "Floodgate Setup",
|
||
"url": "/floodgate/setup/",
|
||
"content": "Floodgate Setup\n\n\n\tFloodgate does NOT replace Geyser! It allows Geyser players to join servers without needing to log into a paid Java Edition account. \n\n\n\n \n Paper / Spigot\n \n \n Fabric\n \n \n Proxy Servers\n \n \n Standalone\n \n \n\n\n \n \n Floodgate-Spigot setup\n\n\n Download Floodgate-Spigot from the download page.\n Place the Floodgate-Spigot.jar in the plugins folder, and restart the server.\n Change auth-type in Geyser’s config to floodgate.\n Restart the server.\n\n\n \n \n \n \nFloodgate-Fabric setup\n\n\n Download Floodgate-Fabric from the modrinth page.\n Place the Floodgate-Fabric.jar in the mods folder, and restart the server. You also need FabricAPI installed.\n Change auth-type in Geyser’s config to floodgate.\n Restart the server.\n\n\nNote for Fabric behind a Velocity proxy:\nYou will need to configure FabricProxyLite to allow the Fabric server to receive data from Velocity.\n\n \n \n \n Floodgate setup on a BungeeCord/Velocity proxy\n\n\n\tYou only need to install Floodgate on the BungeeCord or Velocity proxy server, unless you want to use the Floodgate API on the backend servers.\n Additionally, it will display Bedrock edition skins properly.\n\n\n\n Download Floodgate for your proxy software from the download page.\n Place the Floodgate jar in the plugins folder, and restart the proxy server.\n Change auth-type in Geyser’s config to floodgate.\n Restart the server.\n\n\nInstalling Floodgate on servers behind the proxy\n\nThis is only needed when you want to use the Floodgate API on your backend server(s) behind a proxy.\n\n\n After installing Floodgate on the proxy, install Floodgate on the backend servers (either Floodgate-Spigot, or Floodgate-Fabric).\n Enable ip_forward in your BungeeCord config.yml if using BungeeCord. For Velocity, set up player information forwarding.\n Set bungeecord to true in your spigot.yml. When using Velocity, see their guide, as they have multiple options that require different setups.\n Start the proxy server.\n Edit the Floodgate config on your proxy server and set send-floodgate-data to true.\n Copy the key.pem file in the proxy Floodgate config folder to all backend servers’ Floodgate config folder.\n Restart the backend servers and proxy server.\n\n\n\n DO NOT DISTRIBUTE THIS KEY TO ANYBODY! This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server.\n\n\n \n \n \n Floodgate setup with Geyser-Standalone\n\n\n\tTo be able to use Floodgate authentication, you need to be able to install Floodgate on the server you are connecting to.\n\n\n\n Download Floodgate from the download page.\n Install the Floodgate jar - see the platform instructions for detailed info.\n Change auth-type in Geyser Standalone’s config to floodgate.\n Copy the key.pem file in the Floodgate config folder to the same directory as Geyser Standalone.\n Restart Geyser-Standalone.\n\n\n\n\tDO NOT DISTRIBUTE THIS KEY TO ANYBODY! This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server.\n\n\n \n\n\nFurther information:\n\n Floodgate Features\n Floodgate API"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-anticheat-compatibility": {
|
||
"id": "geyser-anticheat-compatibility",
|
||
"title": "Anticheat Compatibility",
|
||
"url": "/geyser/anticheat-compatibility/",
|
||
"content": "The AntiCheats listed below have been categorized based on their compatibility with Geyser. This is a community-compiled list and does not indicate any endorsement from GeyserMC. Use them at your own risk!\n\n\nAntiCheat compatibility reports\n\nFull Compatibility (Checks Bedrock Players Accurately)\n\n\n AntiAura (Paid) - Last Updated on 19th August 2021\n Themis - Last Updated on 15th Jun 2022\n Negativity V2 (Paid) - Last Updated on 21st March 2022\n SoaromaSAC - Last Updated on 27th March 2022\n Spartan: Bedrock Edition (Paid) - Last Updated on 22nd May 2023\n\n\nPartially Compatible (Does not Check/Ignores Bedrock Players)\n\n\n AAC (Paid) - Last Updated on 19th August 2021\n Flappy Anticheat - Last Updated on 14th September 2021\n GrimAC - Last Updated on 24th March 2022\n Intave (Paid) Requires GeyserMC addon - Last Updated on 24th October 2022\n Matrix (Paid) - Last updated on 2nd September 2021\n Spartan: Java Edition (Paid) - Last Updated on 22nd May 2023\n Vulcan (Paid) - Last Updated on 19th August 2021\n Verus (Paid) - Last Updated on 13th July 2022\n\n\nIncompatible (False Positives on Bedrock Players, no Compatibility at All)\n\n\n AntiCheatReloaded - Last Updated on 19th August 2021\n Negativity V1 - Last Updated on 21st March 2022\n NoCheatPlus (Compat NCP is an addon that enables Partial Compatibility) - Last Updated on 19th August 2021\n GodsEye (GodsEyeGeyserMC is an addon that enables Partial Compatibility) (Paid) - Last Updated on 21st March 2022\n Kauri (Paid) - Last Updated on 21st March 2022\n Reflex (Paid) - Last Updated on 19th August 2021\n Wraith (Paid) - Last Updated on 19th August 2021"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-api": {
|
||
"id": "geyser-api",
|
||
"title": "Geyser API",
|
||
"url": "/geyser/api/",
|
||
"content": "Geyser has an API to extend what is possible with Geyser, and to allow you to interact with Geyser in your own plugins, mods, or extensions.\n\nWhere can I use the Geyser API?\nYou could use the Geyser API in:\n\n A plugin for Paper/Spigot, Velocity, Waterfall/BungeeCord, etc.\n A mod for Fabric or Forge\n A Geyser Extension\n\n\nAccessing the Geyser API\nSee here for how to include the Geyser API dependency in your project.\n\nDocumentation\n\nThe Geyser API offers events to subscribe to, or information on whether a player is joining through Geyser, and gives you the ability to enhance what is possible with Geyser (i.e. register custom items).\n(soon, blocks and entities too).\nIt can be used easily in Geyser Extensions, see here for details on those.\n\nQuick overview: \n\n Note: To see full, detailed documentation, see the javadocs.\n\n\nGeyserApi:\nThe GeyserApi interface serves as a central access point to various functionalities provided by the Geyser API, providing methods to e.g. interact with player connections.\nIt extends the Base API interface, which provides basic information about individual players.\n\nThe class GeyserApi is the base class of the API and you need to use it to access any part of the API.\nTo access it, you simply type:\nGeyserApi.api();\n\n\nAfter you got the instance, you have access to all the methods.\nUse the documentation in the API module to see (and get info about) every single method available.\nMost API methods have a simple explanation.\nSince the Geyser API extends the Base API that is shared across Floodgate and Geyser, you can also use the methods from the Base API.\n\nWe’ll highlight a few to get you started quickly:\nGeyserApi#isBedrockPlayer(UUID)\nUsed to check if the given UUID of an online player is a Bedrock player.\n\nGeyserApi#connectionByUuid(UUID)\nUsed to get the Connection of an online player.\nThis method will return null if the player is not a Bedrock player.\n\n\n You don't need to wait until the Bedrock player is online to use the getPlayer and isBedrockPlayer methods.\n You can even use them in the pre-login events.\n\n\nGeyserApi#sendForm(UUID, Form(Builder))\nUsed to send a form to the Bedrock player with the given UUID.\nClick here to get more information about Forms.\n\nGeyserApi#onlineConnectionsCount()\nUsed to get the amount of online Bedrock players.\n\nShort Overview of the Geyser API\n\nCumulus\nWhile technically not directly in the Geyser API, the Cumulus library is also provided by the Geyser API. \nIt allows you to send Bedrock edition forms to players. See Cumulus for more information.\n\nEvents\nThe event package contains all the events that Geyser fires. See here for detailed information on how to listen to Geyser events.\n\nCommand\nThis package contains classes and interfaces related to commands in Geyser, which allows Geyser Extensions to register custom commands.\n\nEntity\nThe Entity package contains classes and interfaces related to entities in Geyser, like the GeyserPlayerEntity interface, \nwhich represents a player entity in Geyser. This interface extends the GeyserEntity interface, while providing additional functionality specifically for player entities, \nlike currently, showing emotes.\n\nItem\nThe item package contains classes and interfaces related to items in Geyser. You can create custom items and register them using the Geyser API.\nSee here for detailed information on how to register custom items.\n\nBlock\nThe block package contains classes and interfaces related to blocks in Geyser. You can create custom blocks using this package, and register them in using the GeyserDefineCustomBlocksEvent.\nSee here for detailed information.\n\nNetwork\nThe network package contains basic information about the remote server via the \nRemoteServer\ninterface, such as the server’s IP address and port, and the protocol version of the remote server. Or the auth type.\nYou can also get the port/IP that Geyser listens to via the BedrockListener interface.\n\nPack\nThe pack package contains classes and interfaces related to resource packs in Geyser. You can create custom resource packs and send them to individual sessions before they log in using the SessionLoadResourcePacksEvent.\nIf you wish to send a resource pack to all sessions, you can use the GeyserLoadResourcePacksEvent.\n\nPacks can be created using a PackCodec, such as the provided PathPackCodec.\nThis allows you to load a Bedrock resource pack from a file path:\nResourcePack pack = ResourcePack.create(PackCodec.path(path));\n\n\nExtension\nThis package provides the necessary components to create and manage extensions.\nFor a more detailed explanation of extensions, see here."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-commands": {
|
||
"id": "geyser-commands",
|
||
"title": "Commands",
|
||
"url": "/geyser/commands/",
|
||
"content": "Commands and Permissions\n\nGeyser features many built-in commands that can be used by players or server owners.\n\n\n When using BungeeCord and Velocity, you will need to use a permission plugin such as LuckPerms\non the proxy server to assign permissions to players. Assigning permissions on the backend servers will not work.\n\n\nGeyser commands & their permissions\n\n\n \n \n Command\n Permission\n Description\n \n \n \n \n geyser help geyser ?\n geyser.command.help\n Shows help for all registered commands.\n \n \n geyser advancements\n geyser.command.advancements\n Open the Java advancements menu.\n \n \n geyser dump\n geyser.command.dump\n Dumps Geyser debug information for bug reports.\n \n \n geyser list\n geyser.command.list\n List all players connected through Geyser.\n \n \n geyser offhand\n geyser.command.offhand\n Puts an item in your offhand.\n \n \n geyser reload\n geyser.command.reload\n Reloads the Geyser configurations. Kicks all players when used!\n \n \n geyser settings\n geyser.command.settings\n Opens a settings menu allowing you to modify aspects of the world.\n \n \n geyser shutdown geyser stop\n geyser.command.shutdown\n Shuts down Geyser.This command only works on Standalone.\n \n \n geyser statistics\n geyser.command.statistics\n Open the Java statistics menu.\n \n \n geyser version\n geyser.command.version\n Shows the current Geyser version and checks for updates.\n \n \n geyser tooltips\n geyser.command.tooltips\n Toggle showing Advanced Tooltips (F3 + H on Java)\n \n \n\n\nOther Permissions\n\nBesides commands, there are other permissions that are used to guard specific Geyser features.\n\n\n \n \n Permission\n Description\n \n \n \n \n geyser.settings.server\n Allow players to use the game settings menu. (Also requires player to have op.)\n \n \n\n\nFloodgate commands and permissions\n\nFor Floodgate commands, see here."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-common-issues": {
|
||
"id": "geyser-common-issues",
|
||
"title": "Common Issues",
|
||
"url": "/geyser/common-issues/",
|
||
"content": "Commonly, people may have issues with Geyser not showing up in their server list or run into similar issues. \nThis page contains a few common issues people may encounter that you might have as well as potential fixes for them. \nIf you still can’t make it work, join our Discord for support.\n\nFloodgate\nFor Floodgate issues see: Floodgate: Known Issues/Caveats.\n\nI can’t connect! (Either the server doesn’t show up in the friends list or I get “Unable to connect to world”)\n\n If you don’t use a reverse proxy such as TCPShield make sure that enable-proxy-protocol is set to false.\nTo fix “Unable to connect to world” with no console errors, see here.\n\n\nIf the server doesn’t show up in the friends list\n\n\n If using Windows 10, iOS, or Android: try adding the server to the Servers list in-game.\n If using Xbox One: try connecting with BedrockConnect.\n If using PS4: try using a LAN proxy.\n If using Nintendo Switch: there is currently no way for local servers to show up in the Friends tab, but you can still connect using BedrockConnect.\n\n\nIf the Geyser instance is locally hosted: try using localhost or 0.0.0.0 as the IP address.\nIf that doesn’t work, or your Geyser instance is on another computer in the network: use your local IPv4 address.\n\nSee here for fixing “Unable to Connect to World” with no console errors\n\njava.net.BindException: Address already in use: bind on startup.\nThis means something (likely another instance of Geyser) is running on the port you have specified in the config. Please make sure you close all applications running on this port. If you don’t recall opening anything, usually restarting your computer fixes this.\n\n[…] has been compiled by a more recent version of the Java Runtime (class file version 60.0)\n\nSee this link for updating to Java 16: https://paper.readthedocs.io/en/latest/java-update/index.html.\n\nHosting provider will not immediately open up UDP.\n\nThese steps only apply for the standalone version of Geyser.\nThis usually has something to do on your host’s end. Most commonly, it’s because they do not open up ports over the UDP protocol, which is what Minecraft: Bedrock Edition uses, opposed to Minecraft: Java Edition using TCP. \nOne way to get around this (if you’re using an online host) is to shut down your server, and when asking for a server jar, select Nukkit, or any other Bedrock edition server software (you won’t actually be switching to Nukkit). Afterward, open up your FTP file manager and find the Nukkit jar. Then, replace this jar with the server software you’re using. Upon starting up the server, it should open up ports over UDP whilst still allowing you to use the server jar you desire.\n\nPLEASE NOTE: If your server automatically redownloads jars upon startup, such as with an autoupdate system, this workaround will not work. Please contact your host if this does not work for you as there is nothing we can do.\n\nStuck on “Locating Server” with no errors\n\nYou may need to update your Java version. If so, update at Adoptium.net.\n\nSometimes this happens in poor-network environments. There is an mtu option in the Geyser config; lower this number slowly (in batches of 100), restart each time, and re-test joining.\n\nThis option will most likely not help if you are getting “Unable to Connect to World” with no console logs indicating a connection.\n\nLogin Failed\n\nIf you are using a plugin version: in your Geyser config, set your remote address to 127.0.0.1. If that does not work, check your startup log for a message about Docker, and use that address in the remote address\n\nCannot reply to EncryptionRequestPacket without profile and access token\n\nThere are two causes of this message:\n\nFloodgate issue:\n\nThis message can occur with a Floodgate setup. Usually, it means that a misconfiguration occurred, or another plugin is conflicting. If you copied the Floodgate key from its folder to the Geyser folder on the same server, this is now unnecessary and you can safely remove the Geyser copy, restart, and try again.\n\nServer is in Online Mode while Geyser is in Offline Mode:\n\nIf you have your configuration set up like this, put simply, it won’t work. If authentication for the Java server is set to online, it is expected Geyser is configured the same way. The server requires a valid Minecraft: Java Edition account, and if you aren’t logging into one with Geyser, then you will be unable to join the server. If your configuration is set up properly and you’re still getting this issue, it could be that your credentials are invalid.\n\nConnection Refused: <INSERT IP AND/OR DOMAIN>\n\nConnection Refused usually means that a Java server could not be found on that port, or the server denied access to the connection on a network level. \nThe latter can happen with anti-DDOS plugins such as TCPShield, but otherwise ensure that the server you’re trying to connect to is spelled correctly in the config, is up and is port forwarded correctly.\n\nIf you’re updating from an old build of Geyser, set your remote address to auto and try again.\n\nFloodgate Misconfiguration\nSee this page for more information.\n\nMissing profile key. This server requires secure profiles.\n\nSee this page.\n\nMojang Resetting Account Credentials\nThis is unfortunately something we have no control over, and is most likely the case when you’re running Geyser as a plugin on a server host or joining a friend far away from your location. If you’re running Geyser locally, this should not happen to you, but what we recommend for servers is a plugin we make called Floodgate, which allows for Bedrock clients to join your server without needing a Java Edition account. Take a look here for more information.\n\n“Invalid IP address!” from Bedrock\nThis can happen if the domain you are entering resolves to a SRV record, which Bedrock does not support. Try using the IPv4 address instead.\nAdditionally, this can happen when trying to specify both the ip and port in the ip tab - in which case, see here for how to properly connect to “test.geysermc.org:19132”.\n\nBedrock clients freeze when opening up commands for the first time\nDisable command-suggestions in your Geyser config. This will stop the freezing at the expense of removing command suggestions from Bedrock clients.\nIf you’re a dedicated server admin, you can have a list of commands players should be using. This will remove any unnecessary commands from tab completion as well for Java players. \nIt has other benefits too. Here’s a plugin that can just do that: \nCommandWhitelist. Alternatively, use the HideCommands Geyser extension to hide commands just for Bedrock players.\n\nFailed to load locale asset cache: Unrecognized token ‘Cannot’\nThis or anything else related to failing to download a locale file on startup is usually caused by java trying to connect using IPv6 and Mojang only use IPv4, so start Geyser or the server up with this flag -Djava.net.preferIPv4Stack=true, EG: java -Xms1024M -Djava.net.preferIPv4Stack=true -jar Geyser.jar\n\nOutdated client! Please use 1.x.x\n\nThe server is too new or Geyser is outdated. Make sure you’re on the latest Geyser.\n\nOutdated server! I’m still on 1.x.x\n\nUpdate the server or ask them to install ViaVersion. You can also try VIAaaS (ViaVersion as a Service).\n\nQuery: Incorrect Magic!\n\nSee here: https://www.spigotmc.org/threads/query-incorrect-magic-and-high-cpu-usage.159386/#post-2709057\n\n\n If you don’t use a reverse proxy such as TCPShield make sure that enable-proxy-protocol is set to false.\n\n\nOnly for BungeeCord with floodgate\n\nIf you use floodgate ensure that it is installed on all of your Spigot backend servers as following:\n\n\n Bungee: Geyser and Floodgate\n Lobby: floodgate\n Server-1: floodgate\n Server-2: floodgate\n\n\nAnd so on.\n\n\n Please also make sure that you have the same key.pem and config.yml on all of your servers.\n\n\nIf your players can’t connect from the lobby to another backend server, check console.\n\nPlugins that can cause issues\n\n HamsterAPI"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-creating-a-startup-script": {
|
||
"id": "geyser-creating-a-startup-script",
|
||
"title": "Creating a Startup Script",
|
||
"url": "/geyser/creating-a-startup-script/",
|
||
"content": "Creating a Startup Script for Geyser-Standalone\n\nIn order for this to work, you MUST have Java 16 (or higher) installed!\n\nOnce you have downloaded and placed Geyser into its own folder, you will need to create a startup script; similar to how you’d run a Bukkit/Spigot/Paper server.\n\nWindows\n\n Create a new text file in the same location as the Geyser-Standalone jar file, and call it run.bat. Open this with a text editor (preferably Notepad++), and insert the text below:\n @echo off\njava -Xms1024M -jar Geyser-Standalone.jar\npause\n \n \n Double-click the run.bat, and Geyser should start up. Geyser will generate all the needed files.\n\n\nmacOS\n\n Create a text file called run.command, and open it with a text editor such as TextEdit or TextMate. Type the text below into the run.command file:\n #!/bin/bash \ncd \"$( dirname \"$0\" )\" \njava -Xms1024M -jar Geyser-Standalone.jar\n \n \n Open Terminal, and type in chmod a+x (Do NOT press return!), and drag your run.command file into the Terminal.\n Press return on your keyboard, and Geyser will start up. Geyser will generate all the needed files.\n\n\nLinux\n\n Create a file called run.sh, and open it with a text editor. Type the text below into your run.sh file:\n #!/bin/sh \ncd \"$( dirname \"$0\" )\" \njava -Xms1024M -jar Geyser-Standalone.jar\n \n \n In your default terminal application, make the file executable by running chmod +x ~(dir)/run.sh where dir is the name of the folder Geyser is in, or by changing the file permissions;\n Open your default terminal application, and type ./run.sh to run Geyser. Geyser will generate all the needed files."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-current-limitations": {
|
||
"id": "geyser-current-limitations",
|
||
"title": "Current Limitations",
|
||
"url": "/geyser/current-limitations/",
|
||
"content": "With Geyser being a protocol translator between two different games with two different codebases, there are a handful of limitations that Geyser is unfortunately unable to handle. Despite Minecraft Bedrock and Java being quite close in comparison, there are some vast differences in many areas.\n\nThe following things cannot be fixed without changes to Bedrock or the Java protocol in general. As of now, they are not fixable in Geyser.\n\n\n Custom heads in inventories\n Clickable links in chat\n Glowing effect\n Crafting in the 2x2 menu while in creative mode\n Distinguishing between left and right clicks in inventories\n Redstone dot blockstates\n “Can be placed on/destroyed” tag for some blocks - for example, different colors of clay/wool that don’t exist as separate blocks\n Potion colors implemented using NBT\n Various command arguments for any command that doesn’t use the Minecraft Brigadier library\n Anything that relies on tab complete or typing in the chat UI (related to the above) - Bedrock sends no packet that indicates they are in this menu\n Unable to see banner layers past 6\n Movement issues around bamboo due to offset differences between Java and Bedrock: Hurricane can work around it.\n Can’t move mounted entities with carrot/warped fungus on a stick. Hurricane also works around this.\n Custom anvil recipes\n Heights lower than -64 or higher than 320 in the overworld with extended height enabled, and heights lower than 0 or higher than 256 in other dimensions\n Dolphin’s Grace potion effect visuals (effects should still work correctly)\n Invisible item frames\n Blocks (excluding jack-o-lantern) on entity heads (E.G. armor stands, players)\n Saddled camels unmoveable/unrideable on bedrock.\n Bedrock edition players cannot see the changes to fence block states made by the Java Debug Stick.\n\n\nThe following changes are supported with the GeyserOptionalPack, which is a Bedrock resource pack you can install for additional functionality for features Bedrock does not natively support:\n\n Custom armor stand poses\n Illusioners\n Hit particles and other miscellaneous particles not natively in Bedrock\n Offhand animations\n Shulker invisibility\n Spectral arrow texture"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-custom-blocks": {
|
||
"id": "geyser-custom-blocks",
|
||
"title": "Custom blocks with Geyser",
|
||
"url": "/geyser/custom-blocks/",
|
||
"content": "Custom blocks with Geyser\n\nTo setup custom blocks in geyser, you have to choose how you are going to register your blocks. The easiest is using a json file but you can also use a Geyser extension.\n\nIt should be noted that blocks and their associated components are not very stable. Mojang tends to make changes to these much more often than they do for items. This means that any components Geyser allows you to register are liable to break in future versions of Bedrock.\n\nEnabling custom blocks\n\nBefore beginning, ensure that add-non-bedrock-items is set to true in your config.yml file.\n\n# Whether to add any items and blocks which normally does not exist in Bedrock Edition.\n# This should only need to be disabled if using a proxy that does not use the \"transfer packet\" style of server switching.\n# If this is disabled, furnace minecart items will be mapped to hopper minecart items.\n# Geyser's block, item, and skull mappings systems will also be disabled.\n# This option requires a restart of Geyser in order to change its setting.\nadd-non-bedrock-items: true\n\n\nJSON mappings\n\nThe JSON mappings use a similar structure to that of behavior packs registering blocks. The equivalent components are listed in the Minecraft: Bedrock Edition Creator Documentation.\n\nCustom mappings files that register blocks or items should be placed in the custom_mappings folder. This folder is created when you start your server. It is located in the same folder as the Geyser-Standalone.jar file for standalone and inside your Geyser data folder for a plugin. If you do not have this folder, ensure you are on the latest version of Geyser.\n\nExample mappings file\n\n{\n\t\"format_version\": 1,\n\t\"blocks\": {\n\t\t\"minecraft:granite_wall\": {\n\t\t\t\"name\": \"my_block\",\n\t\t\t\"display_name\": \"Custom Granite Wall\",\n\t\t\t\"geometry\": \"geometry.blocks.my_block_geo\",\n\t\t\t\"material_instances\": {\n\t\t\t\t\"*\": {\n\t\t\t\t\t\"texture\": \"some_texture\",\n\t\t\t\t\t\"render_method\": \"alpha_test\",\n\t\t\t\t\t\"face_dimming\": true,\n\t\t\t\t\t\"ambient_occlusion\": true\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"tags\": [\"stone\", \"wall\"],\n\t\t\t\"state_overrides\": {\n\t\t\t\t\"east=none,north=none,south=none,up=true,waterlogged=true,west=none\": {\n\t\t\t\t\t\"geometry\": \"geometry.blocks.my_other_block_geo\",\n\t\t\t\t\t\"destructible_by_mining\": 10,\n\t\t\t\t\t\"place_air\": false\n\t\t\t\t},\n\t\t\t\t\"east=none,north=none,south=none,up=false,waterlogged=true,west=tall\": {\n\t\t\t\t\t\"friction\": 0.6,\n\t\t\t\t\t\"light_emission\": 7,\n\t\t\t\t\t\"light_dampening\": 8,\n\t\t\t\t\t\"transformation\": {\n \"scale\": [0.5, 0.5, 0.5],\n \"translation\": [1, 0, 0],\n \"rotation\": [0, 90, 0]\n }\n\t\t\t\t},\n\t\t\t\t\"east=none,north=none,south=low,up=true,waterlogged=true,west=tall\": {\n\t\t\t\t\t\"placement_filter\": {\n\t\t\t\t\t\t\"conditions\": [{\n\t\t\t\t\t\t\t\"allowed_faces\": [\"up\", \"down\"],\n\t\t\t\t\t\t\t\"block_filter\": [{\n\t\t\t\t\t\t\t\t\t\"tags\": \"!query.any_tag('stone')\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"minecraft:dirt\"\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n\n\nSchema\n\nThe following details the schema for the mappings file. Only the name field is strictly required. All other fields are optional.\n\n\n\n \n format_version:\n \n Type: integer\n \n Description: The version of the format of the mappings file.\n \n \n \n \n blocks:\n \n Type: object\n \n Description: An object containing a list of block definitions.\n \n minecraft:some_block:\n \n Type: object\n \n Description: A block definition to be used to override the specified java block.\n \n name:\n \n Type: string\n \n Default: none\n Description: The name of the custom block.\n \n \n \n \n collision_box:\n \n Type: object\n \n origin:\n \n Type: array\n \n Default: Inferred from overridden block\n Description: An array of x, y, and z origin values\n Range: Must be in range [-8, 0, -8] to [8, 16, 8], inclusive\n \n items:\n \n Type: float\n \n Default: Inferred from overridden block\n Description: An origin value for a single axis\n \n \n \n \n \n \n \n \n \n \n size:\n \n Type: array\n \n Default: Inferred from overridden block\n Description: An array of x, y, and z size values\n \n items:\n \n Type: float\n \n Default: Inferred from overridden block\n Description: An size value for a single axis\n \n \n \n \n \n \n \n \n \n \n Range: Addittion of origin and size must be in range [-8, 0, -8] to [8, 16, 8], inclusive.\n \n \n \n \n destructible_by_mining:\n \n Type: integer\n \n Default: Inferred from overridden block\n Description: The time in seconds to mine the block with base tools.\n \n \n \n \n display_name:\n \n Type: string\n \n Default: the name of the custom block\n Description: The display name of the block.\n \n \n \n \n extended_collision_box:\n \n Type: object\n \n origin:\n \n Type: array\n \n Default: Inferred from overridden block\n Description: An array of x, y, and z origin values\n Range: Must be in range [-8, 0, -8] to [8, 16, 8], inclusive\n \n items:\n \n Type: float\n \n Default: Inferred from overridden block\n Description: An origin value for a single axis\n \n \n \n \n \n \n \n \n \n \n size:\n \n Type: array\n \n Default: Inferred from overridden block\n Description: An array of x, y, and z size values\n \n items:\n \n Type: float\n \n Default: Inferred from overridden block\n Description: An size value for a single axis\n \n \n \n \n \n \n \n \n \n \n Range: Addittion of origin and size must be in range [-8, 0, -8] to [8, 16, 8], inclusive.\n \n \n \n \n friction:\n \n Type: float\n \n Range: 0.0 to 1.0\n Default: 0.4\n Description: The friction value for entities traversing the block.\n \n \n \n \n geometry:\n \n Type: string\n \n Default: none\n Description: The geometry identifier of the block.\n \n \n Type: object\n \n Description: The geometry of the block with bone visbility filters\n \n identifier\n \n Type: string\n \n Default: none\n Description: The geometry identifier of the block.\n \n \n \n \n bone_visibility:\n \n Type: object\n \n Description: An object containing the bone visibility filters for the block.\n \n bone_name:\n \n Type: string\n \n Default: none\n Description: A molang string dictating whether the bone is visible.\n \n \n Type: boolean\n \n Default: none\n Description: Whether the bone is visible.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n light_emission:\n \n Type: integer\n \n Range: 0 to 15\n Default: 0\n Description: The amount of light emitted by the block.\n \n \n \n \n light_dampening:\n \n Type: integer\n \n Range: 0 to 15\n Default: 15\n Description: The amount of light dampened by the block as it passes through.\n \n \n \n \n material_instances:\n \n Type: object\n \n Description: An object containing the material instances for the block.\n \n key:\n \n Type: object\n \n Description: The default material instance for the block. Other globs or specific instances can be used.\n \n texture:\n \n Type: string\n \n Default: the name of the custom block\n Description: The texture resource path of the block.\n \n \n \n \n render_method:\n \n Type: string\n \n Default: alpha_test\n Description: The render method used for the block.\n \n \n \n \n face_dimming:\n \n Type: boolean\n \n Default: false\n Description: Whether face dimming is enabled for the block.\n \n \n \n \n ambient_occlusion:\n \n Type: boolean\n \n Default: false\n Description: Whether ambient occlusion is enabled for the block.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n place_air:\n \n Type: boolean\n \n Default: true\n Description: Whether the block should place air to prevent double placement.\n \n \n \n \n placement_filter:\n \n Type: object\n \n Description: An object containing the placement filter for the block.\n \n conditions:\n \n Type: array\n \n Description: An array of conditions that must be met for the block to be placed.\n \n allowed_faces:\n \n Type: array\n \n Description: An array of faces that the block can be placed on.\n \n items:\n \n Type: string\n \n Range: up, down, north, south, east, west\n Description: A face that the block can be placed on.\n \n \n \n \n block_filter:\n \n Type: array\n \n Description: An array of blocks or true molang queries that the block can be placed on.\n \n items:\n \n Type: string\n \n Description: A block that the block can be placed on.\n \n Type object\n \n Description: Holds a true molang query that the block can be placed on.\n \n tags:\n \n Type: array\n \n Description: A true molang query that the block can be placed on.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n selection_box:\n \n Type: object\n \n origin:\n \n Type: array\n \n Default: Inferred from overridden block\n Description: An array of x, y, and z origin values\n Range: Must be in range [-8, 0, -8] to [8, 16, 8], inclusive\n \n items:\n \n Type: float\n \n Default: Inferred from overridden block\n Description: An origin value for a single axis\n \n \n \n \n \n \n \n \n \n \n size:\n \n Type: array\n \n Default: Inferred from overridden block\n Description: An array of x, y, and z size values\n \n items:\n \n Type: float\n \n Default: Inferred from overridden block\n Description: An size value for a single axis\n \n \n \n \n \n \n \n \n \n \n Range: Addittion of origin and size must be in range [-8, 0, -8] to [8, 16, 8], inclusive.\n \n \n \n \n tags:\n \n Type: array\n \n Description: An array of tags associated with the block.\n \n items:\n \n Type: string\n \n \n \n \n \n \n \n \n transformation:\n \n Type: object\n \n Description: Translation, scale, and rotation values to apply to the block.\n \n scale\n \n Type: array\n \n Default: [1, 1, 1]\n Description: An array of x, y, and z scale values\n \n items:\n \n Type: float\n \n Default: 1\n Description: A scale value for a single axis\n \n \n \n \n \n \n \n \n \n \n translation:\n \n Type: array\n \n Default: [0, 0, 0]\n Description: An array of x, y, and z translation values\n \n items:\n \n Type: float\n \n Default: 0\n Description: A translation value for a single axis\n \n \n \n \n \n \n \n \n \n \n rotation\n \n Type: array\n \n Default: [0, 0, 0]\n Description: An array of x, y, and z rotation values in increments of 90 degrees (e.g. [90, -180, 0])\n \n items:\n \n Type: integer\n \n Range: 0, 90, 180, & 270\n Default: 0\n Description: A rotation value for a single axis\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n unit_cube:\n \n Type: boolean\n \n Default: false\n Description: Whether a unit cube is to be used with tessellation.\n \n \n \n \n creative_category:\n \n Type: string\n \n Default: building_blocks\n Description: The creative category to place the block in.\n Range: See Creative Categories on the Bedrock Wiki.\n \n \n \n \n creative_group:\n \n Type: string\n \n Default: none\n Description: The creative group to place the block in.\n Range: See Creative Tabs on the Bedrock Wiki.\n \n \n \n \n included_in_creative_inventory:\n \n Type: boolean\n \n Default: true\n Description: Whether the block is included in the creative inventory.\n \n \n \n \n only_override_states:\n \n Type: boolean\n \n Default: false\n Description: Whether the block should only override the states specified in state_overrides.\n \n \n \n \n state_overrides:\n \n Type: object\n \n Description: An object containing state overrides for the block.\n \n property1=value1,property2=value2,...:\n \n Type: object\n \n Description: An override for a specific block state. Possible states are listed in Geyser’s Block Mappings\n Accepts all of the same properties as a block definition except creative_category, creative_group, included_in_creative_inventory, only_override_states, and state_overrides.\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n\nGeyser extensions\n\nIn this example, we will create a custom block that overrides the vanilla redstone dot. This block will be placed on top of a block and will emit a visible redstone signal when powered.\n\nFirst, create a class that implements Geyser’s Extension class:\n\npublic class RedstoneDot implements Extension {\n //...\n}\n\n\nNext, create a method to register your blocks in the GeyserDefineCustomBlocksEvent:\n\npublic class RedstoneDot implements Extension {\n @Subscribe\n public void onDefineCustomBlocks(GeyserDefineCustomBlocksEvent event) {\n //...\n }\n}\n\n\nBuild the CustomBlockComponents, CustomBlockData, and list of CustomBlockPermutation (if needed) for the block:\n\npublic class RedstoneDot implements Extension {\n @Subscribe\n public void onDefineCustomBlocks(GeyserDefineCustomBlocksEvent event) {\n BoxComponent selectionBox = new BoxComponent(-5, 0, -5, 10, 1f, 10);\n\n CustomBlockComponents components = CustomBlockComponents.builder()\n .collisionBox(BoxComponent.EMPTY_BOX)\n .selectionBox(selectionBox)\n .geometry(new GeometryComponentBuilder()\n .identifier(\"geometry.amberichu.redstone_dot\")\n .build())\n .destroyTime(0f)\n .lightEmission(0)\n .lightDampening(0)\n .friction(1f)\n .build();\n\n CustomBlockData redstoneDot = CustomBlockData.builder()\n .name(\"redstone_dot\")\n .intProperty(POWER_PROPERTY, IntStream.range(0, 16).boxed().toList())\n .components(components)\n .permutations(createRedstoneDotPermutations())\n .build();\n\n // ...\n }\n\n private List<CustomBlockPermutation> createRedstoneDotPermutations() {\n List<CustomBlockPermutation> permutations = new ArrayList<>();\n for (int power = 0; power < 16; power++) {\n String texture = \"amberichu.redstone_dot\" + power;\n MaterialInstance invisMaterialInstance = MaterialInstance.builder()\n .texture(\"amberichu.invisible\")\n .renderMethod(\"alpha_test\")\n .faceDimming(false)\n .ambientOcclusion(false)\n .build();\n CustomBlockComponents components = CustomBlockComponents.builder()\n .materialInstance(\"up\", MaterialInstance.builder()\n .texture(texture)\n .renderMethod(\"alpha_test\")\n .faceDimming(false)\n .ambientOcclusion(false)\n .build())\n .materialInstance(\"down\", invisMaterialInstance)\n .materialInstance(\"north\", invisMaterialInstance)\n .materialInstance(\"south\", invisMaterialInstance)\n .materialInstance(\"east\", invisMaterialInstance)\n .materialInstance(\"west\", invisMaterialInstance)\n .build();\n String condition = String.format(\"query.block_property('%s') == %d\", POWER_PROPERTY, power);\n permutations.add(new CustomBlockPermutation(components, condition));\n }\n return permutations;\n }\n}\n\n\nFinally, register the custom block, block state overrides, and block item overrides:\n\npublic class RedstoneDot implements Extension {\n @Subscribe\n public void onDefineCustomBlocks(GeyserDefineCustomBlocksEvent event) {\n BoxComponent selectionBox = new BoxComponent(-5, 0, -5, 10, 1f, 10);\n\n CustomBlockComponents components = CustomBlockComponents.builder()\n .collisionBox(BoxComponent.EMPTY_BOX)\n .selectionBox(selectionBox)\n .geometry(new GeometryComponentBuilder()\n .identifier(\"geometry.amberichu.redstone_dot\")\n .build())\n .destroyTime(0f)\n .lightEmission(0)\n .lightDampening(0)\n .friction(1f)\n .build();\n\n CustomBlockData redstoneDot = CustomBlockData.builder()\n .name(\"redstone_dot\")\n .intProperty(POWER_PROPERTY, IntStream.range(0, 16).boxed().toList())\n .components(components)\n .permutations(createRedstoneDotPermutations())\n .build();\n \n event.registerCustomBlock(redstoneDot);\n event.registerBlockItemOverride(\"minecraft:redstone_wire\", redstoneDot);\n\n for (int power = 0; power < 16; power++) {\n String javaIdentifier = String.format(\"minecraft:redstone_wire[east=none,north=none,power=%d,south=none,west=none]\", power);\n event.registerBlockStateOverride(javaIdentifier, redstoneDot.blockStateBuilder()\n .intProperty(POWER_PROPERTY, power)\n .build());\n }\n }\n\n private List<CustomBlockPermutation> createRedstoneDotPermutations() {\n List<CustomBlockPermutation> permutations = new ArrayList<>();\n for (int power = 0; power < 16; power++) {\n String texture = \"amberichu.redstone_dot\" + power;\n MaterialInstance invisMaterialInstance = MaterialInstance.builder()\n .texture(\"amberichu.invisible\")\n .renderMethod(\"alpha_test\")\n .faceDimming(false)\n .ambientOcclusion(false)\n .build();\n CustomBlockComponents components = CustomBlockComponents.builder()\n .materialInstance(\"up\", MaterialInstance.builder()\n .texture(texture)\n .renderMethod(\"alpha_test\")\n .faceDimming(false)\n .ambientOcclusion(false)\n .build())\n .materialInstance(\"down\", invisMaterialInstance)\n .materialInstance(\"north\", invisMaterialInstance)\n .materialInstance(\"south\", invisMaterialInstance)\n .materialInstance(\"east\", invisMaterialInstance)\n .materialInstance(\"west\", invisMaterialInstance)\n .build();\n String condition = String.format(\"query.block_property('%s') == %d\", POWER_PROPERTY, power);\n permutations.add(new CustomBlockPermutation(components, condition));\n }\n return permutations;\n }\n}"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-custom-items": {
|
||
"id": "geyser-custom-items",
|
||
"title": "Custom items with Geyser",
|
||
"url": "/geyser/custom-items/",
|
||
"content": "Custom items with Geyser\n\nTo setup custom items in geyser, you have to choose how you are going to register your items. The easiest is using a json file but you can also use a Geyser extension.\n\nJSON mappings\n\n\n Start your server, and you should have a folder called custom_mappings that is created. That would be with the folder of Geyser.jar file for standalone and inside your Geyser data folder for a plugin.\n Create a .json file, it can be any name you like and as many files as you like. You don’t need to make one file per item. Here is the structure of the file:\n {\n \"format_version\": 1,\n \"items\": {\n\n }\n}\n \n \n Inside the items entry, you can add your java item to extend:\n\n\n\"minecraft:JAVA_ITEM\": [\n\n]\n\n\n Inside this java item, goes an array of all your custom items.\n\n\n{\n \"name\": \"my_item\"\n}\n\n\n Then, you need to set one or more item options or registrations, they can be stacked, so that all of the specified types need to match.\n \n Custom model data: custom_model_data (int)\n Damage predicate: damage_predicate (int) This is a fractional value of damage/max damage and not a number between 0 and 1.\n Unbreakable: unbreakable (boolean)\n \n \n You also have some extra modifiers that you can set to further customise your item. Note that the following modifiers are NOT required.\n \n display_name (string) default: item name\n icon (string) default: item name\n allow_offhand (boolean) default: false\n texture_size (int) default: 16\n render_offsets (object) It works as follows. Note that all the sub-objects are optional, except x, y and z. You can have for example only a main hand with a position, and noting else. default: no render offset\n \"render_offsets\": {\n \"main_hand\": {\n \"first_person\": {\n \"position\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"rotation\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n },\n \"scale\": {\n \"x\": 0,\n \"y\": 0,\n \"z\": 0\n }\n },\n \"third_person\": {\n\n }\n },\n \"off_hand\": {\n\n }\n }\n \n \n \n \n\n\nGeyser extensions\n\nExtending a vanilla item\n\n\n Create your custom item options or registrations, to which you can add any of the following. They can be stacked, so that all of the specified types need to match, but you do NOT need all of them.\n CustomItemOptions itemOptions = CustomItemOptions.builder()\n .customModelData(1)\n .damagePredicate(1) //This is a fractional value of damage/max damage and not a number between 0 and 1.\n .unbreakable(true)\n .build();\n \n \n Create your custom item, and store it somewhere:\n CustomItemData data = CustomItemData.builder()\n .name(\"my_item\")\n .customItemOptions(itemOptions)\n .build();\n \n \n You have some modifiers that you can set to further customise your item. Note that the following modifiers are NOT required.\n .displayName(\"displayName\"); //Default: item name\n.icon(\"my_icon\"); //Default: item name\n.allowOffhand(false); //Default: false\n.textureSize(16); //Default: 16\n.renderOffsets(new CustomRenderOffsets(...)); //Default: no render offset\n \n \n Then, in your pre init event, you can register your item:\n @Subscribe\npublic void onGeyserPreInitializeEvent(GeyserDefineCustomItemsEvent event) {\n event.registerCustomItem(\"minecraft:JAVA_ITEM\", data);\n}\n \n \n\n\nNon vanilla (modded) items with Geyser extensions (for example to use with Fabric)\n\n\n Create your item data:\n NonVanillaCustomItemData data = NonVanillaCustomItemData.builder()\n .name(\"my_item\")\n .identifier(\"my_mod:my_item\")\n .javaId(1)\n \n \n There are many other options you can set to match the behavior that you require for your item. You can see them here\n Register your item in the GeyserDefineCustomItems event:\n @Subscribe\npublic void onGeyserDefineCustomItemsEvent(GeyserDefineCustomItemsEvent event) {\n event.register(data);\n}\n \n \n\n\nResource pack\n\n\n Setup a basic bedrock resource pack. If you need help, you can find it here.\n Make a textures folder.\n Create item_texture.json in the textures, and put this in it:\n\n\n{\n \"resource_pack_name\": \"MY_PACK_NAME_HERE\",\n \"texture_name\": \"atlas.items\",\n \"texture_data\": {\n \n }\n}\n\n\n Inside texture data, you can add your items. The texture name and path must match the name that you set in your mappings.\n\n\n\"my_item\": {\n \"textures\": [\n \"textures/items/my_item\"\n ]\n}\n\n\n Then you need to put your textures inside the textures/items. Make sure to have it match the texture path that you specified in item_texture.json!"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-custom-skulls": {
|
||
"id": "geyser-custom-skulls",
|
||
"title": "Custom skulls with Geyser",
|
||
"url": "/geyser/custom-skulls/",
|
||
"content": "Custom skulls with Geyser\n\nUnlike Java Edition, Bedrock does not have native support for custom skull items. As a result, any method to display custom skulls with Geyser is, to some extent, a workaround. Geyser has long supported in-world custom skulls via the spawning of player entities. This, however, does not allow for the use of custom skulls in inventories, nor does it allow them to be worn by entities. To resolve this, Geyser now allows for the pre-registration of custom skulls via a config file. Geyser will then use this config file to generate a custom resource pack on start that contains the geometry and textures for the pre-registered custom skulls. To the client, these skulls are blocks. Therefore, they can be held in player inventories. In additional, attachables are defined for each skull block so that it is displayed correctly when worn and held by entities.\n\nTo setup custom skulls in geyser, you have to choose how you are going to register your blocks. The easiest is using custom-skulls.yml but you can also use a Geyser extension.\n\nEnabling custom skulls\n\nTo enable custom skulls, you must set add-non-bedrock-items to true in the config.yml file. This will enable the generation of the custom resource pack and the translation of custom skulls to custom blocks. You can then add custom skulls to the custom-skulls.yml file.\n\n# Whether to add any items and blocks which normally does not exist in Bedrock Edition.\n# This should only need to be disabled if using a proxy that does not use the \"transfer packet\" style of server switching.\n# If this is disabled, furnace minecart items will be mapped to hopper minecart items.\n# Geyser's block, item, and skull mappings systems will also be disabled.\n# This option requires a restart of Geyser in order to change its setting.\nadd-non-bedrock-items: true\n\n\ncustom-skulls.yml\n\nThe configuration file custom-skulls.yml is present in Geyser’s configuration folder and is laid out as follows:\n\n# --------------------------------\n# Geyser Custom Skull Configuration Files\n#\n# This file is ignored with `add-custom-skull-blocks` disabled.\n# See `config.yml` for the main set of configuration values\n#\n# Custom skulls with the player username, UUID, or texture specified in this file\n# will be translated as custom blocks and be displayed in the inventory and on entities.\n# --------------------------------\n\n# Java player usernames\n# Skins will be updated when Geyser starts and players will have to re-download\n# the resource pack if any players had changed their skin.\nplayer-usernames:\n - GeyserMC\n\n# Java player UUIDs\n# Skins will be updated when Geyser starts and players will have to re-download\n# the resource pack if any players had changed their skin.\nplayer-uuids:\n - 8b8d8e8f-2759-47c6-acb5-5827de8a72b8\n\n# The long string of characters found in the NBT of custom player heads\nplayer-profiles:\n - ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJBbWJlcmljaHUiLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYTkwNzkwYzU3ZTE4MWVkMTNhZGVkMTRjNDdlZTJmN2M4ZGUzNTMzZTAxN2JhOTU3YWY3YmRmOWRmMWJkZTk0ZiIsCiAgICAgICJtZXRhZGF0YSIgOiB7CiAgICAgICAgIm1vZGVsIiA6ICJzbGltIgogICAgICB9CiAgICB9CiAgfQp9\n\n# The hash of the skin on Minecraft's skin server\nskin-hashes:\n - a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f\n\n\nPlayer usernames\n\nSkulls can be registered in this section via player usernames. These will be updated when Geyser starts. As a result, they may change if the player’s username or skin changes.\n\nPlayer UUIDs\n\nSkulls can be registered in this section via player UUIDs. These will be updated when Geyser starts. As a result, they may change if skin changes.\n\nPlayer profiles\n\nSkulls can be registered in this section via the texture string found in the NBT of custom player heads. Unless the value is changed manually, these will not be updated when Geyser starts. As a result, they will not change if the player’s username or skin changes. The data is simply base64 encoded JSON. For instance, the example given in the config decodes as follows:\n\n{\n \"timestamp\" : 1657322239833,\n \"profileId\" : \"cddbe520d0434a8ba1cc9fc92fde2bcf\",\n \"profileName\" : \"Amberichu\",\n \"textures\" : {\n \"SKIN\" : {\n \"url\" : \"http://textures.minecraft.net/texture/a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f\",\n \"metadata\" : {\n \"model\" : \"slim\"\n }\n }\n }\n}\n\n\nIf on a paper server, this data can be obtained for a skull by holding the item in hand, and running the command /paper dumpitem. This will output the NBT data of the item to chat and console. The texture string is found in the SkullOwner tag, under the Properties tag, under the textures tag, under the Value tag. For example:\n\n[05:58:07 INFO]: .KastleFirefox issued server command: /paper dumpitem\n[05:58:07 INFO]: minecraft:player_head{display: {Name: '{\"text\":\"Test\"}'}, SkullOwner: {Properties: {textures: [{Value: \"ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJkYXZjaG9vIiwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlL2E5MDc5MGM1N2UxODFlZDEzYWRlZDE0YzQ3ZWUyZjdjOGRlMzUzM2UwMTdiYTk1N2FmN2JkZjlkZjFiZGU5NGYiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ\"}]}, Id: [I; -229048314, -553040501, -1407961158, 465313087]}}\n\n\nSkin Hashes\n\nSkulls can be registered in this section via the hash of the skin on Minecraft’s skin server. This is found at the end of the URL. For example, in the URL http://textures.minecraft.net/texture/a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f the hash is a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f.Unless the value is changed manually, these will not be updated when Geyser starts. As a result, they will not change if the player’s username or skin changes.\n\nThis can be obtained by decoding the base64 data obtained from a player profile.\n\nGeyser extensions\n\nIn this example, we will register a custom skull from a player profile. We will use the player profile from the example above.\n\nFirst, create a class that implements Geyser’s Extension class:\n\npublic class RegisterCustomSkull implements Extension {\n //...\n}\n\n\nNext, create a method to register your blocks in the GeyserDefineCustomSkullsEvent:\n\npublic class RegisterCustomSkull implements Extension {\n @Subscribe\n public void onDefineCustomSkulls(GeyserDefineCustomSkullsEvent event) {\n //...\n }\n}\n\n\nFinally, register your skull in the event. Use the enum SkullTextureType to specify that the value being passed is a player profile:\n\npublic class RegisterCustomSkull implements Extension {\n @Subscribe\n public void onDefineCustomSkulls(GeyserDefineCustomSkullsEvent event) {\n String profile = \"ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJkYXZjaG9vIiwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlL2E5MDc5MGM1N2UxODFlZDEzYWRlZDE0YzQ3ZWUyZjdjOGRlMzUzM2UwMTdiYTk1N2FmN2JkZjlkZjFiZGU5NGYiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ\"\n event.registerCustomSkull(profile, SkullTextureType.PROFILE);\n }\n}\n\n\nScraping custom skulls from a world\n\nCustom skulls can be extracted from an existing world for easy implementation via mappings or API using the tool HeadExtractor made by Amberichu. See the linked repository for usage instructions."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-events": {
|
||
"id": "geyser-events",
|
||
"title": "Geyser Events",
|
||
"url": "/geyser/events/",
|
||
"content": "Geyser Events\nGeyser has a powerful event system that allows you to listen to events that are sent by Geyser. Events are at the heart of Geyser Extensions, and can be used by plugins and mods as well.\n\nFull documentation can be found here.\n\nEvent Categories\nTo use events in a Spigot/Paper plugin or a Fabric mod, you need to register the Geyser Event Bus as a listener and then subscribe to the events you want to listen to.\nExtensions can use the @Subscribe annotation.\n\nEvents are categorized into the following categories:\n\n Bedrock: Events that are sent for each connecting Bedrock client,\nfor example the ClientEmoteEvent that is sent when a Bedrock player uses an emote - or the SessionLoginEvent that is sent when a Bedrock player logged in and is about to join a server.\n Java: Events that are sent for the java server, for example\nthe ServerDefineCommandsEvent - it is fired when the Java sends the commands to show for Bedrock players.\n Connection: Connection-related events, such as a ping event to return e.g. a custom MOTD.\n Lifecycle: Events that are sent during Geyser’s lifecycle, such as the loading of custom items, resource packs, or Geyser commands.\n\n\nTo see all the events in the respective categories, click on the links above.\n\nUsage Examples:\n\nEach method that you want to subscribe to an event needs to be annotated with the @Subscribe annotation (from the GeyserMC events package).\n@Subscribe\npublic void onGeyserLoadResourcePacksEvent(GeyserLoadResourcePacksEvent event) {\n logger().info(\"Loading: \" + event.resourcePacks().size() + \" resource packs.\");\n // you could add a resource pack with event.resourcePacks().add(path-to-pack)\n}\n\nIf you wish to listen to events in a Spigot/Paper plugin or a Fabric mod, you need to register the Geyser Event Bus as a listener first. Just make sure you implement EventRegistrar in the main class of your mod or plugin.\nExtensions do not need to do that - they are automatically registered, so a simple @Subscribe annotation is enough.\n\nFabric mod example:\npublic class ExampleMod implements ModInitializer, EventRegistrar {\n public static final Logger LOGGER = LoggerFactory.getLogger(\"modid\");\n \n @Override \n public void onInitialize() {\n ServerLifecycleEvents.SERVER_STARTING.register((server) -> {\n GeyserApi.api().eventBus().register(this, ExampleMod.class); // register your mod & this class as a listener\n });\n \n LOGGER.info(\"Geyser is cool!\");\n }\n \n // here an event, we subscribe as usual with the @Subscribe annotation\n @Subscribe \n public void onGeyserPostInitializeEvent(GeyserPostInitializeEvent eventad {\n LOGGER.info(\"Geyser started!\");\n }\n}\n\n\n Do note: We cannot directly register the event bus in the mod initializer, since the Geyser API would not be loaded yet.\n\n\nTherefore, we register it in the server starting event provided by the Fabric API.\n\nPaper/Spigot plugin example:\n\n\n In your plugin.yml, add the following lines:\n depend: [\"Geyser-Spigot\"]\n \n This ensures that your plugin loads after Geyser has, so the Geyser API would be available.\n \n In your main class, implement the EventRegistrar interface and register the event bus in the onEnable method:\n public class ExamplePlugin extends JavaPlugin implements EventRegistrar {\n \n @Override\n public void onEnable(){\n getLogger().info(\"Registering Geyser event bus!\");\n GeyserApi.api().eventBus().register(this, this); // register your plugin & this class as a listener\n }\n\n // here an event, we subscribe as usual with the @Subscribe annotation\n @Subscribe\n public void onGeyserPostInitializeEvent(GeyserPostInitializeEvent event) {\n getLogger().info(\"Geyser started!\");\n }\n}\n \n \n If you want to provide your event with a consumer, rather than annotating it, you can also manually subscribe your method to the event bus:\n // replace GeyserEvent.class with the event class you want to listen to\nGeyserApi.api().eventBus().subscribe(this, GeyserEvent.class, this::yourMethod);\n \n \n\n\nEvent Priority\nEvents can have a priority, which is used to determine the order in which the listeners are called. The default priority is NORMAL.\nTo (optionally) set the priority of your event listener, you can add the priority to the @Subscribe annotation:\n@Subscribe(postOrder = PostOrder.EARLY)\n\nIf you do not specify a priority, the default priority is used. For all available priorities, see\nhere."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-extensions": {
|
||
"id": "geyser-extensions",
|
||
"title": "Geyser Extensions",
|
||
"url": "/geyser/extensions/",
|
||
"content": "Geyser Extensions\nGeyser Extensions are the equivalent of “plugins”, but specifically for the Geyser platform. This brings the advantage of them being platform-agnostic, meaning that you won’t have to worry about supporting all platforms individually. Additionally, they will be, by design, only applied for Bedrock players joining via Geyser.\n\nWhat can Geyser Extensions do?\nExtensions can fully utilize the Geyser API to add additional functionality to Geyser. See Geyser API docs for info on what is currently possible. To name a few examples:\n\n Register custom items and blocks\n Hide commands from being suggested\n Change the MOTD\n Register your own commands\n Listen to events, e.g. the emote event.\n\n\nThe underlying Geyser API is steadily expanding, creating more and more opportunities.\n\nWhich Geyser Extensions exist?\nAt the moment, extensions are still a new system, so there is only a small list of known extensions for Geyser. However, new extensions are always being created!\nThere is an official list of available extensions you can check out. If you have an extension you’d like to see on this list, feel free to open a PR!\n\nInstalling Extensions\nTo install an extension, simply put the extension .jar file into Geyser’s ‘extensions’ folder. Then, restart Geyser (or the server Geyser runs on).\n\nCreating Geyser Extensions\nThe easiest way to create an extension would be utilizing this official template. Simply create a new repository from the template, customize the ‘extension.yml’ & ‘settings.gradle’ files, and get started making the extension.\n\nGeyser recognizes extensions when they have a file called ‘extension.yml’ in the jars ‘resources’ folder.\n\nextension.yml:\nid: exampleid\nname: ExampleExtension\nmain: org.geyser.extension.exampleid.ExampleExtension\napi: 1.0.0\nversion: 1.0.0\nauthors: [ExampleAuthor]\n\n\nExplanations for the individual fields:\n\n id: The id of the extension. Every extension needs to have their unique id - all lowercase letters. If you e.g. register a command for your extension, it will have the id as a prefix: e.g. ‘/exampleid command’.\n name: The name of the extension.\n main: The main class of your extension.\n api: The Base API version your extension targets.\n authors: The author(s) of the extension. To add more than one entry, separate entries with a comma.\n\n\nCreating the main class\n\nThe main class, the entrypoint for the extension, needs to implement the ‘Extension’ interface provided by Geyser. \nThat way, Geyser recognizes the extension, and gives you access to important methods - such as ‘logger()’, to get your extensions logger. \nTo see all the methods provided by that interface, see here.\n\nUnlike plugins, extensions do not have a ‘onEnable’ or ‘onDisable’ method. Instead, most actions are done in events at different stages during Geyser’s lifecycle using events.\nSome important ones are:\n\n GeyserPreInitializeEvent: This event is fired when Geyser starts to initialize. If you e.g. need to register extension commands that are configured in your config, \nyou would need to load the config here to ensure that your config is ready before the GeyserDefineCommandsEvent is fired.\n GeyserPostInitializeEvent: It is called when Geyser has completed initializing. The bulk of your code should go here, as the GeyserAPI is fully available at this stage.\n GeyserShutdownEvent: Called when Geyser is shutting down. You can use this to e.g. save data, or clean up resources.\n\n\nSee below for an example:\n@Subscribe\npublic void onPostInitialize(GeyserPostInitializeEvent event) {\n // example: show that your extension is loading.\n this.logger().info(\"Loading example extension...\");\n}\n\nIf you wish to register custom items, global resource packs (or soon, custom blocks and entities), you will need to subscribe to the event using the @Subscribe annotation,\nand register them in the event. You can find an example for custom items here. For other events, see here for documentation.\n\nTo build your extension, run the Gradle build task, and install the extension.\n\nCreating commands with Geyser Extensions\nTo create a command, you would need to use the “Commands” package in the Geyser API. Brief rundown:\n\n Command.java\nThis interface represents a command in Geyser - to make one, you can use the CommandBuilder. You can register it with the\nGeyserDefineCommandsEvent\n CommandExecutor.java\nThis interface represents a command execute handler in Geyser, and extends the CommandSource interface.\n CommandSource.java\nThis interface represents a command source in Geyser. It can be used to e.g. send messages to the source, check if the source has permission to execute a command, or get the locale.\n\n\nCommand command = Command.builder(this) // \"this\" is the extension's main class\n .name(\"ExampleCommand\")\n .bedrockOnly(true)\n .source(CommandSource.class)\n .aliases(List.of(\"example\", \"ex\"))\n .description(\"An example command\")\n .executableOnConsole(false) \n .suggestedOpOnly(false)\n .permission(\"example.command\")\n .executor((source, cmd, args) -> {\n // this is the command executor - this is where you would put your code to execute the command.\n // source is the source that executed the command\n // cmd is the command that was executed\n // args are the arguments passed to the command\n source.sendMessage(\"Hello World\");\n })\n .build();\n\n\nTo register the command, you would need to subscribe to the GeyserDefineCommandsEvent, and register the command there:\n@Subscribe\npublic void onDefineCommands(GeyserDefineCommandsEvent event) {\n event.register(command);\n}\n\nIf everything went right, you should be able to execute the command in-game by running “/extesionid [command]” - in our case, “/exampleid examplecommand”.\nHere, it would send “Hello World” to the source that ran the command.\nSince we also set aliases, you could also run “/exampleid example” or “/exampleid ex” for the same command.\nTo provide args, simple run “/exampleid examplecommand [args]” - replacing [args] with the arguments you want to pass to the command.\n\nListening to Events\nSee here for documentation. You do not need to register the event listener, Geyser will do that for you.\n\n\n\nFacing troubles with extensions?\n\n Make sure you are using the latest version of Geyser - older versions might not have the latest API changes.\n Add debug prints.\n Ask in the #development channel in the Geyser Discord server."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-faq": {
|
||
"id": "geyser-faq",
|
||
"title": "FAQ",
|
||
"url": "/geyser/faq/",
|
||
"content": "Frequently Asked Questions\nHere you can find answers to frequently asked questions about Geyser - if you have a question that isn’t answered here, feel free to ask in our Discord!\n\n\n \n \n \n \n \n How Does it Work?\n \n \n \n \n Geyser works as a translator, translating both the incoming and outgoing packets to a format both the client and server can understand. With this being said, it emulates a Minecraft: Java Edition client, so the server actually thinks you’re joining from Java Edition. Regardless of the server or what plugins it has installed, you can join it with Geyser (as long as the server supports the latest vanilla (unmodified) Minecraft version).\n\n \n \n \n \n \n \n \n \n So, how does Redstone work?\n \n \n \n \n Redstone, along with any other mechanics like commands, farms, etc., will work exactly like Java Edition since joining a Java Edition server and Geyser does not modify server behavior.\n\n \n \n \n \n \n \n \n \n Is Geyser paid?\n \n \n \n \n No, Geyser and all related projects are completely free and open-source, licensed under the MIT license.\n\n \n \n \n \n \n \n \n \n What plugins don't work with Geyser?\n \n \n \n \n Geyser should generally work fine with plugins, as we emulate a Java client. There are exceptions, though:\n\n\n TCPShield requires only-allow-proxy-connections disabled without a paid plan. However, their “Premium” plan will allow the support of Geyser - please see here for setup instructions.\n\n\nFloodgate 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.\n\n\n DynamicBungeeAuth Currently working on latest version 10.28B+ (10.27B and older versions produces invalid credentials for Bedrock players)\n FastLogin does not let floodgate add player prefix.\n ExploitFixer thinks that Floodgate users are UUID spoofing - disable the uuidspoof setting in ExploitFixer’s config.\n JPremium alters the UUID of a player, causing Floodgate not to be able to get the Bedrock data from its map.\n LibHatesMods causes authentication to fail with com.github.steveice10.mc.auth.exception.request.InvalidCredentialsException\n ProtocolSupport is currently incompatible with Floodgate. Works with Floodgate, but we recommend using ViaBackwards instead.\n ProtocolSupportBungee changes how the login process works and therefore breaks the Floodgate injection code.\n SayNoToMcLeaks prevents Floodgate from finishing its login system.\n\n\nIf you come across any more, please let us know via Discord.\n\n \n \n \n \n \n \n \n \n What server versions does Geyser support?\n \n \n \n \n The Geyser-Spigot plugin supports any Minecraft server version 1.13.2 or later. Any earlier version is not supported by the plugin - use a proxy version or the standalone build instead.\nSince Geyser emulates a {{ site.data.versions.java }} Java Edition client, you need to install ViaVersion on your server\nif it is not running the latest version of Minecraft. \n\nIn order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the chat signing page. \n\nYou will also need to run at least Java 16 or later to use Geyser. See here for more info on updating Java.\nPaper versions not supporting Java 16 can add -DPaper.IgnoreJavaVersion=true flag to the Java startup arguments to allow Paper to run on Java 16.\n\n \n \n \n \n \n \n \n \n Which plugin version of Geyser do I need?\n \n \n \n \n This is a non-complete list of what platform each plugin version of Geyser is for, and the standalone version can be used for any as it isn’t a plugin.\n\n Geyser-Spigot works with:\n \n Spigot\n Paper (recommended)\n Any other forks of the above\n \n \n Geyser-Bungee works with:\n \n BungeeCord\n Waterfall\n Any other forks of the above\n \n \n Geyser-Velocity works with Velocity\n Geyser-Fabric works with Fabric, and requires FabricAPI to be installed on the server as well.\n\n\n \n \n \n \n \n \n \n \n Which type of Geyser version is better, standalone or plugin?\n \n \n \n \n Because of optimizations that hook into the plugin platforms, plugin versions of Geyser are preferable compared to standalone Geyser. On Spigot, Velocity, and BungeeCord versions of Geyser, direct connections allow for faster loading times, lower latency, and accurate IP addresses without requiring Floodgate. Geyser-Spigot has further optimizations due to having direct world access, including lower memory usage and greater translation accuracy. However, large server networks might prefer standalone Geyser because it can be updated without needing to restart any other proxies or servers, and can offload resource usage onto seperate machines.\n\n \n \n \n \n \n \n \n \n If using BungeeCord or another fork, where do I need to put Geyser/Floodgate?\n \n \n \n \n You only need Geyser and/or Floodgate on the BungeeCord server, as long as not using the Floodgate API. In this case, Floodgate is needed on the “backend” servers as well.\n\n \n \n \n \n \n \n \n \n What IP do I need to give Bedrock players?\n \n \n \n \n Generally, the IP that Bedrock players will join with is your Java IP and the defined port in your Geyser config in the bedrock section under port. For example, if the IP address Java players join with is test.geysermc.org, and the bedrock port is set as 19132, Bedrock players should join with the IP test.geysermc.org and port 19132.\n\n \n \n \n \n \n \n \n \n How can I have Bedrock players load resource packs?\n \n \n \n \n You can add Bedrock resource packs to your Geyser installation in the packs folder of wherever the Geyser config is located. Bedrock clients will automatically download and load those resource packs. There is currently no automatic Java-to-Bedrock resource pack conversion, but you can convert any Java resource pack to Bedrock using this tool and add that to your server. The converter currently only works with packs up until 1.17; you will need to use another converter, or, convert the pack yourself.\n\n \n \n \n \n \n \n \n \n How can Bedrock players hold items in their offhand?\n \n \n \n \n You can use the command /geyser offhand, which will swap the item in their main hand and offhand. There is also a setting you can enable in the config (emote-offhand-workaround) to allow Bedrock players to perform an emote in order to switch their main hand and offhand.\n\n \n \n \n \n \n \n \n \n How do I include players in commands when using Floodgate?\n \n \n \n \n If there is a prefix on Floodgate players, you must include the prefix in the name. Floodgate also replaces all spaces in names with underscores, so be sure to replace any spaces with underscores when executing the command. If this does not work, put double quotes around the name.\n\nExample: /tp \".<bedrock_username>\"\n\n \n \n \n \n \n \n \n \n How do I add players to the whitelist when using Floodgate?\n \n \n \n \n There are three ways you can do this.\n\n\n \n Use Floodgate’s built-in whitelist command: /fwhitelist add <bedrock_username>. This will only work if the player has joined any Geyser server already.\n \n \n Turn off the whitelist using /whitelist off, then get the Geyser player to join. After that, run /whitelist add \".<bedrock_username>\", and finally, turn the whitelist back on using /whitelist on. \nWhen using Local Linking: If you’re linking a Bedrock account to an existing whitelisted Java account, you don’t need to whitelist the Bedrock account separately. You can link the accounts and immediately turn the whitelist back on.\n \n \n Add the player’s UUID, as given by Floodgate, to the whitelist.json file. Then, run /whitelist reload to update the whitelist.\n \n\n\nChoose the method that suits your preferences and server setup.\n\n \n \n \n \n \n \n \n \n How do I find a player's UUID without them joining when using Floodgate?\n \n \n \n \n Use this page. If this doesn’t work, then try this method:\n\nFirst, 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, 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.\n\n \n \n \n \n \n \n \n \n Can I remove the prefix of Floodgate players?\n \n \n \n \n While you can remove the prefix, it is generally recommended not to remove the prefix to prevent situations where player usernames are the same on both editions (Ex: Bedrock Username: JohnDoe, Java Username: JohnDoe). While they have different UUIDs, they have the same username, which may cause conflicts with commands that involve a player name. If you want to remove the prefix to use commands, Try adding quotation marks around the name. Example: /tp \".<bedrock_username>\" Otherwise, the prefix is located in the Floodgate config.yml under username-prefix:.\n\n \n \n \n \n \n \n \n \n Do I need Floodgate in order to use Geyser?\n \n \n \n \n No; Floodgate is only required if you wish to allow Bedrock clients to join without authenticating to Java servers. Without the Floodgate plugin, Geyser can either authenticate to Mojang in online mode, or join without authentication in an offline mode server (though this is unsupportable and dangerous as anyone can join your server and is against Mojang’s EULA).\n\n \n \n \n \n \n \n \n \n Sometimes, when I go really far out, the world starts to experience very odd visual bugs...\n \n \n \n \n This is a Bedrock client issue caused by Bedrock being 32-bit and Java being 64-bit. For more information read here.\n\n \n \n \n \n \n \n \n \n Can I use Geyser to allow Java players to connect to my Bedrock server?\n \n \n \n \n No, this is a translation tool to allow Bedrock players to connect to Java servers. It does not work the opposite way.\n\n \n \n \n \n \n \n \n \n Can I use Geyser with Pterodactyl Panel?\n \n \n \n \n Yes, you can use Geyser as a plugin or a mod for your Minecraft server software running on Pterodactyl. There is also an official egg for the standalone version. It supports auto-updating and has all config options easily editable. You can find it here, download the JSON egg, and import it into your panel. Make sure the Geyser port (using UDP) is exported out to the host & allocated the port to the server.\n\n \n \n \n \n \n \n \n \n Can I use Geyser with Ngrok?\n \n \n \n \n Unfortunately, Ngrok is TCP-only, so you will not be able to use Geyser with Ngrok. As an alternative, you can use playit.gg, which supports both TCP and UDP.\n\n \n \n \n \n \n \n \n \n How do I setup Cosmic Guard?\n \n \n \n \n \n You will need access to the host systems terminal. Note: This guide is for Linux systems only!\n Setup a “Guard” select gaming then Minecraft: Bedrock edition.\n Click setup for linux and run the guardian installer and start the service.\n Run “guardian status” and take note of the “Local IP” it starts with “10.31.x.x”.\n Go to the Geyser config.yml and update the Bedrock address to the Local IP which you found above.\n Restart the mc server and test it out, it should work for both Java and Bedrock.\n\n\n \n \n \n \n \n \n \n \n Can I connect Geyser to an older server?\n \n \n \n \n If the server has ViaVersion and/or supports the latest Minecraft version, yes. However, we are unable to support older versions of Minecraft due to a limitation in our Java support library.\n\n \n \n \n \n \n \n \n \n Can I connect Geyser to a modded (Forge/Fabric) server?\n \n \n \n \n The short answer: if a vanilla client can join the server, then so can Geyser.\n\nThe long answer: currently, there is no way for Geyser to translate the features that most mods add (blocks, items, etc.). Therefore, servers that require mods to be installed clientside are unsupportable through Geyser.\n\n \n \n \n \n \n \n \n \n How can I auto-update Geyser?\n \n \n \n \n GeyserUpdater (GitHub page/Spigot page) 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.\n\n \n \n \n \n \n \n \n \n How can I make DiscordSRV show Floodgate 2.0 or GeyserSkinManager skins?\n \n \n \n \n Replace the AvatarUrl line in your DiscordSRV config with this: AvatarUrl: https://mc-heads.net/avatar/{texture}/{size}.png\n\nNote: you need to be running DiscordSRV v1.22.0 or newer. Floodgate 2.0 or GeyserSkinRestorer is still required for skins to show up for Java players and for this to work.\n\nAlternatively, if you cannot get the above AvatarUrl to work with DiscordSRV, or you’d like to use it with another plugin that does not support texture ids, you can use the TydiumCraft Skin API.\n\n \n \n \n \n \n \n \n \n Can I use Buycraft (Tebex) with Geyser?\n \n \n \n \n You sure can! Buycraft supports Java & Bedrock players via the Offline store mode (Recommended to be used with Floodgate)\n\n(Currently, Buycraft does not support special symbols like * or -, so you’ll have to change the Floodgate prefix to _ or remove it entirely.)\nSteps to create a store to support both versions\n\n Buycraft-> Create Webstore\n Select Game-> Minecraft Offline\n Continue-> Click “Create my Webstore”\n Name your server & Select currency-> Continue\n Select Game Server-> Continue\n Download the plugin version that best suits your server.\n Execute the secret command from your server’s console\n\n\nYour store is now set up to support Bedrock & Java players.\n\n(Please note, if you are using a prefix with Floodgate, Bedrock players will have to enter the prefix.)\n\n \n \n \n \n \n \n \n \n Can I use CraftingStore with Geyser?\n \n \n \n \n You sure can! Buycraft supports Java & Bedrock players via the Offline store mode (Recommended to be used with Floodgate)\n\n(Currently, Buycraft does not support special symbols like * or -, so you’ll have to change the Floodgate prefix to _ or remove it entirely.)\nSteps to create a store to support both versions\n\n Buycraft-> Create Webstore\n Select Game-> Minecraft Offline\n Continue-> Click “Create my Webstore”\n Name your server & Select currency-> Continue\n Select Game Server-> Continue\n Download the plugin version that best suits your server.\n Execute the secret command from your server’s console\n\n\nYour store is now set up to support Bedrock & Java players.\n\n(Please note, if you are using a prefix with Floodgate, Bedrock players will have to enter the prefix.)\n\n \n \n \n \n \n \n \n \n What languages does Geyser support?\n \n \n \n \n We aim to support any of the bedrock languages; see here for our Crowdin page, and below is a list of all the language codes. We also can add support for more languages, and please request them in the Discord server if you are willing to translate them. (Enabled clientside via https://www.curseforge.com/minecraft/mc-addons/translations-for-minecraft)\n\nBedrock languages\n\n\n \n \n Name\n Code\n \n \n \n \n Bulgarian\n bg_bg\n \n \n Czech\n cs_cz\n \n \n Danish\n da_dk\n \n \n German\n de_de\n \n \n Greek\n el_gr\n \n \n British English\n en_gb\n \n \n American English\n en_us\n \n \n Spanish\n es_es\n \n \n Mexican Spanish\n es_mx\n \n \n Finnish\n fi_fi\n \n \n Canadian French\n fr_ca\n \n \n French\n fr_fr\n \n \n Hungarian\n hu_hu\n \n \n Indonesian\n id_id\n \n \n Italian\n it_it\n \n \n Japanese\n ja_jp\n \n \n Korean\n ko_kr\n \n \n Dutch\n nl_nl\n \n \n Norwegian Bokmål\n nb_no\n \n \n Polish\n pl_pl\n \n \n Brazilian Portuguese\n pt_br\n \n \n Portuguese\n pt_pt\n \n \n Russian\n ru_ru\n \n \n Slovak\n sk_sk\n \n \n Swedish\n sv_se\n \n \n Turkish\n tr_tr\n \n \n Ukrainian\n uk_ua\n \n \n Chinese Simplified (China)\n zh_cn\n \n \n Chinese Traditional (Taiwan)\n zh_tw\n \n \n\n\nAdditional languages\n\n\n \n \n Name\n Code\n \n \n \n \n Afrikaans\n af_za\n \n \n Belarusian\n be_by\n \n \n Hebrew\n he_il\n \n \n Hindi\n hi_in\n \n \n\n\n \n \n \n \n \n \n \n \n Adding custom Geyser translation overrides\n \n \n \n \n Please note that you cannot add strings that work in Minecraft formatting - these strings are only for places where Geyser uses them.\n\nTo start, create a languages folder in the same directory as the Geyser config file.\nInside of it, you’ll need to add a file with your desired locale ending in .properties. You can see\nhere for the locale files that Geyser uses - \nyou can download these as a starting point, or you can just add the strings you want to overwrite.\n\nYou must restart Geyser for the changes to apply.\n\n \n \n \n \n \n\nQuestions not related to gameplay\n\n\n \n \n \n \n \n What is the relationship between CubeCraft and Geyser?\n \n \n \n \n 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.\n\n \n \n \n \n \n \n \n \n Does CubeCraft use Geyser?\n \n \n \n \n No"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-fixing-unable-to-connect-to-world": {
|
||
"id": "geyser-fixing-unable-to-connect-to-world",
|
||
"title": "Fixing 'Unable to Connect to World'",
|
||
"url": "/geyser/fixing-unable-to-connect-to-world/",
|
||
"content": "Fixing ‘Unable to Connect to World’ errors\nThis is by far the most common error people get when attempting to set up Geyser. Here’s some steps on how to solve it.\nUsually, this error is caused by improper configuration of Geyser, or issues with your network.\n\n\n\tIf you are using a Minecraft server hosting provider (e.g. Aternos, or Apex Hosting), you should refer to the hosting provider setup instructions on \nthe setup page. Following these will most likely resolve the issue!\n\n\nIf you are not using a Minecraft server hosting provider, carry on.\n\n\n\tTo check if your server is (theoretically) reachable on Bedrock edition, try running the following command in your server console:\n geyser connectiontest <ip>:<port>, and see what it suggests to try.\n\n\nJava Edition players can’t connect!\n\nThis should not be a Geyser problem. Geyser does not modify server behavior. Floodgate does modify the login structure, but only for Bedrock players. \nContact your hosting provider or look elsewhere for fixing this connection issue.\n\nConnecting fails after updating Geyser\n\nIf this occurred after updating a plugin version of Geyser, ensure that you shut off your server, swapped the Geyser jar, and then started up your server. \nIncase you reset your configuration file, check out the setup guide again.\n\nThere are errors in my console!\n\nPlease read through the common issues page. If there is another error not documented there, join us on our Discord.\n\nTry restarting the server and game\n\nEspecially on mobile devices, sometimes just restarting Minecraft fixes the issue.\n\nIs it the server or the client?\n\nRun your Java server IP and Bedrock address here: https://mcsrvstat.us/. It’s a great way of determining if the server is reachable in the first place. \nAdditionally, check if you can see a connection attempt in the server console. If you can’t, it’s likely a network issue.\n\nFor console players specifically: If only they can’t join, while other Bedrock players can, it is likely an issue with their console connecting method.\n\nGeneral troubleshooting steps\n\nEnsure you’re connecting on the right IP and Port\n\nYou should be connecting with the Java server IP and the Bedrock port (set in the Geyser config). If you port forwarded 19132, for example, you should specify port 19132 when connecting from Bedrock.\n\nI’m using a hosting provider or VPS!\n\nPlease read this page on supported hosting providers to see if there are extra configuration steps required for your hosting or server provider.\nSome VPS/KVM providers may require further setup, such as OVH, SoYouStart, and Oracle Cloud. Please read this note for more information.\n\nIssues using Docker or Pterodactyl\nMake sure you assign the port to pterodactyl, and on docker, to the docker compose file. See our port-forwarding page for fixes.\n\nPort forwarding issues\n\nYour server does need to be port forwarded to allow connections from outside the local network. See our port-forwarding guide for more information.\n\nUsing TCP in DNS options/port forwarding instead of UDP\n\nMinecraft: Java Edition uses TCP for connecting; Minecraft: Bedrock Edition uses UDP. Port forwarding your Bedrock Edition port with only TCP will not work, it has to be UDP. Forwarding your Bedrock Edition port with TCP/UDP (both protocols) should also work but is not recommended unless Java Edition and Bedrock Edition is sharing the same port.\n\nBedrock port is less than 10000\n\nHistorically, having a Bedrock port that is a lower number will cause issues. Setting it to 10000 or above seems safe.\n\nBedrock players can connect after hitting the server on a TCP port (e.g. on Java or a website on the same server), OR only people who also play on Java Edition can join from Geyser\n\nThis is likely a firewall issue on your server. Try the following workaround:\nAttempt to connect to the Bedrock IP and port through a web browser - for example, http://test.geysermc.org:19132. It won’t work, but then try connecting through Bedrock, and it should work.\n\nSpecific host fixes for OVH/SoYouStart can be found here.\n\nChanging the bedrock address in the Geyser config.\n\nExcept for a few specific hosting providers, you generally do not need to change this part of the Geyser config. \nHowever, in rare instances, it does fix issues - for example, when Windows has multiple network adapters (check by running ipconfig in cmd), \nit can help to set the address to the local IP of the adapter you want to use.\n\nUsing a hosting provider or other location\n\nPterodactyl\n\nIf you get this error while using the Pterodactyl Panel, try editing the Geyser config and changing the port to something besides 19132 (e.g. 25566).\n\nHosting Geyser on another computer on the same network\n\nCan only connect from the same computer and not anywhere else\n\nYour firewall is likely in the way. Try adding an exception to Java, or disable the firewall for testing purposes.\n\nAs a last resort for troubleshooting…\n\nMinecraft offers a vanilla Bedrock server here. Downloading, running, and attempting to connect to it may help isolate if the issue is on Geyser’s end, or your computer/network’s end.\n\nUsing Geyser on the same computer\n\nWindows 10/11\n\nThis only affects people trying to join Geyser from Windows 10/11 Edition with Geyser hosted on the same computer.\n\nThis is an issue caused by Loopback restrictions not being lifted. By default, Microsoft Apps have this restriction on all their apps for local connections. Geyser will attempt to resolve this automatically; however, if you’re still having connection problems, you can lift it by typing the following in Windows PowerShell in administrator mode: (it should return OK. if it worked)\nCheckNetIsolation LoopbackExempt -a -n=\"Microsoft.MinecraftUWP_8wekyb3d8bbwe\"\n\n\nShould this not work, you can try this set of steps:\n\n\n Hold down Windows Key + R\n In the prompt, type hdwwiz.exe, then press Enter then Next\n Install the Hardware Manually\n Choose Network Adapter > Next > Microsoft > “Microsoft KM-TEST Loopback Adapter” then hit Next until it’s done."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-forms": {
|
||
"id": "geyser-forms",
|
||
"title": "Forms and Cumulus",
|
||
"url": "/geyser/forms/",
|
||
"content": "What is Cumulus?\n\nBedrock Edition has a cool exclusive feature called Forms.\nCumulus is the Forms API that we use in Geyser and Floodgate.\nThe source code is available here. You can access the Cumulus API through the Floodgate API, or the Geyser API.\n\nBedrock knows three types of Forms:\n\n ModalForm\n SimpleForm\n CustomForm\n\n\nWe’ll discuss them one by one starting with the easiest and ending with the least easy form type.\nAfter that, you get an overview of every single component.\nThen we’ll talk about sending the form, receiving a response and doing advanced stuff.\n\nModalForm\n\nWhile this is the easiest form type it’s also the least customisable.\nYou have a title, description (content) and two buttons.\n\n\n\nCode used in the image:\n\nModalForm.builder()\n .title(\"Title\")\n .content(\"Content\")\n .button1(\"Button 1\")\n .button2(\"Button 2\")\n\n\nSimpleForm\n\nWhile this one is less easy than ModalForm is, it also has more customizability.\nIt’s still limited to a title, content and buttons, but these buttons can also have images and do not have a minimum and maximum of two.\n\n\n\nCode used in the image:\nSimpleForm.builder()\n .title(\"Title\")\n .content(\"Content\")\n .button(\"Button without an image\")\n .button(\"Button with URL image\", FormImage.Type.URL, \"https://github.com/GeyserMC.png?size=200\")\n .button(\"Button with path image\", FormImage.Type.PATH, \"textures/i/glyph_world_template.png\")\n\n\nCustomForm\n\nWhile the CustomForm is the last one on our list (and thus the least easy one), it also has the greatest customizability.\nThis form exists of a title, content and a list of different components e.g. label, slider and input.\nSee Components for more information about every component you can use and in which form type.\n\n\n\nCode used in the image:\n\nCustomForm.builder()\n .title(\"Title\")\n .dropdown(\"Text\", \"Option 1\", \"Option 2\")\n .input(\"Input\", \"placeholder\")\n .toggle(\"Toggle\")\n .slider(\"Text\", 0, 10, 1, 5)\n\n\nSending a form\n\nAfter you decided which form type you want to use and finished filling in the actual content, it’s time to send the Form to the Bedrock player.\nYou can do that by calling the API and send a form to the player’s UUID and the form:\nFloodgateApi.getInstance().sendForm(uuid, form); // or #sendForm(uuid, formBuilder)\n\nOr you can do it by using the Player’s FloodgatePlayer instance:\nFloodgatePlayer player = FloodgateApi.getInstance().getPlayer(uuid);\nplayer.sendForm(form); // or #sendForm(formBuilder)\n\nSo you can make and send forms in a pretty compact way by doing something like this:\nFloodgatePlayer player = FloodgateApi.getInstance().getPlayer(uuid);\n...\nplayer.sendForm(\n CustomForm.builder()\n .title(\"My cool title\")\n .label(\"10/10 content\")\n);\n\n\nReceiving a response from the client\n\nIt’s nice and all that we can send forms to a client, but we also want to be able to get a response from a client and being able to handle them.\nWe can do that using one (or multiple) result handers. The most used result handlers are: validResultHandler(BiConsumer<Form, ValidFormResponseResult> | Consumer<ValidFormResponseResult>), invalidResultHandler, closedResultHandler and closedOrInvalidResultHandler.\nHere follows an example that uses result handlers:\nCustomForm.builder()\n .title(\"geyser.auth.login.form.details.title\")\n .label(\"geyser.auth.login.form.details.desc\")\n .input(\"geyser.auth.login.form.details.email\", \"account@geysermc.org\", \"\")\n .input(\"geyser.auth.login.form.details.pass\", \"123456\", \"\")\n .closedOrInvalidResultHandler(() -> buildAndShowLoginDetailsWindow(session))\n .validResultHandler(response -> session.authenticate(response.next(), response.next())));\n\n\nAdvanced stuff\n\nThe FormBuilder also has support for translating the data used in the builder.\nTo add a translator, you can use the translator(BiFunction<String, String, String>) or the translator(BiFunction<String, String, String>, String) method:\nModalForm form = ModalForm.builder()\n .translator(this::translate, userLanguage)\n .title(\"Title\")\n .content(\"Content\")\n .button1(\"translate.button1\")\n .button2(\"translate.button2\")\n .build();\n\npublic String translate(String key, String locale) {\n // this method will be called for every string, in this case, 4 times:\n // Title, Content, translate.button1, translate.button2\n // your own translate logic here\n // return the value that replaces the key\n}\n\nOr you can have the translate method directly in the FormBuilder instead of a separate method:\nModalForm form = ModalForm.builder()\n .translator((key, unused) -> {\n // this method will be called for every string, in this case, 4 times:\n // Title, Content, translate.button1, translate.button2\n // since this isn't a separate method, you don't need the locale argument, so it's unused.\n // your own translate logic here\n // return the value that replaces the key\n })\n .title(\"Title\")\n .content(\"Content\")\n .button1(\"translate.button1\")\n .button2(\"translate.button2\")\n .build();"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-getting-started-with-the-api": {
|
||
"id": "geyser-getting-started-with-the-api",
|
||
"title": "Getting Started with the API",
|
||
"url": "/geyser/getting-started-with-the-api/",
|
||
"content": "To start, add the Open Collaboration repository to your project:\n\nMaven\n<repository>\n <id>opencollab-snapshot</id>\n <url>https://repo.opencollab.dev/main/</url>\n</repository>\n\nThe “main” repository contains both release and snapshot versions.\n\nGradle\nrepositories {\n maven {\n url = uri(\"https://repo.opencollab.dev/main/\")\n }\n}\n\n\nUsing Geyser\n\nAdd Geyser’s API codebase as a dependency:\n\nMaven\n<dependency>\n <groupId>org.geysermc.geyser</groupId>\n <artifactId>api</artifactId>\n <version>2.2.0-SNAPSHOT</version>\n <scope>provided</scope>\n</dependency>\n\n\nGradle\ndependencies {\n compileOnly('org.geysermc.geyser:api:2.2.0-SNAPSHOT')\n}\n\n\nTo get a Geyser player, or check if a player is from Bedrock:\n\nGeyserConnection connection = GeyserApi.api().connectionByUuid(uuid);\n\n\nconnection can be null if such a player does not exist on Geyser.\n\nGeyserApi.api() may be null until after the Geyser plugin enables.\n\nFor more information on the Geyser API, see here.\n\nUsing Floodgate\nThis page has a very simple primer for the Floodgate API. For a full breakdown, see here.\n\nAdd Floodgate’s API as a dependency:\n\nMaven\n<dependency>\n <groupId>org.geysermc.floodgate</groupId>\n <artifactId>api</artifactId>\n <version>2.2.2-SNAPSHOT</version>\n <scope>provided</scope>\n</dependency>\n\n\nGradle\ndependencies {\n compileOnly('org.geysermc.floodgate:api:2.2.2-SNAPSHOT')\n}\n\n\nGet the Floodgate API using:\nFloodgateApi api = FloodgateApi.getInstance();\napi.isFloodgatePlayer(uuid);\n\n\nFor more information on the Floodgate API, see here."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-geyser-command-line-arguments-and-system-properties": {
|
||
"id": "geyser-geyser-command-line-arguments-and-system-properties",
|
||
"title": "Geyser Command Line Arguments and System Properties",
|
||
"url": "/geyser/geyser-command-line-arguments-and-system-properties/",
|
||
"content": "Geyser Command Line Arguments and System Properties\nGeyser offers a few command line arguments/system properties to allow you to configure Geyser without editing the config files.\nAdditionally, you can suppress some warnings that may be printed to the console.\n\nConfiguration system properties\nYou can set Geyser to automatically bind to a specific address and port by using the following command line arguments. \nThis is primarily aimed at server hosting providers to automatically configure servers for users.\n\n\n Note: the Geyser specific properties are prioritized over the plugin properties!\n\n\n\n -DgeyserUdpPort=server or -DpluginUdpPort=server\n \n -1 means UDP is not supported and will forcibly stop Geyser.\n server means to match the port of the TCP server.\n any other number means to use that specific port\n \n \n -DgeyserUdpAddress=server or -DpluginUdpAddress=server\n \n server means to match the bind address of the TCP server\n any other string will be used as-is for the bind address.\n \n \n\n\nDisabling warnings and advanced configuration\nYou may disable some warnings that may be printed to the console by using the following command line arguments:\n\n\n Warning: Disabling Geyser warnings from being logged will not fix the real issue! Only disable them if you know what you are doing. \n\n\n\n -DGeyser.PrintSecureChatInformation=true\n \n Allows you to disable the warning about secure chat being disabled. \nSince the warning is sent when the server sends the warning, this option does not do much anymore.\n \n \n -DGeyser.ShowScoreboardLogs=true\n \n Allows you to disable warnings related to scoreboards, such as “Tried to update score without the existence of its requested objective”.\n \n \n -DGeyser.ShowResourcePackLengthWarning=true\n \n Allows you to disable the warning about a resource pack having too long paths. Disabling this warning will not fix the underlying issue! \nConsole players might not be able to join your server at all if you have a resource pack with paths exceeding the 80 character limit.\n \n \n -DGeyser.PrintPingsInDebugMode=true\n \n Controls if pings are being logged in debug mode.\n \n \n -DGeyser.UseDirectAdapters=true\n \n Allows you to disable the usage of NMS adapters. Disabling will result in a performance penalty and should only be used for debugging.\nThis is Spigot-only and will not work on other platforms.\n \n \n -DGeyser.BedrockNetworkThreads=8\n \n Allows you to set the number of threads used for the Bedrock networking. This is not set to a specific number by default, but is instead calculated based on the available resources.\n \n \n -DGeyser.AddTeamSuggestions=true\n \n Allows you to turn off suggestions for teams in the scoreboard command. This is enabled by default, disabling this can help with performance if there are a lot of teams defined. \nSetting “command-suggestions” to false in the config will also disable this.\n \n \n\n\nGeyser-Standalone specific options:\n\n--config [file]\n\n Alias: -c\n Points to an alternative config file to use.\n\n\n--gui / --nogui\n\n Alias: gui / nogui:\n Forces GUI or non-GUI usage, depending on context.\n\n\nOverriding specific config values\nOverriding a standard config option (e.g. command-suggestions):\n\n--command-suggestions=false\n\nOverriding a nested config option(e.g. the remote section with address):\n\n--remote.address=test.geysermc.org"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-global-api": {
|
||
"id": "geyser-global-api",
|
||
"title": "Global API",
|
||
"url": "/geyser/global-api/",
|
||
"content": "Geyser Global API\nThe Global API is available for every server. It currently includes: Global Linking, skin uploading, getting a xuid by gamertag, and getting a gamertag by xuid.\nWe don’t store anything else than you can access by the Global API, except for some non-identifiable metrics. The source code of the Global API is available here and the source code of the Global Linking server is available here.\n\nAs a user of the API, you can get various info about Geyser (or specifically, Floodgate players) that joined any Geyser + Floodgate server before. This includes:\n\n Conversion methods from a Bedrock gamertag to Bedrock xuid, and vice-versa. Only provides info for players who are in Geyser’s cache. \nIf you need them for all players, you can use a third-party API, e.g. https://mcprofile.io/endpoints, which also provides info from the Geyser Global API.\n Skin info: Whenever a Bedrock player joins via Floodgate, their skin gets converted & uploaded to mineskin. If you want to grab that converted skin, use the xuid of the Bedrock player in this endpoint to get a texture id, or a base64 encoded “value”, which you could use directly in e.g. player heads.\n\n\nSee the Global API docs for more info, and detailed usage.\n\nExamples\nHere are a few examples of how you could use the Global API. \n\nGeyserDiscordBot\n\n GeyserMC’s discord bot has a /uuid command to get a floodgate uuid from a bedrock username. \n\n\nCustomPlayerHeads\n\n A fabric mod that uses the Global API to get a Bedrock player’s skin, and then uses that to create a player head."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-playit-gg": {
|
||
"id": "geyser-playit-gg",
|
||
"title": "playit.gg Setup",
|
||
"url": "/geyser/playit-gg/",
|
||
"content": "Prerequisites\n\n\n You must be able to connect to your Geyser instance locally!\n\n\n\n If you already have playit.gg running & set up (for e.g. Minecraft Java edition), skip steps 1 and 2 and proceed with step 3.\n\n\nSetup\n\n Head over to playit.gg’s website - download the program & run it. It will open the login site in the browser - create an account & sign in. Or, use a guest account.\n Once logged in, make sure to connect the program + site, until step 4 is reached. This should happen automatically, if it does not, follow the instructions on the website and the playit.gg program console.\n\n Click “Create Tunnel” if you see the screen above, or, select the “Tunnels” tab when logged in to your account. There, select “Minecraft Bedrock”, leave “Enable Tunnel” ticked, and click “Add tunnel”.\n\n Once “Add tunnel” is clicked, it should create a new tunnel, and you are set! Scroll down until you see this:\n\nIf you have Geyser running on a port that is not 19132, update the port there. The “Local Address” does not need to be changed unless you are not running playit.gg and Geyser on the same device.\n Connect to your server - use the IP and Port from the “Allocation” tab. In our example - “180.ip.ply.gg” as the IP, and “17019” as the port. Alternatively, use the Domain it gives you instead of the IP.\n If you join successfully, then you are done! Make sure to leave the playit.gg program running as closing it will close the tunnel. You also may want to ratelimit individual connections - use the “Per Connection Rate Limit” option to do so.\n(If you failed to join, check out the troubleshooting section of the page.)\n\n\nTroubleshooting\n\nI can’t connect to my server!\n\n Are there errors in your minecraft server console?\n Make sure to check here beforehand.\n If you changed the port that Geyser would bind to, you’ll have to tell playit.gg to use that port instead! See step 5 here.\n (Alternatively: You can try setting the bedrock port in the Geyser configuration to 19132.)"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-port-forwarding": {
|
||
"id": "geyser-port-forwarding",
|
||
"title": "Port forwarding",
|
||
"url": "/geyser/port-forwarding/",
|
||
"content": "Port forwarding\nThis page contains information on how to set up port forwarding required for Geyser to work when self-hosting.\nThere are also guides for specific configurations, such as Docker/Pterodactyl, or on specific VPS/KVM providers, such as OVH or Oracle Cloud.\n\n\n\tIf you are using a Minecraft server hosting provider (e.g. Aternos, or Apex Hosting), you should refer to the hosting provider setup on the setup page instead.\n\n\nPort forwarding on Linux/Windows/macOS\nTo allow others to play on your server, you will need to set up port forwarding on the device hosting Geyser.\nAdditionally, you will need to port forward the port on your router/modem (in other words, allow and route traffic on that port to the proper machine) if you want the server to be accessible outside your own home network. \nSee here or here for helpful guides.\nDo note: if you do not have a static IP address, your IP address may change over time.\n\n\n\tSome ISPs (Internet Service Providers) block certain ports, or don't allow you to open ports (e.g. by using CGNAT, which doesn't allow you to open a port with a dynamic IP).\nOther ISPs may require you to pay extra for a static IP address. \nAs an alternative to port forwarding, you can use playit.gg to create a tunnel.\n\n\nWindows\nTo open a port on Windows, you will need to open the port through the Windows Firewall. There are multiple ways to do this:\n\n\n \n Powershell (recommended)\n\n To open a port on UDP (in our example, port 19132), run the following command in an administrator Powershell:\n New-NetFirewallRule -DisplayName \"Geyser\" -Direction Inbound -Protocol UDP -LocalPort 19132 -Action Allow\n \n Running this command creates a rule named “Geyser” that allows UDP traffic on port 19132.\n \n \n Windows Defender Firewall with Advanced Security (GUI)\n \n Search for “Windows Defender Firewall with Advanced Security” in the start menu, and open it. (Image)\n Click on “Inbound Rules” in the left sidebar. (Image)\n Click on “New Rule…” in the right sidebar. (Image)\n Select “Port” as the rule type and click “Next”. (Example)\n Select “UDP” and “Specific local ports”, and enter the port you want to open (in our example, 19132). Click “Next”. (Example)\n Select “Allow the connection” and click “Next”. (Example)\n Select the profiles you want to apply the rule to (e.g. “Domain”, “Private”, “Public”), and click “Next”. (Example)\n Enter a name for the rule (e.g. “Geyser”), and click “Finish”. (Image)\n \n \n\n\nLinux\nDifferent Linux distributions, even different VPS providers ship and configure different firewalls. In the following examples, we will use 19132 as the port to open, but you should replace this with the port you are using for Geyser.\n\n\n ufw is a simple firewall front-end for iptables that is commonly used on Ubuntu and Debian. To open a port on UDP, run the following command:\n sudo ufw allow 19132/udp\n \n Then, reload the firewall with sudo ufw reload, and see all open rules with sudo ufw status. \nFurther helpful guides: DigitalOcean, Baeldung\n \n firewalld Add a port on UDP by running:\n sudo firewall-cmd --zone=public --permanent --add-port=19132/udp\n \n Then, reload the firewall with sudo firewall-cmd --reload, and see all open rules with sudo firewall-cmd --list-all. \nFurther helpful guides: DigitalOcean\n \n iptables is a common firewall that is used on many Linux distributions. To open a port on UDP, run the following command:\n sudo iptables -A INPUT -p udp --dport 19132 -j ACCEPT\n \n Then, save the firewall with sudo iptables-save, and see all open rules with sudo iptables -L. \nFurther helpful guides for iptables: DigitalOcean, Ubuntu\n \n\n\nmacOS\nYou will need to disable Block all incoming connections in your Firewall settings, as that will block any connections and won’t allow you to make exceptions. \nTo allow incoming connections, click Allow when getting these prompts.\nIf you are still facing issues, see Apple’s official guide here to open a port on macOS.\n\nUsing Docker or Pterodactyl\nIn addition to port forwarding the port in your server’s firewall (and, if applicable, your router/modem), you will need to assign the port in Docker/Pterodactyl.\n\nPterodactyl\nMake sure to allocate the port to the server in the Pterodactyl panel’s Network tab, additionally to port forwarding the port. \nSee here for more information.\n\n\n\nThere are also different Geyser eggs for Pterodactyl, which can be found here.\n\n\n If you are not able to allocate ports in the Pterodactyl panel, you will need to contact your server host to allocate one for you or try to use an existing port allocation.\n\n\nDocker\nFor Geyser to work under Docker (e.g. using Itzg’s Docker image), you will need to add the Geyser port on UDP to the docker-compose file. This is done by adding the following to the ports section:\nports:\n - \"25565:25565\"\n - \"19132:19132/udp\"\n\nThe additional /udp suffix is required so that the port is exposed on UDP. If you want to run the Java server and Geyser on the same port, the following would work:\nports:\n - \"25565:25565\"\n - \"25565:25565/udp\"\n\nAlternatively, add another port with the -p 19132:19132/udp flag to the docker run command.\n\nIssues with specific VPS/KVM providers\nSome providers, such as OVH, Oracle Cloud, and SoYouStart, have a firewall that blocks UDP ports by default/in most cases.\n\nOVH and SoYouStart\nBy default, OVHs firewall requires a TCP ping to the server before allowing UDP connections. This is not possible with Geyser, so you will need to disable the firewall.\n\n\n If you do not have access to these firewall settings, but got linked to this page, please contact your server host and provide them with this link - they are likely using OVH internally.\t\n\n\nTo verify/temporary work around it:\n\nAttempt to connect to your servers IP and port through a web browser - for example, http://test.geysermc.org:19132. Connecting won’t work, but then try connecting through Bedrock on that same device, and it should work.\nAlternatively, try connecting to the server first on Java edition, then on Bedrock with the same device.\n\nTo resolve it:\n\nOVH:\n\n Navigate to Network interfaces\n Click on the ... button on the table for your IP -> then ... and Configure the GAME firewall -> Add rule -> Other protocol (or minecraftPocketEdition if available)\n Add your Geyser port into outgoing port.\n\n\nSoYouStart (subsidiary of OVH):\n\n Click the IP tab.\n Click the gear at the right of the public IP address; select “Game mitigation”.\n Pick “Add a rule”.\n Select “minecraftPocketEdition” in the dropdown list and enter the target UDP ports.\n Save and wait a few seconds for the changes to come into effect.\n\n\nOracle Cloud/OCI\nYou’ll need to allow port 19132 on UDP in both the security list and the firewall-cmd command.\n\nAdditional step for Ubuntu users:\n\n Remove/comment out -A INPUT -j REJECT --reject-with icmp-host-prohibited in the /etc/iptables/rules.v4 file.\n Then, run the following command to fix ufw:\n sudo iptables-restore < /etc/iptables/rules.v4"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser": {
|
||
"id": "geyser",
|
||
"title": "Geyser",
|
||
"url": "/geyser/",
|
||
"content": "Geyser\n\n\n\n\nA bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition.\n\nCurrently, supporting Minecraft Bedrock 1.20.0-1.20.40 and Minecraft Java 1.20.2\n\nThe goal of Geyser is to bridge the Minecraft: Bedrock Edition and Minecraft: Java Edition by allowing Bedrock clients to join Java Edition servers. This project is still in development and not complete yet, so expect bugs."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-secure-chat": {
|
||
"id": "geyser-secure-chat",
|
||
"title": "Geyser and Secure Chat",
|
||
"url": "/geyser/secure-chat/",
|
||
"content": "In the 1.19 Java Edition updates, a mechanism for reporting player chat messages to Mojang was implemented. \nBedrock Edition does not support this reporting mechanism.\nIf your server or proxy settings require that every player joining supports this mechanism (which may be enabled by default), \nBedrock players will be unable to chat.\n\nServer administrators can disable this setting, but please note that Java players can join with certain mods that make their messages unreportable.\n\nFor a technical explanation of Java’s chat signing system, see this article.\n\nDisabling\n\nVanilla, Spigot/Paper/forks, Fabric\n\nSet enforce-secure-profile: false in server.properties\n\nBungeeCord and forks\n\nSet enforce_secure_profile: false in config.yml\n\nVelocity\n\nSet force-key-authentication = false in velocity.toml"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-setup": {
|
||
"id": "geyser-setup",
|
||
"title": "Setup",
|
||
"url": "/geyser/setup/",
|
||
"content": "Host Provider\n Self Host\n\n\n\n \n \n\n \n Select a provider\n Not listed\n \n \n 365Hosts - 365hosts.com\n \n \n Akliz - akliz.net\n \n \n Apex Hosting - apexminecrafthosting.com\n \n \n Aquatis - aquatis.host\n \n \n Aternos - aternos.org\n \n \n BisectHosting - bisecthosting.com\n \n \n Bloom.Host - bloom.host\n \n \n Cloud Nord - cloudnord.net\n \n \n Clovux - clovux.net\n \n \n Consulhosting - consulhosting.nl\n \n \n Craft-Hosting - craft-hosting.ru\n \n \n CreeperHost - creeperhost.net\n \n \n Cubes Hosting - cubes.host\n \n \n DedicatedMC - dedicatedmc.io\n \n \n ElfIDC - elfidc.com\n \n \n EnviroMC - enviromc.host\n \n \n ExtraVM - extravm.com\n \n \n FREAKHOSTING - freakhosting.com\n \n \n FadeHost - fadehost.com\n \n \n FakaHeda - fakaheda.eu\n \n \n FalixNodes - falixnodes.net\n \n \n Ferox Hosting - feroxhosting.nl\n \n \n Fluctis Hosting - fluctishosting.com\n \n \n FreeMcServer.net - freemcserver.net\n \n \n Fusion Hosting - fusionhostingltd.co.uk\n \n \n Futurehosting - futurehosting.org\n \n \n GGServers - ggservers.com\n \n \n GPortal - g-portal.com\n \n \n GameHosting.it - gamehosting.it\n \n \n Heavynode - heavynode.com\n \n \n Hicoria - hicoria.com\n \n \n HostEZ - hostez.io\n \n \n Hosterfy - hosterfy.com\n \n \n HumbleServers - humbleservers.com\n \n \n MC-HOST24.de - mc-host24.de\n \n \n MCProHosting - mcprohosting.com\n \n \n Meloncube - meloncube.net\n \n \n MineStrator - minestrator.com\n \n \n Minecraft-Hosting.pro - minecraft-hosting.pro\n \n \n Minefort - minefort.com\n \n \n Minehut - minehut.com\n \n \n NFOservers - nfoservers.com\n \n \n Netbela - netbela.nl\n \n \n Nitrado - nitrado.net\n \n \n Nodecraft - nodecraft.com\n \n \n OMGServ - omgserv.com\n \n \n PUBCS - pubcs.com\n \n \n Pebblehost - pebblehost.com\n \n \n Physgun - physgun.com\n \n \n PlanetNode - planetnode.net\n \n \n PloudOS - ploudos.com\n \n \n Pufferfish Host - pufferfish.host\n \n \n RamShard - ramshard.com\n \n \n Redline Hosting - redlinehosting.net\n \n \n Revivenode - revivenode.com\n \n \n SRKHOST - srkhost.eu\n \n \n STIPE - stipe.com.au\n \n \n ScalaCube - scalacube.com\n \n \n Server.pro - server.pro\n \n \n Shockbyte - shockbyte.com\n \n \n Skynode.pro - skynode.pro\n \n \n Snakecraft Hosting - snakecrafthosting.com\n \n \n Sparked Host - sparkedhost.com\n \n \n StellaNode - stellanode.com\n \n \n SyntexHosting - syntexhosting.com\n \n \n TNAHosting - tnahosting.net\n \n \n The Minecraft Hosting - theminecrafthosting.com\n \n \n TurboHost - turbohost.nl\n \n \n UltimateSRV - ultimatesrv.com\n \n \n Virtual Gladiators - virtualgladiators.com\n \n \n Volcano Hosting - volcanohosting.net\n \n \n Vultam - vultam.net\n \n \n WinterNode - winternode.com\n \n \n WiseHosting - wisehosting.com\n \n \n WitherHosting - witherhosting.com\n \n \n ZapHosting - zap-hosting.com\n \n \n exaroton - exaroton.com\n \n \n \n\n\n\n\n\n \n \n Paper / Spigot\n \n \n Fabric\n \n \n Proxy Servers\n \n \n \n\n \n \n \n \nPaper / Spigot setup with server hosting provider\n\n\n If your server is not running 1.20.2, you will need to install ViaVersion.\n See also our FAQ article on supported versions.\n\n\n\n Select your server hosting provider in the dropdown above.\n Download the plugin from the download page.\n Place the Geyser-Spigot.jar in the plugins folder, and restart the server.\n \n Open your Geyser config, located in /plugins/Geyser-Spigot/config.yml, and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0 \n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132 \n\n # Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock. \n # This option makes the Bedrock port the same as the Java port every time you start the server. \n # This option is for the plugin version only. \n clone-remote-port: false \n \n The vital part is the port. This is the port that Bedrock players will use to connect to your server. \n Follow the instructions in the provider selector - change the port, and if necessary, clone-remote-port & address.\n If clone-remote-port is enabled, the bedrock port will be overwritten with the Java port! \n Important: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.\n \n Verify whether connections are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\n\n To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate.\n\n\n \n \n \n \nFabric setup with server hosting provider\n\n\n\tGeyser-Fabric runs only on a 1.20.2 Fabric server. \nTo use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velocity proxy, or Geyser Standalone instead. \n \n\n\n Select your server hosting provider in the dropdown above.\n Download the mod from the download page.\n Place the Geyser-Fabric.jar in the mods folder, and restart the server. You also need FabricAPI.\n \n Open your Geyser config, located in /config/Geyser-Fabric/config.yml, and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0 \n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132 \n\n # Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock. \n # This option makes the Bedrock port the same as the Java port every time you start the server. \n # This option is for the plugin version only. \n clone-remote-port: false \n \n The vital part is the port. This is the port that Bedrock players will use to connect to your server. \n Follow the instructions in the provider selector - change the port, and if necessary, clone-remote-port & address.\n If clone-remote-port is enabled, the bedrock port will be overwritten with the Java port! \n Important: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.\n \n Verify whether connections are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\n\n To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate.\n\n\n \n \n \n \nProxy setup with server hosting provider\n\n\n NOTE: \n - Install Geyser only on the proxy server! You can install Floodgate on all servers for better skin support & \n network-wide Floodgate API availability for other plugins. \n - All servers on the network must accept 1.20.2 Java clients, as Geyser imitates one. \n\n\n\n Select your server hosting provider in the dropdown above.\n Download the plugin for your proxy software from the download page.\n Place the Geyser jar in the plugins folder, and restart the server.\n \n Open your Geyser config, located in /plugins/Geyser-xyz/config.yml, and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0\n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132\n\n # Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock. \n # This option makes the Bedrock port the same as the Java port every time you start the server. \n # This option is for the plugin version only. \n clone-remote-port: false\n \n The vital part is the port. This is the port that Bedrock players will use to connect to your server. \n Follow the instructions in the provider selector - change the port, and if necessary, clone-remote-port & address.\n If clone-remote-port is enabled, the bedrock port will be overwritten with the Java port! \n Important: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.\n \n Verify whether connections are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\n\n To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate.\n\n\n \n \n\n \n\n \n \n \n Paper / Spigot\n \n \n Fabric\n \n \n Proxy Servers\n \n \n \n Standalone\n \n \n \n\n \n \n \n \nPaper / Spigot setup - self-hosting\n\n\n If your server is not running 1.20.2, you will need to install ViaVersion.\n See also our FAQ article on supported versions.\n\n\n\n Download the plugin from the download page.\n Place the Geyser-Spigot.jar in the plugins folder, and restart the server.\n \n Open your Geyser config, located in /plugins/Geyser-Spigot/config.yml, and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0 \n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132 \n \n The vital part is the port. This is the port that Bedrock players will use to connect to your server!\n If you enable clone-remote-port, the port will be overridden and the Java port is used.\n Since you are self-hosting, you can choose the port freely - the default port is 19132. \n Important: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.\n\n \n \n Connecting to your server\n \n Connecting locally in the same network \n On the same device as the server, you can connect using localhost, or 127.0.0.1 as the address.\n Do note: When hosting and playing on the same Windows device, you will need the loopback fix.\n Other devices in the same local network can use your local IPv4 to connect - it starts with 10. or 192.168..\n \n Connecting from a different network\n You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.\n To achieve that, you have two options: \n\n \n \n Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall. \nOur port forwarding guide explains how to do this in detail.\nAfter doing this, players can connect with your public IPv4 + port to your server. \n \n \n playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use\nthe playit.gg service to create a tunnel for you to route the traffic through. See our playit.gg guide.\nNgrok will not work since it is TCP-only. \n \n \n \n Verify whether connections from other networks are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\n\n To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate.\n\n\n \n \n \n \nFabric setup - self-hosting\n\n\n\tGeyser-Fabric runs only on a 1.20.2 Fabric server. \nTo use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velocity proxy, or Geyser Standalone instead. \n \n\n\n Download the mod from the download page.\n Place the Geyser-Fabric.jar in the mods folder, and restart the server. You also need FabricAPI.\n \n Open your Geyser config, located in /config/Geyser-Fabric/config.yml, and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0 \n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132 \n \n The vital part is the port. This is the port that Bedrock players will use to connect to your server!\nIf you enable clone-remote-port, the port will be overridden and the Java port is used.\nSince you are self-hosting, you can choose the port freely - the default port is 19132. \nImportant: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.\n\n \n \n Connecting to your server\n \nConnecting locally in the same network \nOn the same device as the server, you can connect using localhost, or 127.0.0.1 as the address.\nDo note: When hosting and playing on the same Windows device, you will need the loopback fix.\nOther devices in the same local network can use your local IPv4 to connect - it starts with 10. or 192.168..\n \nConnecting from a different network\nYou will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.\nTo achieve that, you have two options: \n\n \n \n Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.\nOur port forwarding guide explains how to do this in detail.\nThen, players can connect with your public IPv4 + port to your server. \n \n \n playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use\nthe playit.gg service to create a tunnel for you to route the traffic through. See our playit.gg guide.\nNgrok will not work since it is TCP-only. \n \n \n \n Verify whether connections from other networks are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\n\n To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate.\n\n\n \n \n \n \nProxy setup - self-hosting\n\n\n NOTE: \n - Install Geyser only on the proxy server! You can install Floodgate on all servers for better skin support & \n network-wide Floodgate API availability for other plugins. \n - All servers on the network must accept 1.20.2 Java clients, as Geyser imitates one. \n\n\n\n Download the plugin for your proxy software from the download page.\n Place the Geyser jar in the plugins folder, and restart the server.\n \n Open your Geyser config, located in /plugins/Geyser-xyz/config.yml, and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0 \n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132 \n \n The vital part is the port. This is the port that Bedrock players will use to connect to your server!\n If you enable clone-remote-port, the port will be overridden and the Java port is used.\n Since you are self-hosting, you can choose the port freely - the default port is 19132. \nImportant: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.\n\n \n \n Connecting to your server\n \n Connecting locally in the same network \n On the same device as the server, you can connect using localhost, or 127.0.0.1 as the address.\n Do note: When hosting and playing on the same Windows device, you will need the loopback fix.\n Other devices in the same local network can use your local IPv4 to connect - it starts with 10. or 192.168..\n \n Connecting from a different network\n You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.\n To achieve that, you have two options: \n\n \n \n Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.\nOur port forwarding guide explains how to do this in detail.\nThen, players can connect with your public IPv4 + port to your server. \n \n \n playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use\nthe playit.gg service to create a tunnel for you to route the traffic through. See our playit.gg guide.\nNgrok will not work since it is TCP-only. \n \n \n \n Verify whether connections from other networks are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\n\n To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use Floodgate.\n\n\n \n \n \n \n Geyser-Standalone Setup\n\n\n You need to have Java 16 or higher installed to run Geyser. To run Geyser Standalone on Android or iOS, see the bottom of this page.\n\n\n\n Geyser-Standalone is NOT a plugin or mod! It is a standalone Java program that you would run separately to your Java Edition server.\n\n\nGeneral Setup & Configuration\n\n\n Download Geyser Standalone from here.\n Create a new folder for Geyser, and drop the jar in there.\n Start Geyser Standalone:\n \n GUI (Recommended): \nDouble-click the jar file and all the necessary files for Geyser will be created.\n Or use the console setup: \nCreate a new bat or startup script, similar to the one you’d use for a Spigot/Paper server, and take a look at this page for what to put into it. \nRun the startup script/bat, and all the necessary files for Geyser will be created.\n \n \n \n Open your Geyser config (config.yml), and find the following:\n\n bedrock: \n # The IP address that will listen for connections. \n # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server. \n #address: 0.0.0.0 \n\n # The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.\n port: 19132 \n \n The port is the port Bedrock players will enter to connect to the server. \nUncommenting and changing address here is only needed if you need to limit connections to a specific IP address.\n\n\n To configure which Java Edition server Geyser Standalone will send players to, find the remote section:\n remote:\n # The IP address of the remote (Java Edition) server\n # If it is \"auto\", for standalone version the remote address will be set to 127.0.0.1.\n address: auto\n\n # The port of the remote (Java Edition) server\n port: 25565\n \n # Authentication type. Can be offline, online, or floodgate (see https://github.com/GeyserMC/Geyser/wiki/Floodgate).\n auth-type: online\n \n Here, change address to the Java server’s address, or to auto if the server is on the same machine as Geyser-Standalone. \nThen, change port to the Java server’s port. If you have set up Floodgate on the remote Java server, you can set auth-type to “floodgate” - otherwise, \nset it to either online for an online mode server, or offline for an offline mode server. To install and set up Floodgate with a Standalone server, see here. \n \n \n Connecting to your server\n \nConnecting locally in the same network \nOn the same device as the server, you can connect using localhost, or 127.0.0.1 as the address.\nDo note: When hosting and playing on the same Windows device, you will need the loopback fix.\nOther devices in the same local network can use your local IPv4 to connect - it starts with 10. or 192.168..\nAlternatively, open Minecraft: Bedrock edition, and join the LAN-Server in the Friends tab.\n \nConnecting from a different network\nYou will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.\nTo achieve that, you have two options: \n\n \n \n Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.\nAfter doing this, players can connect with your public IPv4 + port to your server.\nSee here for a helpful guide. \n \n \n playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use\nthe playit.gg service to create a tunnel for you to route the traffic through. See our playit.gg guide.\nNgrok will not work since it is TCP-only. \n \n \n \n Verify whether connections from other networks are possible by running geyser connectiontest <ip>:<port> in the console.\n\n\nRunning Geyser-Standalone on Android/iOS\n\n\n Applications such as Termux on Android are capable of running Geyser, but this largely depends on how powerful your Android device is. Please do so at your own risk.\n\n\nTermux (Android)\n\n Download and install Termux\n Run pkg install openjdk-17\n Run wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/build/libs/Geyser-Standalone.jar\n Run java -jar Geyser-Standalone.jar\n\n\nOR\n\nWe have an automated setup script for clean Termux installs, which might not work for all users. If the manual guide above does not work, try this.\nRun this to start the download/install:\ncurl https://gist.githubusercontent.com/rtm516/e3e07d6595ee41e05a38b03c0f4d7a80/raw/install.sh | bash\n\n\nNewTerm 2 (iOS)\nNote: A jailbreak is required. You can find what jailbreak to use for your device here.\n\n Install Filza File Manager.\n Install NewTerm 2.\n Download PojavLauncher’s Java 16 JRE for iOS and install it using Filza here.\n Download this package containing modified java commands, and install it using Filza here (Note: Not an official GeyserMC project, install at your own risk).\n Open NewTerm 2 and run wget https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone\n Run java -jar Geyser-Standalone.jar.\n Geyser should show up in the Friends tab inside Minecraft.\n\n\nNote:\nDue to the iOS environment, if your device has low specs, iOS might end up killing NewTerm 2 while you’re playing, stopping the server. There is no fix for that because of how iOS works.\n\n \n \n\n \n\n\n\n Experiencing issues? \n Start with the Common Issues page.\n If your issue is not included there, join our Discord server for support.\n\n\nFurther information:\n\n Full config documentation\n Current Limitations\n Frequently asked questions"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-supported-hosting-providers": {
|
||
"id": "geyser-supported-hosting-providers",
|
||
"title": "Supported Hosting Providers",
|
||
"url": "/geyser/supported-hosting-providers/",
|
||
"content": "This list is incomplete. Please open a PR or contact us on Discord if the information is incorrect or you want to add a new hosting provider!\n\n\n\n\tIt should also be noted that these providers may not be verified by the Geyser team, and the server providers below are reported as working by members of the community.\n\n\n\n\tUsing 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.\n\n\n\n\tThe below information is for the plugin versions of Geyser unless otherwise specified\n\n\nBuilt-in Geyser\n\n\n \n Aternos - Install Geyser in the Aternos plugin list and connect to your server with your Java IP and port. See Aternos’s article for more details. Do note: Aternos automatically installs the latest version of the plugin, but does not auto update it. To update Geyser on Aternos, simply reinstall the plugin (no need to uninstall the plugin/deleting the plugin files).\n \n \n Apex Hosting - Full auto installation. Go to the Customizations tab in the panel and select ‘Enabled’ under the ‘Geyser Auto Installer’ option. Then, restart and connect to your server with your Java IP and port. See Apex’s article for more details.\n \n \n Cloud Nord - Go to their Crossplay Server hosting section and order your server. Instructions on how to join are provided.\n \n \n CreeperHost - Has a toggle within the control panel to automatically enable Geyser. May not be enabled by default, so you may need to toggle it and restart the server.\n \n \n Cubes Hosting - Install Geyser using the plugin manager. Then restart the server and Geyser will run on an additional port - you can check it in the server console. Geyser-Standalone can be set up through a support ticket.\n \n \n exaroton - Install Geyser in the exaroton plugin list and connect to your server with your Java IP and port. See exaroton’s article for more details.\n \n \n GGServers - Can be installed to any server from their auto plugin setups. No further configuration needed.\n \n \n MCProHosting - Click ‘Enable Bedrock Support’ on the server dashboard and follow the steps. For manual installation: Add ‘Destination Port’ 19132 with ‘Protocol UDP’ to the port forward mapping and connect to the given source port.\n \n \n Minefort - On the server dashboard under ‘Connect Support’, make sure ‘Allow Bedrock’ is enabled. Then connect via play.minefort.com and join using /server <servername>, or connect via <servername>.minefort.com.\n \n \n Minehut - Connect via bedrock.minehut.com and do /join <servername>, or connect directly via <servername>.bedrock.minehut.gg.\n \n \n Physgun - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n OMGServ - Select Geyser in the Install Menu, it will be automatically installed. You can enable floodgate in the server properties on the dashboard.\n \n \n PloudOS - Connect via geyser.ploudos.com and enter the with your Java IP and port. See PloudOS’s article for more details.\n \n \n Pufferfish Host - Geyser is installed and configured on all servers by default.\n \n \n Server.pro - Different instructions for different plans: On VPS, select Geyser in the Service Type Menu, Floodgate can be enabled on the dashboard configuration. For manual installation: Using a Premium or Free plan, use the same port as your Java server for the Bedrock port in the configuration file and connect that; for the Free plan, also enable the clone-remote-port option. If you are using a PRO or a VPS plan, you can use any port, which can be opened on the Firewall tab.\n \n \n Snakecraft Hosting - Select ‘Paper + Geyser with Floodgate’ under the Jar Type at checkout to install the Geyser plugin. Players will Connect with the same IP and port as you would on Java.\n \n \n SRKHOST - You can enable Geyser on the version changer page. Geyser will run on the given port by the host.\n \n \n Virtual Gladiators - Find the plugin in the control panel under the ‘VG Recommended’ category and restart your server. IP and port are the same as Java.\n \n \n WiseHosting - Both auto and manual installation available. Find the GeyserMC presets from the Properties tab in the Game Panel. There, click Install and restart your server. See Crossplay FAQ for additional details.\n \n \n ZapHosting - Find the plugin in the control panel and restart your server. IP and port are the same as Java.\n \n \n 365Hosts - Go to their Minecraft: Crossplay hosting section and order your server. Instructions on how to join are provided.\n \n\n\nSupport for Geyser\n\n\n \n Akliz - Offers a working port forwarding option.\n \n \n Aquatis - Need to open a support ticket to get a UDP port, then use that as the bedrock port.\n \n \n BisectHosting - You must have a plan with a dedicated IP. In Geyser’s config, uncomment the bedrock address and set it to the public IP of your server (e.g. address: 51.79.129.18). Leave the port as 19132. Under the home tab, select ‘Enable UDP Network’ and restart the server. See Bisect’s article for full instructions.\n \n \n Bloom.Host - Offers a working port forwarding option.\n \n \n Clovux - Make sure your remote address is ‘auto’, uncomment bedrock address, and change 0.0.0.0 to your Java server’s IP.\n \n \n Consulhosting - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Craft-Hosting - Set the Bedrock port to the Java server’s port and connect with that port; note that this provider appears to only provide service in Russia.\n \n \n DedicatedMC - Contact the support to open the default Bedrock port, which Geyser is configured to use by default.\n \n \n ElfIDC - When placing an order, choose Paper/Spigot + Geyser, which will automatically install the Geyser plugin. Connect with the Java server’s IP and port. Note: This provider only provides service in China.\n \n \n EnviroMC - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n ExtraVM - Make sure your remote address is ‘auto’, uncomment bedrock address, and change 0.0.0.0 to your Java server’s IP.\n \n \n FadeHost - Set the Bedrock port to the Java server’s port and connect with that port. Alternatively, buy a dedicated IP address to support a different port.\n \n \n FakaHeda - Set the bedrock port in the config to the Java server’s port or use one of the available ports allocated to your server, and connect with that port.\n \n \n FalixNodes - Open a port yourself on the network page in the game panel, then use that port in the bedrock section of the Geyser config.\n \n \n Ferox Hosting - Open a port yourself in their panel and check out the knowledgebase article for how to install and configure Geyser.\n \n \n Fluctis Hosting - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n FREAKHOSTING - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n FreeMcServer.net - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Fusion Hosting - Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config (either by setting it yourself, or enabling “clone-remote-port”) and connect with the same IP and port as you would on Java or create a port in the Network tab on the panel & use this for Geyser.\n \n \n Futurehosting - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port. Make sure your bedrock address in your Geyser config is your server IP.\n \n \n GameHosting.it - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n GPortal - You have to adjust the port according to your query port. Scheme: Query port: xxx65. The ports from xxx66 to xxx70 are available. For example, if your query port is 12365, then Geyser can only run under the port range 12366-12370. Furthermore, you have to change the ‘Bedrock’ ‘address’ in the Geyser config to your IP address. You can find it above your query port. Don’t forget to delete the # in front of `address’.\n \n \n Heavynode - Open a port yourself in the networking section of the control panel. Port 19132 is only available with a dedicated IP (contact support), otherwise you will need to use a randomly assigned port. To resolve further connection issues for servers located in Canada and the UK, contact their support with the info found here.\n \n \n Hicoria - Use one of the available ports allocated for your server for the Bedrock port in your config and connect with that port.\n \n \n Hosterfy - Use the same port as your Java server for the Bedrock port in your config (either by setting it yourself, or enabling clone-remote-port) and connect with the same IP and port as you would on Java. You can also ask for a new port.\n \n \n HostEZ - Geyser plugin supported with self-install or installed on request with its own port.\n \n \n HumbleServers - Set the Bedrock port to the Java server’s port, or to one of the two extra ports, and connect with that port. If the subdomain doesn’t work, use your regular numbered IP address.\n \n \n MC-HOST24.de - Enable clone-remote-port (or manually set bedrock port to the Java port), uncomment bedrock address, and change 0.0.0.0 to your Java server’s IP. Connect with the Java IP and port.\n \n \n Meloncube - Contact the support for a UDP port to use for Geyser. Set that port as the bedrock port, and connect with it.\n \n \n MineStrator - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Minecraft-Hosting.pro - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Netbela - Install Geyser with the dedicated Plugin installer. Use the same port as your Java server in your config. Connect with the same address and port as your Java server.\n \n \n NFOservers - Uncomment and set bedrock address to the server IP in the Geyser config file. As an alternative, you can run Geyser standalone separately on an Unmanaged VDS.\n \n \n Nitrado - Get Geyser as a plugin. Add 4 to the Port of the Java server. See here for specific instructions.\n \n \n Nodecraft - Use the default server port and 0.0.0.0 or your server IP as the host address.\n \n \n Pebblehost - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port. See this video for a PebbleHost-specific tutorial.\n \n \n PlanetNode - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n PUBCS - Set the Bedrock port to the Java server’s port and connect with that port, or upgrade to a plan that includes dedicated IP address to support a different port.\n \n \n RamShard - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Redline Hosting - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Revivenode - Set bedrock port to the Java server’s port (either by setting it yourself, or enabling clone-remote-port). You can also create a secondary port in the network tab and use that. To fix random Unable to Connect issues, see here.\n \n \n ScalaCube - Enable clone-remote-port (or manually set bedrock port to the Java port), uncomment bedrock address, and change 0.0.0.0 to your Java server’s IP. Connect with the Java IP and port.\n \n \n Shockbyte - Uncomment and set bedrock address to the Java server’s IP, and bedrock port to the Java server’ port. Connect with the same IP and port as on Java. For Geyser Standalone installation instructions, see here.\n \n \n Skynode.pro - Go to ‘Server Details’, add a new port, and set the bedrock port in your config to that port. Connect with it and the Java server’s address.\n \n \n Sparked Host - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n StellaNode - Open a support ticket on the billing panel to receive an additional UDP port for Geyser, then set that as the bedrock port.\n \n \n STIPE - Set the Bedrock port to the Java server’s port and connect with that port; note that this provider only provides service in Australia.\n \n \n SyntexHosting - Set the Bedrock port to the Java server’s port and connect with that port, or request a (free) additional port.\n \n \n The Minecraft Hosting - Try using 19132 as the Bedrock port, if that does not work, use the same Java server’s port for the bedrock port in your config and connect with that port and the Java server’s IP.\n \n \n TNAHosting - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n TurboHost - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n UltimateSRV - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Volcano Hosting - Enable clone-remote-port (or manually set bedrock port to the Java port), and connect with the Java IP and port.\n \n \n Vultam - Set the bedrock port to the Java server’s port, or request an additional port. The additional port can be 19132 if you buy a dedicated IP.\n \n \n WinterNode - Set the Bedrock port to the Java server’s port and connect with that port. Alternatively, request an additional port, or buy a dedicated IP address.\n \n \n WitherHosting - Either use the Java server’s port, or create a port in the ports manager on the panel and use that for Bedrock. Refer to the hosts support article for further info.\n \n\n\nDoes not support Geyser\n\n\n \n MCPEhost\n \n \n MyArena - Does seem to be working, but the Java version is too old in order for Geyser to run properly.\n \n \n NiCraft - Does not provide Bedrock support, and are affected by a firewall configuration issue, which prohibits most players from joining.\n \n \n Feather - Their proxy network does not support UDP. Therefore, Geyser is not supported. As an alternative, set up a paper server with e.g. playit.gg instead of port forwarding."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-understanding-the-config": {
|
||
"id": "geyser-understanding-the-config",
|
||
"title": "Understanding the Config",
|
||
"url": "/geyser/understanding-the-config/",
|
||
"content": "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.\n\nBedrock Section\nThe options for Geyser on the Bedrock-facing end. Mostly contains options for how Bedrock edition will see the server.\n\naddress: The address of Geyser on the Bedrock end. In most all scenarios, this should not need to be changed, unless you want to limit what IPs can connect to your server. Leave it at 0.0.0.0 (default), unless otherwise instructed in the setup guide.\n\nport: The port Geyser will run on. By default, it is 19132 in Bedrock. If you are using a server hosting provider, you may not have this port available to you - in which case, read the setup guide to proceed.\n\nclone-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.\n\nmotd1: The first line of the MOTD for Geyser.\n\nmotd2: 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!\n\nserver-name: The world name that is shown in the top-right area of the pause menu and the settings menu.\n\ncompression-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. Default is 6.\n\nenable-proxy-protocol: Whether to enable PROXY protocol or not for clients. You DO NOT WANT this feature unless you run UDP reverse proxy in front of your Geyser instance. You do NOT need this for BungeeCord (and forks), Velocity, or Waterfall.\n\nproxy-protocol-whitelisted-ips: Disabled by default, and only enable this if you use “enable-proxy-protocol”. A list of allowed PROXY protocol speaking proxy IP addresses/subnets. Should really only be used when you are not able to use a proper firewall (usually true with shared hosting providers etc.). Keeping this list empty means there is no IP address whitelist. Both IP addresses and subnets are supported.\n\nRemote Section\nOptions for the remote (Java) server.\n\naddress: 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.\n\nport: The port of the Minecraft: Java Edition server you specified in the address section. For plugin versions, if address has been set to “auto”, the port will also follow the server’s listening port.\n\nauth-type: The authentication type of the Minecraft: Java Edition server. Valid options are online, offline, and floodgate.\n\nPlease 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 wiki page.\n\nuse-proxy-protocol: Whether to enable PROXY/HAProxy protocol or not while connecting to the server. This is useful only when:\n\n Your server supports PROXY protocol (it probably doesn’t)\n You run Velocity or BungeeCord with its respective option enabled.\n IF YOU DON’T KNOW WHAT THIS IS, DON’T TOUCH IT!\n\n\nforward-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.\n\nGeneral Options\nGeneral Geyser options that are mostly specific to Geyser itself.\n\nfloodgate-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 installed and the auth-type set to floodgate.\n\nsaved-user-logins: For online mode authentication type only. \nStores a list of Bedrock players that should have their Java Edition account saved after login.\nThis saves a token that can be reused to authenticate the player later. This does not save emails or passwords,\nbut you should still be cautious when adding to this list and giving others access to this Geyser instance’s files.\nRemoving a name from this list will delete its cached login information on the next Geyser startup.\nThe file that tokens will be saved in is in the same folder as this config, named saved-refresh-tokens.json.\n\nFormat:\n\nsaved-user-logins:\n - jeb_\n - Dinnerbone\n\n\ncommand-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.\n\npassthrough-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.\n\npassthrough-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. \n\npassthrough-player-count: If the current and max player counts should be relayed from the remote server.\n\nlegacy-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 Geyser Standalone.\n\nping-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.\n\nforward-player-ping: Whether to forward player ping to the server. While enabling this will allow Bedrock players to have more accurate ping, it may also cause players to time out more easily.\n\nmax-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.\n\ndebug-mode: If debug messages should be printed in console. Useful if you run into an error and need more context. Yes, this will cause more messages, warnings or even errors in console - some packets aren’t translated.\n\nallow-third-party-capes: If third party (Optifine, 5zig, LabyMod, etc.) capes should be displayed to the bedrock player.\n\nallow-third-party-ears: If third party Deadmau5-style ears should be enabled. Currently only supports MinecraftCapes.\n\nshow-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.\n\nshow-coordinates: Bedrock Edition has an option to show coordinates in the top-left part of your screen. This setting enables or disables this.\n\ndisable-bedrock-scaffolding: Whether Bedrock players are blocked from performing their scaffolding-style bridging.\n\nemote-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:\n\n disabled - the default/fallback, which doesn’t apply this workaround\n no-emotes - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen.\n emotes-and-offhand - emotes will be sent to Bedrock clients and offhand will be swapped\n\n\ndefault-locale: The default locale to send to players if their locale could not be found. Check this page to find the code corresponding to your language. This option is disabled by default - to enable it, remove the “#” in front of the option.\n\ncache-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)\n\nallow-custom-skulls: Allows custom skulls to be displayed when placed. Keeping them enabled may cause a performance decrease on older/weaker devices.\n\nmax-visible-custom-skulls: The maximum number of custom skulls to be displayed per player. Increasing this may decrease performance on weaker devices. Setting this to -1 will cause all custom skulls to be displayed regardless of distance or number.\n\ncustom-skull-render-distance: A number value specifying the radius in blocks around the player in which custom skulls are displayed. 32 by default.\n\nadd-non-bedrock-items: Whether to add (at this time, only) the furnace minecart as a separate item in the game, which normally does not exist in Bedrock Edition. This should only need to be disabled if using a proxy that does not use the “transfer packet” style of server switching. If this is disabled, furnace minecart items will be mapped to hopper minecart items. This option requires a restart of Geyser in order to change its setting.\n\nabove-bedrock-nether-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.\n\nforce-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.\n\nxbox-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.\n\nlog-player-ip-addresses: Whether player IP addresses will be logged by the server.\n\nnotify-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.\n\nunusable-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.\n\nMetrics\n\nbStats is a stat tracker that is entirely anonymous and tracks only basic information about Geyser, such as how many people are online, how many servers are using Geyser, what OS is being used, etc. You can learn more about bStats here. To see Geyser Stats, see here.\n\nenabled: If metrics are enabled\n\nuuid: UUID of the server, don’t change this!\n\nAdvanced Options\n\nscoreboard-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.\n\nenable-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.\n\nmtu: 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.\n\nuse-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.\n\nDefault Geyser Config: config.yml"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"geyser-using-geyser-with-consoles": {
|
||
"id": "geyser-using-geyser-with-consoles",
|
||
"title": "Using Geyser with Consoles",
|
||
"url": "/geyser/using-geyser-with-consoles/",
|
||
"content": "All consoles can join third-party servers - including Geyser servers - with workarounds. Xbox One, Nintendo Switch, and PS4 systems can join third-party servers using a third-party program called BedrockConnect. For technical information about the program, including how to run your own setup, see their GitHub repository (This program is not affiliated with GeyserMC). Other methods are also available for use.\n\nThere is also a tool anyone can set up that allows you to connect to the server via adding a user to your friends list - FriendConnect, and MCXboxBroadcast. The latter one can even be set up as a Geyser Extension.\n\nNOTE: The main IP used for BedrockConnect is often blocked on consoles, if you run into issues with internet connection or joining servers after changing your DNS, consider using either one of the other BedrockConnect servers on the BedrockConnect Github Page, or the Public GeyserConnect which allows connecting to both Java and Bedrock servers.\n\nXbox One\n\n(Video linked below)\n\n\n\nNintendo Switch\n\n(Video linked below)\n\n\n\nPlayStation 4\n\n Go to your PS4 Home screen.\n Go to Settings.\n Go to Network.\n Select Set Up Internet connection.\n If you are using wired internet, select “Use LAN Cable”, otherwise choose “Use Wi-Fi”.\n Select the Custom network creation mode.\n Select Automatic IP Address.\n For DHCP Host Name, make sure you select Do Not Specify.\n Under DNS Settings, select Manual.\n Enter the BedrockConnect IP for the preferred Primary DNS (Multiple options depending on region can be found on the BedrockConnect Github Page) and something like Google or Cloudfare’s IP for the Secondary DNS (8.8.8.8 or 1.1.1.1).\n\n\nAlternative Methods\nIf you’d rather try emulating a LAN game on your network on another device, here’s how you’d do that.\n\nNote that this method will not work with the Nintendo Switch.\n\nUsing a PC\nIf you have a PC, you can use Phantom.\n\nUsing an Android Device\nIf you have an Android device, you have several options:\n\n Geyser Android app (Discontinued)\n BedrockTogether\n MC Lan Proxy (Trial)\n MC Lan Proxy (Paid)\n MC Server Connector\n Tempest\n\n\nUsing an iOS device\nIf you have an iOS 14+ device, you can use BedrockTogether."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-community-geyser-projects": {
|
||
"id": "other-community-geyser-projects",
|
||
"title": "Community Geyser Projects",
|
||
"url": "/other/community-geyser-projects/",
|
||
"content": "Below is a list of community-compiled plugins, extensions and tools that work with Geyser.\n\nPlease note that, as these are unofficial, the main Geyser Discord will likely be unable to help with any bugs or issues you run into. Please check the linked pages for their support systems.\n\nIf you wish to add your own plugin to this list, please reach out in the #development channel of Geyser first!\n\nBedrockFormShop\n\nA Spigot shop plugin that uses Bedrock forms.\n\n\n GitHub\n\n\nCreator: KejonaMC\n\nBedrock Player Manager for Floodgate\nA Spigot plugin that is able to run certain commands when a Bedrock player joins, or have Bedrock players able to bypass the anticheat, etc.\n\n\n Spigot page\n\n\nCreator: ofunny\n\nBedrockSkinUtility\nThis is a Fabric mod that allows you to view Bedrock capes from Java.\n\n\n GitHub\n\n\nCreator: Camotoy\n\nCreeperNation Skin API\n\nAn SkinAPI that displays Java or Bedrock skins based on the UUID or username.\n\n\n Website\n\n\nCreators: creeperz653, BlueTree242\n\nCrossplatForms\nA Spigot, BungeeCord, and Velocity plugin to create custom Bedrock Edition forms and inventory menus through configurations.\n\n Spigot page\n GitHub\n\n\nCreators: Konicai, Jens\n\nCustomCommandPrefix\nA Spigot plugin that allows users to enter commands starting with ., to work around Xbox achievements being disabled.\n\n\n Spigot page\n GitHub\n\n\nCreator: Chew\n\nFloodgatePlaceholders\nPlaceholders support for Floodgate.\n\n\n GitHub\n eCloud\n\n\nCreator: rtm516\n\nFloodgate-Skript\nFloodgate support for Skript.\n\n\n GitHub\n\n\nCreator: Camotoy\n\nGeyserBlockJavaPlayers\nPlugin that blocks Java players from joining your Geyser server, so you can have a Bedrock only server that can use Spigot plugins.\n\n\n GitHub\n\n\nCreator: Camotoy\n\nGeyserPreventServerSwitch\nPrevent Bedrock players from joining specific sub-servers on a proxy\n\n\n GitHub\n\n\nCreator: Camotoy\n\nGeyserSkinManager\nSpigot and Bungee plugin to make Bedrock skins work; requires Geyser to be installed on the server.\n\n GitHub\n\n\nCreator: Camotoy\n\nGeyserUpdater\nThis is a Spigot/BungeeCord/Velocity plugin that can be used to automatically update Geyser.\n\n\n GitHub\n Spigot page\n\n\nCreators: Jens, YHDiamond, Konicai\n\nSleepingServerStarter\nSmall application that waits for a player to connect before launching actual minecraft server.\n\n GitHub\n\n\nCreator: Vincss\n\nTydiumCraft Skin API\nAn API makes it easier for your Bedrock skin to be rendered and outputted!\n\n Website\n\n\nCreators: Tydium"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-developer-guide": {
|
||
"id": "other-developer-guide",
|
||
"title": "Developer Guide",
|
||
"url": "/other/developer-guide/",
|
||
"content": "Compiling\n\n Clone the repo to your computer (EG: git clone https://github.com/GeyserMC/Geyser.git)\n Install Maven\n Navigate to the Geyser root directory and run git submodule update --init --recursive. This downloads all the needed submodules for Geyser and is a crucial step in this process.\n Run mvn clean install and locate to the bootstrap, then your desired Geyser version, then target folder.\n\n\nProject layout\n\n bootstrap is where we hold the specific platform code. So if you’re porting Geyser to a new platform, or working with platform-specific code, you likely want to be in here.\n core is where connections are handled and the data conversion is done. The majority of Geyser work is held here.\n\n\nCompiler Tools\n\nLombok\n\nNote that the latest version of IntelliJ IDEA does not require additional setup in order to develop with Geyser.\n\nIf you’re using an IDE for editing any of the GeyserMC projects you will most likely need to install the Project Lombok plugin as it is used to generate a bunch of handy functions. You can edit without it but you may get missing functions and or other issues displayed in your IDE. Please see the IDE section on their site for the supported plugins and install methods https://projectlombok.org/setup/overview.\n\nProtocol Information\n\nGopherTunnel\nGopherTunnel is a library for Bedrock Edition written in Go. The source code is an excellent documentation for the Bedrock protocol.\n\nwiki.vg\nFor a full rundown of the Java Edition protocol, see here.\n\nwiki.vg (Bedrock)\nThe Bedrock Edition protocol is documented here, but it’s currently incomplete so only use it as a reference.\n\nPrograms\n\ndebuginfo-be\ndebuginfo-be is a Spigot plugin that displays an overlay to Geyser clients with useful debug information, similar to the F3 screen in Java Edition.\n\npakkit\npakkit is a GUI-based tool for intercepting packets between a server and client developed by Geyser contributor circuit10/Heath123 built using Electron. It works for both Java Edition (using node-minecraft-protocol) and Bedrock (as a GUI wrapper for ProxyPass adding extra features). It supports features such as viewing packet data in JSON format, Edit and Resend and a hex view for raw packet data. You can download it from here. It’s currently WIP, so expect bugs.\n\nGadget\nGadget is a fabric client mod to inspect & log, amongst other things, packets sent between a java server and a java client. It can be useful to determine java behavior.\nYou can download it from here.\n\nProxyPass\nProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the Cloudburst team. It can be found here and the vanilla Bedrock server can be found here.\n\nMCC Toolchest\nMCC Toolchest is a tool for viewing and editing NBT data for Bedrock edition, this allows you to see data as it is stored in Bedrock. You can download it from here.\n\nNBTExplorer\nNBTExplorer is a tool for viewing and editing NBT data for Java edition, this allows you to see data as it is stored in Java edition. You can download it from here.\n\nWindows 10 Multi-Version Launcher\nThe Windows 10 Multi-Version launcher allows you to switch between release and beta versions of Minecraft Bedrock. Its GitHub repository can be viewed here.\nAlternatively, use FoxyNoTail’s Version Switcher, found here.\nNote: To apply the loopback fix for Minecraft Preview, use the following loopback restriction lifting command with the different app ID: CheckNetIsolation LoopbackExempt -a -n=\"Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe\""
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-discord-bot-usage": {
|
||
"id": "other-discord-bot-usage",
|
||
"title": "Discord Bot Usage",
|
||
"url": "/other/discord-bot-usage/",
|
||
"content": "Our discord bot provides some very useful toos to debug/issue track your server. We will go in-depth on how to use the bot commands and its tools.\n\nServer Logs\n\nIf you are having console errors or Geyser isn’t functioning/starting up, server logs are very useful to find the root cause of why Geyser is not running. You can safely share your server logs with mclogs as it will remove all IP addresses and other sensitive information from the logs.\n\nIf you paste the logs URL into our Discord, our bot will analyze the error and will give a fix if there is one present like seen below. You can also paste the latest.log file into Discord.\n\n\n\nOCR\n\nOCR or Optical Character Recognition is something that our discord bot can process, which means if you upload a picture/image into our discord that contains an error like seen below the bot might be able to help you out with our issue.\n\n\n\nPing Server\n\nIf you are not sure if your server is reachable from the outside you can use our ping tool. Using the ping command in #bot-spam; /ping “serverip” as seen below, The bot will check if your server is online/reachable. When you are not running your server on default port: java 25565 and bedrock 19132 you will need to specify the port like /ping “serverip:serverport”.\n\nIf the bot returns Unable to find Java/Bedrock server at the requested address, your server either is not running/setup properly or your firewall is blocking the connection. More info on how to setup Geyser can be found on the Geyser Setup page.\n\n\n\nProvider List\n\nSome hosting providers have unique setup methods for Geyser. If you do not know how to setup Geyser on your provider you can either checkout the Geyser Host Provider List manually, or use our bot command /provider \"providername\" as seen below.\n\n\n\nDownload Command\n\nSends the download link of the chosen program/plugin. /download \"Geyser\" or /download \"ViaVersion\" and so on.\n\nLeaderboard Command\n\nProvides a link to the Geyser Bot XP leaderboards.\n\nRank Command\n\nYou can give yourself two types of roles on our discord, “GeyserNews” and “Testers”. You can use the command /rank \"chosen rank\" to give one to yourself.\n\nQueue Command\n\nDisplays Current global api skin queue upload times."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-geyserconnect": {
|
||
"id": "other-geyserconnect",
|
||
"title": "GeyserConnect",
|
||
"url": "/other/geyserconnect/",
|
||
"content": "GeyserConnect is a extension for Geyser that allows you to join multiple servers using a single GeyserMC proxy.\n\nSetup\n(For GeyserConnect to work you need an open UDP port, by default it’s 19132.)\n\n Download the latest Geyser build from the downloads page\n Download the latest build from Github Actions\n Extract the downloaded ZIP file, and put the extracted JAR file into the extensions folder in your GeyserMC standalone installation.\n Start Geyser standalone as you do with a normal Geyser install. EG: java -Xms1024M -jar Geyser.jar (More info on Creating a Startup Script)\n Shutdown the standalone Geyser instance, and make you’re desired changes to the GeyserConnect configuration in GeyserConnect in the extensions folder.\n Connect to it to make sure its all working.\n\n\nDNS\nThere are DNS (using bind9) configs in the repo if you would like to use them.\n\nConfig\nSee here."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-geyseroptionalpack": {
|
||
"id": "other-geyseroptionalpack",
|
||
"title": "GeyserOptionalPack",
|
||
"url": "/other/geyseroptionalpack/",
|
||
"content": "Download here\n\nGeyserOptionalPack is a Bedrock resource pack that adds more features to Geyser to bring Bedrock Edition in line with Java Edition. A resource pack allows various features and bug fixes to be implemented in Bedrock, including:\n\n\n Armor stand poses and arm/baseplate visibility\n Illusioner texture\n Missing particles, like sweep attack\n Spectral arrow entity texture\n\n\nA more complete list can be found on the optional pack’s README. Implementation details for those interested in how features are added can be found here.\n\nWhile recommended, it is not required to install the resource pack on the server - clients can install it themselves. Additionally, if you use a proxy like WaterdogPE, you can install the pack on the server without impacting gameplay on other Bedrock servers.\n\nResource pack conflicts\n\nIf your current server resource pack contains any entity definitions that overlap with the optional pack, you will need to merge the definitions for these entities for the optional pack and your own pack to work correctly. Otherwise, the prevailing entity definition will be based on pack application order. This process is best performed manually due to the complexity of entity definition files, though it can also be scripted."
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-hurricane": {
|
||
"id": "other-hurricane",
|
||
"title": "Hurricane",
|
||
"url": "/other/hurricane/",
|
||
"content": "Hurricane\n\nHurricane is a Paper/Spigot plugin, and Fabric mod (unofficial port), that fixes some bugs that otherwise cannot be fixed without server modification.\n\nFixes\nIssues with each workaround are listed in the plugin’s config. Please take your time to read them as the workarounds in this plugin can be used for exploitative purposes.\n\n\n Bamboo and dripstone collision (by setting them to no server-side collision)\n https://github.com/GeyserMC/Geyser/issues/638 by implementing the control server-side.\n\n\nSupported Versions:\n\n 1.14.x - 1.20.x\n 1.17.x & above for pig riding\n\n\nDownload\n\n Spigot/Paper: GitHub releases\n Fabric: Modrinth\n\n\nSource\n\n Main: GeyserMC/Hurricane\n Unofficial fabric fork: onebeastchris/Hurricane-fabric"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other": {
|
||
"id": "other",
|
||
"title": "Other",
|
||
"url": "/other/",
|
||
"content": "Other"
|
||
}
|
||
|
||
|
||
|
||
|
||
,
|
||
|
||
"other-test-server": {
|
||
"id": "other-test-server",
|
||
"title": "Test Server",
|
||
"url": "/other/test-server/",
|
||
"content": "Details\n\n IP: test.geysermc.org (default ports on both Bedrock and Java)\n World size: 20k x 20k\n\n\nInfomation\nGeyser has a test server for those who want to test how Java <-> Bedrock crossplay works on their device, and to see the limitations and restrictions. You can join from either Bedrock or Java, and the server has Floodgate installed so you don’t need a Java account to join from Bedrock.\n\nIf you can’t build/destroy/interact with the world in the test server, run /rtp to get away from the protected spawn area.\n\nIf you have any questions or problems be sure to join our Discord!\n\nCommands:\n\n\n \n \n Command\n Desc\n \n \n \n \n /rtp\n Teleport to a random location\n \n \n /ll\n LandLord base command for managing land claims\n \n \n /spawn\n Teleport to spawn\n \n \n /home\n Set/go-to a home\n \n \n /linkaccount\n Link your Java and Bedrock accounts"
|
||
}
|
||
|
||
|
||
|
||
};
|
||
</script>
|
||
<script src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/0.7.0/lunr.min.js"
|
||
integrity="sha512-eWBLTdGT/I5jd80U2J0TyF2G+Fja6TiTYR6Ymeva7QgGUCy9EA/qhoppa4B/wYn7yWXZ8azgremVGtBi3EFDvg=="
|
||
crossorigin="anonymous" referrerpolicy="no-referrer"></script>
|
||
<script src="/js/search.js"></script>
|
||
|
||
|
||
</main>
|
||
<div class="col-2 d-none d-xl-block">
|
||
<div class="sticky-top">
|
||
<div class="sidebar py-2">
|
||
<a class="d-block text-decoration-none" href="https://github.com/GeyserMC/GeyserWiki/edit/master/pages/search.html" target="_blank"><i class="bi bi-pencil"></i> Edit this page</a>
|
||
<a class="d-block text-decoration-none" href="https://github.com/GeyserMC/GeyserWiki/issues/new?labels=question&title=Question:&body=Question on: pages/search.html" target="_blank"><i class="bi bi-github"></i> Create Wiki issue/bug report</a>
|
||
<a class="d-block text-decoration-none" href="/issues/new" target="_blank"><i class="bi bi-list-check"></i> Create Geyser issue/bug report</a>
|
||
|
||
<div id="page-nav" class="py-3 "></div>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!-- <footer class="p-4 text-center bg-body-tertiary">
|
||
© 2023 GeyserMC
|
||
</footer> -->
|
||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" integrity="sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" crossorigin="anonymous"></script>
|
||
<script src="/js/page-nav.js"></script>
|
||
</body>
|
||
</html>
|