TRX/GeyserWebsite
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial docuasarus and tweaks

Browse Source
This commit is contained in:
Chew committed 2023-11-07 19:40:55 -06:00
1 parent 57cc85d951
commit 8576839fee
224 files changed
+45653 -368
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.editorconfig
+2
View File
@@ -0,0 +1,2 @@
# All .md files should be treated as Jekyll files
.gitignore
+23
View File
@@ -3,3 +3,26 @@ _site
.jekyll-cache
.jekyll-metadata
vendor
.idea/
# Dependencies
/node_modules
# Production
/build
# Generated files
.docusaurus
.cache-loader
# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.idea/.gitignore
Generated
+8
View File
@@ -0,0 +1,8 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml
.idea/GeyserWiki.iml
Generated
+118
View File
@@ -0,0 +1,118 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="RUBY_MODULE" version="4">
<component name="ModuleRunConfigurationManager">
<shared />
</component>
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/_site" />
</content>
<orderEntry type="jdk" jdkName="RVM: ruby-3.0.0" jdkType="RUBY_SDK" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="lunr.js" level="application" />
<orderEntry type="library" scope="PROVIDED" name="activesupport (v6.0.4.4, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="addressable (v2.8.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="coffee-script (v2.4.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="coffee-script-source (v1.11.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="colorator (v1.1.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="commonmarker (v0.17.13, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.9, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="dnsruby (v1.61.9, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="em-websocket (v0.5.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="ethon (v0.15.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="eventmachine (v1.2.7, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="execjs (v2.8.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday (v1.9.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-em_http (v1.0.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-em_synchrony (v1.0.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-excon (v1.1.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-httpclient (v1.0.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-multipart (v1.0.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-net_http (v1.0.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-net_http_persistent (v1.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-patron (v1.0.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-rack (v1.0.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="faraday-retry (v1.0.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="ffi (v1.15.5, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="forwardable-extended (v2.6.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="gemoji (v3.0.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="github-pages (v223, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="github-pages-health-check (v1.17.9, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="html-pipeline (v2.14.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="http_parser.rb (v0.8.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="i18n (v0.9.5, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll (v3.9.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-avatar (v0.7.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-coffeescript (v1.1.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-commonmark (v1.3.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-commonmark-ghpages (v0.1.6, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-default-layout (v0.1.4, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-feed (v0.15.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-gist (v1.5.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-github-metadata (v2.13.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-include-cache (v0.2.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-mentions (v1.6.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-optional-front-matter (v0.3.2, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-paginate (v1.1.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-readme-index (v0.3.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-redirect-from (v0.16.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-relative-links (v0.6.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-remote-theme (v0.4.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-sass-converter (v1.5.2, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-seo-tag (v2.7.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-sitemap (v1.4.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-swiss (v1.0.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-architect (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-cayman (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-dinky (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-hacker (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-leap-day (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-merlot (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-midnight (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-minimal (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-modernist (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-primer (v0.6.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-slate (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-tactile (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-theme-time-machine (v0.2.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-titles-from-headings (v0.5.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jekyll-watch (v2.2.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="jemoji (v0.12.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="kramdown (v2.3.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="kramdown-parser-gfm (v1.1.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="liquid (v4.0.3, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="listen (v3.7.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="mercenary (v0.3.6, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="mini_portile2 (v2.7.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="minima (v2.5.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="minitest (v5.15.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="multipart-post (v2.1.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="octokit (v4.22.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="pathutil (v0.16.2, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="public_suffix (v4.0.6, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="racc (v1.6.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="rb-fsevent (v0.11.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="rb-inotify (v0.10.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="rouge (v3.26.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="ruby-enum (v0.9.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="ruby2_keywords (v0.0.5, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="rubyzip (v2.3.2, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="safe_yaml (v1.0.5, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="sass (v3.7.4, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="sass-listen (v4.0.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="sawyer (v0.8.2, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="simpleidn (v0.2.1, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="terminal-table (v1.8.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.6, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="typhoeus (v1.4.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="tzinfo (v1.2.9, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v1.8.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="webrick (v1.7.0, RVM: ruby-3.0.0) [gem]" level="application" />
<orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.5.4, RVM: ruby-3.0.0) [gem]" level="application" />
</component>
</module>
.idea/codeStyles/codeStyleConfig.xml
Generated
+5
View File
@@ -0,0 +1,5 @@
<component name="ProjectCodeStyleConfiguration">
<state>
<option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
</state>
</component>
.idea/discord.xml
Generated
+7
View File
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="DiscordProjectSettings">
<option name="show" value="PROJECT_FILES" />
<option name="description" value="" />
</component>
</project>
.idea/git_toolbox_prj.xml
Generated
+20
View File
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="GitToolBoxProjectSettings">
<option name="commitMessageIssueKeyValidationOverride">
<BoolValueOverride>
<option name="enabled" value="true" />
</BoolValueOverride>
</option>
<option name="commitMessageValidationConfigOverride">
<CommitMessageValidationOverride>
<option name="enabled" value="true" />
</CommitMessageValidationOverride>
</option>
<option name="commitMessageValidationEnabledOverride">
<BoolValueOverride>
<option name="enabled" value="true" />
</BoolValueOverride>
</option>
</component>
</project>
.idea/inspectionProfiles/Project_Default.xml
Generated
+6
View File
@@ -0,0 +1,6 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
</profile>
</component>
.idea/misc.xml
Generated
+4
View File
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectRootManager" version="2" project-jdk-name="ruby-3.0.2-p107" project-jdk-type="RUBY_SDK" />
</project>
.idea/modules.xml
Generated
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/GeyserWiki.iml" filepath="$PROJECT_DIR$/.idea/GeyserWiki.iml" />
</modules>
</component>
</project>
.idea/vcs.xml
Generated
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="" vcs="Git" />
</component>
</project>
Gemfile.lock
+7 -7
View File
@@ -29,7 +29,7 @@ GEM
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
ffi (1.15.5)
ffi (1.15.5-x64-mingw-ucrt)
ffi (1.15.5-x64-unknown)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (228)
@@ -211,7 +211,9 @@ GEM
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.18.0)
nokogiri (1.14.3-x64-mingw-ucrt)
nokogiri (1.14.3-arm64-darwin)
racc (~> 1.4)
nokogiri (1.14.3-x64-unknown)
racc (~> 1.4)
nokogiri (1.14.3-x86_64-linux)
racc (~> 1.4)
@@ -246,18 +248,16 @@ GEM
ethon (>= 0.9.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
tzinfo-data (1.2022.7)
tzinfo (>= 1.0.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unf_ext (0.0.8.2-x64-mingw-ucrt)
unf_ext (0.0.8.2-x64-unknown)
unicode-display_width (1.8.0)
wdm (0.1.1)
webrick (1.8.1)
PLATFORMS
x64-mingw-ucrt
arm64-darwin-22
x64-unknown
x86_64-linux
DEPENDENCIES
README.md
+39 -3
View File
@@ -1,5 +1,41 @@
# GeyserMC Wiki
# Website
This is the repository that contains the wiki for all of GeyserMCs projects.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
The wiki can be accessed using [this link](https://wiki.geysermc.org).
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
_data/faq.yml
+2 -2
View File
@@ -37,9 +37,9 @@
content: |
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.
Since Geyser emulates a {{ site.data.versions.java }} Java Edition client, you need to [install ViaVersion](https://www.spigotmc.org/resources/viaversion.19254/) on your server
if it is not running the latest version of Minecraft. <br>
if it is not running the latest version of Minecraft.
In 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](/geyser/secure-chat/). <br>
In 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](/geyser/secure-chat/).
You will also need to run at least Java 16 or later to use Geyser. See [here](https://docs.papermc.io/misc/java-install) for more info on updating Java.
Paper versions not supporting Java 16 can add `-DPaper.IgnoreJavaVersion=true` flag to the Java startup arguments to allow Paper to run on Java 16.
_docs/floodgate/setup.md
-50
View File
@@ -1,50 +0,0 @@
---
title: Floodgate Setup
page_sidebar: false
---
# Floodgate Setup
<div class="alert alert-warning" role="alert">
Floodgate does <b>NOT</b> replace Geyser! It allows Geyser players to join servers without needing to log into a paid Java Edition account. <br>
</div>
<div class="nav nav-tabs setup-tabs" role="tablist" aria-label="Setup Options">
<li class="nav-item" role="presentation">
<a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option" type="button" role="tab" aria-controls="spigot-option" aria-selected="false"><img src="{{ '/img/icons/paper.png' | relative_url }}" alt="paper icon"> Paper / Spigot</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option" type="button" role="tab" aria-controls="fabric-option" aria-selected="false"><img src="{{ '/img/icons/fabric.png' | relative_url }}" alt="fabric icon"> Fabric</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option" type="button" role="tab" aria-controls="proxy-option" aria-selected="false"><img src="{{ '/img/icons/velocity.svg' | relative_url }}" alt="velocity icon"> Proxy Servers</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option" type="button" role="tab" aria-controls="standalone-option" aria-selected="false"><img src="{{ '/img/icons/geyser.png' | relative_url }}" alt="geyser icon"> Standalone</a>
</li>
</div>
<div class="tab-content mt-4">
<div id="spigot-option" class="tab-pane fade show active" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/spigot.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="fabric-option" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/fabric.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="proxy-option" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/proxy.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
<div id="standalone-option" class="tab-pane fade" role="tabpanel">
{% capture my_include %}{% include setup/instructions/floodgate/standalone.md %}{% endcapture %}
{{ my_include | markdownify }}
</div>
</div>
<h4 class="mt-4">Further information:</h4>
<ul>
<li><a href="/floodgate/features/">Floodgate Features</a></li>
<li><a href="/floodgate/api/">Floodgate API</a></li>
</ul>
_docs/geyser/anticheat-compatibility.md
-38
View File
@@ -1,38 +0,0 @@
---
title: Anticheat Compatibility
---
<div class="alert alert-warning" role="alert">
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!
</div>
### AntiCheat compatibility reports
Full Compatibility (Checks Bedrock Players Accurately)
- [AntiAura](https://www.spigotmc.org/resources/1368/){:target="_blank"} (Paid) - Last Updated on 19th August 2021
- [Themis](https://www.spigotmc.org/resources/90766/){:target="_blank"} - Last Updated on 15th Jun 2022
- [Negativity V2](https://www.spigotmc.org/resources/86874/){:target="_blank"} (Paid) - Last Updated on 21st March 2022
- [SoaromaSAC](https://www.spigotmc.org/resources/87702/){:target="_blank"} - Last Updated on 27th March 2022
- [Spartan: Bedrock Edition](https://builtbybit.com/resources/12832/){:target="_blank"} (Paid) - Last Updated on 22nd May 2023
Partially Compatible (Does not Check/Ignores Bedrock Players)
- [AAC](https://www.spigotmc.org/resources/6442/){:target="_blank"} (Paid) - Last Updated on 19th August 2021
- [Flappy Anticheat](https://www.spigotmc.org/resources/92180/){:target="_blank"} - Last Updated on 14th September 2021
- [GrimAC](https://github.com/MWHunter/Grim){:target="_blank"} - Last Updated on 24th March 2022
- [Intave](https://intave.ac){:target="_blank"} (Paid) Requires [GeyserMC addon](https://github.com/intave/bedrock){:target="_blank"} - Last Updated on 24th October 2022
- [Matrix](https://matrix.rip/){:target="_blank"} (Paid) - Last updated on 2nd September 2021
- [Spartan: Java Edition](https://www.spigotmc.org/resources/25638/){:target="_blank"} (Paid) - Last Updated on 22nd May 2023
- [Vulcan](https://www.spigotmc.org/resources/83626/){:target="_blank"} (Paid) - Last Updated on 19th August 2021
- [Verus](https://verus.ac){:target="_blank"} (Paid) - Last Updated on 13th July 2022
Incompatible (False Positives on Bedrock Players, no Compatibility at All)
- [AntiCheatReloaded](https://www.spigotmc.org/resources/23799/){:target="_blank"} - Last Updated on 19th August 2021
- [Negativity V1](https://www.spigotmc.org/resources/48399/){:target="_blank"} - Last Updated on 21st March 2022
- [NoCheatPlus](https://ci.codemc.io/job/Updated-NoCheatPlus/job/Updated-NoCheatPlus/){:target="_blank"} ([Compat NCP](https://github.com/Updated-NoCheatPlus/CompatNoCheatPlus/){:target="_blank"} is an addon that enables Partial Compatibility) - Last Updated on 19th August 2021
- [GodsEye](https://www.spigotmc.org/resources/69595/){:target="_blank"} ([GodsEyeGeyserMC](https://github.com/TheDejavu/GodsEyeGeyserMC/releases){:target="_blank"} is an addon that enables Partial Compatibility) (Paid) - Last Updated on 21st March 2022
- [Kauri](https://www.spigotmc.org/resources/53721/){:target="_blank"} (Paid) - Last Updated on 21st March 2022
- [Reflex](https://www.spigotmc.org/resources/21122/){:target="_blank"} (Paid) - Last Updated on 19th August 2021
- [Wraith](https://www.spigotmc.org/resources/66887/){:target="_blank"} (Paid) - Last Updated on 19th August 2021
_docs/geyser/commands.md
-22
View File
@@ -1,22 +0,0 @@
---
title: Commands
---
# Commands and Permissions
| Command | Permission | Description |
|:---:|:---:|:---:|
| `geyser help` <br> `geyser ?` | `geyser.command.help` | Shows help for all registered commands. |
| `geyser advancements` | `geyser.command.advancements` | Open the Java advancements menu. |
| `geyser dump` | `geyser.command.dump` | Dumps Geyser debug information for bug reports. |
| `geyser list` | `geyser.command.list` | List all players connected through Geyser. |
| `geyser offhand` | `geyser.command.offhand` | Puts an item in your offhand. |
| `geyser reload` | `geyser.command.reload` | Reloads the Geyser configurations. Kicks all players when used! |
| `geyser settings` | `geyser.command.settings` | Opens a settings menu allowing you to modify aspects of the world. |
| `geyser shutdown` <br> `geyser stop` | `geyser.command.shutdown` | Shuts down Geyser.<br>*This command only works on Standalone.* |
| `geyser statistics` | `geyser.command.statistics` | Open the Java statistics menu. |
| `geyser version` | `geyser.command.version` | Shows the current Geyser version and checks for updates. |
| `geyser tooltips` | `geyser.command.tooltips`| Toggle showing Advanced Tooltips (F3 + H on Java) |
For Floodgate commands, see [here](/floodgate/commands/).
_docs/geyser/faq.md
-25
View File
@@ -1,25 +0,0 @@
---
title: FAQ
---
{% for section in site.data.faq %}
<h1 id="{{ section.title | slugify }}">{{ section.title }}</h1>
{% if section.desc != nil %}<p>{{ section.desc | markdownify }}</p>{% endif %}
<div class="accordion mb-4" id="accordionFaq">
{% for question in section.items %}
{% assign id = question.title | slugify %}
<div class="accordion-item">
<h2 class="accordion-header">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#{{ id }}" aria-expanded="true" aria-controls="{{ id }}">
{{ question.title }}
</button>
</h2>
<div id="{{ id }}" class="accordion-collapse collapse" data-bs-parent="#accordionFaq">
<div class="accordion-body">
{{ question.content | markdownify }}
</div>
</div>
</div>
{% endfor %}
</div>
{% endfor %}
_docs/geyser/setup.md
-33
View File
@@ -1,33 +0,0 @@
---
title: Setup
page_sidebar: false
---
<div class="row gap-4 mx-0" role="tablist">
<a class="col btn btn-outline-primary active" href="#" data-bs-toggle="tab" data-bs-target="#host-provider-options" type="button" role="tab" aria-controls="host-provider-options" aria-selected="true">Host Provider</a>
<a class="col btn btn-outline-primary" href="#" data-bs-toggle="tab" data-bs-target="#self-host-options" type="button" role="tab" aria-controls="self-host-options" aria-selected="false">Self Host</a>
</div>
<div class="tab-content mt-4">
<div id="host-provider-options" class="tab-pane fade show active" role="tabpanel">
{% include setup/host-provider.html %}
{% include setup/instructions/geyser/tabs.html type="provider" %}
</div>
<div id="self-host-options" class="tab-pane fade" role="tabpanel">
{% include setup/instructions/geyser/tabs.html type="selfhost" show_standalone=true %}
</div>
</div>
<div class="alert alert-warning" role="alert">
<b>Experiencing issues?</b> <br>
Start with the <a href="/geyser/common-issues/">Common Issues</a> page.
If your issue is not included there, join our <a href="https://discord.gg/geysermc">Discord server</a> for support.
</div>
<h4 class="mt-4">Further information:</h4>
<ul>
<li><a href="/geyser/understanding-the-config/">Full config documentation</a></li>
<li><a href="/geyser/current-limitations/">Current Limitations</a></li>
<li><a href="/geyser/faq/">Frequently asked questions</a></li>
</ul>
_docs/geyser/supported-hosting-providers.md
-34
View File
@@ -1,34 +0,0 @@
---
title: Supported Hosting Providers
---
<div class="alert alert-danger" role="alert">
This list is incomplete. Please open a <a href="https://github.com/GeyserMC/GeyserWiki/pulls">PR</a> or contact us on <a href="https://discord.gg/geysermc">Discord</a> if the information is incorrect or you want to add a new hosting provider!
</div>
<div class="alert alert-warning" role="alert">
It 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.
</div>
<div class="alert alert-warning" role="alert">
Using a <i>"Free Host"</i> may not give you the best experience <i>at all</i>. If you want better support, more freedom to control your server, and learn how to run one, PLEASE pay for a server.
</div>
<div class="alert alert-info" role="alert">
The below information is for the plugin versions of Geyser unless otherwise specified
</div>
## Built-in Geyser
{% for provider in site.data.providers.built_in %}
* [{{ provider.name}}]({{ provider.url }}){% if provider.description != nil or provider.description_template != nil %} - {{ site.data.providers.description_templates[provider.description_template] }} {{ provider.description }}{% endif %}
{% endfor %}
## Support for Geyser
{% for provider in site.data.providers.support %}
* [{{ provider.name}}]({{ provider.url }}){% if provider.description != nil or provider.description_template != nil %} - {{ site.data.providers.description_templates[provider.description_template] }} {{ provider.description }}{% endif %}
{% endfor %}
## Does not support Geyser
{% for provider in site.data.providers.no_support %}
* [{{ provider.name}}]({{ provider.url }}){% if provider.description != nil or provider.description_template != nil %} - {{ site.data.providers.description_templates[provider.description_template] }} {{ provider.description }}{% endif %}
{% endfor %}
_includes/setup/host-provider.html
+1 -1
View File
@@ -13,7 +13,7 @@
<script>
window.provider_data = {
"Not listed": {{ "If your hosting provider is not listed, try enabling the `clone-remote-port` option in the config. Then, restart the server, and try connecting with the same IP and port as on Java Edition. <br> If this does not work, ask your server hosting provider for a UDP port, and use that. For VPS/KVM servers please follow the self-hosting steps." | markdownify | jsonify }},
"Not listed": {{ "If your hosting provider is not listed, try enabling the `clone-remote-port` option in the config. Then, restart the server, and try connecting with the same IP and port as on Java Edition. If this does not work, ask your server hosting provider for a UDP port, and use that. For VPS/KVM servers please follow the self-hosting steps." | markdownify | jsonify }},
{% for provider in all_providers %}
"{{ provider.name }}": {{ site.data.providers.description_templates[provider.description_template] | append: " " | append: provider.description | markdownify | strip | jsonify }},
{% endfor %}
_includes/setup/instructions/geyser/provider/fabric.md
+3 -3
View File
@@ -2,7 +2,7 @@
# Fabric setup with server hosting provider
<div class="alert alert-warning" role="alert">
Geyser-Fabric runs <b>only</b> on a {{ site.data.versions.java }} Fabric server. <br>
Geyser-Fabric runs <b>only</b> on a {{ site.data.versions.java }} Fabric server.
To use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velocity proxy, or Geyser Standalone instead.
</div>
@@ -27,11 +27,11 @@ To use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velo
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server.
Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`.
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! <br>
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port!
**Important**: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
5. Verify whether connections are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
</div>
_includes/setup/instructions/geyser/provider/proxy.md
+4 -4
View File
@@ -2,9 +2,9 @@
# Proxy setup with server hosting provider
<div class="alert alert-info" role="alert">
NOTE: <br>
NOTE:
- Install Geyser <b>only</b> on the proxy server! You can install Floodgate on all servers for better skin support &
network-wide Floodgate API availability for other plugins. <br>
network-wide Floodgate API availability for other plugins.
- All servers on the network must accept {{ site.data.versions.java }} Java clients, as Geyser imitates one.
</div>
@@ -29,11 +29,11 @@
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server.
Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`.
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! <br>
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port!
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
5. Verify whether connections are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
</div>
_includes/setup/instructions/geyser/provider/spigot.md
+1 -1
View File
@@ -27,7 +27,7 @@
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server.
Follow the instructions in the provider selector - change the port, and if necessary, `clone-remote-port` & `address`.
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port! <br>
If `clone-remote-port` is enabled, the bedrock port will be overwritten with the Java port!
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
5. Verify whether connections are possible by running `geyser connectiontest <ip>:<port>` in the console.
_includes/setup/instructions/geyser/selfhost/fabric.md
+11 -11
View File
@@ -2,7 +2,7 @@
# Fabric setup - self-hosting
<div class="alert alert-warning" role="alert">
Geyser-Fabric runs <b>only</b> on a {{ site.data.versions.java }} Fabric server. <br>
Geyser-Fabric runs <b>only</b> on a {{ site.data.versions.java }} Fabric server.
To use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velocity proxy, or Geyser Standalone instead.
</div>
@@ -21,31 +21,31 @@ To use Geyser on an older Fabric server, you can use Geyser on a BungeeCord/Velo
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
Since you are self-hosting, you can choose the port freely - the default port is 19132.
**Important**: Other services/mods that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
**Connecting locally in the same network**
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
**Connecting from a different network**
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
To achieve that, you have two options:
- Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
[Our port forwarding guide](/geyser/port-forwarding) explains how to do this in detail.
Then, players can connect with your public IPv4 + port to your server. <br>
Then, players can connect with your public IPv4 + port to your server.
- 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
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
Ngrok will not work since it is TCP-only.
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
</div>
_includes/setup/instructions/geyser/selfhost/proxy.md
+12 -12
View File
@@ -2,9 +2,9 @@
# Proxy setup - self-hosting
<div class="alert alert-info" role="alert">
NOTE: <br>
NOTE:
- Install Geyser <b>only</b> on the proxy server! You can install Floodgate on all servers for better skin support &
network-wide Floodgate API availability for other plugins. <br>
network-wide Floodgate API availability for other plugins.
- All servers on the network must accept {{ site.data.versions.java }} Java clients, as Geyser imitates one.
</div>
@@ -23,31 +23,31 @@
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
Since you are self-hosting, you can choose the port freely - the default port is 19132.
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
**Connecting locally in the same network**
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
**Connecting from a different network**
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
To achieve that, you have two options:
- Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
[Our port forwarding guide](/geyser/port-forwarding) explains how to do this in detail.
Then, players can connect with your public IPv4 + port to your server. <br>
Then, players can connect with your public IPv4 + port to your server.
- 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
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
Ngrok will not work since it is TCP-only.
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>
</div>
_includes/setup/instructions/geyser/selfhost/spigot.md
+9 -9
View File
@@ -21,28 +21,28 @@
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
Since you are self-hosting, you can choose the port freely - the default port is 19132.
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
**Connecting locally in the same network**
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
**Connecting from a different network**
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
To achieve that, you have two options:
- Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
[Our port forwarding guide](/geyser/port-forwarding) explains how to do this in detail.
After doing this, players can connect with your public IPv4 + port to your server. <br>
After doing this, players can connect with your public IPv4 + port to your server.
- 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
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
Ngrok will not work since it is TCP-only.
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
_includes/setup/instructions/geyser/selfhost/standalone.md
+14 -14
View File
@@ -13,10 +13,10 @@
1. Download Geyser Standalone from [here](https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone).
2. Create a new folder for Geyser, and drop the jar in there.
3. Start Geyser Standalone:
- **GUI** (Recommended): <br>
- **GUI** (Recommended):
Double-click the jar file and all the necessary files for Geyser will be created.
- Or use the **console setup**: <br>
Create a new bat or startup script, similar to the one you'd use for a Spigot/Paper server, and take a look at [this](/geyser/creating-a-startup-script/) page for what to put into it. <br>
- Or use the **console setup**:
Create a new bat or startup script, similar to the one you'd use for a Spigot/Paper server, and take a look at [this](/geyser/creating-a-startup-script/) page for what to put into it.
Run the startup script/bat, and all the necessary files for Geyser will be created.
4. Open your Geyser config (`config.yml`), and find the following:
@@ -30,9 +30,9 @@
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
```
The `port` is the port Bedrock players will enter to connect to the server. <br>
The `port` is the port Bedrock players will enter to connect to the server.
Uncommenting and changing `address` here is only needed if you need to limit connections to a specific IP address.
<br>
To configure which Java Edition server Geyser Standalone will send players to, find the remote section:
```yaml
@@ -49,27 +49,27 @@
```
Here, change `address` to the Java server's address, or to `auto` if the server is on the same machine as Geyser-Standalone.
Then, 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,
set 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](/floodgate/setup). <br>
set 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](/floodgate/setup).
5. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
**Connecting locally in the same network**
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
Alternatively, open Minecraft: Bedrock edition, and join the LAN-Server in the **Friends** tab.
<br> <br>
**Connecting from a different network**<br>
**Connecting from a different network**
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
To achieve that, you have two options:
- Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
After doing this, players can connect with your public IPv4 + port to your server.
See [here](/geyser/port-forwarding/) for a helpful guide. <br>
See [here](/geyser/port-forwarding/) for a helpful guide.
- 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
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
Ngrok will not work since it is TCP-only.
6. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
@@ -104,4 +104,4 @@ curl https://gist.githubusercontent.com/rtm516/e3e07d6595ee41e05a38b03c0f4d7a80/
7. Geyser should show up in the Friends tab inside Minecraft.
**Note:**
Due 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.
Due 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.
_includes/setup/instructions/geyser/tabs.html
+5 -5
View File
@@ -1,16 +1,16 @@
<div class="nav nav-tabs setup-tabs" role="tablist" aria-label="Setup Options">
<li class="nav-item" role="presentation">
<a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option-{{include.type}}" type="button" role="tab" aria-controls="spigot-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/paper.png' | relative_url }}" alt="paper icon"> Paper / Spigot</a>
<a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option-{{include.type}}" type="button" role="tab" aria-controls="spigot-option-{{include.type}}" aria-selected="false"><img src="/img/icons/paper.png" alt="paper icon"> Paper / Spigot</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option-{{include.type}}" type="button" role="tab" aria-controls="fabric-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/fabric.png' | relative_url }}" alt="fabric icon"> Fabric</a>
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option-{{include.type}}" type="button" role="tab" aria-controls="fabric-option-{{include.type}}" aria-selected="false"><img src="/img/icons/fabric.png" alt="fabric icon"> Fabric</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option-{{include.type}}" type="button" role="tab" aria-controls="proxy-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/velocity.svg' | relative_url }}" alt="velocity icon"> Proxy Servers</a>
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option-{{include.type}}" type="button" role="tab" aria-controls="proxy-option-{{include.type}}" aria-selected="false"><img src="/img/icons/velocity.svg" alt="velocity icon"> Proxy Servers</a>
</li>
{% if include.show_standalone != nil %}
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option-{{include.type}}" type="button" role="tab" aria-controls="standalone-option-{{include.type}}" aria-selected="false"><img src="{{ '/img/icons/geyser.png' | relative_url }}" alt="geyser icon"> Standalone</a>
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option-{{include.type}}" type="button" role="tab" aria-controls="standalone-option-{{include.type}}" aria-selected="false"><img src="/img/icons/geyser.png" alt="geyser icon"> Standalone</a>
</li>
{% endif %}
</div>
@@ -34,4 +34,4 @@
{{ my_include | markdownify }}
</div>
{% endif %}
</div>
</div>
_layouts/default.html
+6 -6
View File
@@ -10,8 +10,8 @@
<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' | relative_url }}">
<link rel="stylesheet" href="{{ '/css/darcula.css' | relative_url }}">
<link rel="stylesheet" href="/css/style.css">
<link rel="stylesheet" href="/css/darcula.css">
<meta name="author" content="{{ site.author }}">
<meta name="description" content="{{ site.description }}">
@@ -21,8 +21,8 @@
<meta property="og:url" content="{{ site.url }}">
<meta property="og:title" content="{{ site.title }}{% if page.title %}: {{ page.title }}{% endif %}">
<meta property="og:description" content="{{ site.description }}">
<meta property="og:image" content="{{ '/android-chrome-192x192.png' | relative_url }}">
<meta property="og:image" content="/android-chrome-192x192.png">
<link rel="shortcut icon" type="image/x-icon" href="{{ 'favicon.ico' | relative_url }}">
<link rel="icon" type="image/x-icon" href="{{ 'favicon.ico' | relative_url }}">
@@ -84,6 +84,6 @@
&copy; {{ 'now' | date: "%Y" }} {{ site.author }}
</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' | relative_url }}"></script>
<script src="/js/page-nav.js"></script>
</body>
</html>
</html>
_site/CNAME
+1
View File
@@ -0,0 +1 @@
wiki.geysermc.org
_site/CONTRIBUTING.md
+50
View File
@@ -0,0 +1,50 @@
# Contributing
If you would like to contribute to the wiki, please [open a pull request](https://github.com/GeyserMC/GeyserWiki/pulls).
### Creating a new page
Most documentation is in the `docs` folder, where you can add new pages or edit the current ones.
If a new page is being added make sure you add its page properties at the beginning of the file.
Make sure that the file extension is .md - in this case `pagetitle.md`.
### Example page layout
```md
---
title: Page title
page_sidebar: false (optional)
---
# Page title
This is an example page.
```
### Adding page to the sidebar
Once you have added the file you can add a sidebar link. All sidebar links + sub links are in the _data/toc.yml file.
### Example sidebar structure
```
- title: Page Title Documentation
url: "page/"
links:
- title: "Pagetitle sub link"
url: "page/pagetitle/"
children:
- title: PageChild sub link
url: "page/pagetitle/#headerLink"
```
### GeyserWiki development - Local deployment on Windows.
* Download and install Ruby using the Ruby+Devkit from https://rubyinstaller.org/downloads/.
* Once installed, run 'ridk install' in console to open the RubyInstaller.
For this usecase, it is recommended to choose the third option, "MSYS and MINGW". After that, the Ruby installation is completed.
* Open the GeyserWiki folder in VScode. There, open a terminal to install the bundle using the 'bundle install' command.
Installing it for the first time can take a while.
* Once installed, you can start the webserver locally with the 'bundle exec jekyll serve' command in the VSC terminal.
_site/COPYRIGHT
+13
View File
@@ -0,0 +1,13 @@
Copyright 2019-2021 Vanessa Sochat
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
_site/Gemfile
+35
View File
@@ -0,0 +1,35 @@
source "https://rubygems.org"
# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
#gem "jekyll", "~> 4.3.2"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
# gem "minima", "~> 2.5"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
# gem "jekyll-feed", "~> 0.12"
end
gem 'webrick'
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end
# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
_site/Gemfile.lock
+272
View File
@@ -0,0 +1,272 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (7.0.4.3)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 1.6, < 2)
minitest (>= 5.1)
tzinfo (~> 2.0)
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.23.9)
concurrent-ruby (1.2.2)
dnsruby (1.61.9)
simpleidn (~> 0.1)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
execjs (2.8.1)
faraday (2.7.4)
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
ffi (1.15.5)
ffi (1.15.5-x64-unknown)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (228)
github-pages-health-check (= 1.17.9)
jekyll (= 3.9.3)
jekyll-avatar (= 0.7.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.4.0)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.15.1)
jekyll-gist (= 1.5.0)
jekyll-github-metadata (= 2.13.0)
jekyll-include-cache (= 0.2.1)
jekyll-mentions (= 1.6.0)
jekyll-optional-front-matter (= 0.3.2)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.3.0)
jekyll-redirect-from (= 0.16.0)
jekyll-relative-links (= 0.6.1)
jekyll-remote-theme (= 0.4.3)
jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.8.0)
jekyll-sitemap (= 1.4.0)
jekyll-swiss (= 1.0.0)
jekyll-theme-architect (= 0.2.0)
jekyll-theme-cayman (= 0.2.0)
jekyll-theme-dinky (= 0.2.0)
jekyll-theme-hacker (= 0.2.0)
jekyll-theme-leap-day (= 0.2.0)
jekyll-theme-merlot (= 0.2.0)
jekyll-theme-midnight (= 0.2.0)
jekyll-theme-minimal (= 0.2.0)
jekyll-theme-modernist (= 0.2.0)
jekyll-theme-primer (= 0.6.0)
jekyll-theme-slate (= 0.2.0)
jekyll-theme-tactile (= 0.2.0)
jekyll-theme-time-machine (= 0.2.0)
jekyll-titles-from-headings (= 0.5.3)
jemoji (= 0.12.0)
kramdown (= 2.3.2)
kramdown-parser-gfm (= 1.1.0)
liquid (= 4.0.4)
mercenary (~> 0.3)
minima (= 2.5.1)
nokogiri (>= 1.13.6, < 2.0)
rouge (= 3.26.0)
terminal-table (~> 1.4)
github-pages-health-check (1.17.9)
addressable (~> 2.3)
dnsruby (~> 1.60)
octokit (~> 4.0)
public_suffix (>= 3.0, < 5.0)
typhoeus (~> 1.3)
html-pipeline (2.14.3)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.8.0)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
jekyll (3.9.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (>= 0.7, < 2)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (>= 1.17, < 3)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-avatar (0.7.0)
jekyll (>= 3.0, < 5.0)
jekyll-coffeescript (1.1.1)
coffee-script (~> 2.2)
coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.4.0)
commonmarker (~> 0.22)
jekyll-commonmark-ghpages (0.4.0)
commonmarker (~> 0.23.7)
jekyll (~> 3.9.0)
jekyll-commonmark (~> 1.4.0)
rouge (>= 2.0, < 5.0)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.15.1)
jekyll (>= 3.7, < 5.0)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-github-metadata (2.13.0)
jekyll (>= 3.4, < 5.0)
octokit (~> 4.0, != 4.4.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-mentions (1.6.0)
html-pipeline (~> 2.3)
jekyll (>= 3.7, < 5.0)
jekyll-optional-front-matter (0.3.2)
jekyll (>= 3.0, < 5.0)
jekyll-paginate (1.1.0)
jekyll-readme-index (0.3.0)
jekyll (>= 3.0, < 5.0)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-relative-links (0.6.1)
jekyll (>= 3.3, < 5.0)
jekyll-remote-theme (0.4.3)
addressable (~> 2.0)
jekyll (>= 3.5, < 5.0)
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-swiss (1.0.0)
jekyll-theme-architect (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-cayman (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-dinky (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-hacker (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-leap-day (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-merlot (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-midnight (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-minimal (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-modernist (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-primer (0.6.0)
jekyll (> 3.5, < 5.0)
jekyll-github-metadata (~> 2.9)
jekyll-seo-tag (~> 2.0)
jekyll-theme-slate (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-tactile (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-time-machine (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-titles-from-headings (0.5.3)
jekyll (>= 3.3, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
jemoji (0.12.0)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0)
kramdown (2.3.2)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.18.0)
nokogiri (1.14.3-arm64-darwin)
racc (~> 1.4)
nokogiri (1.14.3-x64-unknown)
racc (~> 1.4)
nokogiri (1.14.3-x86_64-linux)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
racc (1.6.2)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.26.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
simpleidn (0.2.1)
unf (~> 0.1.4)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
typhoeus (1.4.0)
ethon (>= 0.9.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unf_ext (0.0.8.2-x64-unknown)
unicode-display_width (1.8.0)
webrick (1.8.1)
PLATFORMS
arm64-darwin-22
x64-unknown
x86_64-linux
DEPENDENCIES
github-pages
http_parser.rb (~> 0.6.0)
tzinfo (>= 1, < 3)
tzinfo-data
wdm (~> 0.1.1)
webrick
BUNDLED WITH
2.4.6
android-chrome-192x192.png → _site/android-chrome-192x192.png
View File
File renamed without changes.
android-chrome-512x512.png → _site/android-chrome-512x512.png
View File
File renamed without changes.
apple-touch-icon.png → _site/apple-touch-icon.png
View File
File renamed without changes.
_site/assets/css/style.css
+2883
View File
File diff suppressed because it is too large. Load diff
_site/css/darcula.css
+147
View File
@@ -0,0 +1,147 @@
/**
* Syntax highlighting styles
* Based on the Darcula theme for JetBrains IDEs
* https://github.com/shadowfacts/RougeDarcula
* Author: Shadowfacts
*/
.highlight {
background-color: #2B2B2B;
margin-bottom: 15px;
color: #A9B7C6; }
.highlight pre {
background-color: #2B2B2B; }
.highlight pre code {
background-color: #2B2B2B; }
.highlight .lineno {
color: #888888; }
.highlighter-rouge .highlight {
background: #2B2B2B; }
.highlight .c {
color: #808080; }
.highlight .err {
color: #BC3F3C; }
.highlight .k {
color: #CC7832; }
.highlight .o {
color: #A9B7C6; }
.highlight .cm {
color: #808080; }
.highlight .cp {
color: #808080;
font-style: italic; }
.highlight .c1 {
color: #808080; }
.highlight .cs {
color: #629755;
font-style: italic; }
.highlight .gd {
color: #BBBBBB;
background-color: #450505;
text-decoration: line-through; }
.highlight .gd .x {
color: #BBBBBB;
background-color: #450505;
text-decoration: line-through; }
.highlight .ge {
font-style: italic; }
.highlight .gr {
color: #BC3F3C; }
.highlight .gh {
color: #999; }
.highlight .gi {
background-color: #364135; }
.highlight .gi .x {
background-color: #364135; }
.highlight .go {
color: #A9B7C6; }
.highlight .gp {
color: #007F00; }
.highlight .gs {
font-weight: bold; }
.highlight .gu {
color: #aaa; }
.highlight .gt {
color: #a00; }
.highlight .kc {
color: #CC7832; }
.highlight .kd {
color: #CC7832; }
.highlight .kn {
color: #CC7832; }
.highlight .kp {
color: #CC7832;
font-weight: bold; }
.highlight .kr {
color: #CC7832; }
.highlight .kt {
color: #CC7832; }
.highlight .m {
color: #6897BB; }
.highlight .s {
color: #6A8759; }
.highlight .n {
color: #A9B7C6; }
.highlight .na {
color: #A9B7C6; }
.highlight .nb {
color: #CC7832; }
.highlight .nc {
color: #A9B7C6; }
.highlight .no {
color: #9876AA; }
.highlight .ni {
color: #9876AA; }
.highlight .ne {
color: #A9B7C6; }
.highlight .nf {
color: #A9B7C6; }
.highlight .nn {
color: #A9B7C6; }
.highlight .nt {
color: #E8BF6A; }
.highlight .nv {
color: #A9B7C6; }
.highlight .ow {
color: #A9B7C6; }
.highlight .mf {
color: #6897BB; }
.highlight .mh {
color: #6897BB; }
.highlight .mi {
color: #6897BB; }
.highlight .mo {
color: #6897BB; }
.highlight .sb {
color: #d14; }
.highlight .sc {
color: #6A8759; }
.highlight .sd {
color: #6A8759; }
.highlight .s2 {
color: #6A8759; }
.highlight .se {
color: #CC7832; }
.highlight .sh {
color: #6A8759; }
.highlight .si {
color: #6A8759; }
.highlight .sx {
color: #6A8759; }
.highlight .sr {
background-color: #364135; }
.highlight .s1 {
color: #6A8759; }
.highlight .ss {
color: #6A8759; }
.highlight .bp {
color: #CC7832; }
.highlight .vc {
color: #A9B7C6; }
.highlight .vg {
color: #A9B7C6; }
.highlight .vi {
color: #A9B7C6; }
.highlight .il {
color: #6897BB; }
.highlight .p {
color: #A9B7C6; }
_site/css/style.css
+98
View File
@@ -0,0 +1,98 @@
:root {
--bs-body-font-family: 'Montserrat', sans-serif;
}
body {
display: flex;
min-height: 100vh;
flex-direction: column;
padding-top: 3.75rem;
}
.sticky-top {
top: 3.75rem;
}
.sidebar {
max-height: calc(100vh - 3.75rem);
overflow-y: auto;
}
.sidebar a {
text-decoration: none;
--bs-link-color-rgb: var(--bs-body-color);
}
.sidebar a:hover {
--bs-link-color-rgb: var(--bs-link-hover-color-rgb);
}
#page-content {
flex-grow: 1;
}
h1[id]::before, h2[id]::before, h3[id]::before {
content: '';
display: block;
position: relative;
width: 0;
height: 3.75rem;
margin-top: -3.75rem;
}
h1 {
margin-bottom: 2rem;
padding-bottom: 0.5rem;
border-bottom: 1px solid var(--bs-secondary-color);
}
div.highlight {
margin: 1rem;
padding: 0.5rem;
border-radius: 5px;
}
.highlight pre {
margin: 0;
tab-size: 4;
}
div.long-list {
overflow-x: scroll;
}
.long-list > ul {
min-width: 500px;
}
.long-list ul {
padding-left: 15px;
}
.no-p-margin p {
margin: 0;
}
.list-disc {
list-style: disc;
}
main img {
max-width: 100%;
}
.setup-tabs .nav-link {
color: var(--bs-white) !important;
}
.setup-tabs .nav-link img {
width: 1.5em;
height: 1.5em;
}
table {
margin-bottom: 1rem;
}
_site/debug.log
+1
View File
@@ -0,0 +1 @@
# Logfile created on 2022-02-20 17:51:46 -0600 by logger.rb/v1.4.3
favicon-16x16.png → _site/favicon-16x16.png
View File
File renamed without changes.
favicon-32x32.png → _site/favicon-32x32.png
View File
File renamed without changes.
favicon.ico → _site/favicon.ico
View File
File renamed without changes.
_site/floodgate/api/index.html
+479
View File
@@ -0,0 +1,479 @@
<!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: Floodgate 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: Floodgate 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" 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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">Floodgate API</li>
</ol>
</nav>
<h3 id="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">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 <a href="/geyser/forms/">Cumulus</a></h3>
<p>This page will contain information about class FloodgateApi.<br />
See the sidebar for more information about other parts of the API.</p>
<h3 id="accessing-the-floodgate-api">Accessing the Floodgate API</h3>
<p>See <a href="/geyser/getting-started-with-the-api">here</a> for how to include the Floodgate API in your project.</p>
<h2 id="the-floodgate-api-has-changed-in-floodgate-20-the-most-important-change-is-that-the-api-methods-are-no-longer-static-and-instead-instance-based-as-shown-below">The 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.</h2>
<p>The class FloodgateApi is the base class of the API and you need to use it to access any part of the API.<br />
To access it, you simply type:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">FloodgateApi</span><span class="o">.</span><span class="na">getInstance</span><span class="o">();</span>
</code></pre></div></div>
<p>After you got the instance, you have access to all the methods.<br />
Use the documentation in the API module to see (and get info about) every single method available.<br />
Most <a href="https://github.com/GeyserMC/Floodgate/tree/master/api/src/main/java/org/geysermc/floodgate/api">API methods have a simple explanation</a>.</p>
<div class="alert alert-info" role="alert">
Note: To see full, detailed documentation, see the <a href="https://repo.opencollab.dev/javadoc/maven-snapshots/org/geysermc/floodgate/api/2.2.2-SNAPSHOT">javadocs</a>.
</div>
<h4 id="well-highlight-a-few-to-get-you-started-quickly">We’ll highlight a few to get you started quickly:</h4>
<p><code class="language-plaintext highlighter-rouge">FloodgateApi#isFloodgatePlayer(UUID)</code><br />
Used to check if the given UUID of an <strong>online</strong> player is a Bedrock player.</p>
<p><code class="language-plaintext highlighter-rouge">FloodgateApi#getPlayer(UUID)</code><br />
Used to get the FloodgatePlayer instance of an <strong>online</strong> player.<br />
Click <a href="/floodgate/player/">here</a> to get more information about the FloodgatePlayer class.</p>
<p><strong>Note</strong>: You don’t need to wait until the Bedrock player is online to use the getPlayer and isFloodgatePlayer methods.<br />
You can even use them in the pre-login events.</p>
<p><code class="language-plaintext highlighter-rouge">FloodgateApi#getPlayerLink()</code><br />
Used to get the PlayerLink instance used by Floodgate to check for linked accounts.<br />
Click <a href="/floodgate/linking/">here</a> to get more information about the PlayerLink class</p>
<p><code class="language-plaintext highlighter-rouge">FloodgateApi#sendForm(UUID, Form(Builder))</code><br />
Used to send a form to the Bedrock player with the given UUID.<br />
Click <a href="/geyser/forms/">here</a> to get more information about Forms.</p>
<h3 id="using-the-api-on-backend-servers">Using the API on backend servers</h3>
<p>In order to successfully use the API on backend Spigot servers when using a proxy, <code class="language-plaintext highlighter-rouge">send-floodgate-data</code> must be set to <code class="language-plaintext highlighter-rouge">true</code> on the proxy Floodgate’s config, and the <code class="language-plaintext highlighter-rouge">key.pem</code> file must be identical between all Floodgate instances.</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/floodgate/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/floodgate/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">
&copy; 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>
_site/floodgate/commands/index.html
+461
View File
@@ -0,0 +1,461 @@
<!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: Commands</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: Commands">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">Commands</li>
</ol>
</nav>
<table>
<thead>
<tr>
<th style="text-align: center">Command</th>
<th style="text-align: center">Permission</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center"><code class="language-plaintext highlighter-rouge">fwhitelist</code></td>
<td style="text-align: center"><code class="language-plaintext highlighter-rouge">floodgate.command.fwhitelist</code></td>
<td style="text-align: center">Whitelist command for Floodgate players. See <a href="/floodgate/features/#whitelist-command">here</a> for details.</td>
</tr>
<tr>
<td style="text-align: center"><code class="language-plaintext highlighter-rouge">linkaccount</code></td>
<td style="text-align: center"><code class="language-plaintext highlighter-rouge">floodgate.command.linkaccount</code></td>
<td style="text-align: center">Link your account for local linking.</td>
</tr>
<tr>
<td style="text-align: center"><code class="language-plaintext highlighter-rouge">unlinkaccount</code></td>
<td style="text-align: center"><code class="language-plaintext highlighter-rouge">floodgate.command.unlinkaccount</code></td>
<td style="text-align: center">Unlink your account for local linking.</td>
</tr>
</tbody>
</table>
</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/floodgate/commands.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/floodgate/commands.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">
&copy; 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>
_site/floodgate/faq/index.html
+455
View File
@@ -0,0 +1,455 @@
<!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: FAQ</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: FAQ">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">FAQ</li>
</ol>
</nav>
<h1 id="faq">FAQ</h1>
<h2 id="changingdisabling-the-prefix">Changing/disabling the prefix</h2>
<p><strong><em>Please 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.</em></strong></p>
<p>In your Floodgate config, change <code class="language-plaintext highlighter-rouge">username-prefix</code> to whichever prefix you desire - you can set it to <code class="language-plaintext highlighter-rouge">""</code> and there will be no prefix.</p>
<p>On some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your <code class="language-plaintext highlighter-rouge">usercache.json</code> file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See <a href="/floodgate/issues/#prefix-is-not-changing-on-the-server-after-changing-it-in-the-config">this issue</a> for more information.</p>
<h2 id="obtaining-uuids-for-floodgate-players">Obtaining UUIDs for Floodgate players</h2>
<p>Check your server logs, or use <a href="https://uuid.kejona.dev/">this</a> page. If this doesn’t work, then try this method:</p>
<p>First, you’ll need to get the XUID of the player. There are several third-party websites to find this, for example, <a href="https://www.cxkes.me/xbox/xuid">this one</a> (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 <code class="language-plaintext highlighter-rouge">xxxxxxxxxxxxxxxx</code>. To turn the XUID into a UUID that Java Edition can recognize, you need to put the XUID in this format: <code class="language-plaintext highlighter-rouge">00000000-0000-0000-xxxx-xxxxxxxxxxxx</code>. If formatted right, Java Edition should accept it as a UUID.</p>
<h2 id="using-placeholderapi">Using PlaceholderAPI</h2>
<p>If you’re using the Spigot version of Floodgate, download the Placeholder plugin <a href="https://github.com/rtm516/FloodgatePlaceholders/">here</a>. Using the placeholders shouldn’t require additional setup other than having <a href="https://www.spigotmc.org/resources/6245/">PlaceholderAPI</a> installed. See the section above on installing Floodgate on backend servers if you wish to use this on BungeeCord.</p>
<h2 id="using-skript">Using Skript</h2>
<p>If you’re using the Spigot version of Floodgate, there is an unofficial plugin that adds Skript support <a href="https://github.com/kejonaMC/floodgate-skript">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/floodgate/faq.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/floodgate/faq.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">
&copy; 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>
_site/floodgate/features/index.html
+454
View File
@@ -0,0 +1,454 @@
<!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: Features</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: Features">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">Features</li>
</ol>
</nav>
<h2 id="whitelist-command">Whitelist command</h2>
<p>Floodgate 2.0 has a whitelist command, <code class="language-plaintext highlighter-rouge">fwhitelist</code>, that should be used for adding or removing Floodgate players to whitelist.json. The username prefix doesn’t need to be included.
<code class="language-plaintext highlighter-rouge">fwhitelist add Tim203</code>
<code class="language-plaintext highlighter-rouge">fwhitelist remove Tim203</code></p>
<p>You can also specify a UUID: <code class="language-plaintext highlighter-rouge">fwhitelist add 00000000-0000-0000-0009-01f64f65c7c3</code></p>
<p>The permission node is <code class="language-plaintext highlighter-rouge">floodgate.command.fwhitelist</code>.</p>
<h2 id="what-is-skin-uploading">What is skin uploading?</h2>
<p>Skins of Bedrock player should be visible to Java players on servers with Floodgate 2.0 installed.<br />
If 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.</p>
<p>Skin uploading is also a part of the <a href="/geyser/global-api">Global Api</a>. It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition.</p>
<p>We’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 <a href="https://mineskin.org/account">this page</a> for more info.</p>
<p><img src="/img/wiki/skin_upload_example.png" alt="Example skin upload" /></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/floodgate/features.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/floodgate/features.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">
&copy; 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>
_site/floodgate/index.html
+439
View File
@@ -0,0 +1,439 @@
<!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: Floodgate</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: Floodgate">
<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 show" 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 show">
<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">Floodgate</li>
</ol>
</nav>
<h1 id="floodgate">Floodgate</h1>
<h2 id="what-is-floodgate">What is Floodgate?</h2>
<p>Floodgate is a hybrid mode plugin that allows Minecraft: Bedrock Accounts to join Minecraft: Java Edition servers without needing a Minecraft: Java Edition account.
This 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.</p>
<h2 id="what-has-floodgate-20-to-offer">What has Floodgate 2.0 to offer?</h2>
<p>Floodgate 2.0 is a rewrite of Floodgate 1.0, with various bugfixes and improvements. It also introduces new features: being able to <a href="/floodgate/features/#what-is-skin-uploading">see Bedrock player skins on Java edition</a>,
being able to <a href="/geyser/forms/">use Bedrock forms</a>, link your account once and login on every server that has <a href="/floodgate/linking/#what-is-global-linking">Global Linking</a> enabled,
and the <a href="/geyser/global-api">Global Api</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/floodgate/root.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/floodgate/root.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">
&copy; 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>
_site/floodgate/issues/index.html
+490
View File
@@ -0,0 +1,490 @@
<!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: Issues</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: Issues">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">Issues</li>
</ol>
</nav>
<h1 id="known-issues--caveats">Known Issues &amp; Caveats</h1>
<p>If an issue you’re experiencing is not listed here, please consider joining the Geyser <a href="http://discord.geysermc.org/">Discord</a>.</p>
<h2 id="running-commands">Running commands</h2>
<p>In some instances, like if you have the <code class="language-plaintext highlighter-rouge">username-prefix</code> set to <code class="language-plaintext highlighter-rouge">*</code>, you may need to wrap the Bedrock player’s username in quotes; for example: <code class="language-plaintext highlighter-rouge">/tp "*BedrockPlayer"</code>. Setting the prefix to <code class="language-plaintext highlighter-rouge">.</code> should also fix this.</p>
<h2 id="if-you-wish-to-use-ip-forwarding-please-enable-it-in-your-bungeecord-config-as-well">If you wish to use IP forwarding, please enable it in your BungeeCord config as well!</h2>
<p>It is likely you have enabled <code class="language-plaintext highlighter-rouge">send-floodgate-data</code> 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).</p>
<h2 id="javalangillegalstateexception-cannot-reply-to-encryptionrequestpacket-without-profile-and-access-token"><code class="language-plaintext highlighter-rouge">java.lang.IllegalStateException: Cannot reply to EncryptionRequestPacket without profile and access token.</code></h2>
<p>Make sure the server has Floodgate installed and started up correctly. Otherwise, see if the next line fixes your error.</p>
<h2 id="javaxcryptoaeadbadtagexception-tag-mismatch"><code class="language-plaintext highlighter-rouge">javax.crypto.AEADBadTagException: Tag mismatch!</code></h2>
<p>If Geyser and Floodgate are on the same server, shut down your server, delete the <code class="language-plaintext highlighter-rouge">floodgate</code> plugin folder, delete any key file in the Geyser folder, and restart your server.
If 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 <a href="https://winscp.net">WinSCP</a> if you need to use FTP.</p>
<h2 id="javalangnumberformatexception-for-input-string-">java.lang.NumberFormatException: For input string: “”</h2>
<p>You’re trying to log in without an Xbox account. Floodgate requires an Xbox account to authenticate the Bedrock player.</p>
<h2 id="geyser-floodgate51777-lost-connection-internal-exception-javalangnumberformatexception-for-input-string-sfqdxv36-or-a-similar-error">Geyser-Floodgate:51777 lost connection: Internal Exception: java.lang.NumberFormatException: For input string: “SfqdXv36” (or a similar error)</h2>
<p>Set <code class="language-plaintext highlighter-rouge">ip-forwarding</code> in your BungeeCord to <code class="language-plaintext highlighter-rouge">true</code>.</p>
<h2 id="please-connect-through-the-official-geyser-disconnect-message">“Please connect through the official Geyser” disconnect message</h2>
<p>Ensure that Floodgate and Geyser are both up-to-date.</p>
<h2 id="prefix-is-not-changing-on-the-server-after-changing-it-in-the-config">Prefix is not changing on the server after changing it in the config.</h2>
<p>Between 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.</p>
<p>Ensure that you removed the <code class="language-plaintext highlighter-rouge">usercache.json</code> file from the server root directory and restart your server.</p>
<h2 id="issues-with-luckperms-and-prefixes">Issues with LuckPerms and prefixes</h2>
<p>Set <code class="language-plaintext highlighter-rouge">allow-invalid-usernames</code> to <code class="language-plaintext highlighter-rouge">true</code> in LuckPerms’ config.</p>
<h2 id="failed-to-verify-username-with-paper">Failed to verify username! (with Paper)</h2>
<p>To completely mitigate this issue, disable <code class="language-plaintext highlighter-rouge">perform-username-validation</code> in the <a href="https://paper.readthedocs.io/en/latest/server/configuration.html#unsupported_settings">unsupported settings of the <code class="language-plaintext highlighter-rouge">config/paper-global.yml</code> file</a> (<code class="language-plaintext highlighter-rouge">paper.yml</code> in the root server folder on servers below 1.19). Using Floodgate on the backend servers will also mitigate this issue.</p>
<h2 id="error-with-forge-or-fabric-bukkit-hybrid">Error with Forge or Fabric Bukkit Hybrid</h2>
<p>At 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).</p>
<p>If 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.</p>
<h2 id="after-enabling-global-linking-in-offline-mode-player-data-is-not-synced-between-java-and-bedrock-players">After enabling global linking in offline mode, player data is not synced between Java and Bedrock players.</h2>
<p>This 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.</p>
<p>When using global linking, ensure <code class="language-plaintext highlighter-rouge">online-mode</code> in <code class="language-plaintext highlighter-rouge">server.properties</code> is set to <code class="language-plaintext highlighter-rouge">true</code>. 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.</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/floodgate/issues.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/floodgate/issues.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">
&copy; 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>
_site/floodgate/linking/index.html
+487
View File
@@ -0,0 +1,487 @@
<!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: Linking</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: Linking">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">Linking</li>
</ol>
</nav>
<h2 id="what-is-global-linking">What is Global Linking?</h2>
<p>Instructions and information about how to link can also be found here: <a href="https://link.geysermc.org/">https://link.geysermc.org/</a></p>
<p>Before 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.<br /></p>
<p>Keep 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.</p>
<p>Global Linking is part of the <a href="/geyser/global-api">Global Api</a> and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following:</p>
<ol>
<li>Join the GlobalLinkServer with both your Java and Bedrock account<br />
(IP: <code class="language-plaintext highlighter-rouge">link.geysermc.org</code>, Java port: <code class="language-plaintext highlighter-rouge">25565</code>, Bedrock port: <code class="language-plaintext highlighter-rouge">19132</code>)</li>
<li>Start the linking process by typing <code class="language-plaintext highlighter-rouge">/linkaccount</code> on your Java <strong>or</strong> Bedrock account</li>
<li>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.</li>
<li>Enter the random number on the other account by typing <code class="language-plaintext highlighter-rouge">/linkaccount &lt;code&gt;</code></li>
<li>You should get kicked from the server on both your Bedrock and Java account with the message that it had successfully linked your accounts.</li>
</ol>
<p>To unlink your globally linked accounts, join the GlobalLinkServer (as described above for linking) on either Java or Bedrock, and use the <code class="language-plaintext highlighter-rouge">/unlinkaccount</code> command.</p>
<p>Global 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 <code class="language-plaintext highlighter-rouge">player-link</code> section looks similar to this:</p>
<div class="language-yml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Configuration for player linking</span>
<span class="na">player-link</span><span class="pi">:</span>
<span class="c1"># Whether to enable the linking system. Turning this off will prevent</span>
<span class="c1"># players from using the linking feature even if they are already linked.</span>
<span class="na">enabled</span><span class="pi">:</span> <span class="no">true</span>
<span class="c1"># Whether to use global linking. Global linking uses a central server to request link</span>
<span class="c1"># accounts, allowing people to link once, join everywhere (on servers with global linking).</span>
<span class="na">use-global-linking</span><span class="pi">:</span> <span class="no">true</span>
</code></pre></div></div>
<p>(<a href="https://github.com/GeyserMC/Floodgate/blob/master/core/src/main/resources/config.yml">see the default config</a>)</p>
<p>Once you saved the config and restarted your server you should be using Global Linking.</p>
<p>If you don’t want to use Global Linking, you can disable <code class="language-plaintext highlighter-rouge">enable-global-linking</code> in the Floodgate config.</p>
<h2 id="local-linking">Local Linking</h2>
<p>You 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.</p>
<p>Note that you only have to follow these steps on your proxy (BungeeCord or Velocity), if you have one.</p>
<ol>
<li>Download one of the linking databases extensions <a href="https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/">here</a>.
If you need help picking the right one: choose <code class="language-plaintext highlighter-rouge">mysql</code> if you already have a database or want to have a multi-proxy setup. For anything else choose <code class="language-plaintext highlighter-rouge">sqlite</code>. The full name should be <code class="language-plaintext highlighter-rouge">floodgate-*type*-database.jar</code>.</li>
<li>Copy the database extension jar you just downloaded <em>into</em> the floodgate 2.0 plugin folder (e.g. <code class="language-plaintext highlighter-rouge">/plugins/floodgate/</code>).</li>
<li>Enable <code class="language-plaintext highlighter-rouge">enable-own-linking</code> in the <code class="language-plaintext highlighter-rouge">player-link</code> section of Floodgate.</li>
<li>Set <code class="language-plaintext highlighter-rouge">type</code> in the <code class="language-plaintext highlighter-rouge">player-link</code> section to your database type (currently either <code class="language-plaintext highlighter-rouge">mysql</code> or <code class="language-plaintext highlighter-rouge">sqlite</code>). (If you used Floodgate 1.0 and had linking enabled back then; the database type was <code class="language-plaintext highlighter-rouge">sqlite</code>).</li>
<li>Restart your server</li>
</ol>
<p>If you have selected <code class="language-plaintext highlighter-rouge">mysql</code> 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.</p>
<p>That should be it. You can then link your accounts by following the instructions you get when typing <code class="language-plaintext highlighter-rouge">/linkaccount</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/floodgate/linking.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/floodgate/linking.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">
&copy; 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>
_site/floodgate/player/index.html
+439
View File
@@ -0,0 +1,439 @@
<!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: FloodgatePlayer</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: FloodgatePlayer">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">FloodgatePlayer</li>
</ol>
</nav>
<p>FloodgatePlayer is something that every player who’s connect through Floodgate has.<br />
It contains information about the Bedrock client which can be useful in various situations.</p>
<p>You can get a FloodgatePlayer by using the <code class="language-plaintext highlighter-rouge">FloodgateApi#getPlayer(uuid)</code> method (where uuid is the unique id of the connected player)</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/floodgate/player.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/floodgate/player.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">
&copy; 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>
_site/floodgate/setup/index.html
+548
View File
@@ -0,0 +1,548 @@
<!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: Floodgate Setup</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: Floodgate Setup">
<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 show" 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 show">
<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/floodgate/">Floodgate</a></li>
<li class="breadcrumb-item active" aria-current="page">Floodgate Setup</li>
</ol>
</nav>
<h1 id="floodgate-setup">Floodgate Setup</h1>
<div class="alert alert-warning" role="alert">
Floodgate does <b>NOT</b> replace Geyser! It allows Geyser players to join servers without needing to log into a paid Java Edition account. <br />
</div>
<div class="nav nav-tabs setup-tabs" role="tablist" aria-label="Setup Options">
<li class="nav-item" role="presentation">
<a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option" type="button" role="tab" aria-controls="spigot-option" aria-selected="false"><img src="/img/icons/paper.png" alt="paper icon" /> Paper / Spigot</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option" type="button" role="tab" aria-controls="fabric-option" aria-selected="false"><img src="/img/icons/fabric.png" alt="fabric icon" /> Fabric</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option" type="button" role="tab" aria-controls="proxy-option" aria-selected="false"><img src="/img/icons/velocity.svg" alt="velocity icon" /> Proxy Servers</a>
</li>
<li class="nav-item" role="presentation">
<a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option" type="button" role="tab" aria-controls="standalone-option" aria-selected="false"><img src="/img/icons/geyser.png" alt="geyser icon" /> Standalone</a>
</li>
</div>
<div class="tab-content mt-4">
<div id="spigot-option" class="tab-pane fade show active" role="tabpanel">
<h1 id="floodgate-spigot-setup">Floodgate-Spigot setup</h1>
<ol>
<li>Download Floodgate-Spigot from the <a href="https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot">download page</a>.</li>
<li>Place the Floodgate-Spigot.jar in the <code class="language-plaintext highlighter-rouge">plugins</code> folder, and restart the server.</li>
<li>Change <code class="language-plaintext highlighter-rouge">auth-type</code> in Geyser’s config to <code class="language-plaintext highlighter-rouge">floodgate</code>.</li>
<li>Restart the server.</li>
</ol>
</div>
<div id="fabric-option" class="tab-pane fade" role="tabpanel">
<h1 id="floodgate-fabric-setup">Floodgate-Fabric setup</h1>
<ol>
<li>Download Floodgate-Fabric from the <a href="https://modrinth.com/mod/floodgate">modrinth page</a>.</li>
<li>Place the Floodgate-Fabric.jar in the <code class="language-plaintext highlighter-rouge">mods</code> folder, and restart the server. <strong>You also need <a href="https://modrinth.com/mod/fabric-api">FabricAPI</a> installed.</strong></li>
<li>Change <code class="language-plaintext highlighter-rouge">auth-type</code> in Geyser’s config to <code class="language-plaintext highlighter-rouge">floodgate</code>.</li>
<li>Restart the server.</li>
</ol>
<p><strong>Note for Fabric behind a Velocity proxy:</strong>
You will need to configure FabricProxyLite to allow the Fabric server to receive data from Velocity.</p>
</div>
<div id="proxy-option" class="tab-pane fade" role="tabpanel">
<h1 id="floodgate-setup-on-a-bungeecordvelocity-proxy">Floodgate setup on a BungeeCord/Velocity proxy</h1>
<div class="alert alert-info" role="alert">
You only need to install Floodgate on the BungeeCord or Velocity proxy server, unless you want to use the Floodgate API on the backend servers.
Additionally, it will display Bedrock edition skins properly.
</div>
<ol>
<li>Download Floodgate for your proxy software from the <a href="https://geysermc.org/download">download page</a>.</li>
<li>Place the Floodgate jar in the <code class="language-plaintext highlighter-rouge">plugins</code> folder, and restart the proxy server.</li>
<li>Change <code class="language-plaintext highlighter-rouge">auth-type</code> in Geyser’s config to <code class="language-plaintext highlighter-rouge">floodgate</code>.</li>
<li>Restart the server.</li>
</ol>
<h2 id="installing-floodgate-on-servers-behind-the-proxy">Installing Floodgate on servers behind the proxy</h2>
<p>This is only needed when you want to use the Floodgate API on your backend server(s) behind a proxy.</p>
<ol>
<li>After installing Floodgate on the proxy, install Floodgate on the backend servers (either Floodgate-Spigot, or Floodgate-Fabric).</li>
<li>Enable <code class="language-plaintext highlighter-rouge">ip_forward</code> in your BungeeCord <code class="language-plaintext highlighter-rouge">config.yml</code> if using BungeeCord. For Velocity, set up <a href="https://docs.papermc.io/velocity/player-information-forwarding">player information forwarding</a>.</li>
<li>Set <code class="language-plaintext highlighter-rouge">bungeecord</code> to <code class="language-plaintext highlighter-rouge">true</code> in your spigot.yml. When using Velocity, see their guide, as they have multiple options that require different setups.</li>
<li>Start the proxy server.</li>
<li>Edit the Floodgate config on your proxy server and set <code class="language-plaintext highlighter-rouge">send-floodgate-data</code> to <code class="language-plaintext highlighter-rouge">true</code>.</li>
<li>Copy the <code class="language-plaintext highlighter-rouge">key.pem</code> file in the proxy Floodgate config folder to all backend servers’ Floodgate config folder.</li>
<li>Restart the backend servers and proxy server.</li>
</ol>
<div class="alert alert-warning" role="alert">
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.
</div>
</div>
<div id="standalone-option" class="tab-pane fade" role="tabpanel">
<h1 id="floodgate-setup-with-geyser-standalone">Floodgate setup with Geyser-Standalone</h1>
<div class="alert alert-info" role="alert">
To be able to use Floodgate authentication, you need to be able to install Floodgate on the server you are connecting to.
</div>
<ol>
<li>Download Floodgate from the <a href="https://geysermc.org/download">download page</a>.</li>
<li>Install the Floodgate jar - see the platform instructions for detailed info.</li>
<li>Change <code class="language-plaintext highlighter-rouge">auth-type</code> in Geyser Standalone’s config to <code class="language-plaintext highlighter-rouge">floodgate</code>.</li>
<li>Copy the <code class="language-plaintext highlighter-rouge">key.pem</code> file in the Floodgate config folder to the same directory as Geyser Standalone.</li>
<li>Restart Geyser-Standalone.</li>
</ol>
<div class="alert alert-warning" role="alert">
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.
</div>
</div>
</div>
<h4 class="mt-4">Further information:</h4>
<ul>
<li><a href="/floodgate/features/">Floodgate Features</a></li>
<li><a href="/floodgate/api/">Floodgate API</a></li>
</ul>
</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/floodgate/setup.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/floodgate/setup.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 d-none"></div>
</div>
</div>
</div>
</div>
</div>
<!-- <footer class="p-4 text-center bg-body-tertiary">
&copy; 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>
_site/geyser/anticheat-compatibility/index.html
+475
View File
@@ -0,0 +1,475 @@
<!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: Anticheat Compatibility</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: Anticheat Compatibility">
<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">Anticheat Compatibility</li>
</ol>
</nav>
<div class="alert alert-warning" role="alert">
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!
</div>
<h3 id="anticheat-compatibility-reports">AntiCheat compatibility reports</h3>
<p>Full Compatibility (Checks Bedrock Players Accurately)</p>
<ul>
<li><a href="https://www.spigotmc.org/resources/1368/" target="_blank">AntiAura</a> (Paid) - Last Updated on 19th August 2021</li>
<li><a href="https://www.spigotmc.org/resources/90766/" target="_blank">Themis</a> - Last Updated on 15th Jun 2022</li>
<li><a href="https://www.spigotmc.org/resources/86874/" target="_blank">Negativity V2</a> (Paid) - Last Updated on 21st March 2022</li>
<li><a href="https://www.spigotmc.org/resources/87702/" target="_blank">SoaromaSAC</a> - Last Updated on 27th March 2022</li>
<li><a href="https://builtbybit.com/resources/12832/" target="_blank">Spartan: Bedrock Edition</a> (Paid) - Last Updated on 22nd May 2023</li>
</ul>
<p>Partially Compatible (Does not Check/Ignores Bedrock Players)</p>
<ul>
<li><a href="https://www.spigotmc.org/resources/6442/" target="_blank">AAC</a> (Paid) - Last Updated on 19th August 2021</li>
<li><a href="https://www.spigotmc.org/resources/92180/" target="_blank">Flappy Anticheat</a> - Last Updated on 14th September 2021</li>
<li><a href="https://github.com/MWHunter/Grim" target="_blank">GrimAC</a> - Last Updated on 24th March 2022</li>
<li><a href="https://intave.ac" target="_blank">Intave</a> (Paid) Requires <a href="https://github.com/intave/bedrock" target="_blank">GeyserMC addon</a> - Last Updated on 24th October 2022</li>
<li><a href="https://matrix.rip/" target="_blank">Matrix</a> (Paid) - Last updated on 2nd September 2021</li>
<li><a href="https://www.spigotmc.org/resources/25638/" target="_blank">Spartan: Java Edition</a> (Paid) - Last Updated on 22nd May 2023</li>
<li><a href="https://www.spigotmc.org/resources/83626/" target="_blank">Vulcan</a> (Paid) - Last Updated on 19th August 2021</li>
<li><a href="https://verus.ac" target="_blank">Verus</a> (Paid) - Last Updated on 13th July 2022</li>
</ul>
<p>Incompatible (False Positives on Bedrock Players, no Compatibility at All)</p>
<ul>
<li><a href="https://www.spigotmc.org/resources/23799/" target="_blank">AntiCheatReloaded</a> - Last Updated on 19th August 2021</li>
<li><a href="https://www.spigotmc.org/resources/48399/" target="_blank">Negativity V1</a> - Last Updated on 21st March 2022</li>
<li><a href="https://ci.codemc.io/job/Updated-NoCheatPlus/job/Updated-NoCheatPlus/" target="_blank">NoCheatPlus</a> (<a href="https://github.com/Updated-NoCheatPlus/CompatNoCheatPlus/" target="_blank">Compat NCP</a> is an addon that enables Partial Compatibility) - Last Updated on 19th August 2021</li>
<li><a href="https://www.spigotmc.org/resources/69595/" target="_blank">GodsEye</a> (<a href="https://github.com/TheDejavu/GodsEyeGeyserMC/releases" target="_blank">GodsEyeGeyserMC</a> is an addon that enables Partial Compatibility) (Paid) - Last Updated on 21st March 2022</li>
<li><a href="https://www.spigotmc.org/resources/53721/" target="_blank">Kauri</a> (Paid) - Last Updated on 21st March 2022</li>
<li><a href="https://www.spigotmc.org/resources/21122/" target="_blank">Reflex</a> (Paid) - Last Updated on 19th August 2021</li>
<li><a href="https://www.spigotmc.org/resources/66887/" target="_blank">Wraith</a> (Paid) - Last Updated on 19th August 2021</li>
</ul>
</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/anticheat-compatibility.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/anticheat-compatibility.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">
&copy; 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>
_site/geyser/api/index.html
+536
View File
@@ -0,0 +1,536 @@
<!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: Geyser 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: Geyser 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">Geyser API</li>
</ol>
</nav>
<p>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.</p>
<h3 id="where-can-i-use-the-geyser-api">Where can I use the Geyser API?</h3>
<p>You could use the Geyser API in:</p>
<ul>
<li>A plugin for Paper/Spigot, Velocity, Waterfall/BungeeCord, etc.</li>
<li>A mod for Fabric or Forge</li>
<li>A Geyser Extension</li>
</ul>
<h3 id="accessing-the-geyser-api">Accessing the Geyser API</h3>
<p>See <a href="/geyser/getting-started-with-the-api">here</a> for how to include the Geyser API dependency in your project.</p>
<h3 id="documentation">Documentation</h3>
<p>The 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).
(soon, blocks and entities too).
It can be used easily in Geyser Extensions, see <a href="/geyser/extensions">here</a> for details on those.</p>
<p><strong>Quick overview:</strong> <br /></p>
<div class="alert alert-info" role="alert">
Note: To see full, detailed documentation, see the <a href="https://repo.opencollab.dev/javadoc/maven-snapshots/org/geysermc/geyser/api/latest">javadocs</a>.
</div>
<h4 id="geyserapi"><a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/GeyserApi.java">GeyserApi</a>:</h4>
<p>The 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.
It extends the <a href="https://github.com/GeyserMC/api/blob/master/base/src/main/java/org/geysermc/api/GeyserApiBase.java">Base API</a> interface, which provides basic information about individual players.</p>
<p>The class GeyserApi is the base class of the API and you need to use it to access any part of the API.<br />
To access it, you simply type:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">GeyserApi</span><span class="o">.</span><span class="na">api</span><span class="o">();</span>
</code></pre></div></div>
<p>After you got the instance, you have access to all the methods.<br />
Use the documentation in the API module to see (and get info about) every single method available.<br />
Most <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/GeyserApi.java">API methods have a simple explanation</a>.
Since the Geyser API extends the Base API that is shared across Floodgate and Geyser, you can also use the <a href="https://github.com/GeyserMC/api/blob/master/base/src/main/java/org/geysermc/api/GeyserApiBase.java">methods from the Base API</a>.</p>
<h4 id="well-highlight-a-few-to-get-you-started-quickly">We’ll highlight a few to get you started quickly:</h4>
<p><code class="language-plaintext highlighter-rouge">GeyserApi#isBedrockPlayer(UUID)</code><br />
Used to check if the given UUID of an <strong>online</strong> player is a Bedrock player.</p>
<p><code class="language-plaintext highlighter-rouge">GeyserApi#connectionByUuid(UUID)</code><br />
Used to get the <a href="https://github.com/GeyserMC/api/blob/master/base/src/main/java/org/geysermc/api/connection/Connection.java">Connection</a> of an <strong>online</strong> player.<br />
This method will return null if the player is not a Bedrock player.</p>
<div class="alert alert-info" role="alert">
You don't need to wait until the Bedrock player is online to use the getPlayer and isBedrockPlayer methods.<br />
You can even use them in the pre-login events.
</div>
<p><code class="language-plaintext highlighter-rouge">GeyserApi#sendForm(UUID, Form(Builder))</code><br />
Used to send a form to the Bedrock player with the given UUID.<br />
Click <a href="/geyser/forms/">here</a> to get more information about Forms.</p>
<p><code class="language-plaintext highlighter-rouge">GeyserApi#onlineConnectionsCount()</code><br />
Used to get the amount of online Bedrock players.</p>
<h3 id="short-overview-of-the-geyser-api">Short Overview of the Geyser API</h3>
<h4 id="cumulus"><a href="https://github.com/GeyserMC/Cumulus/tree/master/src/main/java/org/geysermc/cumulus">Cumulus</a></h4>
<p>While technically not directly in the Geyser API, the Cumulus library is also provided by the Geyser API.
It allows you to send Bedrock edition forms to players. See <a href="/geyser/forms/">Cumulus</a> for more information.</p>
<h4 id="events"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event">Events</a></h4>
<p>The event package contains all the events that Geyser fires. See <a href="/geyser/events">here</a> for detailed information on how to listen to Geyser events.</p>
<h4 id="command"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/command">Command</a></h4>
<p>This package contains classes and interfaces related to commands in Geyser, which allows <a href="/geyser/extensions">Geyser Extensions</a> to register custom commands.</p>
<h4 id="entity"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/entity">Entity</a></h4>
<p>The Entity package contains classes and interfaces related to entities in Geyser, like the GeyserPlayerEntity interface,
which represents a player entity in Geyser. This interface extends the GeyserEntity interface, while providing additional functionality specifically for player entities,
like currently, showing emotes.</p>
<h4 id="item"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/item">Item</a></h4>
<p>The item package contains classes and interfaces related to items in Geyser. You can create custom items and register them using the Geyser API.
See <a href="/geyser/custom-items">here</a> for detailed information on how to register custom items.</p>
<h4 id="block"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/block">Block</a></h4>
<p>The 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 <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCustomBlocksEvent.java">GeyserDefineCustomBlocksEvent</a>.
See <a href="/geyser/custom-blocks">here</a> for detailed information.</p>
<h4 id="network"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/network">Network</a></h4>
<p>The network package contains basic information about the remote server via the
<a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/network/RemoteServer.java">RemoteServer</a>
interface, such as the server’s IP address and port, and the protocol version of the remote server. Or the auth type.
You can also get the port/IP that Geyser listens to via the <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/network/BedrockListener.java">BedrockListener</a> interface.</p>
<h4 id="pack"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/pack">Pack</a></h4>
<p>The 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 <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/bedrock/SessionLoadResourcePacksEvent.java">SessionLoadResourcePacksEvent</a>.
If you wish to send a resource pack to all sessions, you can use the <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserLoadResourcePacksEvent.java">GeyserLoadResourcePacksEvent</a>.</p>
<p>Packs can be created using a <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/pack/PackCodec.java">PackCodec</a>, such as the provided <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/pack/PathPackCodec.java">PathPackCodec</a>.
This allows you to load a Bedrock resource pack from a file path:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">ResourcePack</span> <span class="n">pack</span> <span class="o">=</span> <span class="nc">ResourcePack</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="nc">PackCodec</span><span class="o">.</span><span class="na">path</span><span class="o">(</span><span class="n">path</span><span class="o">));</span>
</code></pre></div></div>
<h4 id="extension"><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/extension">Extension</a></h4>
<p>This package provides the necessary components to create and manage extensions.
For a more detailed explanation of extensions, see <a href="/geyser/extensions">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/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/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">
&copy; 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>
_site/geyser/commands/index.html
+535
View File
@@ -0,0 +1,535 @@
<!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: Commands</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: Commands">
<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">Commands</li>
</ol>
</nav>
<h1 id="commands-and-permissions">Commands and Permissions</h1>
<p>Geyser features many built-in commands that can be used by players or server owners.</p>
<div class="alert alert-info" role="alert">
When using BungeeCord and Velocity, you will need to use a permission plugin such as <a href="https://luckperms.net/">LuckPerms</a>
on the proxy server to assign permissions to players. Assigning permissions on the backend servers will not work.
</div>
<h2 id="geyser-commands--their-permissions">Geyser commands &amp; their permissions</h2>
<table class="table table-striped table-bordered">
<thead>
<tr>
<th style="text-align: left">Command</th>
<th style="text-align: left">Permission</th>
<th style="text-align: left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser help</code> <br /> <code class="language-plaintext highlighter-rouge">geyser ?</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.help</code></td>
<td style="text-align: left">Shows help for all registered commands.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser advancements</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.advancements</code></td>
<td style="text-align: left">Open the Java advancements menu.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser dump</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.dump</code></td>
<td style="text-align: left">Dumps Geyser debug information for bug reports.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser list</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.list</code></td>
<td style="text-align: left">List all players connected through Geyser.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser offhand</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.offhand</code></td>
<td style="text-align: left">Puts an item in your offhand.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser reload</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.reload</code></td>
<td style="text-align: left">Reloads the Geyser configurations. Kicks all players when used!</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser settings</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.settings</code></td>
<td style="text-align: left">Opens a settings menu allowing you to modify aspects of the world.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser shutdown</code> <br /> <code class="language-plaintext highlighter-rouge">geyser stop</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.shutdown</code></td>
<td style="text-align: left">Shuts down Geyser.<br /><em>This command only works on Standalone.</em></td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser statistics</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.statistics</code></td>
<td style="text-align: left">Open the Java statistics menu.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser version</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.version</code></td>
<td style="text-align: left">Shows the current Geyser version and checks for updates.</td>
</tr>
<tr>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser tooltips</code></td>
<td style="text-align: left"><code class="language-plaintext highlighter-rouge">geyser.command.tooltips</code></td>
<td style="text-align: left">Toggle showing Advanced Tooltips (F3 + H on Java)</td>
</tr>
</tbody>
</table>
<h2 id="other-permissions">Other Permissions</h2>
<p>Besides commands, there are other permissions that are used to guard specific Geyser features.</p>
<table class="table table-striped table-bordered">
<thead>
<tr>
<th>Permission</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="language-plaintext highlighter-rouge">geyser.settings.server</code></td>
<td>Allow players to use the <a href="/img/wiki/game_menu.png">game settings menu</a>. (Also requires player to have op.)</td>
</tr>
</tbody>
</table>
<h2 id="floodgate-commands-and-permissions">Floodgate commands and permissions</h2>
<p>For Floodgate commands, see <a href="/floodgate/commands/">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/commands.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/commands.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">
&copy; 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>
_site/geyser/common-issues/index.html
+570
View File
@@ -0,0 +1,570 @@
<!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: Common Issues</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: Common Issues">
<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">Common Issues</li>
</ol>
</nav>
<p>Commonly, people may have issues with Geyser not showing up in their server list or run into similar issues.
This page contains a few common issues people may encounter that you might have as well as potential fixes for them.
If you still can’t make it work, join <a href="https://discord.gg/geysermc">our Discord</a> for support.</p>
<h1 id="floodgate">Floodgate</h1>
<p>For Floodgate issues see: <a href="/floodgate/issues/">Floodgate: Known Issues/Caveats</a>.</p>
<h1 id="i-cant-connect-either-the-server-doesnt-show-up-in-the-friends-list-or-i-get-unable-to-connect-to-world">I can’t connect! (Either the server doesn’t show up in the friends list or I get “Unable to connect to world”)</h1>
<ul>
<li>If you don’t use a reverse proxy such as TCPShield make sure that <code class="language-plaintext highlighter-rouge">enable-proxy-protocol</code> is set to false.
To fix “Unable to connect to world” with no console errors, see <a href="/geyser/fixing-unable-to-connect-to-world/">here</a>.</li>
</ul>
<h2 id="if-the-server-doesnt-show-up-in-the-friends-list">If the server doesn’t show up in the friends list</h2>
<ul>
<li><em>If using Windows 10, iOS, or Android</em>: try adding the server to the Servers list in-game.</li>
<li><em>If using Xbox One</em>: try connecting with <a href="/geyser/using-geyser-with-consoles/">BedrockConnect</a>.</li>
<li><em>If using PS4</em>: <a href="/geyser/using-geyser-with-consoles/#playstation-4">try using a LAN proxy.</a></li>
<li><em>If using Nintendo Switch</em>: there is currently no way for local servers to show up in the Friends tab, but you can still connect using <a href="/geyser/using-geyser-with-consoles/">BedrockConnect</a>.</li>
</ul>
<p><em>If the Geyser instance is locally hosted:</em> try using <code class="language-plaintext highlighter-rouge">localhost</code> or <code class="language-plaintext highlighter-rouge">0.0.0.0</code> as the IP address.
<em>If that doesn’t work, or your Geyser instance is on another computer in the network</em>: use your <strong>local</strong> IPv4 address.</p>
<h2 id="see-here-for-fixing-unable-to-connect-to-world-with-no-console-errors">See <a href="/geyser/fixing-unable-to-connect-to-world/">here</a> for fixing “Unable to Connect to World” with no console errors</h2>
<h3 id="javanetbindexception-address-already-in-use-bind-on-startup"><code class="language-plaintext highlighter-rouge">java.net.BindException: Address already in use: bind</code> on startup.</h3>
<p>This 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.</p>
<h3 id="-has-been-compiled-by-a-more-recent-version-of-the-java-runtime-class-file-version-600">[…]<code class="language-plaintext highlighter-rouge"> has been compiled by a more recent version of the Java Runtime (class file version 60.0)</code></h3>
<p>See this link for updating to Java 16: https://paper.readthedocs.io/en/latest/java-update/index.html.</p>
<h3 id="hosting-provider-will-not-immediately-open-up-udp">Hosting provider will not immediately open up UDP.</h3>
<p>These steps only apply for the standalone version of Geyser.
This 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.
One 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.</p>
<p><strong>PLEASE NOTE:</strong> 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.</p>
<h1 id="stuck-on-locating-server-with-no-errors">Stuck on “Locating Server” with no errors</h1>
<p>You may need to update your Java version. If so, update at <a href="https://adoptium.net/">Adoptium.net</a>.</p>
<p>Sometimes this happens in poor-network environments. There is an <code class="language-plaintext highlighter-rouge">mtu</code> option in the Geyser config; lower this number slowly (in batches of 100), restart each time, and re-test joining.</p>
<p>This option will most likely not help if you are getting “Unable to Connect to World” with no console logs indicating a connection.</p>
<h1 id="login-failed">Login Failed</h1>
<p><strong><em>If you are using a plugin version:</em></strong> in your Geyser config, set your remote address to <code class="language-plaintext highlighter-rouge">127.0.0.1</code>. If that does not work, check your startup log for a message about Docker, and use that address in the remote address</p>
<h3 id="cannot-reply-to-encryptionrequestpacket-without-profile-and-access-token">Cannot reply to EncryptionRequestPacket without profile and access token</h3>
<p>There are two causes of this message:</p>
<p><em>Floodgate issue</em>:</p>
<p>This 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.</p>
<p><em>Server is in Online Mode while Geyser is in Offline Mode</em>:</p>
<p>If 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.</p>
<h3 id="connection-refused-insert-ip-andor-domain">Connection Refused: &lt;INSERT IP AND/OR DOMAIN&gt;</h3>
<p>Connection 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.
The 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.</p>
<p>If you’re updating from an old build of Geyser, set your remote address to <code class="language-plaintext highlighter-rouge">auto</code> and try again.</p>
<h3 id="floodgate-misconfiguration">Floodgate Misconfiguration</h3>
<p>See <a href="/floodgate/setup/">this page</a> for more information.</p>
<h3 id="missing-profile-key-this-server-requires-secure-profiles">Missing profile key. This server requires secure profiles.</h3>
<p>See <a href="/geyser/secure-chat/">this page</a>.</p>
<h3 id="mojang-resetting-account-credentials">Mojang Resetting Account Credentials</h3>
<p>This 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 <a href="https://github.com/GeyserMC/Floodgate">Floodgate</a>, which allows for Bedrock clients to join your server without needing a Java Edition account. Take a look <a href="Floodgate">here</a> for more information.</p>
<h1 id="invalid-ip-address-from-bedrock">“Invalid IP address!” from Bedrock</h1>
<p>This can happen if the domain you are entering resolves to a SRV record, which Bedrock does not support. Try using the IPv4 address instead.
Additionally, this can happen when trying to specify both the ip and port in the ip tab - in which case, see <a href="/img/wiki/edit_server_form.png">here</a> for how to properly connect to “test.geysermc.org:19132”.</p>
<h1 id="bedrock-clients-freeze-when-opening-up-commands-for-the-first-time">Bedrock clients freeze when opening up commands for the first time</h1>
<p>Disable <code class="language-plaintext highlighter-rouge">command-suggestions</code> in your Geyser config. This will stop the freezing at the expense of removing command suggestions from Bedrock clients.
If 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.
It has other benefits too. Here’s a plugin that can just do that:
<a href="https://www.spigotmc.org/resources/81326/">CommandWhitelist</a>. Alternatively, use the <a href="https://github.com/Redned235/HideCommands">HideCommands</a> Geyser extension to hide commands just for Bedrock players.</p>
<h1 id="failed-to-load-locale-asset-cache-unrecognized-token-cannot">Failed to load locale asset cache: Unrecognized token ‘Cannot’</h1>
<p>This 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 <code class="language-plaintext highlighter-rouge">-Djava.net.preferIPv4Stack=true</code>, EG: <code class="language-plaintext highlighter-rouge">java -Xms1024M -Djava.net.preferIPv4Stack=true -jar Geyser.jar</code></p>
<h1 id="outdated-client-please-use-1xx">Outdated client! Please use 1.x.x</h1>
<p>The server is too new or Geyser is outdated. Make sure you’re on the latest Geyser.</p>
<h1 id="outdated-server-im-still-on-1xx">Outdated server! I’m still on 1.x.x</h1>
<p>Update the server or ask them to install <a href="https://viaversion.com/">ViaVersion</a>. You can also try <a href="https://github.com/ViaVersion/VIAaaS">VIAaaS</a> (ViaVersion as a Service).</p>
<h1 id="query-incorrect-magic">Query: Incorrect Magic!</h1>
<p>See here: https://www.spigotmc.org/threads/query-incorrect-magic-and-high-cpu-usage.159386/#post-2709057</p>
<ul>
<li>If you don’t use a reverse proxy such as TCPShield make sure that <code class="language-plaintext highlighter-rouge">enable-proxy-protocol</code> is set to false.</li>
</ul>
<h1 id="only-for-bungeecord-with-floodgate">Only for BungeeCord with floodgate</h1>
<p>If you use floodgate ensure that it is installed on all of your Spigot backend servers as following:</p>
<ol>
<li><code class="language-plaintext highlighter-rouge">Bungee: Geyser and Floodgate</code></li>
<li><code class="language-plaintext highlighter-rouge">Lobby: floodgate</code></li>
<li><code class="language-plaintext highlighter-rouge">Server-1: floodgate</code></li>
<li><code class="language-plaintext highlighter-rouge">Server-2: floodgate</code></li>
</ol>
<p>And so on.</p>
<ul>
<li>Please also make sure that you have the same <code class="language-plaintext highlighter-rouge">key.pem</code> and <code class="language-plaintext highlighter-rouge">config.yml</code> on all of your servers.</li>
</ul>
<p>If your players can’t connect from the lobby to another backend server, check console.</p>
<h3 id="plugins-that-can-cause-issues">Plugins that can cause issues</h3>
<ul>
<li><code class="language-plaintext highlighter-rouge">HamsterAPI</code></li>
</ul>
</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/common-issues.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/common-issues.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">
&copy; 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>
_site/geyser/creating-a-startup-script/index.html
+475
View File
@@ -0,0 +1,475 @@
<!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: Creating a Startup Script</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: Creating a Startup Script">
<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">Creating a Startup Script</li>
</ol>
</nav>
<h1 id="creating-a-startup-script-for-geyser-standalone">Creating a Startup Script for Geyser-Standalone</h1>
<p><strong>In order for this to work, you MUST have Java 16 (or higher) installed!</strong></p>
<p>Once 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.</p>
<h3 id="windows">Windows</h3>
<ul>
<li>Create a new text file in the same location as the Geyser-Standalone jar file, and call it <code class="language-plaintext highlighter-rouge">run.bat</code>. Open this with a text editor (preferably Notepad++), and insert the text below:
<div class="language-batch highlighter-rouge"><div class="highlight"><pre class="highlight"><code>@echo <span class="na">off</span>
<span class="kd">java</span> <span class="na">-Xms</span><span class="m">1024</span><span class="kd">M</span> <span class="na">-jar </span><span class="kd">Geyser</span><span class="na">-Standalone</span>.jar
<span class="nb">pause</span>
</code></pre></div> </div>
</li>
<li>Double-click the <strong>run.bat</strong>, and Geyser should start up. Geyser will generate all the needed files.</li>
</ul>
<h3 id="macos">macOS</h3>
<ul>
<li>Create a text file called <strong>run.command</strong>, and open it with a text editor such as TextEdit or TextMate. Type the text below into the <strong>run.command</strong> file:
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c">#!/bin/bash </span>
<span class="nb">cd</span> <span class="s2">"</span><span class="si">$(</span> <span class="nb">dirname</span> <span class="s2">"</span><span class="nv">$0</span><span class="s2">"</span> <span class="si">)</span><span class="s2">"</span>
java <span class="nt">-Xms1024M</span> <span class="nt">-jar</span> Geyser-Standalone.jar
</code></pre></div> </div>
</li>
<li>Open Terminal, and type in <code class="language-plaintext highlighter-rouge">chmod a+x</code> <strong>(Do NOT press return!)</strong>, and drag your <em>run.command</em> file into the Terminal.</li>
<li>Press return on your keyboard, and Geyser will start up. Geyser will generate all the needed files.</li>
</ul>
<h3 id="linux">Linux</h3>
<ul>
<li>Create a file called <em>run.sh</em>, and open it with a text editor. Type the text below into your <code class="language-plaintext highlighter-rouge">run.sh</code> file:
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c">#!/bin/sh </span>
<span class="nb">cd</span> <span class="s2">"</span><span class="si">$(</span> <span class="nb">dirname</span> <span class="s2">"</span><span class="nv">$0</span><span class="s2">"</span> <span class="si">)</span><span class="s2">"</span>
java <span class="nt">-Xms1024M</span> <span class="nt">-jar</span> Geyser-Standalone.jar
</code></pre></div> </div>
</li>
<li>In your default terminal application, make the file executable by running <code class="language-plaintext highlighter-rouge">chmod +x ~(dir)/run.sh</code> where <code class="language-plaintext highlighter-rouge">dir</code> is the name of the folder Geyser is in, or by changing the file permissions;</li>
<li>Open your default terminal application, and type <code class="language-plaintext highlighter-rouge">./run.sh</code> to run Geyser. Geyser will generate all the needed files.</li>
</ul>
</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/creating-a-startup-script.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/creating-a-startup-script.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">
&copy; 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>
_site/geyser/current-limitations/index.html
+471
View File
@@ -0,0 +1,471 @@
<!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: Current Limitations</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: Current Limitations">
<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">Current Limitations</li>
</ol>
</nav>
<p>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.</p>
<p>The following things cannot be fixed without changes to Bedrock or the Java protocol in general. As of now, they are not fixable in Geyser.</p>
<ul>
<li>Custom heads in inventories</li>
<li>Clickable links in chat</li>
<li>Glowing effect</li>
<li>Crafting in the 2x2 menu while in creative mode</li>
<li>Distinguishing between left and right clicks in inventories</li>
<li>Redstone dot blockstates</li>
<li>“Can be placed on/destroyed” tag for <em>some</em> blocks - for example, different colors of clay/wool that don’t exist as separate blocks</li>
<li>Potion colors implemented using NBT</li>
<li>Various command arguments for any command that doesn’t use the Minecraft Brigadier library</li>
<li>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</li>
<li>Unable to see banner layers past 6</li>
<li>Movement issues around bamboo due to offset differences between Java and Bedrock: <a href="/other/hurricane">Hurricane</a> can work around it.</li>
<li>Can’t move mounted entities with carrot/warped fungus on a stick. Hurricane also works around this.</li>
<li>Custom anvil recipes</li>
<li>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</li>
<li>Dolphin’s Grace potion effect visuals (effects should still work correctly)</li>
<li>Invisible item frames</li>
<li>Blocks (excluding jack-o-lantern) on entity heads (E.G. armor stands, players)</li>
<li>Saddled camels unmoveable/unrideable on bedrock.</li>
<li>Bedrock edition players cannot see the changes to fence block states made by the Java Debug Stick.</li>
</ul>
<p>The following changes <strong>are supported</strong> with the <a href="/other/geyseroptionalpack/">GeyserOptionalPack</a>, which is a Bedrock resource pack you can install for additional functionality for features Bedrock does not natively support:</p>
<ul>
<li>Custom armor stand poses</li>
<li>Illusioners</li>
<li>Hit particles and other miscellaneous particles not natively in Bedrock</li>
<li>Offhand animations</li>
<li>Shulker invisibility</li>
<li>Spectral arrow texture</li>
</ul>
</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/current-limitations.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/current-limitations.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">
&copy; 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>
_site/geyser/custom-blocks/index.html
+1324
View File
File diff suppressed because it is too large. Load diff
_site/geyser/custom-items/index.html
+601
View File
@@ -0,0 +1,601 @@
<!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: Custom items with Geyser</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: Custom items with Geyser">
<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">Custom items with Geyser</li>
</ol>
</nav>
<h1 id="custom-items-with-geyser">Custom items with Geyser</h1>
<p>To setup custom items in geyser, you have to choose how you are going to register your items. The easiest is <a href="#json-mappings">using a json file</a> but you can also <a href="#geyser-extensions">use a Geyser extension</a>.</p>
<h2 id="json-mappings">JSON mappings</h2>
<ol>
<li>Start your server, and you should have a folder called <code class="language-plaintext highlighter-rouge">custom_mappings</code> that is created. That would be with the folder of <code class="language-plaintext highlighter-rouge">Geyser.jar</code> file for standalone and inside your Geyser data folder for a plugin.</li>
<li>Create a <code class="language-plaintext highlighter-rouge">.json</code> 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:
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nl">"format_version"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
</span><span class="nl">"items"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div> </div>
</li>
<li>Inside the <code class="language-plaintext highlighter-rouge">items</code> entry, you can add your java item to extend:</li>
</ol>
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nl">"minecraft:JAVA_ITEM"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">]</span><span class="w">
</span></code></pre></div></div>
<ol>
<li>Inside this java item, goes an array of all your custom items.</li>
</ol>
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my_item"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>
<ol>
<li>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.
<ul>
<li>Custom model data: <code class="language-plaintext highlighter-rouge">custom_model_data</code> (int)</li>
<li>Damage predicate: <code class="language-plaintext highlighter-rouge">damage_predicate</code> (int) This is a fractional value of damage/max damage and not a number between 0 and 1.</li>
<li>Unbreakable: <code class="language-plaintext highlighter-rouge">unbreakable</code> (boolean)</li>
</ul>
</li>
<li>You also have some extra modifiers that you can set to further customise your item. <strong>Note that the following modifiers are NOT required.</strong>
<ul>
<li><code class="language-plaintext highlighter-rouge">display_name</code> (string) default: item name</li>
<li><code class="language-plaintext highlighter-rouge">icon</code> (string) default: item name</li>
<li><code class="language-plaintext highlighter-rouge">allow_offhand</code> (boolean) default: false</li>
<li><code class="language-plaintext highlighter-rouge">texture_size</code> (int) default: 16</li>
<li><code class="language-plaintext highlighter-rouge">render_offsets</code> (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
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="w"> </span><span class="nl">"render_offsets"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"main_hand"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"first_person"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"position"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"x"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"y"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"z"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"rotation"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"x"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"y"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"z"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"scale"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"x"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"y"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w">
</span><span class="nl">"z"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"third_person"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"off_hand"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div> </div>
</li>
</ul>
</li>
</ol>
<h2 id="geyser-extensions">Geyser extensions</h2>
<h3 id="extending-a-vanilla-item">Extending a vanilla item</h3>
<ol>
<li>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 <strong>do NOT need all of them.</strong>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">CustomItemOptions</span> <span class="n">itemOptions</span> <span class="o">=</span> <span class="nc">CustomItemOptions</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">customModelData</span><span class="o">(</span><span class="mi">1</span><span class="o">)</span>
<span class="o">.</span><span class="na">damagePredicate</span><span class="o">(</span><span class="mi">1</span><span class="o">)</span> <span class="c1">//This is a fractional value of damage/max damage and not a number between 0 and 1.</span>
<span class="o">.</span><span class="na">unbreakable</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</code></pre></div> </div>
</li>
<li>Create your custom item, and store it somewhere:
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">CustomItemData</span> <span class="n">data</span> <span class="o">=</span> <span class="nc">CustomItemData</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"my_item"</span><span class="o">)</span>
<span class="o">.</span><span class="na">customItemOptions</span><span class="o">(</span><span class="n">itemOptions</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</code></pre></div> </div>
</li>
<li>You have some modifiers that you can set to further customise your item. <strong>Note that the following modifiers are NOT required.</strong>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">.</span><span class="na">displayName</span><span class="o">(</span><span class="s">"displayName"</span><span class="o">);</span> <span class="c1">//Default: item name</span>
<span class="o">.</span><span class="na">icon</span><span class="o">(</span><span class="s">"my_icon"</span><span class="o">);</span> <span class="c1">//Default: item name</span>
<span class="o">.</span><span class="na">allowOffhand</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span> <span class="c1">//Default: false</span>
<span class="o">.</span><span class="na">textureSize</span><span class="o">(</span><span class="mi">16</span><span class="o">);</span> <span class="c1">//Default: 16</span>
<span class="o">.</span><span class="na">renderOffsets</span><span class="o">(</span><span class="k">new</span> <span class="nc">CustomRenderOffsets</span><span class="o">(...));</span> <span class="c1">//Default: no render offset</span>
</code></pre></div> </div>
</li>
<li>Then, in your pre init event, you can register your item:
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onGeyserPreInitializeEvent</span><span class="o">(</span><span class="nc">GeyserDefineCustomItemsEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="n">event</span><span class="o">.</span><span class="na">registerCustomItem</span><span class="o">(</span><span class="s">"minecraft:JAVA_ITEM"</span><span class="o">,</span> <span class="n">data</span><span class="o">);</span>
<span class="o">}</span>
</code></pre></div> </div>
</li>
</ol>
<h3 id="non-vanilla-modded-items-with-geyser-extensions-for-example-to-use-with-fabric">Non vanilla (modded) items with Geyser extensions (for example to use with Fabric)</h3>
<ol>
<li>Create your item data:
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">NonVanillaCustomItemData</span> <span class="n">data</span> <span class="o">=</span> <span class="nc">NonVanillaCustomItemData</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"my_item"</span><span class="o">)</span>
<span class="o">.</span><span class="na">identifier</span><span class="o">(</span><span class="s">"my_mod:my_item"</span><span class="o">)</span>
<span class="o">.</span><span class="na">javaId</span><span class="o">(</span><span class="mi">1</span><span class="o">)</span>
</code></pre></div> </div>
</li>
<li>There are many other options you can set to match the behavior that you require for your item. You can see them <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/item/custom/NonVanillaCustomItemData.java">here</a></li>
<li>Register your item in the GeyserDefineCustomItems event:
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onGeyserDefineCustomItemsEvent</span><span class="o">(</span><span class="nc">GeyserDefineCustomItemsEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="n">event</span><span class="o">.</span><span class="na">register</span><span class="o">(</span><span class="n">data</span><span class="o">);</span>
<span class="o">}</span>
</code></pre></div> </div>
</li>
</ol>
<h2 id="resource-pack">Resource pack</h2>
<ol>
<li>Setup a basic bedrock resource pack. If you need help, you can find it <a href="https://wiki.bedrock.dev/guide/project-setup.html#rp-manifest">here</a>.</li>
<li>Make a <code class="language-plaintext highlighter-rouge">textures</code> folder.</li>
<li>Create <code class="language-plaintext highlighter-rouge">item_texture.json</code> in the <code class="language-plaintext highlighter-rouge">textures</code>, and put this in it:</li>
</ol>
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nl">"resource_pack_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"MY_PACK_NAME_HERE"</span><span class="p">,</span><span class="w">
</span><span class="nl">"texture_name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"atlas.items"</span><span class="p">,</span><span class="w">
</span><span class="nl">"texture_data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>
<ol>
<li>Inside texture data, you can add your items. The texture name and path must match the name that you set in your mappings.</li>
</ol>
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nl">"my_item"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"textures"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"textures/items/my_item"</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>
<ol>
<li>Then you need to put your textures inside the <code class="language-plaintext highlighter-rouge">textures/items</code>. Make sure to have it match the texture path that you specified in <code class="language-plaintext highlighter-rouge">item_texture.json</code>!</li>
</ol>
</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/custom-items.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/custom-items.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">
&copy; 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>
_site/geyser/custom-skulls/index.html
+562
View File
@@ -0,0 +1,562 @@
<!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: Custom skulls with Geyser</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: Custom skulls with Geyser">
<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">Custom skulls with Geyser</li>
</ol>
</nav>
<h1 id="custom-skulls-with-geyser">Custom skulls with Geyser</h1>
<p>Unlike 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.</p>
<p>To setup custom skulls in geyser, you have to choose how you are going to register your blocks. The easiest is <a href="#custom-skullsyml">using custom-skulls.yml</a> but you can also <a href="#geyser-extensions">use a Geyser extension</a>.</p>
<h2 id="enabling-custom-skulls">Enabling custom skulls</h2>
<p>To enable custom skulls, you must set <code class="language-plaintext highlighter-rouge">add-non-bedrock-items</code> to <code class="language-plaintext highlighter-rouge">true</code> in the <code class="language-plaintext highlighter-rouge">config.yml</code> 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 <code class="language-plaintext highlighter-rouge">custom-skulls.yml</code> file.</p>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Whether to add any items and blocks which normally does not exist in Bedrock Edition.</span>
<span class="c1"># This should only need to be disabled if using a proxy that does not use the "transfer packet" style of server switching.</span>
<span class="c1"># If this is disabled, furnace minecart items will be mapped to hopper minecart items.</span>
<span class="c1"># Geyser's block, item, and skull mappings systems will also be disabled.</span>
<span class="c1"># This option requires a restart of Geyser in order to change its setting.</span>
<span class="na">add-non-bedrock-items</span><span class="pi">:</span> <span class="no">true</span>
</code></pre></div></div>
<h2 id="custom-skullsyml">custom-skulls.yml</h2>
<p>The configuration file <code class="language-plaintext highlighter-rouge">custom-skulls.yml</code> is present in Geyser’s configuration folder and is laid out as follows:</p>
<div class="language-yml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># --------------------------------</span>
<span class="c1"># Geyser Custom Skull Configuration Files</span>
<span class="c1">#</span>
<span class="c1"># This file is ignored with `add-custom-skull-blocks` disabled.</span>
<span class="c1"># See `config.yml` for the main set of configuration values</span>
<span class="c1">#</span>
<span class="c1"># Custom skulls with the player username, UUID, or texture specified in this file</span>
<span class="c1"># will be translated as custom blocks and be displayed in the inventory and on entities.</span>
<span class="c1"># --------------------------------</span>
<span class="c1"># Java player usernames</span>
<span class="c1"># Skins will be updated when Geyser starts and players will have to re-download</span>
<span class="c1"># the resource pack if any players had changed their skin.</span>
<span class="na">player-usernames</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">GeyserMC</span>
<span class="c1"># Java player UUIDs</span>
<span class="c1"># Skins will be updated when Geyser starts and players will have to re-download</span>
<span class="c1"># the resource pack if any players had changed their skin.</span>
<span class="na">player-uuids</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">8b8d8e8f-2759-47c6-acb5-5827de8a72b8</span>
<span class="c1"># The long string of characters found in the NBT of custom player heads</span>
<span class="na">player-profiles</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJBbWJlcmljaHUiLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYTkwNzkwYzU3ZTE4MWVkMTNhZGVkMTRjNDdlZTJmN2M4ZGUzNTMzZTAxN2JhOTU3YWY3YmRmOWRmMWJkZTk0ZiIsCiAgICAgICJtZXRhZGF0YSIgOiB7CiAgICAgICAgIm1vZGVsIiA6ICJzbGltIgogICAgICB9CiAgICB9CiAgfQp9</span>
<span class="c1"># The hash of the skin on Minecraft's skin server</span>
<span class="na">skin-hashes</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f</span>
</code></pre></div></div>
<h3 id="player-usernames">Player usernames</h3>
<p>Skulls 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.</p>
<h3 id="player-uuids">Player UUIDs</h3>
<p>Skulls 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.</p>
<h3 id="player-profiles">Player profiles</h3>
<p>Skulls 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:</p>
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nl">"timestamp"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="mi">1657322239833</span><span class="p">,</span><span class="w">
</span><span class="nl">"profileId"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"cddbe520d0434a8ba1cc9fc92fde2bcf"</span><span class="p">,</span><span class="w">
</span><span class="nl">"profileName"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"Amberichu"</span><span class="p">,</span><span class="w">
</span><span class="nl">"textures"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"SKIN"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"url"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"http://textures.minecraft.net/texture/a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f"</span><span class="p">,</span><span class="w">
</span><span class="nl">"metadata"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"model"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"slim"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>
<p>If on a paper server, this data can be obtained for a skull by holding the item in hand, and running the command <code class="language-plaintext highlighter-rouge">/paper dumpitem</code>. This will output the NBT data of the item to chat and console. The texture string is found in the <code class="language-plaintext highlighter-rouge">SkullOwner</code> tag, under the <code class="language-plaintext highlighter-rouge">Properties</code> tag, under the <code class="language-plaintext highlighter-rouge">textures</code> tag, under the <code class="language-plaintext highlighter-rouge">Value</code> tag. For example:</p>
<pre><code class="language-log">[05:58:07 INFO]: .KastleFirefox issued server command: /paper dumpitem
[05:58:07 INFO]: minecraft:player_head{display: {Name: '{"text":"Test"}'}, SkullOwner: {Properties: {textures: [{Value: "ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJkYXZjaG9vIiwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlL2E5MDc5MGM1N2UxODFlZDEzYWRlZDE0YzQ3ZWUyZjdjOGRlMzUzM2UwMTdiYTk1N2FmN2JkZjlkZjFiZGU5NGYiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ"}]}, Id: [I; -229048314, -553040501, -1407961158, 465313087]}}
</code></pre>
<h3 id="skin-hashes">Skin Hashes</h3>
<p>Skulls 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 <code class="language-plaintext highlighter-rouge">http://textures.minecraft.net/texture/a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f</code> the hash is <code class="language-plaintext highlighter-rouge">a90790c57e181ed13aded14c47ee2f7c8de3533e017ba957af7bdf9df1bde94f</code>.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.</p>
<p>This can be obtained by decoding the base64 data obtained from a player profile.</p>
<h2 id="geyser-extensions">Geyser extensions</h2>
<p>In this example, we will register a custom skull from a player profile. We will use the player profile from the example above.</p>
<p>First, create a class that implements Geyser’s Extension class:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">RegisterCustomSkull</span> <span class="kd">implements</span> <span class="nc">Extension</span> <span class="o">{</span>
<span class="c1">//...</span>
<span class="o">}</span>
</code></pre></div></div>
<p>Next, create a method to register your blocks in the <code class="language-plaintext highlighter-rouge">GeyserDefineCustomSkullsEvent</code>:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">RegisterCustomSkull</span> <span class="kd">implements</span> <span class="nc">Extension</span> <span class="o">{</span>
<span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onDefineCustomSkulls</span><span class="o">(</span><span class="nc">GeyserDefineCustomSkullsEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">//...</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
<p>Finally, register your skull in the event. Use the enum SkullTextureType to specify that the value being passed is a player profile:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">RegisterCustomSkull</span> <span class="kd">implements</span> <span class="nc">Extension</span> <span class="o">{</span>
<span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onDefineCustomSkulls</span><span class="o">(</span><span class="nc">GeyserDefineCustomSkullsEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="nc">String</span> <span class="n">profile</span> <span class="o">=</span> <span class="s">"ewogICJ0aW1lc3RhbXAiIDogMTY1NzMyMjIzOTgzMywKICAicHJvZmlsZUlkIiA6ICJjZGRiZTUyMGQwNDM0YThiYTFjYzlmYzkyZmRlMmJjZiIsCiAgInByb2ZpbGVOYW1lIiA6ICJkYXZjaG9vIiwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlL2E5MDc5MGM1N2UxODFlZDEzYWRlZDE0YzQ3ZWUyZjdjOGRlMzUzM2UwMTdiYTk1N2FmN2JkZjlkZjFiZGU5NGYiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ"</span>
<span class="n">event</span><span class="o">.</span><span class="na">registerCustomSkull</span><span class="o">(</span><span class="n">profile</span><span class="o">,</span> <span class="nc">SkullTextureType</span><span class="o">.</span><span class="na">PROFILE</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
<h2 id="scraping-custom-skulls-from-a-world">Scraping custom skulls from a world</h2>
<p>Custom skulls can be extracted from an existing world for easy implementation via mappings or API using the tool <a href="https://github.com/davchoo/HeadExtractor">HeadExtractor</a> made by Amberichu. See the linked repository for usage instructions.</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/custom-skulls.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/custom-skulls.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">
&copy; 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>
_site/geyser/events/index.html
+533
View File
@@ -0,0 +1,533 @@
<!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: Geyser Events</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: Geyser Events">
<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">Geyser Events</li>
</ol>
</nav>
<h1 id="geyser-events">Geyser Events</h1>
<p>Geyser 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.</p>
<p>Full documentation can be found <a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event">here</a>.</p>
<h2 id="event-categories">Event Categories</h2>
<p>To 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.
Extensions can use the @Subscribe annotation.</p>
<p>Events are categorized into the following categories:</p>
<ul>
<li><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event/bedrock">Bedrock</a>: Events that are sent for each connecting Bedrock client,
for 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.</li>
<li><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event/java">Java</a>: Events that are sent for the java server, for example
the ServerDefineCommandsEvent - it is fired when the Java sends the commands to show for Bedrock players.</li>
<li><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event/connection">Connection</a>: Connection-related events, such as a ping event to return e.g. a custom MOTD.</li>
<li><a href="https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle">Lifecycle</a>: Events that are sent during Geyser’s lifecycle, such as the loading of custom items, resource packs, or Geyser commands.</li>
</ul>
<p>To see all the events in the respective categories, click on the links above.</p>
<h2 id="usage-examples">Usage Examples:</h2>
<p>Each method that you want to subscribe to an event needs to be annotated with the @Subscribe annotation (from the GeyserMC events package).</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onGeyserLoadResourcePacksEvent</span><span class="o">(</span><span class="nc">GeyserLoadResourcePacksEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="n">logger</span><span class="o">().</span><span class="na">info</span><span class="o">(</span><span class="s">"Loading: "</span> <span class="o">+</span> <span class="n">event</span><span class="o">.</span><span class="na">resourcePacks</span><span class="o">().</span><span class="na">size</span><span class="o">()</span> <span class="o">+</span> <span class="s">" resource packs."</span><span class="o">);</span>
<span class="c1">// you could add a resource pack with event.resourcePacks().add(path-to-pack)</span>
<span class="o">}</span>
</code></pre></div></div>
<p>If 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 <code class="language-plaintext highlighter-rouge">EventRegistrar</code> in the main class of your mod or plugin.
Extensions do not need to do that - they are automatically registered, so a simple @Subscribe annotation is enough.</p>
<p><strong>Fabric mod example:</strong></p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">ExampleMod</span> <span class="kd">implements</span> <span class="nc">ModInitializer</span><span class="o">,</span> <span class="nc">EventRegistrar</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kd">final</span> <span class="nc">Logger</span> <span class="no">LOGGER</span> <span class="o">=</span> <span class="nc">LoggerFactory</span><span class="o">.</span><span class="na">getLogger</span><span class="o">(</span><span class="s">"modid"</span><span class="o">);</span>
<span class="nd">@Override</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onInitialize</span><span class="o">()</span> <span class="o">{</span>
<span class="nc">ServerLifecycleEvents</span><span class="o">.</span><span class="na">SERVER_STARTING</span><span class="o">.</span><span class="na">register</span><span class="o">((</span><span class="n">server</span><span class="o">)</span> <span class="o">-&gt;</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">eventBus</span><span class="o">().</span><span class="na">register</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nc">ExampleMod</span><span class="o">.</span><span class="na">class</span><span class="o">);</span> <span class="c1">// register your mod &amp; this class as a listener</span>
<span class="o">});</span>
<span class="no">LOGGER</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"Geyser is cool!"</span><span class="o">);</span>
<span class="o">}</span>
<span class="c1">// here an event, we subscribe as usual with the @Subscribe annotation</span>
<span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onGeyserPostInitializeEvent</span><span class="o">(</span><span class="nc">GeyserPostInitializeEvent</span> <span class="n">eventad</span> <span class="o">{</span>
<span class="no">LOGGER</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"Geyser started!"</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
<div class="alert alert-info" role="alert">
Do note: We cannot directly register the event bus in the mod initializer, since the Geyser API would not be loaded yet.
</div>
<p>Therefore, we register it in the server starting event provided by the Fabric API.</p>
<p><strong>Paper/Spigot plugin example:</strong></p>
<ol>
<li>In your plugin.yml, add the following lines:
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="na">depend</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">Geyser-Spigot"</span><span class="pi">]</span>
</code></pre></div> </div>
<p>This ensures that your plugin loads after Geyser has, so the Geyser API would be available.</p>
</li>
<li>In your main class, implement the EventRegistrar interface and register the event bus in the onEnable method:
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="nc">ExamplePlugin</span> <span class="kd">extends</span> <span class="nc">JavaPlugin</span> <span class="kd">implements</span> <span class="nc">EventRegistrar</span> <span class="o">{</span>
<span class="nd">@Override</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onEnable</span><span class="o">(){</span>
<span class="n">getLogger</span><span class="o">().</span><span class="na">info</span><span class="o">(</span><span class="s">"Registering Geyser event bus!"</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">eventBus</span><span class="o">().</span><span class="na">register</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="k">this</span><span class="o">);</span> <span class="c1">// register your plugin &amp; this class as a listener</span>
<span class="o">}</span>
<span class="c1">// here an event, we subscribe as usual with the @Subscribe annotation</span>
<span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onGeyserPostInitializeEvent</span><span class="o">(</span><span class="nc">GeyserPostInitializeEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="n">getLogger</span><span class="o">().</span><span class="na">info</span><span class="o">(</span><span class="s">"Geyser started!"</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div> </div>
</li>
<li>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:
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// replace GeyserEvent.class with the event class you want to listen to</span>
<span class="nc">GeyserApi</span><span class="o">.</span><span class="na">api</span><span class="o">().</span><span class="na">eventBus</span><span class="o">().</span><span class="na">subscribe</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nc">GeyserEvent</span><span class="o">.</span><span class="na">class</span><span class="o">,</span> <span class="k">this</span><span class="o">::</span><span class="n">yourMethod</span><span class="o">);</span>
</code></pre></div> </div>
</li>
</ol>
<h2 id="event-priority">Event Priority</h2>
<p>Events can have a priority, which is used to determine the order in which the listeners are called. The default priority is NORMAL.
To (optionally) set the priority of your event listener, you can add the priority to the <code class="language-plaintext highlighter-rouge">@Subscribe</code> annotation:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nd">@Subscribe</span><span class="o">(</span><span class="n">postOrder</span> <span class="o">=</span> <span class="nc">PostOrder</span><span class="o">.</span><span class="na">EARLY</span><span class="o">)</span>
</code></pre></div></div>
<p>If you do not specify a priority, the default priority is used. For all available priorities, see
<a href="https://github.com/GeyserMC/Events/blob/master/src/main/java/org/geysermc/event/PostOrder.java">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/events.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/events.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">
&copy; 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>
_site/geyser/extensions/index.html
+560
View File
@@ -0,0 +1,560 @@
<!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: Geyser Extensions</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: Geyser Extensions">
<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">Geyser Extensions</li>
</ol>
</nav>
<h2 id="geyser-extensions">Geyser Extensions</h2>
<p>Geyser 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.</p>
<h3 id="what-can-geyser-extensions-do">What can Geyser Extensions do?</h3>
<p>Extensions can fully utilize the Geyser API to add additional functionality to Geyser. See <a href="/geyser/api/">Geyser API docs</a> for info on what is currently possible. To name a few examples:</p>
<ul>
<li>Register custom items and blocks</li>
<li>Hide commands from being suggested</li>
<li>Change the MOTD</li>
<li>Register your own commands</li>
<li>Listen to events, e.g. the emote event.</li>
</ul>
<p>The underlying Geyser API is steadily expanding, creating more and more opportunities.</p>
<h3 id="which-geyser-extensions-exist">Which Geyser Extensions exist?</h3>
<p>At 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!
There is an <a href="https://github.com/GeyserMC/GeyserExtensionList">official list</a> 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!</p>
<h3 id="installing-extensions">Installing Extensions</h3>
<p>To install an extension, simply put the extension .jar file into Geyser’s ‘extensions’ folder. Then, restart Geyser (or the server Geyser runs on).</p>
<h3 id="creating-geyser-extensions">Creating Geyser Extensions</h3>
<p>The easiest way to create an extension would be utilizing <a href="https://github.com/GeyserMC/GeyserExampleExtension/">this official template</a>. Simply create a new repository from the template, customize the ‘extension.yml’ &amp; ‘settings.gradle’ files, and get started making the extension.</p>
<p>Geyser recognizes extensions when they have a file called ‘extension.yml’ in the jars ‘resources’ folder.</p>
<p>extension.yml:</p>
<div class="language-yml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">id</span><span class="pi">:</span> <span class="s">exampleid</span>
<span class="na">name</span><span class="pi">:</span> <span class="s">ExampleExtension</span>
<span class="na">main</span><span class="pi">:</span> <span class="s">org.geyser.extension.exampleid.ExampleExtension</span>
<span class="na">api</span><span class="pi">:</span> <span class="s">1.0.0</span>
<span class="na">version</span><span class="pi">:</span> <span class="s">1.0.0</span>
<span class="na">authors</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">ExampleAuthor</span><span class="pi">]</span>
</code></pre></div></div>
<p>Explanations for the individual fields:</p>
<ul>
<li>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’.</li>
<li>name: The name of the extension.</li>
<li>main: The main class of your extension.</li>
<li>api: The Base API version your extension targets.</li>
<li>authors: The author(s) of the extension. To add more than one entry, separate entries with a comma.</li>
</ul>
<h3 id="creating-the-main-class">Creating the main class</h3>
<p>The main class, the entrypoint for the extension, needs to <a href="https://github.com/GeyserMC/GeyserExampleExtension/blob/master/src/main/java/org/geyser/extension/exampleid/ExampleExtension.java#L12">implement the ‘Extension’ interface provided by Geyser</a>.
That way, Geyser recognizes the extension, and gives you access to important methods - such as ‘logger()’, to get your extensions logger. <br />
To see all the methods provided by that interface, see <a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/extension/Extension.java">here</a>.</p>
<p>Unlike 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.
Some important ones are:</p>
<ul>
<li><code class="language-plaintext highlighter-rouge">GeyserPreInitializeEvent</code>: This event is fired when Geyser starts to initialize. If you e.g. need to register extension commands that are configured in your config,
you would need to load the config here to ensure that your config is ready before the GeyserDefineCommandsEvent is fired.</li>
<li><code class="language-plaintext highlighter-rouge">GeyserPostInitializeEvent</code>: 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.</li>
<li><code class="language-plaintext highlighter-rouge">GeyserShutdownEvent</code>: Called when Geyser is shutting down. You can use this to e.g. save data, or clean up resources.</li>
</ul>
<p>See below for an example:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onPostInitialize</span><span class="o">(</span><span class="nc">GeyserPostInitializeEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// example: show that your extension is loading.</span>
<span class="k">this</span><span class="o">.</span><span class="na">logger</span><span class="o">().</span><span class="na">info</span><span class="o">(</span><span class="s">"Loading example extension..."</span><span class="o">);</span>
<span class="o">}</span>
</code></pre></div></div>
<p>If 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,
and register them in the event. You can find an example for custom items <a href="/geyser/custom-items/#geyser-extensions">here</a>. For other events, see <a href="/geyser/events">here</a> for documentation.</p>
<p>To build your extension, run the Gradle build task, and install the extension.</p>
<h3 id="creating-commands-with-geyser-extensions">Creating commands with Geyser Extensions</h3>
<p>To create a command, you would need to use the “Commands” package in the Geyser API. Brief rundown:</p>
<ul>
<li><a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/command/Command.java">Command.java</a>
This interface represents a command in Geyser - to make one, you can use the CommandBuilder. You can register it with the
<a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCommandsEvent.java">GeyserDefineCommandsEvent</a></li>
<li><a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/command/CommandExecutor.java">CommandExecutor.java</a>
This interface represents a command execute handler in Geyser, and extends the CommandSource interface.</li>
<li><a href="https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/command/CommandSource.java">CommandSource.java</a>
This 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.</li>
</ul>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">Command</span> <span class="n">command</span> <span class="o">=</span> <span class="nc">Command</span><span class="o">.</span><span class="na">builder</span><span class="o">(</span><span class="k">this</span><span class="o">)</span> <span class="c1">// "this" is the extension's main class</span>
<span class="o">.</span><span class="na">name</span><span class="o">(</span><span class="s">"ExampleCommand"</span><span class="o">)</span>
<span class="o">.</span><span class="na">bedrockOnly</span><span class="o">(</span><span class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">source</span><span class="o">(</span><span class="nc">CommandSource</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="o">.</span><span class="na">aliases</span><span class="o">(</span><span class="nc">List</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"example"</span><span class="o">,</span> <span class="s">"ex"</span><span class="o">))</span>
<span class="o">.</span><span class="na">description</span><span class="o">(</span><span class="s">"An example command"</span><span class="o">)</span>
<span class="o">.</span><span class="na">executableOnConsole</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span>
<span class="o">.</span><span class="na">suggestedOpOnly</span><span class="o">(</span><span class="kc">false</span><span class="o">)</span>
<span class="o">.</span><span class="na">permission</span><span class="o">(</span><span class="s">"example.command"</span><span class="o">)</span>
<span class="o">.</span><span class="na">executor</span><span class="o">((</span><span class="n">source</span><span class="o">,</span> <span class="n">cmd</span><span class="o">,</span> <span class="n">args</span><span class="o">)</span> <span class="o">-&gt;</span> <span class="o">{</span>
<span class="c1">// this is the command executor - this is where you would put your code to execute the command.</span>
<span class="c1">// source is the source that executed the command</span>
<span class="c1">// cmd is the command that was executed</span>
<span class="c1">// args are the arguments passed to the command</span>
<span class="n">source</span><span class="o">.</span><span class="na">sendMessage</span><span class="o">(</span><span class="s">"Hello World"</span><span class="o">);</span>
<span class="o">})</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</code></pre></div></div>
<p>To register the command, you would need to subscribe to the GeyserDefineCommandsEvent, and register the command there:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nd">@Subscribe</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">onDefineCommands</span><span class="o">(</span><span class="nc">GeyserDefineCommandsEvent</span> <span class="n">event</span><span class="o">)</span> <span class="o">{</span>
<span class="n">event</span><span class="o">.</span><span class="na">register</span><span class="o">(</span><span class="n">command</span><span class="o">);</span>
<span class="o">}</span>
</code></pre></div></div>
<p>If everything went right, you should be able to execute the command in-game by running “/extesionid [command]” - in our case, “/exampleid examplecommand”.
Here, it would send “Hello World” to the source that ran the command.
Since we also set aliases, you could also run “/exampleid example” or “/exampleid ex” for the same command.
To provide args, simple run “/exampleid examplecommand [args]” - replacing [args] with the arguments you want to pass to the command.</p>
<h3 id="listening-to-events">Listening to Events</h3>
<p>See <a href="/geyser/events">here</a> for documentation. You do not need to register the event listener, Geyser will do that for you.</p>
<hr />
<p>Facing troubles with extensions?</p>
<ul>
<li>Make sure you are using the latest version of Geyser - older versions might not have the latest API changes.</li>
<li>Add debug prints.</li>
<li>Ask in the #development channel in the <a href="https://discord.gg/geysermc">Geyser Discord server</a>.</li>
</ul>
</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/extensions.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/extensions.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">
&copy; 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>
_site/geyser/faq/index.html
+1187
View File
File diff suppressed because it is too large. Load diff
_site/geyser/fixing-unable-to-connect-to-world/index.html
+550
View File
@@ -0,0 +1,550 @@
<!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: Fixing 'Unable to Connect to World'</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: Fixing 'Unable to Connect to World'">
<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">Fixing 'Unable to Connect to World'</li>
</ol>
</nav>
<h1 id="fixing-unable-to-connect-to-world-errors">Fixing ‘Unable to Connect to World’ errors</h1>
<p>This is by far the most common error people get when attempting to set up Geyser. Here’s some steps on how to solve it.
Usually, this error is caused by improper configuration of Geyser, or issues with your network.</p>
<div class="alert alert-warning" role="alert">
If you are using a Minecraft server hosting provider (e.g. Aternos, or Apex Hosting), you should refer to the hosting provider setup instructions on
the <a href="/geyser/setup/">setup</a> page. Following these will most likely resolve the issue!
</div>
<p>If you are not using a Minecraft server hosting provider, carry on.</p>
<div class="alert alert-info" role="alert">
To check if your server is (theoretically) reachable on Bedrock edition, try running the following command in your server console:
<code>geyser connectiontest &lt;ip&gt;:&lt;port&gt;</code>, and see what it suggests to try.
</div>
<h3 id="java-edition-players-cant-connect">Java Edition players can’t connect!</h3>
<p>This <strong>should not be</strong> a Geyser problem. Geyser does not modify server behavior. Floodgate does modify the login structure, but only for Bedrock players.
Contact your hosting provider or look elsewhere for fixing this connection issue.</p>
<h3 id="connecting-fails-after-updating-geyser">Connecting fails after updating Geyser</h3>
<p>If 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.
Incase you reset your configuration file, check out the <a href="/geyser/setup/">setup guide</a> again.</p>
<h3 id="there-are-errors-in-my-console">There are errors in my console!</h3>
<p>Please read through the <a href="/geyser/common-issues/">common issues page</a>. If there is another error not documented there, join us on our <a href="https://discord.geysermc.org">Discord</a>.</p>
<h3 id="try-restarting-the-server-and-game">Try restarting the server and game</h3>
<p>Especially on mobile devices, sometimes just restarting Minecraft fixes the issue.</p>
<h3 id="is-it-the-server-or-the-client">Is it the server or the client?</h3>
<p>Run 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.
Additionally, check if you can see a connection attempt in the server console. If you can’t, it’s likely a network issue.</p>
<p>For console players specifically: If only they can’t join, while other Bedrock players can, it is likely an issue with their console connecting method.</p>
<h1 id="general-troubleshooting-steps">General troubleshooting steps</h1>
<h3 id="ensure-youre-connecting-on-the-right-ip-and-port">Ensure you’re connecting on the right IP and Port</h3>
<p>You 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.</p>
<h3 id="im-using-a-hosting-provider-or-vps">I’m using a hosting provider or VPS!</h3>
<p>Please read <a href="/geyser/supported-hosting-providers/">this page on supported hosting providers</a> to see if there are extra configuration steps required for your hosting or server provider.
Some VPS/KVM providers may require further setup, such as OVH, SoYouStart, and Oracle Cloud. Please read this <a href="/geyser/port-forwarding/#issues-with-specific-vpskvm-providers">note</a> for more information.</p>
<h3 id="issues-using-docker-or-pterodactyl">Issues using Docker or Pterodactyl</h3>
<p>Make sure you assign the port to pterodactyl, and on docker, to the docker compose file. See our <a href="/geyser/port-forwarding/#using-docker-or-pterodactyl">port-forwarding</a> page for fixes.</p>
<h1 id="port-forwarding-issues">Port forwarding issues</h1>
<p>Your server does need to be port forwarded to allow connections from outside the local network. See <a href="/geyser/port-forwarding/">our port-forwarding guide</a> for more information.</p>
<h3 id="using-tcp-in-dns-optionsport-forwarding-instead-of-udp">Using TCP in DNS options/port forwarding instead of UDP</h3>
<p>Minecraft: 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 <code class="language-plaintext highlighter-rouge">TCP/UDP</code> (both protocols) should also work but is not recommended unless Java Edition and Bedrock Edition is sharing the same port.</p>
<h3 id="bedrock-port-is-less-than-10000">Bedrock port is less than 10000</h3>
<p>Historically, having a Bedrock port that is a lower number will cause issues. Setting it to 10000 or above seems safe.</p>
<h3 id="bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server-or-only-people-who-also-play-on-java-edition-can-join-from-geyser">Bedrock players can connect <em>after</em> 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</h3>
<p>This is likely a firewall issue on your server. Try the following workaround:
Attempt to connect to the Bedrock IP and port through a web browser - for example, <code class="language-plaintext highlighter-rouge">http://test.geysermc.org:19132</code>. It won’t work, but then try connecting through Bedrock, and it should work.</p>
<p>Specific host fixes for OVH/SoYouStart can be found <a href="/geyser/port-forwarding/#issues-with-specific-vpskvm-providers">here</a>.</p>
<h3 id="changing-the-bedrock-address-in-the-geyser-config">Changing the <code class="language-plaintext highlighter-rouge">bedrock</code> <code class="language-plaintext highlighter-rouge">address</code> in the Geyser config.</h3>
<p>Except for a few specific hosting providers, you generally do not need to change this part of the Geyser config.
However, in rare instances, it does fix issues - for example, when Windows has multiple network adapters (check by running <code class="language-plaintext highlighter-rouge">ipconfig</code> in cmd),
it can help to set the <code class="language-plaintext highlighter-rouge">address</code> to the local IP of the adapter you want to use.</p>
<h1 id="using-a-hosting-provider-or-other-location">Using a hosting provider or other location</h1>
<h3 id="pterodactyl">Pterodactyl</h3>
<p>If you get this error while using the Pterodactyl Panel, try editing the Geyser config and changing the port to something besides <code class="language-plaintext highlighter-rouge">19132</code> (e.g. <code class="language-plaintext highlighter-rouge">25566</code>).</p>
<h1 id="hosting-geyser-on-another-computer-on-the-same-network">Hosting Geyser on another computer on the same network</h1>
<h3 id="can-only-connect-from-the-same-computer-and-not-anywhere-else">Can only connect from the same computer and not anywhere else</h3>
<p>Your firewall is likely in the way. Try adding an exception to Java, or disable the firewall for testing purposes.</p>
<h1 id="as-a-last-resort-for-troubleshooting">As a last resort for troubleshooting…</h1>
<p>Minecraft offers a vanilla Bedrock server <a href="https://www.minecraft.net/download/server/bedrock">here</a>. 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.</p>
<h1 id="using-geyser-on-the-same-computer">Using Geyser on the same computer</h1>
<h3 id="windows-1011">Windows 10/11</h3>
<p><em>This only affects people trying to join Geyser from Windows 10/11 Edition with Geyser hosted on the same computer.</em></p>
<p>This 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 <code class="language-plaintext highlighter-rouge">OK.</code> if it worked)</p>
<div class="language-powershell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">CheckNetIsolation</span><span class="w"> </span><span class="nx">LoopbackExempt</span><span class="w"> </span><span class="nt">-a</span><span class="w"> </span><span class="nt">-n</span><span class="o">=</span><span class="s2">"Microsoft.MinecraftUWP_8wekyb3d8bbwe"</span><span class="w">
</span></code></pre></div></div>
<p>Should this not work, you can try this set of steps:</p>
<ol>
<li>Hold down Windows Key + R</li>
<li>In the prompt, type <code class="language-plaintext highlighter-rouge">hdwwiz.exe</code>, then press Enter then Next</li>
<li>Install the Hardware Manually</li>
<li>Choose Network Adapter &gt; Next &gt; Microsoft &gt; “Microsoft KM-TEST Loopback Adapter” then hit Next until it’s done.</li>
</ol>
</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/fixing-unable-to-connect-to-world.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/fixing-unable-to-connect-to-world.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">
&copy; 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>
_site/geyser/forms/index.html
+570
View File
@@ -0,0 +1,570 @@
<!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: Forms and Cumulus</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: Forms and Cumulus">
<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">Forms and Cumulus</li>
</ol>
</nav>
<h1 id="what-is-cumulus">What is Cumulus?</h1>
<p>Bedrock Edition has a cool exclusive feature called Forms.<br />
Cumulus is the Forms API that we use in Geyser and Floodgate.<br />
The source code is available <a href="https://github.com/GeyserMC/Cumulus">here</a>. You can access the Cumulus API through the <a href="/floodgate/api/">Floodgate API</a>, or the <a href="/geyser/api">Geyser API</a>.</p>
<p>Bedrock knows three types of Forms:</p>
<ul>
<li>ModalForm</li>
<li>SimpleForm</li>
<li>CustomForm</li>
</ul>
<p>We’ll discuss them one by one starting with the easiest and ending with the least easy form type.<br />
After that, you get an overview of every single component.<br />
Then we’ll talk about sending the form, receiving a response and doing advanced stuff.<br /></p>
<h2 id="modalform">ModalForm</h2>
<p>While this is the easiest form type it’s also the least customisable.<br />
You have a title, description (content) and two buttons.</p>
<p><img src="https://i.imgur.com/kMpMgOh.png" alt="Example of a ModalForm" /></p>
<p>Code used in the image:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">ModalForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"Title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">content</span><span class="o">(</span><span class="s">"Content"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button1</span><span class="o">(</span><span class="s">"Button 1"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button2</span><span class="o">(</span><span class="s">"Button 2"</span><span class="o">)</span>
</code></pre></div></div>
<h2 id="simpleform">SimpleForm</h2>
<p>While this one is less easy than ModalForm is, it also has more customizability.<br />
It’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.</p>
<p><img src="https://i.imgur.com/3rj2OQ2.png" alt="Example of a SimpleForm" /></p>
<p>Code used in the image:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">SimpleForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"Title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">content</span><span class="o">(</span><span class="s">"Content"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button</span><span class="o">(</span><span class="s">"Button without an image"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button</span><span class="o">(</span><span class="s">"Button with URL image"</span><span class="o">,</span> <span class="nc">FormImage</span><span class="o">.</span><span class="na">Type</span><span class="o">.</span><span class="na">URL</span><span class="o">,</span> <span class="s">"https://github.com/GeyserMC.png?size=200"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button</span><span class="o">(</span><span class="s">"Button with path image"</span><span class="o">,</span> <span class="nc">FormImage</span><span class="o">.</span><span class="na">Type</span><span class="o">.</span><span class="na">PATH</span><span class="o">,</span> <span class="s">"textures/i/glyph_world_template.png"</span><span class="o">)</span>
</code></pre></div></div>
<h2 id="customform">CustomForm</h2>
<p>While the CustomForm is the last one on our list (and thus the least easy one), it also has the greatest customizability.<br />
This form exists of a title, content and a list of different components e.g. label, slider and input.<br />
See <a href="https://github.com/GeyserMC/Cumulus/tree/master/src/main/java/org/geysermc/cumulus/component">Components</a> for more information about every component you can use and in which form type.</p>
<p><img src="https://i.imgur.com/zHgxELm.png" alt="Example of a CustomForm" /></p>
<p>Code used in the image:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">CustomForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"Title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">dropdown</span><span class="o">(</span><span class="s">"Text"</span><span class="o">,</span> <span class="s">"Option 1"</span><span class="o">,</span> <span class="s">"Option 2"</span><span class="o">)</span>
<span class="o">.</span><span class="na">input</span><span class="o">(</span><span class="s">"Input"</span><span class="o">,</span> <span class="s">"placeholder"</span><span class="o">)</span>
<span class="o">.</span><span class="na">toggle</span><span class="o">(</span><span class="s">"Toggle"</span><span class="o">)</span>
<span class="o">.</span><span class="na">slider</span><span class="o">(</span><span class="s">"Text"</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="mi">10</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="mi">5</span><span class="o">)</span>
</code></pre></div></div>
<h2 id="sending-a-form">Sending a form</h2>
<p>After 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.<br />
You can do that by calling the API and send a form to the player’s UUID and the form:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">FloodgateApi</span><span class="o">.</span><span class="na">getInstance</span><span class="o">().</span><span class="na">sendForm</span><span class="o">(</span><span class="n">uuid</span><span class="o">,</span> <span class="n">form</span><span class="o">);</span> <span class="c1">// or #sendForm(uuid, formBuilder)</span>
</code></pre></div></div>
<p>Or you can do it by using the Player’s FloodgatePlayer instance:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">FloodgatePlayer</span> <span class="n">player</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="na">getPlayer</span><span class="o">(</span><span class="n">uuid</span><span class="o">);</span>
<span class="n">player</span><span class="o">.</span><span class="na">sendForm</span><span class="o">(</span><span class="n">form</span><span class="o">);</span> <span class="c1">// or #sendForm(formBuilder)</span>
</code></pre></div></div>
<p>So you can make and send forms in a pretty compact way by doing something like this:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">FloodgatePlayer</span> <span class="n">player</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="na">getPlayer</span><span class="o">(</span><span class="n">uuid</span><span class="o">);</span>
<span class="o">...</span>
<span class="n">player</span><span class="o">.</span><span class="na">sendForm</span><span class="o">(</span>
<span class="nc">CustomForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"My cool title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">label</span><span class="o">(</span><span class="s">"10/10 content"</span><span class="o">)</span>
<span class="o">);</span>
</code></pre></div></div>
<h2 id="receiving-a-response-from-the-client">Receiving a response from the client</h2>
<p>It’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.<br />
We can do that using one (or multiple) result handers. The most used result handlers are: <code class="language-plaintext highlighter-rouge">validResultHandler(BiConsumer&lt;Form, ValidFormResponseResult&gt; | Consumer&lt;ValidFormResponseResult&gt;)</code>, <code class="language-plaintext highlighter-rouge">invalidResultHandler</code>, <code class="language-plaintext highlighter-rouge">closedResultHandler</code> and <code class="language-plaintext highlighter-rouge">closedOrInvalidResultHandler</code>.<br />
Here follows an example that uses result handlers:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">CustomForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"geyser.auth.login.form.details.title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">label</span><span class="o">(</span><span class="s">"geyser.auth.login.form.details.desc"</span><span class="o">)</span>
<span class="o">.</span><span class="na">input</span><span class="o">(</span><span class="s">"geyser.auth.login.form.details.email"</span><span class="o">,</span> <span class="s">"account@geysermc.org"</span><span class="o">,</span> <span class="s">""</span><span class="o">)</span>
<span class="o">.</span><span class="na">input</span><span class="o">(</span><span class="s">"geyser.auth.login.form.details.pass"</span><span class="o">,</span> <span class="s">"123456"</span><span class="o">,</span> <span class="s">""</span><span class="o">)</span>
<span class="o">.</span><span class="na">closedOrInvalidResultHandler</span><span class="o">(()</span> <span class="o">-&gt;</span> <span class="n">buildAndShowLoginDetailsWindow</span><span class="o">(</span><span class="n">session</span><span class="o">))</span>
<span class="o">.</span><span class="na">validResultHandler</span><span class="o">(</span><span class="n">response</span> <span class="o">-&gt;</span> <span class="n">session</span><span class="o">.</span><span class="na">authenticate</span><span class="o">(</span><span class="n">response</span><span class="o">.</span><span class="na">next</span><span class="o">(),</span> <span class="n">response</span><span class="o">.</span><span class="na">next</span><span class="o">())));</span>
</code></pre></div></div>
<h2 id="advanced-stuff">Advanced stuff</h2>
<p>The FormBuilder also has support for translating the data used in the builder.<br />
To add a translator, you can use the <code class="language-plaintext highlighter-rouge">translator(BiFunction&lt;String, String, String&gt;)</code> or the <code class="language-plaintext highlighter-rouge">translator(BiFunction&lt;String, String, String&gt;, String)</code> method:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">ModalForm</span> <span class="n">form</span> <span class="o">=</span> <span class="nc">ModalForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">translator</span><span class="o">(</span><span class="k">this</span><span class="o">::</span><span class="n">translate</span><span class="o">,</span> <span class="n">userLanguage</span><span class="o">)</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"Title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">content</span><span class="o">(</span><span class="s">"Content"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button1</span><span class="o">(</span><span class="s">"translate.button1"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button2</span><span class="o">(</span><span class="s">"translate.button2"</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
<span class="kd">public</span> <span class="nc">String</span> <span class="nf">translate</span><span class="o">(</span><span class="nc">String</span> <span class="n">key</span><span class="o">,</span> <span class="nc">String</span> <span class="n">locale</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// this method will be called for every string, in this case, 4 times:</span>
<span class="c1">// Title, Content, translate.button1, translate.button2</span>
<span class="c1">// your own translate logic here</span>
<span class="c1">// return the value that replaces the key</span>
<span class="o">}</span>
</code></pre></div></div>
<p>Or you can have the translate method directly in the FormBuilder instead of a separate method:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">ModalForm</span> <span class="n">form</span> <span class="o">=</span> <span class="nc">ModalForm</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
<span class="o">.</span><span class="na">translator</span><span class="o">((</span><span class="n">key</span><span class="o">,</span> <span class="n">unused</span><span class="o">)</span> <span class="o">-&gt;</span> <span class="o">{</span>
<span class="c1">// this method will be called for every string, in this case, 4 times:</span>
<span class="c1">// Title, Content, translate.button1, translate.button2</span>
<span class="c1">// since this isn't a separate method, you don't need the locale argument, so it's unused.</span>
<span class="c1">// your own translate logic here</span>
<span class="c1">// return the value that replaces the key</span>
<span class="o">})</span>
<span class="o">.</span><span class="na">title</span><span class="o">(</span><span class="s">"Title"</span><span class="o">)</span>
<span class="o">.</span><span class="na">content</span><span class="o">(</span><span class="s">"Content"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button1</span><span class="o">(</span><span class="s">"translate.button1"</span><span class="o">)</span>
<span class="o">.</span><span class="na">button2</span><span class="o">(</span><span class="s">"translate.button2"</span><span class="o">)</span>
<span class="o">.</span><span class="na">build</span><span class="o">();</span>
</code></pre></div></div>
</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/forms.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/forms.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">
&copy; 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>
_site/geyser/getting-started-with-the-api/index.html
+509
View File
@@ -0,0 +1,509 @@
<!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">&lt;repository&gt;</span>
<span class="nt">&lt;id&gt;</span>opencollab-snapshot<span class="nt">&lt;/id&gt;</span>
<span class="nt">&lt;url&gt;</span>https://repo.opencollab.dev/main/<span class="nt">&lt;/url&gt;</span>
<span class="nt">&lt;/repository&gt;</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">&lt;dependency&gt;</span>
<span class="nt">&lt;groupId&gt;</span>org.geysermc.geyser<span class="nt">&lt;/groupId&gt;</span>
<span class="nt">&lt;artifactId&gt;</span>api<span class="nt">&lt;/artifactId&gt;</span>
<span class="nt">&lt;version&gt;</span>2.2.0-SNAPSHOT<span class="nt">&lt;/version&gt;</span>
<span class="nt">&lt;scope&gt;</span>provided<span class="nt">&lt;/scope&gt;</span>
<span class="nt">&lt;/dependency&gt;</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">&lt;dependency&gt;</span>
<span class="nt">&lt;groupId&gt;</span>org.geysermc.floodgate<span class="nt">&lt;/groupId&gt;</span>
<span class="nt">&lt;artifactId&gt;</span>api<span class="nt">&lt;/artifactId&gt;</span>
<span class="nt">&lt;version&gt;</span>2.2.2-SNAPSHOT<span class="nt">&lt;/version&gt;</span>
<span class="nt">&lt;scope&gt;</span>provided<span class="nt">&lt;/scope&gt;</span>
<span class="nt">&lt;/dependency&gt;</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">
&copy; 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>
_site/geyser/geyser-command-line-arguments-and-system-properties/index.html
+534
View File
@@ -0,0 +1,534 @@
<!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: Geyser Command Line Arguments and System Properties</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: Geyser Command Line Arguments and System Properties">
<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">Geyser Command Line Arguments and System Properties</li>
</ol>
</nav>
<h1 id="geyser-command-line-arguments-and-system-properties">Geyser Command Line Arguments and System Properties</h1>
<p>Geyser offers a few command line arguments/system properties to allow you to configure Geyser without editing the config files.
Additionally, you can suppress some warnings that may be printed to the console.</p>
<h3 id="configuration-system-properties">Configuration system properties</h3>
<p>You can set Geyser to automatically bind to a specific address and port by using the following command line arguments. <br />
This is primarily aimed at server hosting providers to automatically configure servers for users.</p>
<div class="alert alert-info" role="alert">
Note: the Geyser specific properties are prioritized over the plugin properties!
</div>
<ul>
<li><code class="language-plaintext highlighter-rouge">-DgeyserUdpPort=server</code> or <code class="language-plaintext highlighter-rouge">-DpluginUdpPort=server</code>
<ul>
<li><code class="language-plaintext highlighter-rouge">-1</code> means UDP is not supported and will forcibly stop Geyser.</li>
<li><code class="language-plaintext highlighter-rouge">server</code> means to match the port of the TCP server.</li>
<li>any other number means to use that specific port</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DgeyserUdpAddress=server</code> or <code class="language-plaintext highlighter-rouge">-DpluginUdpAddress=server</code>
<ul>
<li><code class="language-plaintext highlighter-rouge">server</code> means to match the bind address of the TCP server</li>
<li>any other string will be used as-is for the bind address.</li>
</ul>
</li>
</ul>
<h3 id="disabling-warnings-and-advanced-configuration">Disabling warnings and advanced configuration</h3>
<p>You may disable some warnings that may be printed to the console by using the following command line arguments:</p>
<div class="alert alert-danger" role="alert">
Warning: Disabling Geyser warnings from being logged will not fix the real issue! Only disable them if you know what you are doing.
</div>
<ul>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.PrintSecureChatInformation=true</code>
<ul>
<li>Allows you to disable the warning about secure chat being disabled.
Since the warning is sent when the server sends the warning, this option does not do much anymore.</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.ShowScoreboardLogs=true</code>
<ul>
<li>Allows you to disable warnings related to scoreboards, such as “Tried to update score without the existence of its requested objective”.</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.ShowResourcePackLengthWarning=true</code>
<ul>
<li>Allows you to disable the warning about a resource pack having too long paths. Disabling this warning will not fix the underlying issue!
Console players might not be able to join your server at all if you have a resource pack with paths exceeding the 80 character limit.</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.PrintPingsInDebugMode=true</code>
<ul>
<li>Controls if pings are being logged in debug mode.</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.UseDirectAdapters=true</code>
<ul>
<li>Allows you to disable the usage of NMS adapters. Disabling will result in a performance penalty and should only be used for debugging.
This is Spigot-only and will not work on other platforms.</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.BedrockNetworkThreads=8</code>
<ul>
<li>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.</li>
</ul>
</li>
<li><code class="language-plaintext highlighter-rouge">-DGeyser.AddTeamSuggestions=true</code>
<ul>
<li>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.
Setting “command-suggestions” to false in the config will also disable this.</li>
</ul>
</li>
</ul>
<h2 id="geyser-standalone-specific-options">Geyser-Standalone specific options:</h2>
<h4 id="--config-file"><code class="language-plaintext highlighter-rouge">--config [file]</code></h4>
<ul>
<li><strong>Alias: <code class="language-plaintext highlighter-rouge">-c</code></strong></li>
<li>Points to an alternative config file to use.</li>
</ul>
<h4 id="--gui----nogui"><code class="language-plaintext highlighter-rouge">--gui</code> / <code class="language-plaintext highlighter-rouge">--nogui</code></h4>
<ul>
<li><strong>Alias: <code class="language-plaintext highlighter-rouge">gui</code> / <code class="language-plaintext highlighter-rouge">nogui</code></strong>:</li>
<li>Forces GUI or non-GUI usage, depending on context.</li>
</ul>
<h3 id="overriding-specific-config-values">Overriding specific config values</h3>
<p>Overriding a standard config option (e.g. <code class="language-plaintext highlighter-rouge">command-suggestions</code>):</p>
<p><code class="language-plaintext highlighter-rouge">--command-suggestions=false</code></p>
<p>Overriding a nested config option(e.g. the <code class="language-plaintext highlighter-rouge">remote</code> section with <code class="language-plaintext highlighter-rouge">address</code>):</p>
<p><code class="language-plaintext highlighter-rouge">--remote.address=test.geysermc.org</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/geyser/geyser-command-line-arguments-and-system-properties.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/geyser-command-line-arguments-and-system-properties.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">
&copy; 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>
_site/geyser/global-api/index.html
+460
View File
@@ -0,0 +1,460 @@
<!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: Global 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: Global 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">Global API</li>
</ol>
</nav>
<h3 id="geyser-global-api">Geyser Global API</h3>
<p>The Global API is available for every server. It currently includes: <a href="/floodgate/linking/#what-is-global-linking">Global Linking</a>, <a href="/floodgate/features/#what-is-skin-uploading">skin uploading</a>, getting a xuid by gamertag, and getting a gamertag by xuid.
We 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 <a href="https://github.com/GeyserMC/global_api">here</a> and the source code of the Global Linking server is available <a href="https://github.com/GeyserMC/GlobalLinkServer">here</a>.</p>
<p>As 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:</p>
<ul>
<li>Conversion methods from a Bedrock gamertag to Bedrock xuid, and vice-versa. Only provides info for players who are in Geyser’s cache. <br />
If 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.</li>
<li>Skin info: Whenever a Bedrock player joins via Floodgate, their skin gets converted &amp; 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.</li>
</ul>
<p>See the <a href="https://api.geysermc.org/docs">Global API docs</a> for more info, and detailed usage.</p>
<h3 id="examples">Examples</h3>
<p>Here are a few examples of how you could use the Global API. <br /></p>
<p><a href="https://github.com/GeyserMC/GeyserDiscordBot/blob/master/src/main/java/org/geysermc/discordbot/commands/FloodgateUuidCommand.java">GeyserDiscordBot</a></p>
<ul>
<li>GeyserMC’s discord bot has a /uuid command to get a floodgate uuid from a bedrock username. <br /></li>
</ul>
<p><a href="https://github.com/onebeastchris/customplayerheads/blob/master/src/main/java/net/onebeastofchris/customplayerheads/utils/PlayerUtils.java#L54-L72">CustomPlayerHeads</a></p>
<ul>
<li>A fabric mod that uses the Global API to get a Bedrock player’s skin, and then uses that to create a player head.</li>
</ul>
</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/global-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/global-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">
&copy; 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>
_site/geyser/index.html
+440
View File
@@ -0,0 +1,440 @@
<!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: Geyser</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: Geyser">
<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 active" aria-current="page">Geyser</li>
</ol>
</nav>
<h1 id="geyser">Geyser</h1>
<p><a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?label=License" alt="License: MIT" /></a>
<a href="https://github.com/GeyserMC/Geyser/actions/workflows/build.yml"><img src="https://github.com/GeyserMC/Geyser/actions/workflows/build.yml/badge.svg" alt="Build Status" /></a>
<a href="https://discord.geysermc.org"><img src="https://img.shields.io/discord/613163671870242838?color=cornflowerblue&amp;label=Discord&amp;logo=Discord&amp;logoColor=white" alt="Discord" /></a></p>
<p><em>A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition.</em></p>
<p><strong>Currently, supporting Minecraft Bedrock 1.20.0-1.20.40 and Minecraft Java 1.20.2</strong></p>
<p>The 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.</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/root.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/root.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">
&copy; 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>
_site/geyser/playit-gg/index.html
+469
View File
@@ -0,0 +1,469 @@
<!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: playit.gg Setup</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: playit.gg Setup">
<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">playit.gg Setup</li>
</ol>
</nav>
<h2 id="prerequisites">Prerequisites</h2>
<div class="alert alert-info" role="alert">
You must be able to connect to your Geyser instance locally!
</div>
<ul>
<li>If you already have playit.gg running &amp; set up (for e.g. Minecraft Java edition), skip steps 1 and 2 and proceed with step 3.</li>
</ul>
<h2 id="setup">Setup</h2>
<ol>
<li>Head over to <a href="https://playit.gg/">playit.gg’s website</a> - download the program &amp; run it. It will open the login site in the browser - create an account &amp; sign in. Or, use a guest account.</li>
<li>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.
<img src="/img/wiki/playit-gg/running.png" alt="img" /></li>
<li>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”.
<img src="/img/wiki/playit-gg/add_tunnel.png" alt="img" /></li>
<li>Once “Add tunnel” is clicked, it should create a new tunnel, and you are set! Scroll down until you see this:
<img src="/img/wiki/playit-gg/added_tunnel.png" alt="img" />
If 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.</li>
<li>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.</li>
<li>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.
(If you failed to join, check out the <a href="#troubleshooting">troubleshooting</a> section of the page.)</li>
</ol>
<h2 id="troubleshooting">Troubleshooting</h2>
<h3 id="i-cant-connect-to-my-server">I can’t connect to my server!</h3>
<ul>
<li><em>Are there errors in your minecraft server console?</em></li>
<li><em>Make sure to check <a href="/geyser/fixing-unable-to-connect-to-world/">here</a> beforehand.</em></li>
<li><em>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.</em></li>
<li><em>(Alternatively: You can try setting the</em> <code class="language-plaintext highlighter-rouge">bedrock</code> <code class="language-plaintext highlighter-rouge">port</code> <em>in the Geyser configuration to</em> <code class="language-plaintext highlighter-rouge">19132</code>.)</li>
</ul>
</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/playit-gg.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/playit-gg.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">
&copy; 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>
_site/geyser/port-forwarding/index.html
+584
View File
@@ -0,0 +1,584 @@
<!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: Port forwarding</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: Port forwarding">
<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">Port forwarding</li>
</ol>
</nav>
<h1 id="port-forwarding">Port forwarding</h1>
<p>This page contains information on how to set up port forwarding required for Geyser to work when self-hosting.
There are also guides for specific configurations, such as Docker/Pterodactyl, or on specific VPS/KVM providers, such as OVH or Oracle Cloud.</p>
<div class="alert alert-warning" role="alert">
If you are using a Minecraft server hosting provider (e.g. Aternos, or Apex Hosting), you should refer to the hosting provider setup on the <a href="/geyser/setup/">setup</a> page instead.
</div>
<h2 id="port-forwarding-on-linuxwindowsmacos">Port forwarding on Linux/Windows/macOS</h2>
<p>To allow others to play on your server, you will need to set up port forwarding on the device hosting Geyser.
Additionally, 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.
See <a href="https://www.howtogeek.com/66214/how-to-forward-ports-on-your-router/">here</a> or <a href="https://www.lifewire.com/how-to-port-forward-4163829">here</a> for helpful guides.
Do note: if you do not have a static IP address, your IP address may change over time.</p>
<div class="alert alert-info" role="alert">
Some 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).
Other ISPs may require you to pay extra for a static IP address. <br />
As an alternative to port forwarding, you can use <a href="/geyser/playit-gg/">playit.gg</a> to create a tunnel.
</div>
<h3 id="windows">Windows</h3>
<p>To open a port on Windows, you will need to open the port through the Windows Firewall. There are multiple ways to do this:</p>
<ul>
<li>
<p><code class="language-plaintext highlighter-rouge">Powershell</code> (recommended)</p>
<p>To open a port on UDP (in our example, port 19132), run the following command in an administrator Powershell:</p>
<div class="language-powershell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">New-NetFirewallRule</span><span class="w"> </span><span class="nt">-DisplayName</span><span class="w"> </span><span class="s2">"Geyser"</span><span class="w"> </span><span class="nt">-Direction</span><span class="w"> </span><span class="nx">Inbound</span><span class="w"> </span><span class="nt">-Protocol</span><span class="w"> </span><span class="nx">UDP</span><span class="w"> </span><span class="nt">-LocalPort</span><span class="w"> </span><span class="nx">19132</span><span class="w"> </span><span class="nt">-Action</span><span class="w"> </span><span class="nx">Allow</span><span class="w">
</span></code></pre></div> </div>
<p>Running this command creates a rule named “Geyser” that allows UDP traffic on port 19132.</p>
</li>
<li>
<p>Windows Defender Firewall with Advanced Security (GUI)</p>
<ol>
<li>Search for “Windows Defender Firewall with Advanced Security” in the start menu, and open it. (<a href="/img/wiki/port-forwarding/windows-1.png">Image</a>)</li>
<li>Click on “Inbound Rules” in the left sidebar. (<a href="/img/wiki/port-forwarding/windows-2.png">Image</a>)</li>
<li>Click on “New Rule…” in the right sidebar. (<a href="/img/wiki/port-forwarding/windows-2.png">Image</a>)</li>
<li>Select “Port” as the rule type and click “Next”. (<a href="/img/wiki/port-forwarding/windows-3.png">Example</a>)</li>
<li>Select “UDP” and “Specific local ports”, and enter the port you want to open (in our example, 19132). Click “Next”. (<a href="/img/wiki/port-forwarding/windows-4.png">Example</a>)</li>
<li>Select “Allow the connection” and click “Next”. (<a href="/img/wiki/port-forwarding/windows-5.png">Example</a>)</li>
<li>Select the profiles you want to apply the rule to (e.g. “Domain”, “Private”, “Public”), and click “Next”. (<a href="/img/wiki/port-forwarding/windows-6.png">Example</a>)</li>
<li>Enter a name for the rule (e.g. “Geyser”), and click “Finish”. (<a href="/img/wiki/port-forwarding/windows-7.png">Image</a>)</li>
</ol>
</li>
</ul>
<h3 id="linux">Linux</h3>
<p>Different Linux distributions, even different VPS providers ship and configure different firewalls. In the following examples, we will use <code class="language-plaintext highlighter-rouge">19132</code> as the port to open, but you should replace this with the port you are using for Geyser.</p>
<ul>
<li><code class="language-plaintext highlighter-rouge">ufw</code> 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:
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>ufw allow 19132/udp
</code></pre></div> </div>
<p>Then, reload the firewall with <code class="language-plaintext highlighter-rouge">sudo ufw reload</code>, and see all open rules with <code class="language-plaintext highlighter-rouge">sudo ufw status</code>. <br />
Further helpful guides: <a href="https://www.digitalocean.com/community/tutorials/how-to-setup-a-firewall-with-ufw-on-an-ubuntu-and-debian-cloud-server">DigitalOcean</a>, <a href="https://www.baeldung.com/linux/uncomplicated-firewall">Baeldung</a></p>
</li>
<li><code class="language-plaintext highlighter-rouge">firewalld</code> Add a port on UDP by running:
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>firewall-cmd <span class="nt">--zone</span><span class="o">=</span>public <span class="nt">--permanent</span> <span class="nt">--add-port</span><span class="o">=</span>19132/udp
</code></pre></div> </div>
<p>Then, reload the firewall with <code class="language-plaintext highlighter-rouge">sudo firewall-cmd --reload</code>, and see all open rules with <code class="language-plaintext highlighter-rouge">sudo firewall-cmd --list-all</code>. <br />
Further helpful guides: <a href="https://www.digitalocean.com/community/tutorials/how-to-set-up-a-firewall-using-firewalld-on-centos-7">DigitalOcean</a></p>
</li>
<li><code class="language-plaintext highlighter-rouge">iptables</code> is a common firewall that is used on many Linux distributions. To open a port on UDP, run the following command:
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>iptables <span class="nt">-A</span> INPUT <span class="nt">-p</span> udp <span class="nt">--dport</span> 19132 <span class="nt">-j</span> ACCEPT
</code></pre></div> </div>
<p>Then, save the firewall with <code class="language-plaintext highlighter-rouge">sudo iptables-save</code>, and see all open rules with <code class="language-plaintext highlighter-rouge">sudo iptables -L</code>. <br />
Further helpful guides for iptables: <a href="https://www.digitalocean.com/community/tutorials/how-to-set-up-a-firewall-using-iptables-on-ubuntu-14-04">DigitalOcean</a>, <a href="https://help.ubuntu.com/community/IptablesHowTo">Ubuntu</a></p>
</li>
</ul>
<h3 id="macos">macOS</h3>
<p>You will need to disable <code class="language-plaintext highlighter-rouge">Block all incoming connections</code> in your Firewall settings, as that will block any connections and won’t allow you to make exceptions.
To allow incoming connections, click <code class="language-plaintext highlighter-rouge">Allow</code> when getting <a href="/img/wiki/port-forwarding/macos_warning.png">these prompts</a>.
If you are still facing issues, see Apple’s official guide <a href="https://support.apple.com/guide/mac-help/MH11783">here</a> to open a port on macOS.</p>
<h2 id="using-docker-or-pterodactyl">Using Docker or Pterodactyl</h2>
<p>In 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.</p>
<h3 id="pterodactyl">Pterodactyl</h3>
<p>Make sure to allocate the port to the server in the Pterodactyl panel’s <code class="language-plaintext highlighter-rouge">Network</code> tab, additionally to port forwarding the port.
See <a href="https://pterodactyl.io/community/games/minecraft.html#allocations-in-the-panel">here</a> for more information.</p>
<p><img src="/img/wiki/port-forwarding/pterodactyl-1.png" alt="Pterodactyl panel, Network section" /></p>
<p>There are also different Geyser eggs for Pterodactyl, which can be found <a href="https://github.com/GeyserMC/pterodactyl-stuff">here</a>.</p>
<div class="alert alert-warning" role="alert">
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.
</div>
<h3 id="docker">Docker</h3>
<p>For Geyser to work under Docker (e.g. using <a href="https://github.com/itzg/docker-minecraft-server">Itzg’s Docker image</a>), you will need to add the Geyser port on UDP to the docker-compose file. This is done by adding the following to the <code class="language-plaintext highlighter-rouge">ports</code> section:</p>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">ports</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">25565:25565"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">19132:19132/udp"</span>
</code></pre></div></div>
<p>The additional <code class="language-plaintext highlighter-rouge">/udp</code> 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:</p>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">ports</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">25565:25565"</span>
<span class="pi">-</span> <span class="s2">"</span><span class="s">25565:25565/udp"</span>
</code></pre></div></div>
<p>Alternatively, add another port with the <code class="language-plaintext highlighter-rouge">-p 19132:19132/udp</code> flag to the docker run command.</p>
<h2 id="issues-with-specific-vpskvm-providers">Issues with specific VPS/KVM providers</h2>
<p>Some providers, such as OVH, Oracle Cloud, and SoYouStart, have a firewall that blocks UDP ports by default/in most cases.</p>
<h3 id="ovh-and-soyoustart">OVH and SoYouStart</h3>
<p>By 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.</p>
<div class="alert alert-warning" role="alert">
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.
</div>
<p><strong>To verify/temporary work around it:</strong></p>
<p>Attempt to connect to your servers IP and port through a web browser - for example, <code class="language-plaintext highlighter-rouge">http://test.geysermc.org:19132</code>. Connecting won’t work, but then try connecting through Bedrock on that same device, and it should work.
Alternatively, try connecting to the server first on Java edition, then on Bedrock with the same device.</p>
<p><strong>To resolve it:</strong></p>
<p>OVH:</p>
<ol>
<li>Navigate to <code class="language-plaintext highlighter-rouge">Network interfaces</code></li>
<li>Click on the <code class="language-plaintext highlighter-rouge">...</code> button on the table for your IP -&gt; then <code class="language-plaintext highlighter-rouge">...</code> and <code class="language-plaintext highlighter-rouge">Configure the GAME firewall</code> -&gt; <code class="language-plaintext highlighter-rouge">Add rule</code> -&gt; <code class="language-plaintext highlighter-rouge">Other protocol</code> (or <code class="language-plaintext highlighter-rouge">minecraftPocketEdition</code> if available)</li>
<li>Add your Geyser port into <code class="language-plaintext highlighter-rouge">outgoing port</code>.</li>
</ol>
<p>SoYouStart (subsidiary of OVH):</p>
<ol>
<li>Click the IP tab.</li>
<li>Click the gear at the right of the public IP address; select “Game mitigation”.</li>
<li>Pick “Add a rule”.</li>
<li>Select “minecraftPocketEdition” in the dropdown list and enter the target UDP ports.</li>
<li>Save and wait a few seconds for the changes to come into effect.</li>
</ol>
<h3 id="oracle-cloudoci">Oracle Cloud/OCI</h3>
<p>You’ll need to allow port 19132 on UDP in both the security list and the firewall-cmd command.</p>
<p>Additional step for Ubuntu users:</p>
<ol>
<li>Remove/comment out <code class="language-plaintext highlighter-rouge">-A INPUT -j REJECT --reject-with icmp-host-prohibited</code> in the <code class="language-plaintext highlighter-rouge">/etc/iptables/rules.v4</code> file.</li>
<li>Then, run the following command to fix ufw:
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>iptables-restore &lt; /etc/iptables/rules.v4
</code></pre></div> </div>
</li>
</ol>
</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/port-forwarding.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/port-forwarding.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">
&copy; 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>
_site/geyser/secure-chat/index.html
+457
View File
@@ -0,0 +1,457 @@
<!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: Geyser and Secure Chat</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: Geyser and Secure Chat">
<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">Geyser and Secure Chat</li>
</ol>
</nav>
<p>In the 1.19 Java Edition updates, a mechanism for reporting player chat messages to Mojang was implemented.
Bedrock Edition does not support this reporting mechanism.
If your server or proxy settings require that every player joining supports this mechanism (which may be enabled by default),
Bedrock players will be unable to chat.</p>
<p>Server administrators can disable this setting, but please note that Java players can join with certain mods that make their messages unreportable.</p>
<p>For a technical explanation of Java’s chat signing system, see this <a href="https://gist.github.com/kennytv/ed783dd244ca0321bbd882c347892874">article</a>.</p>
<h1 id="disabling">Disabling</h1>
<p><em>Vanilla, Spigot/Paper/forks, Fabric</em></p>
<p>Set <code class="language-plaintext highlighter-rouge">enforce-secure-profile: false</code> in <a href="https://minecraft.fandom.com/wiki/Server.properties">server.properties</a></p>
<p><em>BungeeCord and forks</em></p>
<p>Set <code class="language-plaintext highlighter-rouge">enforce_secure_profile: false</code> in <a href="https://www.spigotmc.org/wiki/bungeecord-configuration-guide/">config.yml</a></p>
<p><em>Velocity</em></p>
<p>Set <code class="language-plaintext highlighter-rouge">force-key-authentication = false</code> in <a href="https://github.com/PaperMC/Velocity/blob/dev/3.0.0/proxy/src/main/resources/default-velocity.toml#L19">velocity.toml</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/secure-chat.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/secure-chat.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">
&copy; 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>
_site/geyser/setup/index.html
+1355
View File
File diff suppressed because it is too large. Load diff
_site/geyser/supported-hosting-providers/index.html
+709
View File
@@ -0,0 +1,709 @@
<!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: Supported Hosting Providers</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: Supported Hosting Providers">
<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">Supported Hosting Providers</li>
</ol>
</nav>
<div class="alert alert-danger" role="alert">
This list is incomplete. Please open a <a href="https://github.com/GeyserMC/GeyserWiki/pulls">PR</a> or contact us on <a href="https://discord.gg/geysermc">Discord</a> if the information is incorrect or you want to add a new hosting provider!
</div>
<div class="alert alert-warning" role="alert">
It 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.
</div>
<div class="alert alert-warning" role="alert">
Using a <i>"Free Host"</i> may not give you the best experience <i>at all</i>. If you want better support, more freedom to control your server, and learn how to run one, PLEASE pay for a server.
</div>
<div class="alert alert-info" role="alert">
The below information is for the plugin versions of Geyser unless otherwise specified
</div>
<h2 id="built-in-geyser">Built-in Geyser</h2>
<ul>
<li>
<p><a href="https://aternos.org/">Aternos</a> - Install Geyser in the Aternos plugin list and connect to your server with your Java IP and port. See <a href="https://support.aternos.org/hc/en-us/articles/360051047631">Aternos’s article</a> 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).</p>
</li>
<li>
<p><a href="https://apexminecrafthosting.com/">Apex Hosting</a> - 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 <a href="https://apexminecrafthosting.com/geysermc/">Apex’s article</a> for more details.</p>
</li>
<li>
<p><a href="https://cloudnord.net/">Cloud Nord</a> - Go to their <a href="https://cloudnord.net/minecraftcrossplay-server-hosting/">Crossplay Server</a> hosting section and order your server. Instructions on how to join are provided.</p>
</li>
<li>
<p><a href="https://www.creeperhost.net/">CreeperHost</a> - 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.</p>
</li>
<li>
<p><a href="https://www.cubes.host/">Cubes Hosting</a> - 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.</p>
</li>
<li>
<p><a href="https://exaroton.com/">exaroton</a> - Install Geyser in the exaroton plugin list and connect to your server with your Java IP and port. See <a href="https://support.exaroton.com/hc/en-us/articles/360019857918-Geyser">exaroton’s article</a> for more details.</p>
</li>
<li>
<p><a href="https://ggservers.com">GGServers</a> - Can be installed to any server from their auto plugin setups. No further configuration needed.</p>
</li>
<li>
<p><a href="https://mcprohosting.com/">MCProHosting</a> - Click ‘Enable Bedrock Support’ on the server dashboard and follow the steps. For manual installation: Add ‘Destination Port’ <code class="language-plaintext highlighter-rouge">19132</code> with ‘Protocol UDP’ to the port forward mapping and connect to the given source port.</p>
</li>
<li>
<p><a href="https://minefort.com/">Minefort</a> - On the server dashboard under ‘Connect Support’, make sure ‘Allow Bedrock’ is enabled. Then connect via <code class="language-plaintext highlighter-rouge">play.minefort.com</code> and join using <code class="language-plaintext highlighter-rouge">/server &lt;servername&gt;</code>, or connect via <code class="language-plaintext highlighter-rouge">&lt;servername&gt;.minefort.com</code>.</p>
</li>
<li>
<p><a href="https://minehut.com/">Minehut</a> - Connect via <code class="language-plaintext highlighter-rouge">bedrock.minehut.com</code> and do <code class="language-plaintext highlighter-rouge">/join &lt;servername&gt;</code>, or connect directly via <code class="language-plaintext highlighter-rouge">&lt;servername&gt;.bedrock.minehut.gg</code>.</p>
</li>
<li>
<p><a href="https://physgun.com/">Physgun</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://www.omgserv.com/en/">OMGServ</a> - Select Geyser in the <a href="https://i.imgur.com/Gewpsrq.png">Install Menu</a>, it will be automatically installed. You can enable floodgate in the <a href="https://i.imgur.com/jg5mzNj.png">server properties on the dashboard</a>.</p>
</li>
<li>
<p><a href="https://ploudos.com/">PloudOS</a> - Connect via <code class="language-plaintext highlighter-rouge">geyser.ploudos.com</code> and enter the with your Java IP and port. See <a href="https://ploudos.com/faq/#How-do-I-connect-from-Bedrock-to-a-Java-server">PloudOS’s article</a> for more details.</p>
</li>
<li>
<p><a href="https://pufferfish.host/">Pufferfish Host</a> - Geyser is installed and configured on all servers by default.</p>
</li>
<li>
<p><a href="https://server.pro">Server.pro</a> - Different instructions for different plans: On VPS, select Geyser in the <a href="https://i.imgur.com/loSNmvu.png">Service Type Menu</a>, 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 <code class="language-plaintext highlighter-rouge">clone-remote-port</code> option. If you are using a PRO or a VPS plan, you can use any port, which can be opened on the Firewall tab.</p>
</li>
<li>
<p><a href="https://snakecrafthosting.com/">Snakecraft Hosting</a> - 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.</p>
</li>
<li>
<p><a href="https://www.srkhost.eu/">SRKHOST</a> - You can enable Geyser on the version changer page. Geyser will run on the given port by the host.</p>
</li>
<li>
<p><a href="https://virtualgladiators.com/">Virtual Gladiators</a> - Find the plugin in the control panel under the ‘VG Recommended’ category and restart your server. IP and port are the same as Java.</p>
</li>
<li>
<p><a href="https://wisehosting.com">WiseHosting</a> - Both auto and manual installation available. Find the GeyserMC presets from the <code class="language-plaintext highlighter-rouge">Properties</code> tab in the Game Panel. There, click <code class="language-plaintext highlighter-rouge">Install</code> and restart your server. See <a href="https://wisehosting.com/knowledgebase/how-to-install-geysermc-java-bedrock-crossplay-to-your-server">Crossplay FAQ</a> for additional details.</p>
</li>
<li>
<p><a href="https://zap-hosting.com/en/">ZapHosting</a> - Find the plugin in the control panel and restart your server. IP and port are the same as Java.</p>
</li>
<li>
<p><a href="https://365hosts.com">365Hosts</a> - Go to their <a href="https://www.365hosts.com/gaming/crossplayminecraft">Minecraft: Crossplay</a> hosting section and order your server. Instructions on how to join are provided.</p>
</li>
</ul>
<h2 id="support-for-geyser">Support for Geyser</h2>
<ul>
<li>
<p><a href="https://www.akliz.net/">Akliz</a> - Offers a working port forwarding option.</p>
</li>
<li>
<p><a href="https://aquatis.host/">Aquatis</a> - Need to open a support ticket to get a UDP port, then use that as the <code class="language-plaintext highlighter-rouge">bedrock port</code>.</p>
</li>
<li>
<p><a href="https://www.bisecthosting.com/">BisectHosting</a> - You must have a plan with a dedicated IP. In Geyser’s config, uncomment the <code class="language-plaintext highlighter-rouge">bedrock address</code> and set it to the public IP of your server (e.g. <code class="language-plaintext highlighter-rouge">address: 51.79.129.18</code>). Leave the port as <code class="language-plaintext highlighter-rouge">19132</code>. Under the home tab, select ‘Enable UDP Network’ and restart the server. See Bisect’s <a href="https://www.bisecthosting.com/clients/index.php?rp=/knowledgebase/193/How-to-install-Geyser-and-Floodgate-on-a-Minecraft-Java-server.html">article</a> for full instructions.</p>
</li>
<li>
<p><a href="https://www.bloom.host/">Bloom.Host</a> - Offers a working port forwarding option.</p>
</li>
<li>
<p><a href="https://clovux.net/">Clovux</a> - Make sure your remote address is ‘auto’, uncomment <code class="language-plaintext highlighter-rouge">bedrock address</code>, and change <code class="language-plaintext highlighter-rouge">0.0.0.0</code> to your Java server’s IP.</p>
</li>
<li>
<p><a href="https://consulhosting.nl/">Consulhosting</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://craft-hosting.ru/">Craft-Hosting</a> - 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.</p>
</li>
<li>
<p><a href="https://dedicatedmc.io/">DedicatedMC</a> - Contact the support to open the default Bedrock port, which Geyser is configured to use by default.</p>
</li>
<li>
<p><a href="https://www.elfidc.com/">ElfIDC</a> - 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.</p>
</li>
<li>
<p><a href="https://enviromc.host/">EnviroMC</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://extravm.com/">ExtraVM</a> - Make sure your remote address is ‘auto’, uncomment <code class="language-plaintext highlighter-rouge">bedrock address</code>, and change <code class="language-plaintext highlighter-rouge">0.0.0.0</code> to your Java server’s IP.</p>
</li>
<li>
<p><a href="https://fadehost.com/">FadeHost</a> - 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.</p>
</li>
<li>
<p><a href="https://fakaheda.eu/">FakaHeda</a> - Set the <code class="language-plaintext highlighter-rouge">bedrock port</code> 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.</p>
</li>
<li>
<p><a href="https://falixnodes.net/">FalixNodes</a> - Open a port yourself on the network page in the game panel, then use that port in the bedrock section of the Geyser config.</p>
</li>
<li>
<p><a href="https://feroxhosting.nl">Ferox Hosting</a> - Open a port yourself in their panel and check out the <a href="https://feroxhosting.nl/kb/">knowledgebase article</a> for how to install and configure Geyser.</p>
</li>
<li>
<p><a href="https://fluctishosting.com">Fluctis Hosting</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://freakhosting.com/">FREAKHOSTING</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://freemcserver.net">FreeMcServer.net</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://fusionhostingltd.co.uk">Fusion Hosting</a> - 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 &amp; use this for Geyser.</p>
</li>
<li>
<p><a href="https://futurehosting.org/">Futurehosting</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port. Make sure your <code class="language-plaintext highlighter-rouge">bedrock</code> <code class="language-plaintext highlighter-rouge">address</code> in your Geyser config is your server IP.</p>
</li>
<li>
<p><a href="https://www.gamehosting.it/">GameHosting.it</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://www.g-portal.com/">GPortal</a> - 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’.</p>
</li>
<li>
<p><a href="https://www.heavynode.com/">Heavynode</a> - Open a port yourself in the networking section of the control panel. Port <code class="language-plaintext highlighter-rouge">19132</code> 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 <a href="https://wiki.geysermc.org/geyser/port-forwarding/#ovh-and-soyoustart">here</a>.</p>
</li>
<li>
<p><a href="https://hicoria.com/en/">Hicoria</a> - Use one of the available ports allocated for your server for the Bedrock port in your config and connect with that port.</p>
</li>
<li>
<p><a href="https://www.hosterfy.com/">Hosterfy</a> - Use the same port as your Java server for the Bedrock port in your config (either by setting it yourself, or enabling <code class="language-plaintext highlighter-rouge">clone-remote-port</code>) and connect with the same IP and port as you would on Java. You can also ask for a new port.</p>
</li>
<li>
<p><a href="https://hostez.io/minecraft">HostEZ</a> - Geyser plugin supported with self-install or installed on request with its own port.</p>
</li>
<li>
<p><a href="https://humbleservers.com/">HumbleServers</a> - 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.</p>
</li>
<li>
<p><a href="https://mc-host24.de/">MC-HOST24.de</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), uncomment <code class="language-plaintext highlighter-rouge">bedrock address</code>, and change <code class="language-plaintext highlighter-rouge">0.0.0.0</code> to your Java server’s IP. Connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://www.meloncube.net/">Meloncube</a> - Contact the support for a UDP port to use for Geyser. Set that port as the <code class="language-plaintext highlighter-rouge">bedrock port</code>, and connect with it.</p>
</li>
<li>
<p><a href="https://minestrator.com/">MineStrator</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://www.minecraft-hosting.pro/">Minecraft-Hosting.pro</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://netbela.nl/store/minecraft">Netbela</a> - 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.</p>
</li>
<li>
<p><a href="https://nfoservers.com/">NFOservers</a> - Uncomment and set <code class="language-plaintext highlighter-rouge">bedrock address</code> to the server IP in the Geyser config file. As an alternative, you can run Geyser standalone separately on an Unmanaged VDS.</p>
</li>
<li>
<p><a href="https://nitrado.net">Nitrado</a> - Get Geyser as a plugin. Add 4 to the Port of the Java server. See <a href="https://wiki.nitrado.net/en/How_to_install_GeyserMC_and_Floodgate">here</a> for specific instructions.</p>
</li>
<li>
<p><a href="https://nodecraft.com">Nodecraft</a> - Use the default server port and <code class="language-plaintext highlighter-rouge">0.0.0.0</code> or your server IP as the host address.</p>
</li>
<li>
<p><a href="https://pebblehost.com/">Pebblehost</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port. See <a href="https://youtu.be/v9lC80UBZF4">this video</a> for a PebbleHost-specific tutorial.</p>
</li>
<li>
<p><a href="https://planetnode.net">PlanetNode</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://pubcs.com">PUBCS</a> - 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.</p>
</li>
<li>
<p><a href="https://ramshard.com/">RamShard</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://redlinehosting.net/">Redline Hosting</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://revivenode.com/">Revivenode</a> - Set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java server’s port (either by setting it yourself, or enabling <code class="language-plaintext highlighter-rouge">clone-remote-port</code>). You can also create a secondary port in the <code class="language-plaintext highlighter-rouge">network tab</code> and use that. To fix random <code class="language-plaintext highlighter-rouge">Unable to Connect</code> issues, see <a href="https://wiki.geysermc.org/geyser/port-forwarding/#ovh-and-soyoustart">here</a>.</p>
</li>
<li>
<p><a href="https://scalacube.com/">ScalaCube</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), uncomment <code class="language-plaintext highlighter-rouge">bedrock address</code>, and change <code class="language-plaintext highlighter-rouge">0.0.0.0</code> to your Java server’s IP. Connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://shockbyte.com/">Shockbyte</a> - Uncomment and set <code class="language-plaintext highlighter-rouge">bedrock address</code> to the Java server’s IP, and <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java server’ port. Connect with the same IP and port as on Java. For Geyser Standalone installation instructions, see <a href="https://shockbyte.com/billing/knowledgebase/173/Introduction-to-GeyserMCorDragonProxy-How-GeyserMC-Works.html">here</a>.</p>
</li>
<li>
<p><a href="https://skynode.pro/">Skynode.pro</a> - Go to ‘Server Details’, add a new port, and set the <code class="language-plaintext highlighter-rouge">bedrock port</code> in your config to that port. Connect with it and the Java server’s address.</p>
</li>
<li>
<p><a href="https://sparkedhost.com">Sparked Host</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://stellanode.com/">StellaNode</a> - Open a support ticket on the billing panel to receive an additional UDP port for Geyser, then set that as the <code class="language-plaintext highlighter-rouge">bedrock port</code>.</p>
</li>
<li>
<p><a href="https://stipe.com.au/">STIPE</a> - Set the Bedrock port to the Java server’s port and connect with that port; note that this provider only provides service in Australia.</p>
</li>
<li>
<p><a href="https://syntexhosting.com/">SyntexHosting</a> - Set the Bedrock port to the Java server’s port and connect with that port, or request a (free) additional port.</p>
</li>
<li>
<p><a href="https://theminecrafthosting.com/">The Minecraft Hosting</a> - Try using <code class="language-plaintext highlighter-rouge">19132</code> as the Bedrock port, if that does not work, use the same Java server’s port for the <code class="language-plaintext highlighter-rouge">bedrock port</code> in your config and connect with that port and the Java server’s IP.</p>
</li>
<li>
<p><a href="https://tnahosting.net/">TNAHosting</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://turbohost.nl/">TurboHost</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://ultimatesrv.com/">UltimateSRV</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://www.volcanohosting.net/">Volcano Hosting</a> - Enable <code class="language-plaintext highlighter-rouge">clone-remote-port</code> (or manually set <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java port), and connect with the Java IP and port.</p>
</li>
<li>
<p><a href="https://vultam.net/">Vultam</a> - Set the <code class="language-plaintext highlighter-rouge">bedrock port</code> to the Java server’s port, or request an additional port. The additional port can be <code class="language-plaintext highlighter-rouge">19132</code> if you buy a dedicated IP.</p>
</li>
<li>
<p><a href="https://winternode.com">WinterNode</a> - 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.</p>
</li>
<li>
<p><a href="https://witherhosting.com/">WitherHosting</a> - 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 <a href="https://support.witherhosting.com/en/article/how-to-install-and-use-geysermc-1xn5l6v/">support article</a> for further info.</p>
</li>
</ul>
<h2 id="does-not-support-geyser">Does not support Geyser</h2>
<ul>
<li>
<p><a href="https://mcpehost.ru/">MCPEhost</a></p>
</li>
<li>
<p><a href="https://www.myarena.ru/">MyArena</a> - Does seem to be working, but the Java version is too old in order for Geyser to run properly.</p>
</li>
<li>
<p><a href="https://www.ni-host.com/">NiCraft</a> - Does not provide Bedrock support, and are affected by a <a href="https://wiki.geysermc.org/geyser/port-forwarding/#ovh-and-soyoustart">firewall configuration issue</a>, which prohibits most players from joining.</p>
</li>
<li>
<p><a href="https://feathermc.com/">Feather</a> - 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.</p>
</li>
</ul>
</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/supported-hosting-providers.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/supported-hosting-providers.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">
&copy; 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>
_site/geyser/understanding-the-config/index.html
+575
View File
@@ -0,0 +1,575 @@
<!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: Understanding the Config</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: Understanding the Config">
<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">Understanding the Config</li>
</ol>
</nav>
<p>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.</p>
<h2 id="bedrock-section">Bedrock Section</h2>
<p>The options for Geyser on the Bedrock-facing end. Mostly contains options for how Bedrock edition will see the server.</p>
<p><strong><code class="language-plaintext highlighter-rouge">address</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">port</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">clone-remote-port</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">motd1</code></strong>: The first line of the MOTD for Geyser.</p>
<p><strong><code class="language-plaintext highlighter-rouge">motd2</code></strong>: The second line of the MOTD for Geyser. <strong>Please keep in mind, this option will only work if Geyser is shown in the Friends tab!</strong></p>
<p><strong><code class="language-plaintext highlighter-rouge">server-name</code></strong>: The world name that is shown in the top-right area of the pause menu and the settings menu.</p>
<p><strong><code class="language-plaintext highlighter-rouge">compression-level</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">enable-proxy-protocol</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">proxy-protocol-whitelisted-ips</code></strong>: 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.</p>
<h2 id="remote-section">Remote Section</h2>
<p>Options for the remote (Java) server.</p>
<p><strong><code class="language-plaintext highlighter-rouge">address</code></strong>: The address of the Minecraft: Java Edition server you want to join. By default, this value is <code class="language-plaintext highlighter-rouge">auto</code>. By keeping it as <code class="language-plaintext highlighter-rouge">auto</code>, the address, port, and Floodgate support will be automatically configured. In standalone, keeping this as <code class="language-plaintext highlighter-rouge">auto</code> sets the remote address to 127.0.0.1.</p>
<p><strong><code class="language-plaintext highlighter-rouge">port</code></strong>: The port of the Minecraft: Java Edition server you specified in the <code class="language-plaintext highlighter-rouge">address</code> section. For plugin versions, if address has been set to “auto”, the port will also follow the server’s listening port.</p>
<p><strong><code class="language-plaintext highlighter-rouge">auth-type</code></strong>: The authentication type of the Minecraft: Java Edition server. Valid options are <code class="language-plaintext highlighter-rouge">online</code>, <code class="language-plaintext highlighter-rouge">offline</code>, and <code class="language-plaintext highlighter-rouge">floodgate</code>.</p>
<p><strong>Please keep in mind, what you specify in the Geyser <code class="language-plaintext highlighter-rouge">auth-type</code> 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 <a href="/floodgate/">Floodgate</a> wiki page.</strong></p>
<p><strong><code class="language-plaintext highlighter-rouge">use-proxy-protocol</code></strong>: Whether to enable PROXY/HAProxy protocol or not while connecting to the server. This is useful only when:</p>
<ul>
<li>Your server supports PROXY protocol (it probably doesn’t)</li>
<li>You run Velocity or BungeeCord with its respective option enabled.</li>
<li>IF YOU DON’T KNOW WHAT THIS IS, DON’T TOUCH IT!</li>
</ul>
<p><strong><code class="language-plaintext highlighter-rouge">forward-hostname</code></strong>: 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.</p>
<h2 id="general-options">General Options</h2>
<p>General Geyser options that are mostly specific to Geyser itself.</p>
<p><strong><code class="language-plaintext highlighter-rouge">floodgate-key-file</code></strong>: 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 <a href="/floodgate/">Floodgate</a> installed and the <code class="language-plaintext highlighter-rouge">auth-type</code> set to <code class="language-plaintext highlighter-rouge">floodgate</code>.</p>
<p><strong><code class="language-plaintext highlighter-rouge">saved-user-logins</code></strong>: For online mode authentication type only.
Stores a list of Bedrock players that should have their Java Edition account saved after login.
This saves a token that can be reused to authenticate the player later. This does not save emails or passwords,
but you should still be cautious when adding to this list and giving others access to this Geyser instance’s files.
Removing a name from this list will delete its cached login information on the next Geyser startup.
The file that tokens will be saved in is in the same folder as this config, named <code class="language-plaintext highlighter-rouge">saved-refresh-tokens.json</code>.</p>
<p>Format:</p>
<div class="language-yml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">saved-user-logins</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">jeb_</span>
<span class="pi">-</span> <span class="s">Dinnerbone</span>
</code></pre></div></div>
<p><strong><code class="language-plaintext highlighter-rouge">command-suggestions</code></strong>: 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. <strong>Since 1.16.100:</strong> command freezing and crashing has been largely reduced; you may no longer need this option disabled.</p>
<p><strong><code class="language-plaintext highlighter-rouge">passthrough-motd</code></strong>: If the MOTD should be relayed from the remote server. Causes the <code class="language-plaintext highlighter-rouge">motd1</code> and <code class="language-plaintext highlighter-rouge">motd2</code> options in the bedrock section to no longer have a use.</p>
<p><strong><code class="language-plaintext highlighter-rouge">passthrough-protocol-name</code></strong>: 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. <mcsrvstat.us></mcsrvstat.us></p>
<p><strong><code class="language-plaintext highlighter-rouge">passthrough-player-count</code></strong>: If the current and max player counts should be relayed from the remote server.</p>
<p><strong><code class="language-plaintext highlighter-rouge">legacy-ping-passthrough</code></strong>: If enabled, manually pings the server by impersonating a Minecraft client instead of using the server’s API. <strong>This option should <em>only</em> be enabled if your MOTD or player count is not accurate,</strong> as it can cause errors especially on BungeeCord. This option does nothing on Geyser Standalone.</p>
<p><strong><code class="language-plaintext highlighter-rouge">ping-passthrough-interval</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">forward-player-ping</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">max-players</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">debug-mode</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">allow-third-party-capes</code></strong>: If third party (Optifine, 5zig, LabyMod, etc.) capes should be displayed to the bedrock player.</p>
<p><strong><code class="language-plaintext highlighter-rouge">allow-third-party-ears</code></strong>: If third party Deadmau5-style ears should be enabled. Currently only supports MinecraftCapes.</p>
<p><strong><code class="language-plaintext highlighter-rouge">show-cooldown</code></strong>: 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 <code class="language-plaintext highlighter-rouge">false</code> (no cooldown is sent), <code class="language-plaintext highlighter-rouge">title</code>/<code class="language-plaintext highlighter-rouge">true</code> (a cooldown indication is shown in the title), or <code class="language-plaintext highlighter-rouge">actionbar</code> (a cooldown indication is shown in the action bar). All other options default to <code class="language-plaintext highlighter-rouge">false</code>.</p>
<p><strong><code class="language-plaintext highlighter-rouge">show-coordinates</code></strong>: Bedrock Edition has an option to show coordinates in the top-left part of your screen. This setting enables or disables this.</p>
<p><strong><code class="language-plaintext highlighter-rouge">disable-bedrock-scaffolding</code></strong>: Whether Bedrock players are blocked from performing their scaffolding-style bridging.</p>
<p><strong><code class="language-plaintext highlighter-rouge">emote-offhand-workaround</code></strong>: 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:</p>
<ul>
<li><code class="language-plaintext highlighter-rouge">disabled</code> - the default/fallback, which doesn’t apply this workaround</li>
<li><code class="language-plaintext highlighter-rouge">no-emotes</code> - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen.</li>
<li><code class="language-plaintext highlighter-rouge">emotes-and-offhand</code> - emotes will be sent to Bedrock clients and offhand will be swapped</li>
</ul>
<p><strong><code class="language-plaintext highlighter-rouge">default-locale</code></strong>: The default locale to send to players if their locale could not be found. Check <a href="/geyser/faq/#what-languages-does-geyser-support">this</a> 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">cache-images</code></strong>: 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)</p>
<p><strong><code class="language-plaintext highlighter-rouge">allow-custom-skulls</code></strong>: Allows custom skulls to be displayed when placed. Keeping them enabled may cause a performance decrease on older/weaker devices.</p>
<p><strong><code class="language-plaintext highlighter-rouge">max-visible-custom-skulls</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">custom-skull-render-distance</code></strong>: A number value specifying the radius in blocks around the player in which custom skulls are displayed. 32 by default.</p>
<p><strong><code class="language-plaintext highlighter-rouge">add-non-bedrock-items</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">above-bedrock-nether-building</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">force-resource-packs</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">xbox-achievements-enabled</code></strong>: Allows Xbox achievements to be unlocked. <strong>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</strong>. Commands such as /gamemode and /give will not work from Bedrock with this enabled.</p>
<p><strong><code class="language-plaintext highlighter-rouge">log-player-ip-addresses</code></strong>: Whether player IP addresses will be logged by the server.</p>
<p><strong><code class="language-plaintext highlighter-rouge">notify-on-new-bedrock-update</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">unusable-space-block</code></strong>: 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. <code class="language-plaintext highlighter-rouge">minecraft:apple</code>. To set this to a custom item, you will need to add the <code class="language-plaintext highlighter-rouge">geyser_custom:</code> namespace.</p>
<h2 id="metrics">Metrics</h2>
<p>bStats 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 <a href="https://bstats.org/">here</a>. To see Geyser Stats, see <a href="https://bstats.org/plugin/server-implementation/GeyserMC/">here</a>.</p>
<p><strong><code class="language-plaintext highlighter-rouge">enabled</code></strong>: If metrics are enabled</p>
<p><strong><code class="language-plaintext highlighter-rouge">uuid</code></strong>: UUID of the server, don’t change this!</p>
<h2 id="advanced-options">Advanced Options</h2>
<p><strong><code class="language-plaintext highlighter-rouge">scoreboard-packet-threshold</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">enable-proxy-connections</code></strong>: Allow connections from ProxyPass and Waterdog. See https://www.spigotmc.org/wiki/firewall-guide/ for assistance - use UDP instead of TCP. <strong>This option does not need to be enabled in instances like BungeeCord or Velocity</strong>.</p>
<p><strong><code class="language-plaintext highlighter-rouge">mtu</code></strong>: 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.</p>
<p><strong><code class="language-plaintext highlighter-rouge">use-direct-connection</code></strong>: 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.</p>
<p>Default Geyser Config: <a href="https://github.com/GeyserMC/Geyser/blob/master/core/src/main/resources/config.yml">config.yml</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/understanding-the-config.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/understanding-the-config.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">
&copy; 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>
_site/geyser/using-geyser-with-consoles/index.html
+488
View File
@@ -0,0 +1,488 @@
<!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: Using Geyser with Consoles</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: Using Geyser with Consoles">
<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">Using Geyser with Consoles</li>
</ol>
</nav>
<p>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 <a href="https://github.com/Pugmatt/BedrockConnect">their GitHub repository</a> (<em>This program is not affiliated with GeyserMC</em>). Other methods are also available for use.</p>
<p>There is also a tool anyone can set up that allows you to connect to the server via adding a user to your friends list - <a href="https://github.com/Androecia/FriendConnect">FriendConnect</a>, and <a href="https://github.com/rtm516/MCXboxBroadcast">MCXboxBroadcast</a>. The latter one can even be set up as a Geyser Extension.</p>
<p><strong>NOTE: 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 <a href="https://github.com/Pugmatt/BedrockConnect">BedrockConnect Github Page</a>, or the <a href="https://www.geyserconnect.net">Public GeyserConnect</a> which allows connecting to both Java and Bedrock servers.</strong></p>
<h1 id="xbox-one">Xbox One</h1>
<p>(Video linked below)</p>
<p><a href="https://www.youtube.com/watch?v=g8mHvasVHMs"><img src="https://img.youtube.com/vi/g8mHvasVHMs/0.jpg" alt="Xbox One BedrockConnect" /></a></p>
<h1 id="nintendo-switch">Nintendo Switch</h1>
<p>(Video linked below)</p>
<p><a href="https://www.youtube.com/watch?v=zalT_oR1nPM"><img src="https://img.youtube.com/vi/zalT_oR1nPM/0.jpg" alt="Nintendo Switch BedrockConnect" /></a></p>
<h1 id="playstation-4">PlayStation 4</h1>
<ol>
<li>Go to your PS4 Home screen.</li>
<li>Go to Settings.</li>
<li>Go to Network.</li>
<li>Select Set Up Internet connection.</li>
<li>If you are using wired internet, select “Use LAN Cable”, otherwise choose “Use Wi-Fi”.</li>
<li>Select the Custom network creation mode.</li>
<li>Select Automatic IP Address.</li>
<li>For DHCP Host Name, make sure you select Do Not Specify.</li>
<li>Under DNS Settings, select Manual.</li>
<li>Enter the BedrockConnect IP for the preferred Primary DNS (Multiple options depending on region can be found on the <a href="https://github.com/Pugmatt/BedrockConnect">BedrockConnect Github Page</a>) and something like Google or Cloudfare’s IP for the Secondary DNS (8.8.8.8 or 1.1.1.1).</li>
</ol>
<h2 id="alternative-methods">Alternative Methods</h2>
<p>If you’d rather try emulating a LAN game on your network on another device, here’s how you’d do that.</p>
<p><em>Note that this method will not work with the Nintendo Switch.</em></p>
<h3 id="using-a-pc">Using a PC</h3>
<p>If you have a PC, you can use <a href="https://github.com/jhead/phantom">Phantom</a>.</p>
<h3 id="using-an-android-device">Using an Android Device</h3>
<p>If you have an Android device, you have several options:</p>
<ul>
<li><del><a href="https://github.com/GeyserMC/GeyserAndroid">Geyser Android app</a></del> (Discontinued)</li>
<li><a href="https://play.google.com/store/apps/details?id=pl.extollite.bedrocktogetherapp">BedrockTogether</a></li>
<li><a href="https://play.google.com/store/apps/details?id=com.luzenna.mineproxydroidtrial">MC Lan Proxy (Trial)</a></li>
<li><a href="https://play.google.com/store/apps/details?id=com.luzenna.mineproxydroid">MC Lan Proxy (Paid)</a></li>
<li><a href="https://play.google.com/store/apps/details?id=com.smokiem.mcserverconnector">MC Server Connector</a></li>
<li><a href="https://play.google.com/store/apps/details?id=net.ahmed.tempest">Tempest</a></li>
</ul>
<h3 id="using-an-ios-device">Using an iOS device</h3>
<p>If you have an iOS 14+ device, you can use <a href="https://apps.apple.com/app/bedrocktogether/id1534593376">BedrockTogether</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/using-geyser-with-consoles.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/using-geyser-with-consoles.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">
&copy; 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>
img/icons/fabric.png → _site/img/icons/fabric.png
View File
File renamed without changes.
img/icons/geyser.png → _site/img/icons/geyser.png
View File
File renamed without changes.
img/icons/paper.png → _site/img/icons/paper.png
View File
File renamed without changes.
img/icons/sponge.png → _site/img/icons/sponge.png
View File
File renamed without changes.
img/icons/velocity.svg → _site/img/icons/velocity.svg
View File
File renamed without changes.
img/wiki/discord-bot/logs.png → _site/img/wiki/discord-bot/logs.png
View File
File renamed without changes.
img/wiki/discord-bot/ocr.png → _site/img/wiki/discord-bot/ocr.png
View File
File renamed without changes.
img/wiki/discord-bot/ping.png → _site/img/wiki/discord-bot/ping.png
View File
File renamed without changes.
img/wiki/discord-bot/provider.png → _site/img/wiki/discord-bot/provider.png
View File
File renamed without changes.
img/wiki/edit_server_form.png → _site/img/wiki/edit_server_form.png
View File
File renamed without changes.
img/wiki/playit-gg/add_tunnel.png → _site/img/wiki/playit-gg/add_tunnel.png
View File
File renamed without changes.
img/wiki/playit-gg/added_tunnel.png → _site/img/wiki/playit-gg/added_tunnel.png
View File
File renamed without changes.
img/wiki/playit-gg/running.png → _site/img/wiki/playit-gg/running.png
View File
File renamed without changes.
img/wiki/port-forwarding/macos_warning.png → _site/img/wiki/port-forwarding/macos_warning.png
View File
File renamed without changes.
img/wiki/port-forwarding/pterodactyl-1.png → _site/img/wiki/port-forwarding/pterodactyl-1.png
View File
File renamed without changes.
img/wiki/port-forwarding/windows-1.png → _site/img/wiki/port-forwarding/windows-1.png
View File
File renamed without changes.
img/wiki/port-forwarding/windows-2.png → _site/img/wiki/port-forwarding/windows-2.png
View File
File renamed without changes.
img/wiki/port-forwarding/windows-3.png → _site/img/wiki/port-forwarding/windows-3.png
View File
File renamed without changes.
img/wiki/port-forwarding/windows-4.png → _site/img/wiki/port-forwarding/windows-4.png
View File
File renamed without changes.
img/wiki/port-forwarding/windows-5.png → _site/img/wiki/port-forwarding/windows-5.png
View File
File renamed without changes.
img/wiki/port-forwarding/windows-6.png → _site/img/wiki/port-forwarding/windows-6.png
View File
File renamed without changes.
Loaded 100 of 224 files, more files were not shown because too many files have changed in this diff. Show more