510 lines
17 KiB
HTML
510 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: Getting Started with the API</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: Getting Started with the API">
|
||
<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 show" 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 show">
|
||
|
||
<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"><a href="http://localhost:4000/geyser/">Geyser</a></li>
|
||
|
||
|
||
|
||
|
||
<li class="breadcrumb-item active" aria-current="page">Getting Started with the API</li>
|
||
|
||
|
||
</ol>
|
||
</nav>
|
||
|
||
<p>To start, add the Open Collaboration repository to your project:</p>
|
||
|
||
<p><strong>Maven</strong></p>
|
||
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><repository></span>
|
||
<span class="nt"><id></span>opencollab-snapshot<span class="nt"></id></span>
|
||
<span class="nt"><url></span>https://repo.opencollab.dev/main/<span class="nt"></url></span>
|
||
<span class="nt"></repository></span>
|
||
</code></pre></div></div>
|
||
<p>The “main” repository contains both release and snapshot versions.</p>
|
||
|
||
<p><strong>Gradle</strong></p>
|
||
<div class="language-groovy highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">repositories</span> <span class="o">{</span>
|
||
<span class="n">maven</span> <span class="o">{</span>
|
||
<span class="n">url</span> <span class="o">=</span> <span class="n">uri</span><span class="o">(</span><span class="s2">"https://repo.opencollab.dev/main/"</span><span class="o">)</span>
|
||
<span class="o">}</span>
|
||
<span class="o">}</span>
|
||
</code></pre></div></div>
|
||
|
||
<h2 id="using-geyser">Using Geyser</h2>
|
||
|
||
<p>Add Geyser’s API codebase as a dependency:</p>
|
||
|
||
<p><strong>Maven</strong></p>
|
||
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><dependency></span>
|
||
<span class="nt"><groupId></span>org.geysermc.geyser<span class="nt"></groupId></span>
|
||
<span class="nt"><artifactId></span>api<span class="nt"></artifactId></span>
|
||
<span class="nt"><version></span>2.2.0-SNAPSHOT<span class="nt"></version></span>
|
||
<span class="nt"><scope></span>provided<span class="nt"></scope></span>
|
||
<span class="nt"></dependency></span>
|
||
</code></pre></div></div>
|
||
|
||
<p><strong>Gradle</strong></p>
|
||
<div class="language-groovy highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">dependencies</span> <span class="o">{</span>
|
||
<span class="n">compileOnly</span><span class="o">(</span><span class="s1">'org.geysermc.geyser:api:2.2.0-SNAPSHOT'</span><span class="o">)</span>
|
||
<span class="o">}</span>
|
||
</code></pre></div></div>
|
||
|
||
<p>To get a Geyser player, or check if a player is from Bedrock:</p>
|
||
|
||
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">GeyserConnection</span> <span class="n">connection</span> <span class="o">=</span> <span class="nc">GeyserApi</span><span class="o">.</span><span class="na">api</span><span class="o">().</span><span class="na">connectionByUuid</span><span class="o">(</span><span class="n">uuid</span><span class="o">);</span>
|
||
</code></pre></div></div>
|
||
|
||
<p><code class="language-plaintext highlighter-rouge">connection</code> can be null if such a player does not exist on Geyser.</p>
|
||
|
||
<p><code class="language-plaintext highlighter-rouge">GeyserApi.api()</code> may be null until after the Geyser plugin enables.</p>
|
||
|
||
<p>For more information on the Geyser API, see <a href="/geyser/api/">here</a>.</p>
|
||
|
||
<h2 id="using-floodgate">Using Floodgate</h2>
|
||
<p>This page has a very simple primer for the Floodgate API. For a full breakdown, see <a href="/floodgate/api/">here</a>.</p>
|
||
|
||
<p>Add Floodgate’s API as a dependency:</p>
|
||
|
||
<p><strong>Maven</strong></p>
|
||
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><dependency></span>
|
||
<span class="nt"><groupId></span>org.geysermc.floodgate<span class="nt"></groupId></span>
|
||
<span class="nt"><artifactId></span>api<span class="nt"></artifactId></span>
|
||
<span class="nt"><version></span>2.2.2-SNAPSHOT<span class="nt"></version></span>
|
||
<span class="nt"><scope></span>provided<span class="nt"></scope></span>
|
||
<span class="nt"></dependency></span>
|
||
</code></pre></div></div>
|
||
|
||
<p><strong>Gradle</strong></p>
|
||
<div class="language-groovy highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">dependencies</span> <span class="o">{</span>
|
||
<span class="n">compileOnly</span><span class="o">(</span><span class="s1">'org.geysermc.floodgate:api:2.2.2-SNAPSHOT'</span><span class="o">)</span>
|
||
<span class="o">}</span>
|
||
</code></pre></div></div>
|
||
|
||
<p>Get the Floodgate API using:</p>
|
||
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">FloodgateApi</span> <span class="n">api</span> <span class="o">=</span> <span class="nc">FloodgateApi</span><span class="o">.</span><span class="na">getInstance</span><span class="o">();</span>
|
||
<span class="n">api</span><span class="o">.</span><span class="na">isFloodgatePlayer</span><span class="o">(</span><span class="n">uuid</span><span class="o">);</span>
|
||
</code></pre></div></div>
|
||
|
||
<p>For more information on the Floodgate API, see <a href="/floodgate/api/">here</a>.</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/geyser/getting-started-with-the-api.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/geyser/getting-started-with-the-api.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>
|