494 lines
17 KiB
HTML
494 lines
17 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: Developer Guide</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: Developer Guide">
|
||
<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 show" 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 show">
|
||
|
||
<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"><a href="http://localhost:4000/other/">Other</a></li>
|
||
|
||
|
||
|
||
|
||
<li class="breadcrumb-item active" aria-current="page">Developer Guide</li>
|
||
|
||
|
||
</ol>
|
||
</nav>
|
||
|
||
<h2 id="compiling">Compiling</h2>
|
||
<ol>
|
||
<li>Clone the repo to your computer (EG: <code class="language-plaintext highlighter-rouge">git clone https://github.com/GeyserMC/Geyser.git</code>)</li>
|
||
<li><a href="https://maven.apache.org/install.html">Install Maven</a></li>
|
||
<li>Navigate to the Geyser root directory and run <code class="language-plaintext highlighter-rouge">git submodule update --init --recursive</code>. This downloads all the needed submodules for Geyser and is a crucial step in this process.</li>
|
||
<li>Run <code class="language-plaintext highlighter-rouge">mvn clean install</code> and locate to the <code class="language-plaintext highlighter-rouge">bootstrap</code>, then your desired Geyser version, then <code class="language-plaintext highlighter-rouge">target</code> folder.</li>
|
||
</ol>
|
||
|
||
<h2 id="project-layout">Project layout</h2>
|
||
<ul>
|
||
<li><code class="language-plaintext highlighter-rouge">bootstrap</code> 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.</li>
|
||
<li><code class="language-plaintext highlighter-rouge">core</code> is where connections are handled and the data conversion is done. The majority of Geyser work is held here.</li>
|
||
</ul>
|
||
|
||
<h1 id="compiler-tools">Compiler Tools</h1>
|
||
|
||
<h2 id="lombok">Lombok</h2>
|
||
|
||
<p><em>Note that the latest version of IntelliJ IDEA does not require additional setup in order to develop with Geyser.</em></p>
|
||
|
||
<p>If 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 <a href="https://projectlombok.org/setup/overview">https://projectlombok.org/setup/overview</a>.</p>
|
||
|
||
<h1 id="protocol-information">Protocol Information</h1>
|
||
|
||
<h2 id="gophertunnel">GopherTunnel</h2>
|
||
<p><a href="https://github.com/Sandertv/gophertunnel/tree/master/minecraft/protocol/packet">GopherTunnel</a> is a library for Bedrock Edition written in Go. The source code is an excellent documentation for the Bedrock protocol.</p>
|
||
|
||
<h2 id="wikivg">wiki.vg</h2>
|
||
<p>For a full rundown of the Java Edition protocol, see <a href="https://wiki.vg/Protocol">here</a>.</p>
|
||
|
||
<h2 id="wikivg-bedrock">wiki.vg (Bedrock)</h2>
|
||
<p>The Bedrock Edition protocol is documented <a href="https://wiki.vg/Bedrock_Protocol">here</a>, but it’s currently incomplete so only use it as a reference.</p>
|
||
|
||
<h1 id="programs">Programs</h1>
|
||
|
||
<h2 id="debuginfo-be">debuginfo-be</h2>
|
||
<p><a href="https://github.com/Heath123/debuginfo-be">debuginfo-be</a> is a Spigot plugin that displays an overlay to Geyser clients with useful debug information, similar to the F3 screen in Java Edition.</p>
|
||
|
||
<h2 id="pakkit">pakkit</h2>
|
||
<p>pakkit is a GUI-based tool for intercepting packets between a server and client developed by Geyser contributor <a href="https://github.com/Heath123/">circuit10/Heath123</a> 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 <a href="https://github.com/Heath123/pakkit/releases/">here</a>. It’s currently WIP, so expect bugs.</p>
|
||
|
||
<h2 id="gadget">Gadget</h2>
|
||
<p>Gadget 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.
|
||
You can download it from <a href="https://modrinth.com/mod/gadget">here</a>.</p>
|
||
|
||
<h2 id="proxypass">ProxyPass</h2>
|
||
<p>ProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the Cloudburst team. It can be found <a href="https://github.com/CloudburstMC/ProxyPass">here</a> and the vanilla Bedrock server can be found <a href="https://www.minecraft.net/download/server/bedrock/">here</a>.</p>
|
||
|
||
<h2 id="mcc-toolchest">MCC Toolchest</h2>
|
||
<p>MCC 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 <a href="https://mcctoolchest.weebly.com/">here</a>.</p>
|
||
|
||
<h2 id="nbtexplorer">NBTExplorer</h2>
|
||
<p>NBTExplorer 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 <a href="https://github.com/jaquadro/NBTExplorer/releases">here</a>.</p>
|
||
|
||
<h2 id="windows-10-multi-version-launcher">Windows 10 Multi-Version Launcher</h2>
|
||
<p>The Windows 10 Multi-Version launcher allows you to switch between release and beta versions of Minecraft Bedrock. Its GitHub repository can be viewed <a href="https://github.com/MCMrARM/mc-w10-version-launcher/">here</a>.
|
||
Alternatively, use FoxyNoTail’s Version Switcher, found <a href="https://foxynotail.com/software/mcbe-switcher">here</a>.
|
||
Note: To apply the <a href="/geyser/fixing-unable-to-connect-to-world/#windows-1011">loopback fix</a> for Minecraft Preview, use the following loopback restriction lifting command with the different app ID: <code class="language-plaintext highlighter-rouge">CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe"</code></p>
|
||
|
||
|
||
</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/_docs/other/developer-guide.md" 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: _docs/other/developer-guide.md" 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>
|