Initial changes

Co-authored-by: Jens Collaert <63231928+Jens-Co@users.noreply.github.com>
This commit is contained in:
rtm516andJens Collaert committed 2021-12-12 14:16:38 +00:00
1 parent 6d849e9549
commit e99e87ebc8
50 files changed
+2120 -743

No files matched your search

+2 -2
View File
@@ -9,7 +9,7 @@ workflows:
- build-site:
filters:
branches:
ignore: master
ignore:
build_jekyll: &build_jekyll
name: Jekyll Build
@@ -47,4 +47,4 @@ jobs:
- run: *build_jekyll
- store_artifacts:
path: ~/repo/_site
destination: docsy-jekyll
destination: GeyserDocs
+3
View File
@@ -0,0 +1,3 @@
# Default ignored files
/shelf/
/workspace.xml
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="JAVA_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>
+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/docsy-jekyll.iml" filepath="$PROJECT_DIR$/.idea/docsy-jekyll.iml" />
</modules>
</component>
</project>
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>
+1 -1
View File
@@ -16,7 +16,7 @@ ruby RUBY_VERSION
# 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
gem "master", group: :jekyll_plugins
# If you have any plugins, put them here!
# group :jekyll_plugins do
+6 -6
View File
@@ -14,24 +14,24 @@
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Docsy Jekyll
title: GeyserMC Docs
email: your-email@domain.com
author: Dinosaur Avocado
author: GeyserMC
description: > # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
# Add your baseurl here (your repository) but DO NOT CHANGE THE LINE NUMBER without editing .circleci/circle_urls.sh
baseurl: "/docsy-jekyll" # the subpath of your site, e.g. /blog
baseurl: "/GeyserDocs" # the subpath of your site, e.g. /blog
# This is mostly for testing
url: "https://vsoch.github.io" # the base hostname & protocol for your site
# Social (First three Required)
repo: "https://github.com/vsoch/docsy-jekyll"
github_user: "vsoch"
github_repo: "docsy-jekyll"
repo: "https://github.com/Jens-Co/GeyserDocs"
github_user: "Jens-Co"
github_repo: "GeyserDocs"
github_branch: "master"
# Optional
+6 -4
View File
@@ -1,4 +1,6 @@
- title: About
url: about
- title: Documentation
url: docs
- title: Geyser Download
external_url: https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/
- title: Floodgate Download
external_url: https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/
-25
View File
@@ -1,25 +0,0 @@
title: This is the Quiz Title
randomized: false
questions:
- type: "multiple-choice"
question: "What is your favorite color?"
items:
- choice: Red
correct: null
- choice: Blue
correct: null
- choice: Green
correct: null
followup: There is no correct answer to asking your favorite color! All choices would be good.
- type: "multiple-choice"
question: "True or False, Pittsburgh is West of Philadelphia"
items:
- choice: True
correct: true
- choice: False
correct: false
followup: |
The answer is True! Pittsburgh is 304.9 miles West of Philadelphia, or approximately
a car ride of 4 hours and 52 minutes. Buckle up!
+89 -20
View File
@@ -1,23 +1,92 @@
- title: Documentation
url: docs
- title: Geyser Documentation
url: "geyser/Geyser"
links:
- title: "Getting Started"
url: "docs/getting-started"
- title: "Geyser Setup"
url: "geyser/GeyserSetup"
children:
- title: Features
url: "docs/getting-started#getting-started"
- title: Development
url: "docs/getting-started#development"
- title: Customization
url: "docs/getting-started#customization"
- title: "About"
url: "about"
- title: "News"
url: "news"
- title: "Extras"
url: "docs/extras"
- title: prerequisites
url: "geyser/GeyserSetup#prerequisites"
- title: plugin-setup
url: "geyser/GeyserSetup#plugin-setup"
- title: bungeecordvelocity-setup
url: "geyser/GeyserSetup#bungeecordvelocity-setup"
- title: standalone-setup
url: "geyser/GeyserSetup#standalone-setup"
- title: gui-setup-recommended
url: "geyser/GeyserSetup#gui-setup-recommended"
- title: console-setup
url: "geyser/GeyserSetup#console-setup"
- title: standalone-setup-geyser-and-floodgate-are-not-on-the-same-server
url: "geyser/GeyserSetup#standalone-setup-geyser-and-floodgate-are-not-on-the-same-server"
- title: port-forwarding
url: "geyser/GeyserSetup#port-forwarding"
- title: termux-android
url: "geyser/GeyserSetup#termux-android"
- title: newterm-2-ios
url: "geyser/GeyserSetup#newterm-2-ios"
- title: setup-videos
url: "geyser/GeyserSetup#setup-videos"
- title: FAQ
url: geyser/FAQ
- title: Common Issues
url: geyser/Common-Issues
children:
- title: Fixing Unable to Connect to World
url: "geyser/Common-Issues/#see-here-for-fixing-unable-to-connect-to-world-with-no-console-errors"
- title: Understanding the Config
url: geyser/Understanding-the-Config
- title: Standalone Command Line Arguments
url: geyser/Standalone-Command-Line-Arguments
- title: Commands
url: geyser/Commands
- title: Supported Hosting Providers
url: geyser/Supported-Hosting-Providers
- title: Anticheat Compatibility
url: geyser/Anticheat-Compatibility
- title: Using geyser or floodgate as a dependency
url: geyser/Using-Geyser-or-Floodgate-as-a-dependency
- title: Current Limitations
url: geyser/Current-Limitations
- title: Floodgate Documentation
url: "floodgate/Floodgate"
links:
- title: Quizzes
url: "docs/extras/example-quiz"
- title: Tags Page
url: "tags"
- title: "Floodgate Setup"
url: "floodgate/FloodgateSetup"
- title: "Issues"
url: "floodgate/Issues"
- title: "Features"
url: "floodgate/Features"
children:
- title: Whitelist command
url: "floodgate/Features#whitelist-command"
- title: Global Api
url: "floodgate/Features#what-is-the-global-api"
- title: Global Linking
url: "floodgate/Features#what-is-global-linking"
- title: Local Linking
url: "floodgate/Features#local-linking"
- title: Skin Uploading
url: "floodgate/Features#what-is-skin-uploading"
- title: "FloodgateAPI"
url: "floodgate/FloodgateApi"
- title: "FloodgatePlayer"
url: "floodgate/FloodgatePlayer"
- title: "Forms and Cumulus"
url: "floodgate/Forms"
- title: "Commands"
url: "floodgate/Commands"
- title: Other
url: "other/Other"
links:
- title: "GeyserOptionalPack"
url: "other/GeyserOptionalPack"
- title: "GeyserConnect"
url: "other/GeyserConnect"
- title: "Geyser-Fabric"
url: "other/Geyser-Fabric"
- title: "Test Server"
url: "other/TestServer"
- title: "Developer Guide"
url: "other/DeveloperGuide"
- title: "Community Geyser Projects"
url: "other/Community-Geyser-Projects"
-36
View File
@@ -1,36 +0,0 @@
---
title: A Nested Page
description: An example of a nested page
---
# A Nested Page
This is an example of a page that doesn't have a permalink defined, and
is not included in the table of contents (`_data/toc.yml`). This means
that it will render based on it's path. Since it's in `docs/example-page.md`,
the url will be `docs/example-page/`.
## Link to a subfolder
Now let's say we want to link to a subfolder, specifically with this
setup:
```
docs/
example-page.md (-- we are here
subfolder/
example-page.md (-- we want to link here
```
You can provide the relative path to the file, like `subfolder/example-page.md`
and Jekyll will handle parsing it. For example:
- [here is that link](subfolder/example-page)
And {% include doc.html name="here" path="subfolder/example-page" %} is the same link,
but generated with the include statement:
```
{% raw %}{% include doc.html name="here" path="subfolder/example-page" %}{% endraw %}
```
-63
View File
@@ -1,63 +0,0 @@
---
title: Quiz
description: How to add interactive quizzes to your site.
---
# Quizzes
As of version 0.0.12, docsy-jekyll has support for basic quizzes! These are
intended to help educate your users about the content of your documentation.
For a quiz, you can add a new file to the folder `_data/quizzes`, and write a
questions file based on the format shown in `_data/quizzes/example-quiz.yml`.
Here is a simple example of a multiple choice question (which can also serve as
True/False):
```yaml
title: This is the Quiz Title
randomized: false
questions:
- type: "multiple-choice"
question: "True or False, Pittsburgh is West of Philadelphia"
items:
- choice: True
correct: true
- choice: False
correct: false
followup: |
The answer is True! Pittsburgh is 304.9 miles West of
Philadelphia, or approximately a car ride of
4 hours and 52 minutes. Buckle up!
```
The quiz is rendered with a "Show Answer" button below each question, and when
the user clicks it, any questions that are flagged with `correct: true` will be
bolded, and if a followup section is included, it will be displayed.
See the live example at the end of this page.
## Options
#### Title
If you include a title, it will be rendered at the top of the quiz. This is
optional - you can leave it out and add it before the include on the page.
#### Random
If you want your questions to be presented randomly, just add randomized: true
to the data.
## Example Quiz
If I want to include the quiz located at `_data/quizzes/example-quiz.yml`, I
can do so like this:
```
{% raw %}{% include quiz.html file='example-quiz' %}{% endraw %}
```
The rendered quiz is shown here:
{% include quiz.html file='example-quiz' %}
-17
View File
@@ -1,17 +0,0 @@
---
title: Extras
description: Extras, including quizzes.
tags:
- survey
---
# Extras
Extras include other integrations that aren't relevant to style or customization,
but can further enhance your documentation pages. Currently, we have support
for adding interactive quizzes.
- [Quizzes](example-quiz)
- [Tags]({{ site.baseurl }}/tags/)
Would you like to see another question type, or another kind of extra? Please [open an issue]({{ site.repo }}/issues/new).
-390
View File
@@ -1,390 +0,0 @@
---
title: Getting Started
tags:
- jekyll
- github
description: Getting started with Docsy Jekyll
---
# Getting Started
## Features
### User Interaction
On the right side of any page, you'll notice links to edit the page, or
open an issue. This ensures that any time you have a question or want to
suggest or request a change, you can do so immediately and link directly
to the section of interest. The sections on the page also have permalinks so
you can link directly to them.
### Search
The entire site, including posts and documentation, is indexed and then available
for search at the top or side of the page. Give it a try! The content is rendered
into window data that is used by lunr.js to generate the search results.
If you want to exclude any file from search, add this to its front end matter:
```
---
layout: null
excluded_in_search: true
---
```
The example above is for a javascript file in the assets folder that is used as a template,
but should not be included in search.
### External Search
If you have an external site with a search GET endpoint (meaning one that ends
in `?q=<term>`, then you can automatically link page tags to search this endpoint.
For example, on an HPC site I'd want a tag like "mpi" to do a search on
[http://ask.cyberinfrastructure.org](http://ask.cyberinfrastructure.org) for mpi.
See the [tags](#tags) section below for how to configure this.
### Documentation
Documentation pages should be written in the `docs` folder of the repository,
and you are allowed to use whatever level of nesting (subfolders) that
works for you! It's a Jekyll [collection](https://jekyllrb.com/docs/collections/), which means that you
can add other content (images, scripts) and it will be included for linking to.
To create subfolders with files, you can simply create new markdon files. For example:
- `_docs/subfolder/example-page.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/example-page/`
- `_docs/subfolder.md` renders to `http://localhost:4000/docsy-jekyll/docs/subfolder/`
And the page you are reading now renders from `_docs/getting-started.md`
#### Organization
The url that will render is based on the path. For example, if we had the following structure:
```
docs/
getting-started.md
clusters/
sherlock/
getting-started.md
```
The first page (akin to the one you are reading) would render at it's path,
`/docs/getting-started/`.
#### Linking
From that page, we could provide the
direct path in markdown to any subfolder to link to it, such as the second
getting started page for sherlock:
```
{% raw %}[example](clusters/sherlock/getting-started.md){% endraw %}
```
[Here](example-page) is an example link to a relative path of a file (`example-page.md`)
in the same directory, and from that page you can test linking to a subfolder.
In the case of not having a subfolder, we could write the link out directly:
```
{% raw %}[example]({{ site.baseurl }}/docs/clusters/sherlock/getting-started.md){% endraw %}
```
or just put the relative path:
```
{% raw %}[Here](example-page){% endraw %}
```
or better, there is a shortand trick! We can use the provided "includes"
template to do the same based on the path to create a link:
```
{% raw %}{% include doc.html name="Sherlock Cluster" path="clusters/sherlock/getting-started" %}{% endraw %}
```
The path should be relative to the docs folder.
### Pages
The `pages` folder uses the same page layout, but is not part of the docs collection.
The two are provided to create a distinction between website pages (e.g., about,
feed.xml) and documentation pages.
### Navigation
Whether you place your page under "pages" or "docs," for those pages that you want added to the navigation,
you should add them to `_data/toc.yml`. If you've defined a `permalink` in the
front end matter, you can use that (e.g., "About" below). If you haven't and
want to link to docs, the url is the path starting with the docs folder.
Here is an example (currently the active example):
```yaml
- title: Documentation
url: docs
links:
- title: "Getting Started"
url: "docs/getting-started"
children:
- title: Features
url: "docs/getting-started#getting-started"
- title: Development
url: "docs/getting-started#development"
- title: Customization
url: "docs/getting-started#customization"
- title: "Extras"
url: "docs/extras"
children:
- title: Quizzes
url: "docs/extras/example-quiz"
- title: "About"
url: "about"
- title: "News"
url: "news
```
If you want to add an external url for a parent or child, do this:
```yaml
- title: GitHub Repository
external_url: https://www.github.com/vsoch/mkdocs-jekyll
```
### News Posts
It might be the case that your site or group has news items that would
warrent sharing with the community, and should be available as a feed.
For this reason, you can write traditional [posts](https://jekyllrb.com/docs/posts/) in the `_posts`
folder that will parse into the site [feed]({{ site.baseurl }}/feed.xml)
The bottom of the page links the user to a post archive, where posts are organized
according to the year.
### Buttons
Buttons come in a nice array of colors. Here is the code for a basic example,
and you'd want to vary the `.btn-<tag>` to get different classes.
```html
<button class="btn btn-success">.btn-success</button>
```
<button class="btn btn-success">.btn-success</button>
<button class="btn btn-info">.btn-info</button>
<button class="btn btn-secondary">.btn-secondary</button>
<button class="btn btn-primary">.btn-primary</button>
<button class="btn btn-danger">.btn-danger</button>
<button class="btn btn-warning">.btn-warning</button>
### Badges
For news post items, it's nice to be able to tag it with something that indicates
a status, such as "warning" or "alert." For this reason, you can add badges to
the front end matter of any post page, and they will render colored by a type,
with the tag of your choice. For example, here is an example header for
a post:
```yaml
---
title: "Two Thousand Nineteen"
date: 2019-06-28 18:52:21
categories: jekyll update
badges:
- type: warning
tag: warning-badge
- type: danger
tag: danger-badge
---
```
And here is the post preview with the rendered badges that it produces:
<span class="badge badge-warning">warning-badge</span>
<span class="badge badge-danger">danger-badge</span>
And the other badges that you can define include success, info, secondary,
and primary.
<span class="badge badge-success">success-badge</span>
<span class="badge badge-info">info-badge</span>
<span class="badge badge-secondary">secondary-badge</span>
<span class="badge badge-primary">primary-badge</span>
### Alerts
{% include alert.html type="info" title="What is an alert?" content="An alert is a box that can stand out to indicate important information. You can choose from levels success, warning, danger, info, and primary. This example is an info box, and the code for another might look like this:" %}
```
{%raw%}{% include alert.html type="info" title="Here is another!" %}{%endraw%}
```
Just for fun, here are all the types:
{% include alert.html type="warning" content="This is a warning" %}
{% include alert.html type="danger" content="This alerts danger!" %}
{% include alert.html type="success" content="This alerts success" %}
{% include alert.html type="info" content="This is useful information." %}
{% include alert.html type="primary" content="This is a primary alert" %}
{% include alert.html type="secondary" content="This is a secondary alert" %}
### Quotes
You can include block quotes to emphasize text.
> Here is an example. Isn't this much more prominent to the user?
## Development
Initially (on OS X), you will need to setup [Brew](http://brew.sh/) which is a package manager for OS X and [Git](https://git-scm.com/). To install Brew and Git, run the following commands:
```bash
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install git
```
If you are on Debian/Ubuntu, then you can easily install git with `apt-get`
```bash
apt-get update && apt-get install -y git
```
### Install Jekyll
You can also install Jekyll with brew.
```bash
$ brew install ruby
$ gem install jekyll
$ gem install bundler
$ bundle install
```
On Ubuntu I do a different method:
```bash
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc
exec $SHELL
rbenv install 2.3.1
rbenv global 2.3.1
gem install bundler
rbenv rehash
ruby -v
# Rails
curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs
gem install rails -v 4.2.6
rbenv rehash
# Jekyll
gem install jekyll
gem install github-pages
gem install jekyll-sass-converter
rbenv rehash
```
### Get the code
You should first fork the repository to your GitHub organization or username,
and then clone it.
```bash
$ git clone https://github.com/<username>/mkdocs-jekyll.git docs
$ cd docs
```
You can clone the repository right to where you want to host the docs:
```bash
$ git clone https://github.com/<username>/mkdocs-jekyll.git docs
$ cd docs
```
### Serve
Depending on how you installed jekyll:
```bash
jekyll serve
# or
bundle exec jekyll serve
```
### Preview
We provide a [CircleCI](https://circleci.com/) configuration recipe that you
can use to preview your site on CircleCI before merging into master. You
should follow the instructions to [set up a project](https://circleci.com/docs/enterprise/quick-start/),
and then in the project settings be sure to enable building forked build requests,
and to cancel redundant builds. The preview will be built on CircleCI, and saved
to static files for you to browse. The only change you will need is to edit
the static files location to be the name of your respository, which is at te
bottom of the `.circleci/config.yml` file:
```yaml
- store_artifacts:
path: ~/repo/_site
destination: mkdocs-jekyll
```
In the above, the destination should coincide with your repository name.
Remember that for most links, CircleCI won't honor an `index.html` file in a subfolder
(e.g., `subfolder/index.html` will not be served as `subfolder/`, so for example,
you might need to turn this:
```
https://<circleci>/0/mkdocs-jekyll/docs/getting-started/
```
into this:
```
https://<circleci>/0/mkdocs-jekyll/docs/getting-started/index.html
```
## Customization
#### config.yml
To edit configuration values, customize the [_config.yml](_config.yml).
Most are documented there, and please [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_user }}/issues) if you have questions.
#### Adding pages
To add pages, write them into the [pages](pages) folder.
You define urls based on the `permalink` attribute in your pages,
and then add them to the navigation by adding to the content of [_data/toc.yml](_data/toc.yml).
#### Tags
If you include tags on a page, by default they will link to the [tags page]({{ site.url }}{{ site.baseurl }}/tags) on the site. However, if you define a `tag_search_endpoint` url in your configuration file, by clicking
the tag, the user will be taken to this page to search for it. As an example,
we define the current search endpoint to be Ask Cyberinfrastructure, and
page tags link to a search on it:
```yaml
tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
tag_color: danger # danger, success, warning, primary, secondary, info
```
Note that you can also choose a color! The tags appear at the top of the page,
as they do on this page. The tags should be defined like this in the front end
matter:
```yaml
tags:
- jekyll
- github
```
They are appended to the first h1 block, so generally your pages should have a header.
If you comment out this variable, then each of your tags will link to it's appropriate
spot on the tags page linked above.
```yaml
#tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
tag_color: primary # danger, success, warning, primary, info, secondary
```
-9
View File
@@ -1,9 +0,0 @@
---
title: The Subfolder Page
description: An example of a subfolder page.
---
# A Subfolder Page.
This is an example of a page that doesn't have a permalink defined, and
is not included in the table of contents (`_data/toc.yml`).
-9
View File
@@ -1,9 +0,0 @@
---
title: A Nested Page
description: An example of a nested page in a subfolder.
---
# A Nested Page
This is an example of a page that doesn't have a permalink defined, and
is not included in the table of contents (`_data/toc.yml`).
-12
View File
@@ -1,12 +0,0 @@
---
title: "Two Thousand Nineteen"
date: 2019-06-28 18:52:21
categories: jekyll update
badges:
- type: warning
tag: warning-badge
- type: danger
tag: danger-badge
---
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-36
View File
@@ -1,36 +0,0 @@
---
title: "Welcome to Docsy Jekyll"
date: 2019-06-28 5:52:21 -0500
categories: jekyll update
badges:
- type: primary
tag: primary-badge
- type: secondary
tag: secondary-badge
- type: info
tag: info-badge
- type: success
tag: success-badge
---
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
<!--more-->
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
Jekyll also offers powerful support for code snippets:
{% highlight ruby %}
def print_hi(name)
puts "Hi, #{name}"
end
print_hi('Tom')
#=> prints 'Hi, Tom' to STDOUT.
{% endhighlight %}
Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
[jekyll-docs]: http://jekyllrb.com/docs/home
[jekyll-gh]: https://github.com/jekyll/jekyll
[jekyll-talk]: https://talk.jekyllrb.com/
Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 35 KiB

-15
View File
@@ -1,15 +0,0 @@
---
title: About
permalink: /about/
---
# About
This is a [starter template](https://vsoch.github.io/docsy-jekyll/) for a Docsy jekyll theme, based
on the Beautiful [Docsy](https://github.com/google/docsy) that renders with Hugo. This version is intended for
native deployment on GitHub pages. See the [respository]({{ site.repo }}) for more details.
## Support
If you need help, please don't hesitate to [open an issue](https://www.github.com/{{ site.github_user }}/{{ site.github_repo }}).
-17
View File
@@ -1,17 +0,0 @@
---
layout: page
title: Articles
permalink: /archive/
---
# News Archive
{% for post in site.posts %}{% capture this_year %}{{ post.date | date: "%Y" }}{% endcapture %}{% capture next_year %}{{ post.previous.date | date: "%Y" }}{% endcapture %}
{% if forloop.first %}<h2 class="c-archives__year" id="{{ this_year }}-ref">{{this_year}}</h2>
<ul class="c-archives__list">{% endif %}
<li class="c-archives__item">
{{ post.date | date: "%b %-d, %Y" }}: <a href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a>
</li>{% if forloop.last %}</ul>{% else %}{% if this_year != next_year %}
</ul>
<h2 class="c-archives__year" id="{{ next_year }}-ref">{{next_year}}</h2>
<ul class="c-archives__list">{% endif %}{% endif %}{% endfor %}
-19
View File
@@ -1,19 +0,0 @@
---
layout: page
title: Documentation
permalink: /docs/
---
# Documentation
Welcome to the {{ site.title }} Documentation pages! Here you can quickly jump to a
particular page.
<div class="section-index">
<hr class="panel-line">
{% for post in site.docs %}
<div class="entry">
<h5><a href="{{ post.url | prepend: site.baseurl }}">{{ post.title }}</a></h5>
<p>{{ post.description }}</p>
</div>{% endfor %}
</div>
+11
View File
@@ -0,0 +1,11 @@
---
layout: page
title: Commands
permalink: /floodgate/Commands/
---
| Command | Permission | Description |
|:---:|:---:|:---:|
| `fwhitelist` | `floodgate.command.whitelist` | Whitelist command for Floodgate players. See [here](https://github.com/GeyserMC/Floodgate/wiki/Features#whitelist-command) for details. |
| `linkaccount` | `floodgate.command.linkaccount` | Link your account for local linking. |
| `unlinkaccount` | `floodgate.command.unlinkaccount` | Unlink your account for local linking. |
+70
View File
@@ -0,0 +1,70 @@
---
layout: page
title: Features
permalink: /floodgate/Features/
---
## Whitelist command
Floodgate 2.0 has a whitelist command, `fwhitelist`, that should be used for adding or removing Floodgate players to whitelist.json. The username prefix doesn't need to be included.
`fwhitelist add Tim203`
`fwhitelist remove Tim203`
You can also specify a UUID: `fwhitelist add 00000000-0000-0000-0009-01f64f65c7c3`
The permission node is `floodgate.command.whitelist`.
## What is the Global Api?
The Global Api is an API that is available for every server. It currently includes: [Global Linking](#What-is-Global-Linking), [skin uploading](#What-is-skin-uploading), 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 [here](https://github.com/GeyserMC/global_api) and the source code of the Global Linking server is available [here](https://github.com/GeyserMC/GlobalLinkServer).
## What is Global Linking?
Instructions and information about how to link can also be found here: https://link.geysermc.org/
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>
Global Linking is part of the [Global Api](#What-is-the-Global-Api) and uses the GlobalLinkServer to link your account. To be able to link your account you have to do the following:
1. Join the GlobalLinkServer with both your Java and Bedrock account
(IP: `link.geysermc.org`, Java port: `25565`, Bedrock port: `19132`)
2. Start the linking process by typing `/linkaccount` on your Java **or** Bedrock account
3. 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.
4. Enter the random number on the other account by typing `/linkaccount <code>`
5. You should get kicked from the server on both your Bedrock and Java account with the message that it had successfully linked your accounts.
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 `player-link` section looks similar to this:
```yml
# Configuration for player linking
player-link:
# Whether to enable the linking system. Turning this off will prevent
# players from using the linking feature even if they are already linked.
enabled: true
# Whether to use global linking. Global linking uses a central server to request link
# accounts, allowing people to link once, join everywhere (on servers with global linking).
use-global-linking: true
```
([see the default config](https://github.com/GeyserMC/Floodgate/blob/master/common/src/main/resources/config.yml))
Once you saved the config and restarted your server you should be using Global Linking.
If you don't want to use Global Linking, you can disable `enable-global-linking` in the Floodgate config.
### Local Linking
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.
Note that you only have to follow these steps on your proxy (BungeeCord or Velocity), if you have one.
1. Download one of the linking databases extensions [here](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/).
If you need help picking the right one: choose `mysql` if you already have a database or want to have a multi-proxy setup. For anything else choose `sqlite`. The full name should be `floodgate-*type*-database.jar`.
2. Copy the database extension jar you just downloaded *into* the floodgate 2.0 plugin folder (e.g. `/plugins/floodgate/`).
3. Enable `enable-own-linking` in the `player-link` section of Floodgate.
4. Set `type` in the `player-link` section to your database type (currently either `mysql` or `sqlite`). (If you used Floodgate 1.0 and had linking enabled back then; the database type was `sqlite`).
5. Restart your server
If you have selected `mysql` a new data folder for the database should be generated inside the Floodgate data folder. You can enter your database credentials in there. After you did that restart your server once more.
That should be it. You can then link your accounts by following the instructions you get when typing `/linkaccount`.
## What is skin uploading?
Skins of Bedrock player should be visible to Java players on servers with Floodgate 2.0 installed.
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.
Skin uploading is also a part of the [Global Api](#What-is-the-Global-Api). It is responsible for converting Bedrock skins to Java skins and uploading them to Mojang servers make them show up on Java Edition.
+20
View File
@@ -0,0 +1,20 @@
---
layout: page
title: Floodgate
permalink: /floodgate/Floodgate/
---
# Floodgate
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Build Status](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/badge/icon)](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/)
[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/)
[![HitCount](https://hits.dwyl.com/GeyserMC/Floodgate.svg)](http://hits.dwyl.com/GeyserMC/Floodgate)
Hybrid mode plugin to allow for connections from [Geyser](https://github.com/GeyserMC/Geyser) to join online mode servers.
Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net).
See the [Floodgate](https://github.com/GeyserMC/Geyser/wiki/Floodgate) page in the Geyser Wiki for more info about the what Floodgate is, how you setup Floodgate and known issues/caveats.
See the [Floodgate wiki](https://github.com/GeyserMC/Floodgate/wiki) (currently work in progress) for a more in-depth look into Floodgate, how it works and the Floodgate API.
+66
View File
@@ -0,0 +1,66 @@
---
layout: page
title: Floodgate API
permalink: /floodgate/FloodgateApi/
---
### 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](Forms)
This page will contain information about class FloodgateApi.<br>
See the sidebar for more information about other parts of the API.
### Accessing the Floodgate API
Floodgate uses the open collaboration repo. The following example is for Maven, but the same concept applies for Gradle etc.
```xml
<repository>
<id>opencollab-snapshot</id>
<url>https://repo.opencollab.dev/maven-snapshots/</url>
</repository>
<dependency>
<groupId>org.geysermc.floodgate</groupId>
<artifactId>api</artifactId>
<version>2.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
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.
---
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:
```java
FloodgateApi.getInstance();
```
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.
Most [API methods have a simple explanation](https://github.com/GeyserMC/Floodgate/tree/master/api/src/main/java/org/geysermc/floodgate/api).
#### We'll highlight a few to get you started quickly:<br>
`FloodgateApi#isFloodgatePlayer(UUID)`<br>
Used to check if the given UUID of an **online** player is a Bedrock player.
`FloodgateApi#getPlayer(UUID)`<br>
Used to get the FloodgatePlayer instance of an **online** player.<br>
Click [here](FloodgatePlayer) to get more information about the FloodgatePlayer class.
**Note**: 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.
`FloodgateApi#getPlayerLink()`<br>
Used to get the PlayerLink instance used by Floodgate to check for linked accounts.<br>
Click [here](PlayerLink) to get more information about the PlayerLink class
`FloodgateApi#sendForm(UUID, Form(Builder))`<br>
Used to send a form to the Bedrock player with the given UUID.<br>
Click [here](Forms) to get more information about Forms.
### Using the API on backend servers
In order to successfully use the API on backend Spigot servers when using a proxy, `send-floodgate-data` must be set to `true` on the proxy Floodgate's config, and the `key.pem` file must be identical between all Floodgate instances.
+10
View File
@@ -0,0 +1,10 @@
---
layout: page
title: FloodgatePlayer
permalink: /floodgate/FloodgatePlayer/
---
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.
You can get a FloodgatePlayer by using the `FloodgateApi#getPlayer(uuid)` method (where uuid is the unique id of the connected player)
+78
View File
@@ -0,0 +1,78 @@
---
layout: page
title: Floodgate Setup
permalink: /floodgate/FloodgateSetup/
---
## Downloads:
Floodgate 2.0: https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/
Geyser: https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/
## Prerequisites
- You must own/manage the server in order to add Floodgate. *If you do not own the server, Floodgate does not allow you to bypass logging into Java servers that require a Mojang Java account*.
- You must either be running Geyser as a [plugin](https://github.com/GeyserMC/Geyser/wiki/Setup#plugin-setup), or be running [Geyser Standalone](https://github.com/GeyserMC/Geyser/wiki/Setup#Standalone-Setup). Floodgate does not replace Geyser.
- You should make sure your Geyser is on the latest version (old versions of Geyser that worked with Floodgate 1.0 will not work with Floodgate 2.0)
- `floodgate-spigot.jar` cannot be installed on CraftBukkit/Bukkit servers.
## Setting Up
*Any reference to Spigot here also refers to any compatible server software such as Paper.*
For BungeeCord/Velocity setups: you only are required to install Floodgate on the BungeeCord or Velocity proxy unless you want to use the Floodgate API on the backend servers - see [below](installing-floodgate-also-on-spigot-servers-behind-bungeecord-or-velocity) for the installation process.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; *Note:* Installing Floodgate on the backend servers will allow Bedrock player skins to display without the Bedrock player having to switch backend servers.
- Download the Floodgate plugin from [here](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/) and add it to your plugins folder on your frontend server.
- `floodgate-spigot.jar` for Spigot, Paper, etc
- `floodgate-bungee.jar` for BungeeCord, Waterfall, etc
- `floodgate-velocity.jar` for Velocity
- Change the `auth-type` in the Geyser config to `floodgate`.
- Restart/start up the server.
**ONLY do this step if using Geyser Standalone:**
- *Copy* the `key.pem` file in the Floodgate config folder to the same directory as Geyser Standalone. **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.
### Installing Floodgate also on Spigot servers behind BungeeCord or Velocity
This is only needed when you want to use the Floodgate API on your Spigot server(s) behind a proxy.
- Install Floodgate on the proxy and on *all* backend servers as per the [previous insructions](#setting-up)
- Enable `ip_forward` in your BungeeCord `config.yml` if using BungeeCord
- Set `bungeecord` to `true` in your `spigot.yml`
- Start the proxy server.
- Edit the Floodgate config on your proxy server and set `send-floodgate-data` to `true`.
- *Copy* the `key.pem` file in the proxy Floodgate config folder to all Spigot servers' Floodgate config folder. **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.
- Restart the Spigot servers and proxy server.
## How do I migrate from Floodgate 1.0 to Floodgate 2.0?
Floodgate 2.0 is not compatible with Floodgate 1.0 and Floodgate 1.0 is not compatible with Floodgate 2.0, which means there may be some manual upgrading required. When Floodgate 2.0 is loaded for the first time (on your server), it will try to convert the Floodgate 1.0 config to a Floodgate 2.0 config and it will generate a new key (the old one can be found under `old-key.pem`). Floodgate 2.0 uses a different algorithm for the key and because of that, you now only have one key (called `key.pem`) instead of two. You will have to copy the new Floodgate key (like you had to do in the initial startup) to all the servers that use Floodgate, including Geyser-Standalone.<br>
Probably not everyone will understand what has been said, so here is a step-by-step guide:
1. Replace Geyser with the [latest version](https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/) (builds of Geyser that worked with floodgate 1.0, don't work) and replace every server that uses Floodgate with the [latest version](https://ci.opencollab.dev/job/GeyserMC/job/Floodgate/job/master/).
2. Restart **one** server that uses Floodgate and let Floodgate update the config and generate a new `key.pem` file.
3. Look at the Floodgate configuration of that server and check if `config-version` is present in the Floodgate config. If it isn't, you have not installed Floodgate 2.0. While you are there, please decide if you want to continue using the legacy player name prefix `*` or use one of the recommended prefixes: `.` (the new default), `+` or `-`. All those new prefixes are easier to use for commands since you don't have to wrap the player's name in quotes.
4. Copy the files: `config.yml` and `key.pem` to all your servers that use Floodgate.
5. If you are using Geyser-Standalone, only copy `key.pem` to the Geyser-Standalone folder.
6. Make sure that you edit the Geyser config to point to `key.pem` instead of `public-key.pem` (the setting is`floodgate-key-file`).
7. Restart the other servers and check for errors.
8. Try to join Geyser with one account to check if everything works as expected. If it doesn't, please make sure that you followed every step correctly. If you did everything correctly and it still doesn't work, join our Discord to get support.
Depending on if you want to keep using [Global Linking](Features#What-is-Global-Linking), which is enabled by default, you should be ready to go.
To migrate your Floodgate 1.0 local account linking database, follow [these](Features#Local-Linking) steps.
## Changing/disabling the prefix
***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.***
In your Floodgate config, change `username-prefix` to whichever prefix you desire - you can set it to `""` and there will be no prefix.
On some older Paper servers (or any forks that use them), you may need to also shut down your server and delete your `usercache.json` file located in the same folder as your server jar to prevent users who already joined from having the old prefix. See [this issue](Issues#Prefix-is not-changing-on-the-server-after-changing-it in-the-config.) for more information.
## Obtaining UUIDs for Floodgate players
Check your server logs, or use [this](https://floodgate-uuid.heathmitchell1.repl.co/) page. If this doesn't work, then try this method:
First, you'll need to get the XUID of the player. There are several third-party websites to find this, for example, this one (unaffiliated with Geyser). Make sure to choose "Hexidecimal." You'll need to enter the player's Xbox Gamertag, and, once submitted, and it should display the XUID in the format of `xxxxxxxxxxxxxxxx`. To turn the XUID into a UUID that Java Edition can recognize, you need to put the XUID in this format: `00000000-0000-0000-xxxx-xxxxxxxxxxxx`. If formatted right, Java Edition should accept it as a UUID.
## Using PlaceholderAPI
If you're using the Bukkit version of Floodgate, download the Placeholder plugin [here](https://github.com/rtm516/FloodgatePlaceholders/). Using the placeholders shouldn't require additional setup other than having [PlaceholderAPI](https://www.spigotmc.org/resources/place
+202
View File
@@ -0,0 +1,202 @@
---
layout: page
title: Forms and Cumulus
permalink: /floodgate/Forms/
---
# What is Cumulus?
Bedrock Edition has a cool exclusive feature called Forms.<br>
Cumulus is the new Forms API that we use in Geyser and Floodgate. The source code is available [here](https://github.com/GeyserMC/Cumulus).
You can access the Cumulus API through the [Floodgate API](FloodgateApi).
Bedrock knows three types of Forms:
* ModalForm
* SimpleForm
* CustomForm
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>
## ModalForm
While this is the easiest form type it's also the least customisable.<br>
You have a title, description (content) and two buttons.
![Example of a ModalForm](https://i.imgur.com/kMpMgOh.png)
Code used in the image:
```java
ModalForm.builder()
.title("Title")
.content("Content")
.button1("Button 1")
.button2("Button 2")
```
## SimpleForm
While this one is less easy then ModalForm is, it also has more customizability.<br>
It's still limited to title, content and buttons, but these buttons can also have images and do not have a minimum and maximum of two.
![Example of a SimpleForm](https://i.imgur.com/3rj2OQ2.png)
Code used in the image:
```java
SimpleForm.builder()
.title("Title")
.content("Content")
.button("Button without an image")
.button("Button with URL image", FormImage.Type.URL, "https://github.com/GeyserMC.png?size=200")
.button("Button with path image", FormImage.Type.PATH, "textures/i/glyph_world_template.png")
```
## CustomForm
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 [Components](#Components) for more information about every component you can use and in which form type.
![Example of a CustomForm](https://i.imgur.com/zHgxELm.png)
Code used in the image:
```java
CustomForm.builder()
.title("Title")
.dropdown("Text", "Option 1", "Option 2")
.input("Input", "placeholder")
.toggle("Toggle")
.slider("Text", 0, 10, 1, 5)
```
## Components
Forms have different component types, most of them are limited to the CustomForm and some are available to everything but CustomForm.
### Button
Limited to ModalForm and SimpleForm. With SimpleForm, buttons can have image icons and there can be more than 2.
### Dropdown
Limited to CustomForm
### Input
Limited to CustomForm.
### Label
Limited to CustomForm.
### Slider
Limited to CustomForm.
### Stepslider
Limited to CustomForm.
### Toggle
Limited to CustomForm.
## Sending a form
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:
```java
FloodgateApi.getInstance().sendForm(uuid, form); // or #sendForm(uuid, formBuilder)
```
Or you can do it by using the Player's FloodgatePlayer instance:
```java
FloodgatePlayer player = FloodgateApi.getInstance().getPlayer(uuid);
player.sendForm(form); // or #sendForm(formBuilder)
```
So you can make and send forms in a pretty compact way by doing something like this:
```java
FloodgatePlayer player = FloodgateApi.getInstance().getPlayer(uuid);
...
player.sendForm(
new CustomForm.Builder()
.title("My cool title")
.content("10/10 content")
));
```
## Receiving a response from the client
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.<be>
We can do that using the `responseHandler(BiConsumer<? extends Form, String>)` method in the FormBuilder:
```java
_Modal_Form.builder()
.title("Feedback form")
.content("We're asking for feedback, are you willing to enter some feedback to improve our server?")
.button1("Yes") // id = 0
.button2("No") // id = 1
.responseHandler((form, responseData) -> {
_Modal_FormResponse response = form.parseResponse(responseData);
if (!response.isCorrect()) {
// player closed the form or returned invalid info (see FormResponse)
return;
}
// short version of getClickedButtonId == 0
if (response.getResult()) {
System.out.println("Yay, he wants to give us feedback");
return;
}
System.out.println("No feedback for us :(");
});
```
Or using the response handler setter of the Form (not a FormBuilder):
```java
_Modal_Form form = ...;
form.setResponseHandler(responseData -> {
_Modal_FormResponse response = form.parseResponse(responseData);
if (!response.isCorrect()) {
// player closed the form or returned invalid info (see FormResponse)
return;
}
// short version of getClickedButtonId == 0
if (response.getResult()) {
System.out.println("Yay, he wants to give us feedback");
return;
}
System.out.println("No feedback for us :(");
});
```
## Advanced stuff
The FormBuilder also has support for translating the data used in the builder.<br>
To add a translator, you can use the `translator(BiFunction<String, String, String>)` or the `translator(BiFunction<String, String, String>, String)` method:
```java
_Modal_Form form = _Modal_Form.builder()
.translator(this::translate, userLanguage)
.title("Title")
.content("Content")
.button1("translate.button1")
.button2("translate.button2")
.build();
public String translate(String key, String locale) {
// this method will be called for every string, in this case, 4 times:
// Title, Content, translate.button1, translate.button2
// your own translate logic here
// return the value that replaces the key
}
```
Or you can have the translate method directly in the FormBuilder instead of a separate method:
```java
_Modal_Form form = _Modal_Form.builder()
.translator((key, unused) -> {
// this method will be called for every string, in this case, 4 times:
// Title, Content, translate.button1, translate.button2
// since this isn't a separate method, you don't need the locale argument, so it's unused.
// your own translate logic here
// return the value that replaces the key
})
.title("Title")
.content("Content")
.button1("translate.button1")
.button2("translate.button2")
.build();
```
+51
View File
@@ -0,0 +1,51 @@
---
layout: page
title: Issues
permalink: /floodgate/Issues/
---
# Known Issues & Caveats
If an issue you're experiencing is not listed here, please consider joining the Geyser [Discord](http://discord.geysermc.org/).
## Running commands
In some instances, like if you have the `username-prefix` set to `*`, you may need to wrap the Bedrock player's username in quotes; for example: `/tp "*BedrockPlayer"`. Setting the prefix to `.` should also fix this.
## If you wish to use IP forwarding, please enable it in your BungeeCord config as well!
It is likely you have enabled `send-floodgate-data` in your Floodgate config but either Floodgate isn't installed on the target server, or you floodgate key isn't the same between the installs of the plugin (please copy them so they all use the same key).
## `java.lang.IllegalStateException: Cannot reply to EncryptionRequestPacket without profile and access token.`
Make sure the server has Floodgate installed and started up correctly. Otherwise, see if the next line fixes your error.
## `javax.crypto.AEADBadTagException: Tag mismatch!`
If Geyser and Floodgate are on the same server, shut down your server, delete the `floodgate` plugin folder, delete any key file in the Geyser folder, and restart your server.
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 [WinSCP](https://winscp.net/eng/index.php) if you need to use FTP.
## java.lang.NumberFormatException: For input string: ""
You're trying to log in without an Xbox account. Floodgate requires an Xbox account to authenticate the Bedrock player.
## Geyser-Floodgate:51777 lost connection: Internal Exception: java.lang.NumberFormatException: For input string: "SfqdXv36" (or a similar error)
Set `ip-forwarding` in your BungeeCord to `true`.
## "Please connect through the official Geyser" disconnect message
Ensure that Floodgate and Geyser are both up-to-date.
## Prefix is not changing on the server after changing it in the config.
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.
Ensure that you removed the `usercache.json` file from the server root directory and restart your server.
## Issues with LuckPerms and prefixes
Set `allow-invalid-usernames` to `true` in LuckPerms' config.
## Error with Forge or Fabric Bukkit Hybrid
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).
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.
+33
View File
@@ -0,0 +1,33 @@
---
layout: page
title: Anticheat Compatibility
permalink: /geyser/Anticheat-Compatibility/
---
Do note that this is a community-compiled list and is incomplete! If you wish to update or add to this list, feel free.
### AntiCheat compatibility reports
Full Compatibility (Checks Bedrock Players Accurately)
- [AntiAura](https://www.spigotmc.org/resources/antiaura-premium-anti-cheat-plugin.1368/) - Last Updated on 8/19/21
- [NESS Reloaded](https://www.spigotmc.org/resources/ness-anti-cheat-reloaded.75887/) - Last Updated on 8/19/21
- [Themis](https://www.spigotmc.org/resources/themis-anti-cheat-1-16-x-bedrock-support-paper-tuinity-compatibility-free-optimized.90766/) - Last Updated on 8/19/21
- [LightAntiCheat](https://www.spigotmc.org/resources/lightanticheat.96341/) - Last Updated on 12/4/21
Partially Compatible (Does not Check/Ignores Bedrock Players)
- [AAC](https://www.spigotmc.org/resources/aac-advanced-anti-cheat-hack-kill-aura-blocker.6442/) - Last Updated on 8/19/21
- [Flappy Anticheat](https://www.spigotmc.org/resources/flappy-anticheat-1-16-1-17.92180/) - Last Updated on 9/14/21
- [Matrix](https://matrix.rip/) - Last updated on 9/2/21
- [Spartan](https://www.spigotmc.org/resources/spartan-anti-cheat-advanced-cheat-detection-hack-blocker-1-7-2-1-16-5.25638/) (Spartan Syn offers full Bedrock checks for an additional $43) - Last Updated on 8/19/21
- [Vulcan](https://www.spigotmc.org/resources/vulcan-advanced-cheat-detection-1-7-1-16-5.83626/) - Last Updated on 8/19/21
Incompatible (False Positives on Bedrock Players, no Compatibility at All)
- [AntiCheatReloaded](https://www.spigotmc.org/resources/anticheatreloaded.23799/) - Last Updated on 8/19/21
- [Negativity](https://www.spigotmc.org/resources/negativity-v2-1-7-to-1-17-bungee-velocity-sponge.86874/) - Last Updated on 8/19/21
- [NoCheatPlus](https://ci.codemc.io/job/Updated-NoCheatPlus/job/Updated-NoCheatPlus/) ([Compat NCP](https://github.com/Updated-NoCheatPlus/CompatNoCheatPlus/) is an addon that enables Partial Compatibility) - Last Updated on 8/19/21
- [Reflex](https://www.spigotmc.org/resources/「reflex」machine-learning-cheat-detection-»-1-8-1-17.21122/) - Last Updated on 8/19/21
- [SoaromaSAC](https://www.spigotmc.org/resources/soaromasac-lightweight-cheat-detection-system.87702/) - Last Updated on 8/19/21
- [Wraith](https://www.spigotmc.org/resources/✅-wraith-anticheat-⛔%EF%B8%8F-haunts-every-cheater.66887/) - Last Updated on 8/19/21
+22
View File
@@ -0,0 +1,22 @@
---
layout: page
title: Commands
permalink: /geyser/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. |
For Floodgate com
+118
View File
@@ -0,0 +1,118 @@
---
layout: page
title: Common Issues
permalink: /geyser/Common-Issues/
---
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 [our Discord](https://discord.geysermc.org) for support.
# Floodgate
For Floodgate issues see: [Floodgate: Known Issues/Caveats](https://github.com/GeyserMC/Floodgate/wiki/Issues).
# I can't connect! (Either the server doesn't show up in the friends list or I get "Unable to connect to world")
* If you don't use a reverse proxy such as TCPShield make sure that `enable-proxy-protocol` is set to false.
## If the server doesn't show up in the friends list
* *If using Windows 10, iOS, or Android*: try adding the server to the Servers list in-game.
* *If using Xbox One*: try connecting with [BedrockConnect](https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles).
* *If using PS4*: [try using a LAN proxy.](https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles#playstation-4)
* *If using Nintendo Switch*: there is currently no way for local servers to show up in the Friends tab, but you can still connect using [BedrockConnect](https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles).
*If the Geyser instance is locally hosted:* try using `localhost` or `0.0.0.0` as the IP address.
*If that doesn't work, or your Geyser instance is on another computer in the network*: use your **local** IPv4 address.
## See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-%27Unable-to-Connect-to-World%27) for fixing "Unable to Connect to World" with no console errors
### `java.net.BindException: Address already in use: bind` on startup.
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.
### [...]` has been compiled by a more recent version of the Java Runtime (class file version 60.0)`
See this link for updating to Java 16: https://paper.readthedocs.io/en/latest/java-update/index.html.
### Hosting provider will not immediately open up UDP.
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 (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.
**PLEASE NOTE:** If your server automatically redownloads jars upon startup, such as with an autoupdate system, this workaround will not work. Please contact your host if this does not work for you as there is nothing we can do.
# Stuck on "Locating Server" with no errors
You may need to update your Java version. If so, update at [AdoptOpenJDK.net](https://adoptopenjdk.net/).
Sometimes this happens in poor-network environments. There is an `mtu` option in the Geyser config; lower this number slowly (in batches of 100), restart each time, and re-test joining.
This option will most likely not help if you are getting "Unable to Connect to World" with no console logs indicating a connection.
# Login Failed
***If you are using a plugin version:*** in your Geyser config, set your remote address to `127.0.0.1`. If that does not work, check your startup log for a message about Docker, and use that address in the remote address
### Cannot reply to EncryptionRequestPacket without profile and access token
There are two causes of this message:
*Floodgate issue*:
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.
*Server is in Online Mode while Geyser is in Offline Mode*:
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.
### Connection Refused: <INSERT IP AND/OR DOMAIN>
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.
If you're updating from an old build of Geyser, set your remote address to `auto` and try again.
### Floodgate Misconfiguration
See [this page](https://github.com/GeyserMC/Floodgate/wiki/Issues) for more information.
### Mojang Resetting Account Credentials
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 [Floodgate](https://github.com/GeyserMC/Floodgate), which allows for Bedrock clients to join your server without needing a Java Edition account. Take a look [here](Floodgate) for more information.
# "Invalid IP address!" from Bedrock
It's currently unknown why this happens even for valid domains. Try using the IPv4 address.
# Bedrock clients freeze when opening up commands for the first time
Disable `command-suggestions` in your Geyser config. This will stop the freezing at the expense of removing command suggestions from Bedrock clients.
# BungeeCord freezes and crashes after bedrock player joins
Make sure you have set `ip-forward` to `true` in your BungeeCord `config.yml` and set `bungeecord` to `true` in each connected server's `spigot.yml`.
# Failed to load locale asset cache: Unrecognized token 'Cannot'
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 `-Djava.net.preferIPv4Stack=true`, EG: `java -Xms1024M -Djava.net.preferIPv4Stack=true -jar Geyser.jar`
# Outdated client! Please use 1.x.x
The server is too new or Geyser is outdated. Make sure you're on the latest Geyser.
# Outdated server! I'm still on 1.x.x
Update the server or ask them to install [ViaVersion](https://viaversion.com/). You can also try [VIAaaS](https://github.com/ViaVersion/VIAaaS) (ViaVersion as a Service).
# Query: Incorrect Magic!
See here: https://www.spigotmc.org/threads/query-incorrect-magic-and-high-cpu-usage.159386/#post-2709057
* If you don't use a reverse proxy such as TCPShield make sure that `enable-proxy-protocol` is set to false.
# Only for BungeeCord with floodgate
If you use floodgate ensure that it is installed on all of your Spigot backend servers as following:
1. `Bungee: Geyser and Floodgate`
2. `Lobby: floodgate`
3. `Server-1: floodgate`
4. `Server-2: floodgate`
And so on.
* Please also make sure that you have the same `key.pem` and `config.yml` on all of your servers.
If your players can't connect from the lobby to another backend server, check console.
### Plugins that can cause issues
* `HamsterAPI`
+35
View File
@@ -0,0 +1,35 @@
---
layout: page
title: Current Limitations
permalink: /geyser/Current-Limitations/
---
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.
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.
- Custom heads in inventories
- Clickable links in chat
- Glowing effect
- Crafting in the 2x2 menu while in creative mode
- Distinguishing between left and right clicks in inventories
- Redstone dot blockstates
- "Can be placed on/destroyed" tag for *some* blocks - for example, different colors of clay/wool that don't exist as separate blocks
- Potion colors implemented using NBT
- Various command arguments for any command that doesn't use the Minecraft Brigadier library
- 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
- Unable to see banner layers past 6
- Movement issues around bamboo due to offset differences between Java and Bedrock, but you can use this plugin for temp fix https://github.com/Camotoy/BambooCollisionFix/releases
- Custom anvil recipes
- 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
- Dolphin's Grace potion effect visuals (effects should still work correctly)
- Invisible item frames
The following changes **are supported** with the [GeyserOptionalPack](https://github.com/GeyserMC/Geyser/wiki/GeyserOptionalPack), which is a Bedrock resource pack you can install for additional functionality for features Bedrock does not natively support:
- Custom armor stand poses
- Illusioners
- Iron golem cracked texture
- Hit particles and other miscellaneous particles not natively in Bedrock
- Offhand animations
- Shulker invisibility
- Spectral arrow texture
+202
View File
@@ -0,0 +1,202 @@
---
layout: page
title: FAQ
permalink: /geyser/FAQ/
---
## How Does it Work?
Geyser works as a translator, translating both the incoming and outgoing packets to a format both the client and server can understand. With this being said, it emulates a Minecraft: Java Edition client, so the server actually thinks you're joining from Java Edition. Regardless of the server or what plugins it has installed, you can join it with Geyser (as long as the server supports the latest vanilla (unmodified) Minecraft version).
## So, how does Redstone work?
Redstone, along with any other mechanics like commands, farms, etc., will work exactly like Java Edition since joining a Java Edition server and Geyser does not modify server behavior.
## Is Geyser paid?
No, Geyser and all related projects are completely free and open-source, licensed under the MIT license.
## What plugins don't work with Geyser?
Geyser should generally work fine with plugins, as we emulate a Java client. There are exceptions, though:
* [TCPShield](https://tcpshield.com/) requires `only-allow-proxy-connections` disabled without a paid plan. However, their "Premium" plan will allow the support of Geyser - please contact their support for help setting this up.
Floodgate can cause issues with plugins as it modifies the login process. *Please note that any offline mode authenticator plugins are only here for documentation; Geyser does not support offline mode usage.*
* [DynamicBungeeAuth](https://www.spigotmc.org/resources/dynamicbungeeauth-premium-command-semi-premium-system-sessions.27480/) produces invalid credentials for Bedrock players.
* [FastLogin](https://www.spigotmc.org/resources/fastlogin.14153/) does not let floodgate add player prefix.
* [ExploitFixer](https://www.spigotmc.org/resources/2ls-exploitfixer-the-ultimate-antiexploit-plugin.62842/) thinks that Floodgate users are UUID spoofing - disable the `uuidspoof` setting in ExploitFixer's config.
* [JPremium](https://www.spigotmc.org/resources/27766/) alters the UUID of a player, causing Floodgate not to be able to get the Bedrock data from its map.
* [LibHatesMods](https://www.spigotmc.org/resources/78202/) causes authentication to fail with `com.github.steveice10.mc.auth.exception.request.InvalidCredentialsException`
* [ProtocolSupport](https://www.spigotmc.org/resources/7201/) ~~is currently incompatible with Floodgate.~~ Works with Floodgate, but we recommend using [ViaBackwards](https://www.spigotmc.org/resources/viabackwards.27448/) instead.
* [ProtocolSupportBungee](https://www.spigotmc.org/resources/8733/) changes how the login process works and therefore breaks the Floodgate injection code.
* [SayNoToMcLeaks](https://www.spigotmc.org/resources/40906/) prevents Floodgate from finishing its login system.
If you come across any more, please let us know via [Discord](http://discord.geysermc.org).
## Which plugin version of Geyser do I need?
This is a non-complete list of what platform each plugin version of Geyser is for, and the standalone version can be used for any as it isn't a plugin.
* Geyser-Spigot works with:
* [Spigot](https://www.spigotmc.org/)
* [Paper](https://papermc.io/downloads) (recommended)
* Any other forks of the above
* Geyser-Bungee works with:
* [BungeeCord](https://www.spigotmc.org/wiki/bungeecord/)
* [Waterfall](https://papermc.io/downloads#Waterfall)
* Any other forks of the above
* Geyser-Velocity works with [Velocity](https://www.velocitypowered.com/)
* Geyser-Sponge works with [SpongeVanilla or SpongeForge](https://www.spongepowered.org/)
## What server versions does Geyser-Spigot support?
The Geyser-Spigot plugin supports any Minecraft server version 1.12.2 or later. Any earlier version is not supported by the plugin - use a proxy version or the standalone build instead.
## If using BungeeCord or another fork, where do I need to put Geyser/Floodgate?
You only need Geyser and/or Floodgate on the BungeeCord server, as long as not using the Floodgate API. In this case, Floodgate is needed on the "backend" servers as well.
## What IP do I need to give Bedrock players?
Generally, the IP that Bedrock players will join with is your Java IP and the defined port in your Geyser config in the `bedrock` section under `port`. For example, if the IP address Java players join with is `test.geysermc.org`, and the `bedrock` `port` is set as 19132, Bedrock players should join with the IP `test.geysermc.org` and port `19132`.
## How can I have Bedrock players load resource packs?
You can add Bedrock resource packs to your Geyser installation in the `packs` folder of wherever the Geyser config is located. Bedrock clients will automatically download and load those resource packs. There is currently no automatic Java-to-Bedrock resource pack conversion, but you can convert any Java resource pack https://rtm516.github.io/ConvertJavaTextureToBedrock/ and add that to your server.
## How can Bedrock players hold items in their offhand?
You can use the command `/geyser offhand`, which will swap the item in their main hand and offhand. There is also a setting you can enable in the config (`emote-offhand-workaround`) to allow Bedrock players to perform an emote in order to switch their main hand and offhand.
## How do I include players in commands when using Floodgate?
If there is a prefix on Floodgate players, you must include the prefix in the name. Floodgate also replaces all spaces in names with underscores, so be sure to replace any spaces with underscores when executing the command. If this does not work, put double quotes around the name.
Example: `/tp ".<bedrock_username>"`
## How do I add players to the whitelist when using Floodgate?
There are three ways you can do this. The first way is to use Floodgate's built-in whitelist command, `/fwhitelist add .<bedrock_username>`. The second way is to turn off the whitelist using `/whitelist off`, then get the Geyser player to join, then run `/whitelist add ".<bedrock_username>"`, then turn the whitelist back on using `/whitelist on`. (If using this method for a Bedrock account linked to an existing, whitelisted Java account, there is no need to _also_ whitelist the Bedrock account; you may link the accounts then immediately turn the whitelist back on.) The second way is to add the player's UUID as given by Floodgate to the whitelist.json file and then run `/whitelist reload`.
## How do I find a player's UUID without them joining when using Floodgate?
Use [this page.](https://floodgate-uuid.heathmitchell1.repl.co/) If this doesn't work, then try this method:
<br><br>
First, you'll need to get the XUID of the player. There are several third-party websites to find this, for example, [this one](https://cxkes.me/xbox/xuid) (unaffiliated with Geyser). Make sure to choose "Hexidecimal." You'll need to enter the player's Xbox Gamertag, and, once submitted, it should display the XUID in the format of `xxxxxxxxxxxxxxxx`. To turn the XUID into a UUID that Java Edition can recognize, you need to put the XUID in this format: `00000000-0000-0000-xxxx-xxxxxxxxxxxx`. If formatted right, Java Edition should accept it as a UUID.
## Can I remove the prefix of Floodgate players?
While you can remove the prefix, it is generally recommended not to remove the prefix to prevent situations where player usernames are the same on both editions (Ex: Bedrock Username: `JohnDoe`, Java Username: `JohnDoe`). While they have different UUIDs, they have the same username, which may cause conflicts with commands that involve a player name. If you want to remove the prefix to use commands, Try adding quotation marks around the name. Example: `/tp ".<bedrock_username>"` Otherwise, the prefix is located in the Floodgate `config.yml` under `username-prefix:`.
## Do I need Floodgate in order to use Geyser?
No; Floodgate is only required if you wish to allow Bedrock clients to join without authenticating to Java servers. Without the Floodgate plugin, Geyser can either authenticate to Mojang in online mode, or join without authentication in an offline mode server (though this is unsupportable and dangerous as anyone can join your server and is against Mojang's EULA).
## Sometimes, when I go really far out, the world starts to experience very odd visual bugs...
This is a Bedrock client issue caused by Bedrock being 32-bit and Java being 64-bit. For more information read [here](https://minecraft.gamepedia.com/Bedrock_Edition_distance_effects).
## Can I use Geyser to allow Java players to connect to my Bedrock server?
No, this is a translation tool to allow Bedrock players to connect to Java servers. It does not work the opposite way.
## Can I use Geyser with Pterodactyl Panel?
Yes, you can use Geyser as a plugin or a mod for your Minecraft server software running on Pterodactyl. There is also an official egg for the standalone version. It supports auto-updating and has all config options easily editable. You can find it [here](https://github.com/GeyserMC/pterodactyl-stuff), download the JSON egg, and import it into your panel.
## Can I use Geyser with Ngrok?
Unfortunately, Ngrok is TCP-only, so you will not be able to use Geyser with Ngrok. As an alternative, you can use [playit.gg](https://playit.gg), which supports both TCP and UDP.
## Can I connect Geyser to an older server?
If the server has ViaVersion and/or supports the latest Minecraft version, yes. However, we are unable to support older versions of Minecraft due to a limitation in our Java support library.
## Can I connect Geyser to a modded (Forge/Fabric) server?
The short answer: if a vanilla client can join the server, then so can Geyser.
The long answer: currently, there is no way for Geyser to translate the features that most mods add (blocks, items, etc.). Therefore, servers that require mods to be installed clientside are unsupportable through Geyser.
## How can I auto-update Geyser?
[Geyser MC Auto Updater](https://github.com/michaelwatne/geysermcupdater) is an option at this time to auto-update Geyser through the command line. Note that this project is unaffiliated with Geyser.
GeyserUpdater ([GitHub page](https://github.com/YHDiamond/GeyserUpdater)/[Spigot page](https://www.spigotmc.org/resources/geyserupdater.88555/)) is a Spigot/BungeeCord plugin option for auto-updating. Please note that this plugin is also unaffiliated and unsupported by Geyser, and users should redirect support for the plugin to its [Discord](https://discord.gg/U5MC2tcCz9).
## How can I make DiscordSRV show Floodgate 2.0 or GeyserSkinManager skins?
Replace the `AvatarUrl` line in your DiscordSRV config with this: `AvatarUrl: https://mc-heads.net/avatar/{texture}/{size}.png`
Note: you need to be running DiscordSRV v1.22.0 or newer. Floodgate 2.0 or GeyserSkinRestorer is still required for skins to show up for Java players and for this to work.
Alternatively, if you cannot get the above AvatarUrl to work with DiscordSRV, or you'd like to use it with another plugin that does not support texture ids, you can use the [TydiumCraft Skin API.](https://tydiumcraft.net/docs/skinapi)
## Can I use Buycraft (Tebex) with Geyser?
You sure can! Buycraft supports Java & Bedrock players via the Offline store mode **(Recommended to be used with Floodgate)**
**(Currently, Buycraft does not support special symbols like `*` or `-`, so you'll have to change the Floodgate prefix to `_` or remove it entirely.)**
### Steps to create a store to support both versions
- Buycraft-> Create Webstore
- Select Game-> Minecraft Offline
- Continue-> Click "Create my Webstore"
- Name your server & Select currency-> Continue
- Select Game Server-> Continue
- Download the plugin version that best suits your server.
- Execute the secret command from your server's console
Your store is now set up to support Bedrock & Java players.
**(Please note, if you are using a prefix with Floodgate, Bedrock players will have to enter the prefix.)**
## Can I use CraftingStore with Geyser?
As mentioned above, bedrock players must include the prefix in their name.
### Steps to make the store work for Geyser
1. Go to the [admin page](https://craftingstore.net/admin)
2. Expand settings on the left
3. Click webshop
4. Make sure 'Require premium accounts' is Off
5. Then, if you are using floodgate in each package, make sure it uses the player's name in any commands, not their UUID
![](https://i.imgur.com/PM7nNSm.png)
## What languages does Geyser support?
We aim to support any of the bedrock languages; see [here](https://translate.geysermc.org/) for our Crowdin page, and below is a list of all the language codes. We also can add support for more languages, and please request them in the Discord server if you are willing to translate them. (Enabled clientside via https://www.curseforge.com/minecraft/mc-addons/translations-for-minecraft)
### Bedrock languages
|Name |Code |
|----------------------------|-----|
|Bulgarian |bg_bg|
|Czech |cs_cz|
|Danish |da_dk|
|German |de_de|
|Greek |el_gr|
|British English |en_gb|
|American English |en_us|
|Spanish |es_es|
|Mexican Spanish |es_mx|
|Finnish |fi_fi|
|Canadian French |fr_ca|
|French |fr_fr|
|Hungarian |hu_hu|
|Indonesian |id_id|
|Italian |it_it|
|Japanese |ja_jp|
|Korean |ko_kr|
|Dutch |nl_nl|
|Norwegian Bokmål |nb_no|
|Polish |pl_pl|
|Brazilian Portuguese |pt_br|
|Portuguese |pt_pt|
|Russian |ru_ru|
|Slovak |sk_sk|
|Swedish |sv_se|
|Turkish |tr_tr|
|Ukrainian |uk_ua|
|Chinese Simplified (China) |zh_cn|
|Chinese Traditional (Taiwan)|zh_tw|
### Additional languages
|Name |Code |
|----------------------------|-----|
|Afrikaans |af_za|
|Belarusian |be_by|
|Hebrew |he_il|
|Hindi |hi_in|
# Questions not related to gameplay
## What is the relationship between CubeCraft and Geyser?
Redned started Geyser in July 2019. In May 2020, CubeCraft acquired the GeyserMC brand. This means that they govern the project (though at this time, they govern lightly). CubeCraft does not own the code of Geyser.
## Does CubeCraft use Geyser?
No.
+16
View File
@@ -0,0 +1,16 @@
---
layout: page
title: Geyser
permalink: /geyser/Geyser/
---
# Geyser
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?label=License)](LICENSE)
[![Build Status](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.nukkitx.com%2Fjob%2FGeyser%2Fjob%2Fmaster%2F&label=Build)](https://ci.nukkitx.com/job/Geyser/job/master/)
[![Discord](https://img.shields.io/discord/613163671870242838?color=cornflowerblue&label=Discord&logo=Discord&logoColor=white)](https://discord.geysermc.org)
_A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition._
**Currently, supporting Minecraft Bedrock 1.17.30 - 1.17.41 + 1.18 and Minecraft Java 1.18**
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.
+124
View File
@@ -0,0 +1,124 @@
---
layout: page
title: Geyser Setup
permalink: /geyser/GeyserSetup/
---
# Setup
Bedrock clients will join through Geyser and it will handle all the packet translations. There are six different versions of Geyser: Geyser for Spigot (works on derivatives such as Paper), Geyser for BungeeCord (also works on Waterfall), Geyser for Velocity, Geyser for Sponge, Geyser for Fabric (does not support client required mods, and more info about that can be found [here](https://github.com/GeyserMC/Geyser/wiki/Geyser-Fabric)) and Geyser Standalone. The first five versions run as plugins/mods and can be installed directly onto the server. The standalone version can be used in a similar way, except you run it separately.
If you are running a server, it is highly recommended you use one of the plugin versions, and if you want to join a server that does not have Geyser installed, you can run the standalone version. If you use Pterodactyl Panel we have an egg for the standalone version, please see [here](FAQ#can-i-use-geyser-with-pterodactyl-panel) for more information.
If you're still having problems with Geyser not working or giving you an "Unable to connect to world" error, see the [Common Issues](Common-Issues) page.\
For more information, take a look at the [Understanding the Config](Understanding-the-Config) page, and the [FAQ](FAQ) page.\
And if you still have questions, feel free to join the [Discord](https://discord.geysermc.org) if you haven't already.
## Prerequisites
- The server you are connecting to has to support the latest version of Minecraft Java Edition (at this time this is Minecraft 1.18.0)
The server itself does not have to be the latest version but does have to allow connections. If you're running the server on an older version, you can use the plugin [ViaVersion](https://www.spigotmc.org/resources/viaversion.19254/), but do note that only **1.12.2 and any version above is officially supported**.
- The device running Geyser must support Java 16 or later. If you need help installing or updating, please see https://paper.readthedocs.io/en/latest/java-update/index.html. If you're running a version of Paper that does not support Java 16 or later, you can add the flag `-DPaper.ignoreJavaVersion=true` to your startup Java arguments to allow Paper to run on Java 16. You can run Geyser standalone on another device if a server software cannot be updated to use Java 16.
- If you are connecting to an online mode Java server, a paid Java account is required. If you are running the server, you can bypass this requirement for your server with [Floodgate](https://github.com/GeyserMC/Floodgate/wiki).
- Your Bedrock client has to be a supported version - at this time that is Bedrock version 1.17.30 - 1.18.0.
- If you are running the server, you need to have a UDP port opened. See below for more instructions.
## Plugin Setup
1. Download a jar of Geyser from the [build server](https://ci.opencollab.dev/job/Geyser/job/master/) depending on what platform your server runs on. See the [FAQ](FAQ#which-plugin-version-of-geyser-do-i-need) if you're confused about which build to download.
2. Put the Geyser jar file in your plugins folder and start up the server.
3. If you are on a hosting provider, you will likely need to change your Bedrock port in `config.yml`. Information on your hosting provider might be available on the [Supported Hosting Providers](https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers) page.
4. Restart your server if you edited your config.
5. If not using a hosting provider you will need to use port forwarding to allow people out of your LAN to connect. You want to port forward 19132 UDP, instructions to do that for most routers can be found [here](https://www.lifewire.com/how-to-port-forward-4163829).
If you are trying to join from the same LAN, the server should show up in the friends tab.
### BungeeCord/Velocity Setup
If you are using a BungeeCord, Waterfall, or Velocity proxy, then you only need to install Geyser (and Floodgate, if you desire) on the proxy.
You can install Floodgate (but not Geyser) on the back-end servers to improve skin functionality and to let other plugins access the Floodgate API. If you do this, then you _must_ make sure that the same `key.pem` file is used between all instances of Floodgate; otherwise, Bedrock clients will not be able to join. Full instructions can be found on the [Floodgate Wiki](https://github.com/GeyserMC/Floodgate/wiki/Setup-and-Usage).
The Bedrock clients, like Java clients, should connect to the proxy server, and should never directly connect to a back-end server. You don't need to (and shouldn't) port-forward anything for the back-end servers!
## Standalone Setup
Please keep in mind, you need some sort of computer or host to run Geyser Standalone on. Applications such as Termux on Android are capable of running Geyser, but this largely depends on how powerful your Android device is. Please do so at your own risk. Instructions to run Geyser on Termux can be found [here](GeyserSetup#termux-android).
1. Download a jar of Geyser from the [build server](https://ci.opencollab.dev/job/Geyser/job/master/).
2. Create a new folder for Geyser, and drop the jar in there.
### GUI Setup (Recommended)
3. Double-click the jar file and all the necessary files for Geyser will be created.
4. Configure options such as the server you want to join in the Geyser config. A description of all options of the config can be found on the [Understanding the Config](https://github.com/GeyserMC/Geyser/wiki/Understanding-the-Config) page.
5. Stop the current instance of Geyser and re-run it.
### Console Setup
3. Create a new bat or startup script, similar to the one you'd use for a Spigot or Paper server, and take a look at [this](Creating-a-Startup-Script) page for what to put into it.
4. Run the startup script/bat, and all the necessary files for Geyser will be created.
5. Configure options such as the server you want to join in the Geyser config. A description of all options of the config can be found on the [Understanding the Config](https://github.com/GeyserMC/Geyser/wiki/Understanding-the-Config) page.
6. Stop the current instance of Geyser and re-run it.
Once you're done, open up Minecraft: Bedrock Edition and in the **Friends** tab, Geyser should show up there. If it does not show up, just add the Java IPv4 address and Bedrock port.
### Standalone Setup (Geyser and Floodgate are not on the same server)
If you want to offload Geyser's processing you can host Geyser (Standalone) somewhere else and make it redirect to your server.
**Warning:** Do not forget to edit the remote section of your Geyser config.
See the [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) wiki page for more details.
## Port Forwarding
Unlike Minecraft Java Edition, Bedrock Edition runs on port 19132 on the UDP protocol. When port forwarding, make sure to allocate to 19132 UDP or another UDP port. For many server hosting providers, you will simply need to change your Bedrock listening port (see [here](https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers) for a list of supported providers).
## Termux (Android)
Please read the disclaimer [here](GeyserSetup#standalone-setup) before continuing.
1. Download and install [Termux](https://termux.com/)
2. Run `pkg install openjdk-17`
3. Run `wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/target/Geyser.jar`
4. Run `java -jar Geyser.jar`
OR
We have an automated setup script for clean Termux installs, which might not work for all users. If the manual guide above does not work, try this.
Run this to start the download/install:
```
curl https://gist.githubusercontent.com/rtm516/e3e07d6595ee41e05a38b03c0f4d7a80/raw/install.sh | bash
```
## NewTerm 2 (iOS)
**Note:** A jailbreak is required. You can find what jailbreak to use for your device [here](https://docs.google.com/spreadsheets/d/11DABHIIqwYQKj1L83AK9ywk_hYMjEkcaxpIg6phbTf0/edit?usp=sharing).
1. Install [Filza File Manager](http://cydia.saurik.com/package/com.tigisoftware.filza/).
2. Install [NewTerm 2](https://chariz.com/get/newterm).
4. Download jre-16 for iOS and install it using Filza [here](https://github.com/PojavLauncherTeam/PojavLauncher_iOS/releases/download/v16-openjdk/openjdk-16-jre_16.0.0+git20201217.8383f41-2_iphoneos-arm.deb).
3. Download my modified java commands, and install it using Filza [here](https://cdn.discordapp.com/attachments/558829512633090048/834014323755319306/com.letschill.java_0.1_iphoneos-arm.deb).
4. Open NewTerm 2 and run `wget https://ci.opencollab.dev/job/GeyserMC/job/Geyser/job/master/lastSuccessfulBuild/artifact/bootstrap/standalone/target/Geyser.jar`.
5. Run `java -jar Geyser.jar`.
6. You can find Geyser server running in MCPE!
**Note:**
Due to iOS's 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.
You may encounter some issues. If you do, run `su` then enter the root password (default is `alpine`) for root access. Then, run the server like you normally would, and it should work just fine.
## Setup Videos
Setup tutorials in a variety of languages.
### English
**Connect to Java servers from Bedrock Edition! | GeyserMC Proxy Tutorial by [raimuakuna](https://www.youtube.com/channel/UCIMZsNCD_-prDETwRypAqmQ)**
[![YouTube Video](https://img.youtube.com/vi/7rwfScY66Jc/0.jpg)](https://www.youtube.com/watch?v=7rwfScY66Jc)
**How to play Java Servers in Minecraft Bedrock! by [PatarHD](https://www.youtube.com/channel/UCpowCAl4XV_hTQSYQpMWF6A)**
[![YouTube Video](https://img.youtube.com/vi/IHg_ts3MgLY/0.jpg)](https://www.youtube.com/watch?v=IHg_ts3MgLY)
**How to connect Bedrock players to Java servers Part One.** by [Casper](https://www.youtube.com/channel/UCHL0K3bOH0o7YoO5T-2_MzA)
[![YouTube Video](https://img.youtube.com/vi/DHZHM1RBtfQ/0.jpg)](https://www.youtube.com/watch?v=DHZHM1RBtfQ)
**How To Add Crossplay to Your Minecraft Server (Geyser Setup Guide).** by [The Breakdown](https://www.youtube.com/channel/UC6Ec5NXzcESo60F3UgtgQRA)
[![YouTube Video](https://i.ytimg.com/vi/2HwqbDHWwu8/hqdefault.jpg)](https://youtu.be/2HwqbDHWwu8)
### Russian
**ЗАШЕЛ НА ХАЙПИКСЕЛЬ С МКПЕ? ЧИТЕРСКИЙ КОНФИГ!** by [TOWUK](https://www.youtube.com/channel/UCK8v-rGsfCOkpbi0slIpAng)
[![YouTube Video](https://img.youtube.com/vi/KcZZp05EfVQ/0.jpg)](https://www.youtube.com/watch?v=KcZZp05EfVQ)
@@ -0,0 +1,30 @@
---
layout: page
title: Standalone Command Line Arguments
permalink: /geyser/Standalone-Command-Line-Arguments/
---
# General command-line arguments
### `--config [file]`
**Alias: `-c`**
Points to an alternative config file to use.
### `--gui` / `--nogui`
**Alias: `gui` / `nogui`**
Forces GUI or non-GUI usage, depending on context.
# Overriding specific config values
Overriding a standard config option (e.g. `command-suggestions`):
`--command-suggestions=false`
Overriding a nested config option(e.g. the `remote` section with `address`):
`--remote.address=test.geysermc.org`
+108
View File
@@ -0,0 +1,108 @@
---
layout: page
title: Supported Hosting Providers
permalink: /geyser/Supported-Hosting-Providers/
---
This list is incomplete. Please add a link or contact us on Discord if the information is incorrect or you want to add a new hosting provider!
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.
**Warning: The below information is for the plugin versions of Geyser unless otherwise specified**
## Built-in Geyser
* [Aternos](https://aternos.org/) (Select as a plugin in the Aternos plugin list and connect to your server with your Java IP and port. See [Aternos's article](https://support.aternos.org/hc/en-us/articles/360051047631) for more details.)
* [CreeperHost](https://www.creeperhost.net/) (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.)
* [exaroton](https://exaroton.com/) (Select as a plugin in the exaroton plugin list and connect to your server with your Java IP and port. See [exaroton's article](https://support.exaroton.com/hc/en-us/articles/360019857918-Geyser) for more details.)
* [FreeMcServer.net](https://freemcserver.net) (Can be selected from the reinstall tab of the control panel.)
* [GGServers](https://ggservers.com) (Can easily be installed to any server in just one click from their auto plugin setups. No configuration needed.)
* [MCProHosting](https://mcprohosting.com/) (Geyser-Spigot only: Click "Enable Bedrock Support" on the server dashboard and follow the steps. For other versions: Add Destination Port 19132 with Protocol UDP to the [port forward mapping](https://mcprohosting.com/billing/knowledgebase/379/Firewall-and-Port-Management.html) and connect to the given source port.)
* [Minehut](https://minehut.com/) (Connect via `bedrock.minehut.com` and do `/join <servername>`.)
* [OMGServ](https://www.omgserv.com/en/) (Select Geyser in [Install Menu](https://i.imgur.com/Gewpsrq.png), all is automatically installed. You can turn on/off floodgate in [server properties on the dashboard](https://i.imgur.com/jg5mzNj.png).)
* [PloudOS](https://ploudos.com/) (Connect via `geyser.ploudos.com` and enter the with your Java IP and port. See [PloudOS's article](https://ploudos.com/faq/#How-do-I-connect-from-Bedrock-to-a-Java-server) for more details.)
* [Pufferfish Host](https://pufferfish.host/) (Geyser is installed and configured on all servers by default.)
* [SoulNode](https://soulnode.net/) (Select [Plugin Pack](https://i.imgur.com/7e2QEKV.png) at checkout to auto-install Geyser. No extra setup required. Will auto bind to your default port to connect.)
* [SRKHOST](https://www.srkhost.eu/) (You can enable Geyser at the Version changer page. This feature is built-in and uses the given port by the host.)
* [Virtual Gladiators](https://virtualgladiators.com/) (Find the plugin in the control panel under the "VG Recommended" category and restart your server. IP and port are the same as Java.)
* [ZapHosting](https://zap-hosting.com/en/) (Find the plugin in the control panel and restart your server. IP and port is the same as Java.)
* [365Hosts](https://365hosts.com) (Go to their [Minecraft: Crossplay](https://www.365hosts.com/gaming/crossplayminecraft) hosting section and simply order your server. Instructions on how to join are provided.)
## Support for Geyser
* [Akliz](https://www.akliz.net/) (Get Geyser as a plugin. They should have a port forwarding option that works.)
* [Apex Hosting](https://apexminecrafthosting.com/) (Get Geyser as a plugin. Need to set the Bedrock address in the config on the Java IP, default port may not work.)
* [Aquatis](https://aquatis.host/) (Get Geyser as a plugin. Need to open a support ticket to get UDP ports and then update the config to reflect your new Bedrock port.)
* [Azure](https://azure.microsoft.com/) (Get Geyser as a plugin. Not a dedicated Minecraft service provider.)
* [BisectHosting](https://www.bisecthosting.com/) (Get Geyser as a plugin. Need to ask to open a UDP port, and set the Bedrock address in the config to the Java IP. To open a UDP port, you need to have a dedicated IP.)
* [Bloom.Host](https://www.bloom.host/) (Get Geyser as a plugin. They have a port forwarding option that works.)
* [Clovux](https://clovux.net/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port. Make sure your remote address is 'auto' and your bedrock address is your server IP.)
* [Consulhosting](https://consulhosting.nl/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Craft-Hosting](https://craft-hosting.ru/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port; note that this provider appears to only provide service in Russia.)
* [CubedHost](https://cubedhost.com/) (Get Geyser a plugin. Use the same address as your Java server for the Bedrock address in your config. See [here](https://cubedhost.com/help/en/articles/4632618-how-can-bedrock-players-join-my-java-edition-server) for specific instructions.)
* [Dashflo.net](https://dashflo.net/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port, or buy a dedicated IP address to support a different port.)
* [DedicatedMC](https://dedicatedmc.io/) (Get Geyser as a plugin. Need to ask to open the default bedrock port.)
* [ExtraVM](https://extravm.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port. Make sure your remote address and your bedrock address is your server IP.)
* [FadeHost](https://fadehost.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port or buy a dedicated IP address to support a different port.)
* [FakaHeda](https://fakaheda.eu/) (Get Geyser as a plugin. Use the same port as your Java server or use one of the available ports allocated for your server, for the Bedrock port in your config and connect with that port.)
* [FalixNodes](https://falixnodes.net/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Ferox Hosting](https://feroxhosting.nl) (Get Geyser as a plugin. Open a port yourself in our panel and check out the [knowledgebase](https://kb.FeroxHosting.nl) for how to install and configure the plugin.)
* [Fluctis Hosting](https://fluctishosting.com) (Get the Geyser plugin. Use the same port as your Java Server for the Bedrock port in your config and connect with that port.)
* [FreeMC.Host](https://freemc.host/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [FreeMcServer.net](https://freemcserver.net) Get Geyser as a plugin. (Create a UDP port in the ports tab then type it in your config and connect with that port.)
* [Futurehosting](https://futurehosting.org/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port. Make sure your `bedrock` `address` in your Geyser config is your server IP.)
* [GameHosting.it](https://www.gamehosting.it/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Google Cloud](https://cloud.google.com/) (Not a dedicated Minecraft provider)
- 90 day/$300 free trial
- [Tutorial for a Minecraft server Google Cloud](https://cloud.google.com/solutions/gaming/minecraft-server)
- Note: You'll need to also allow port 19132 on UDP, use Paper instead of vanilla, and put Geyser in the plugins folder
- You also don't need an SSD, they're just trying to make you pay more
* [Heavynode](https://www.heavynode.com/) (Get Geyser as a plugin. Use default port and 0.0.0.0 as the address. 19132 is blocked for DDOS reasons so your best bet is to use the same port as your Java server for the Bedrock port in your config and connect with that port. Also, see [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-%22Unable-to-Connect-to-World%22#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server))
* [Hetzner](https://hetzner.com) (Not a dedicated Minecraft provider.)
* [Hicoria](https://hicoria.com/en/) (Get Geyser as a plugin. Use the one of the available ports allocated for your server, for the Bedrock port in your config and connect with that port.)
* [HostMC4Free](https://hostmc4free.com) (Order new service, choose Geyser in Bedrock section, and open a ticket to request a second port all ports support UDP)
* [HostValues](https://hostvalues.net/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [HumbleServers](https://humbleservers.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config, or one of the two extra ports, and connect with that port. If the subdomain doesn't work, use your regular IP address with numbers.)
* [Hexit](https://client.hexit.cc/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [KolakZ Network](https://kolakz.com/) (Get Geyser as a plugin. Need to ask to open the default bedrock port.)
* [MC-HOST24.de](https://mc-host24.de/) (Get Geyser as a plugin. Use the same address as your Java server for the Bedrock address in your config.)
* [Meloncube](https://www.meloncube.net/) (Get Geyser as a plugin. Need to ask to open a UDP port.)
* [MineStrator](https://minestrator.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Minecraft-Hosting.pro](https://www.minecraft-hosting.pro/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Minehub](https://minehub.de/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port, or buy a dedicated IP address to support a different port.)
* [NFOservers](https://nfoservers.com/) (Get Geyser as a plugin. Make sure your remote address and your bedrock address are your server IP in the Geyser config file. As an alternative, you can run Geyser standalone separately on an Unmanaged VDS.)
* [NiCraft](https://www.ni-host.com/)
- Use the same port as your Java server for the Bedrock port in your config and connect with that port.
- See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-%22Unable-to-Connect-to-World%22#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server).
- So if your players encounter this issue, please ask them to try to connect (even if they don't have Minecraft) from Java Edition first while their Bedrock client is opened, and after they should be able to join on Bedrock Edition.
* [Nitrado](https://nitrado.net) (Get Geyser as a plugin. Add 4 to the Port of the Java server. See [here](https://wiki.nitrado.net/en/How_to_install_GeyserMC_and_Floodgate) for specific instructions.)
* [NightNodes](https://nightnodes.host/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Nodecraft](https://nodecraft.com) (Get Geyser as a plugin. Use the default server port and 0.0.0.0 or your server IP as the host address.)
* [OVH](https://www.ovh.com/) (See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-'Unable-to-Connect-to-World'#issues-connecting-with-ovh-or-a-subsidiary).)
* [Pebblehost](https://pebblehost.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port. See [this video](https://youtu.be/v9lC80UBZF4) for a PebbleHost-specific tutorial.)
* [PhoenixNodes](https://phoenixnodes.com) (Get Geyser as a plugin. Open a ticket to request an additional port for Geyser.)
* [PlanetNode](https://planetnode.net) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [RamShard](https://ramshard.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Revivenode](https://revivenode.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [ScalaCube](https://scalacube.com/) (Get Geyser as a plugin. Use the same address and port as your Java server for the Bedrock address and port in your config and connect with that port.)
* [Server.pro](https://server.pro) (Get Geyser as a plugin. If you are using a Premium or Free plan, use the same port as your Java server for the Bedrock port in the configuration file and connect with that same port; for the Free plan, also enable the `clone-remote-port` option; leave the IP values as default (`0.0.0.0` and `auto`). If you are using a Pro or VPS plan, you can use any port you'd like and it's recommended to leave it to the default or `19132`.)
* [Shockbyte](https://shockbyte.com/) (Use the same port as your Java server for the Bedrock address and port in your config and connect with that port. You can also see standalone installation instructions [here](https://shockbyte.com/billing/knowledgebase/173/Introduction-to-GeyserMCorDragonProxy-How-GeyserMC-Works.html).)
* [Skynode.pro](https://skynode.pro/) (Get Geyser as a plugin. Go to "Server Details", add a new port, and change the port in your config. Connect with that, using the address from your main port.)
* [SoYouStart](https://www.soyoustart.com) (See [here](https://github.com/GeyserMC/Geyser/wiki/Fixing-'Unable-to-Connect-to-World'#bedrock-players-can-connect-after-hitting-the-server-on-a-tcp-port-eg-on-java-or-a-website-on-the-same-server).)
* [Sparked Host](https://sparkedhost.com) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [SpawnMC](https://spawnmc.net/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port; note that this provider only provides service in China.)
* [STIPE](https://stipe.com.au/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port; note that this provider only provides service in Australia.)
* [SyntexHosting](https://syntexhosting.com/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in the config and connect with that port, or request a (free) additional port for your bedrock clients.)
* [The Minecraft Hosting](https://theminecrafthosting.com/) (Get Geyser as a plugin. 19132 should work as a Bedrock port, if not use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Titan Nodes](https://titannodes.com/) (Get Geyser as a plugin. Use the Default server port and 0.0.0.0 as the host address.)
* [TNAHosting](https://tnahosting.net/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [TurboHost](https://turbohost.nl/) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port.)
* [Vultam](https://vultam.net/) (Get Geyser as a plugin. Use the same port as your Java server and 0.0.0.0 as the address for Bedrock, or request an additional port. The additional port can be 19132 if you buy a dedicated IP.)
* [WinterNode](https://winternode.com) (Get Geyser as a plugin. Use the same port as your Java server for the Bedrock port in your config and connect with that port, request an additional port, or buy a dedicated IP address.)
* [WitherHosting](https://witherhosting.com/) (Get Geyser as a plugin. Put the port provided by the host in your config.yml for the Java and bedrock sections, or create a port in the ports manager on the panel and use that for bedrock with the main one for Java, and you will be able to connect! Refer to the hosts [support article](https://support.witherhosting.com/en/article/how-to-install-and-use-geysermc-1xn5l6v/) for more)
## Does not support Geyser
* [MCPEhost](https://mcpehost.ru/)
* [MyArena](https://www.myarena.ru/) (Does seem to be working, but the Java version is too old in order for Geyser to run properly.)
---
**Warning: Using a *”Free Host”* may not give you the best experience *at all*. If you want better support, more freedom to control your server, and learn how to run one, PLEASE pay for a server.**
+323
View File
@@ -0,0 +1,323 @@
---
layout: page
title: Understanding the Config
permalink: /geyser/Understanding-the-Config/
---
This page covers basic information about the Geyser config and what each option does. Though they are explained in the configuration itself, this explains what each option does in more detail.
## Bedrock Section
The options for Geyser on the bedrock-facing end. Mostly contains options for how bedrock edition will see the server.
**`address`**: The address of Geyser on the bedrock end. In most all scenarios, this should not need to be changed.
**`port`**: The port Geyser will run on. By default, it is 19132 in bedrock.
**`clone-remote-port`**: Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock/UDP connections. This option makes the Bedrock port the same as the Java port every time you start the server. This option does not do anything on the Standalone version of Geyser.
**`motd1`**: The first line of the MOTD for Geyser.
**`motd2`**: The second line of the MOTD for Geyser. **Please keep in mind, this option will only work if Geyser is shown in the Friends tab!**
**`server-name`**: The world name that is shown in the top-right area of the pause screen.
**`compression-level`**: An number value that represents how much to compress outgoing traffic. Can be any number from -1 to 9; any other value will be replaced with the nearest acceptable value. The higher the number, the more CPU processing that is used but with less bandwidth used.
## Remote Section
Options for the remote (java) server.
**`address`**: The address of the Minecraft: Java Edition server you want to join. By default, this value is `auto`. By keeping it as `auto`, the address, port, and Floodgate support will be automatically configured. In standalone, keeping this as `auto` sets the remote address to 127.0.0.1.
**`port`**: The port of the Minecraft: Java Edition server you specified in the `address` section.
**`auth-type`**: The authentication type of the Minecraft: Java Edition server. Valid options are `online`, `offline`, and `floodgate`.
**Please keep in mind, what you specify in the Geyser `auth-type` option MUST be the same as what the remote server has (with the exception of Geyser being in online mode and remote being in offline mode). You simply cannot join an online mode server without a genuine account. If you want to allow Minecraft: Bedrock Edition accounts to join without a Minecraft: Java Edition account, see the [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) wiki page.**
**`use-proxy-protocol`**: Whether to enable PROXY/HAProxy protocol or not while connecting to the server. This is useful only when:
- Your server supports PROXY protocol (it probably doesn't)
- You run Velocity or BungeeCord with its respective option enabled.
**`forward-hostname`**: Forwards the hostname/IP address that the Bedrock client used to connect over to the Java server. This is designed to be used for forced hosts on proxies.
## General Options
General Geyser options that are mostly specific to Geyser itself.
**`floodgate-key-file`**: The key file path for Floodgate. Requires that you have [Floodgate](https://github.com/GeyserMC/Floodgate/wiki/) installed and the `auth-type` set to `floodgate`.
**`userAuths`**: A section where you can put the authentication information for your Minecraft: Java Edition account for immediate login when joining Geyser. **It is advised you ONLY use this option if you are running Geyser locally and that ONLY you have access to the config as it requires you put your Minecraft: Java Edition credentials in plain text!**
If your Xbox account name was Notch, your Java email was `foobar2000@gmail.com` and your password was `hunter2`, you would fill this into the config:
```
userAuths:
Notch: # MCPE/Xbox username
email: foobar2000@gmail.com
password: "hunter2"
microsoft-account: true
```
Put two spaces before the username and four spaces before the email and password.
**`command-suggestions`**: Bedrock clients freeze or crash when opening up the command prompt for the first time with a large amount of command suggestions. This config option disables command suggestions being sent to prevent any freezing. **Since 1.16.100:** command freezing and crashing has been largely reduced; you may no longer need this option disabled.
**`passthrough-motd`**: If the MOTD should be relayed from the remote server. Causes the `motd1` and `motd2` options in the bedrock section to no longer have a use.
**`passthrough-protocol-name`**: Relay the protocol name (e.g. BungeeCord [X.X], Paper 1.X) - this is only really useful when using a custom protocol name! This will also show up on sites like MCSrvStatus. <mcsrvstat.us>
**`passthrough-players`**: If the current and max player counts should be relayed from the remote server.
**`legacy-ping-passthrough`**: If enabled, manually pings the server by impersonating a Minecraft client instead of using the server's API. **This option should *only* be enabled if your MOTD or player count is not accurate,** as it can cause errors especially on BungeeCord. This option does nothing on standalone.
**`ping-passthrough-interval`**: How often the fake Minecraft client should attempt to ping the remote server to update information, in seconds (a setting of 1 will ping the server every second; a setting of 3 will ping the server every three seconds). Only relevant for standalone and legacy ping passthrough. Increase the number if you're getting timeout or BrokenPipe exceptions.
**`max-players`**: The maximum amount of players shown when pinging the server. This does not actually cap how many players can join the Geyser instance at this time. The number will visually increase when pinging if the amount of players is greater, as Bedrock clients will not even attempt to join a full server.
**`debug-mode`**: If debug messages should be printed in console. Useful if you run into an error and need more context.
**`general-thread-pool`**: The amount of threads Geyser will be able to use. Higher is not always better :P.
**`allow-third-party-capes`**: If third party (Optifine, 5zig, LabyMod, etc.) capes should be displayed to the bedrock player.
**`allow-third-party-ears`**: If third party Deadmau5-style ears should be enabled. Currently only supports MinecraftCapes.
**`show-cooldown`**: Bedrock Edition currently does not have Java Edition 1.9+ combat mechanics. In order to get around this, Geyser sends a fake cooldown by sending a title message. This cooldown should not show if 1.8 combat mechanics are in use. The options available for this setting are `false` (no cooldown is sent), `title`/`true` (a cooldown indication is shown in the title), or `actionbar` (a cooldown indication is shown in the action bar). All other options default to `false`.
**`show-coordinates`**: Bedrock Edition has an option to show coordinates in the top-left part of your screen. This setting enables or disables this.
**`emote-offhand-workaround`**: Since Java Edition 1.9, clients have had the ability to switch the item in their mainhand and offhand with a keybind. Bedrock Edition does not have this ability, so this config option makes up for it, If set, when a Bedrock player performs any emote, it will swap the offhand and mainhand items, just like the Java Edition keybind. There are three options this can be set to:
- `disabled` - the default/fallback, which doesn't apply this workaround
- `no-emotes` - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen.
- `emotes-and-offhand` - emotes will be sent to Bedrock clients and offhand will be swapped
**`default-locale`**: The default locale to send to players if their locale could not be found. Check [this](https://github.com/GeyserMC/Geyser/wiki/FAQ#what-languages-does-geyser-support) page to find the code corresponding to your language.
**`chunk-caching`**: Cache chunks for each Bedrock player, adds support for additional sounds and fixing movement issues at the expense of slightly more RAM usage. This option is always on for Spigot as we can use the server's API to get block information at no expense. *Geyser does not recommend disabling this option.*
**`cache-images`**: Specify how many days images will be cached to disk to save downloading them from the internet. A value of 0 is disabled. (Default: 0)
**`allow-custom-skulls`**: Allows custom skulls to be displayed when placed. Keeping them enabled may cause a performance decrease on older/weaker devices.
**`above-nether-bedrock-building`**: Bedrock prevents building and displaying blocks above Y127 in the Nether - enabling this config option works around that by changing the Nether dimension ID to the End ID. The main downside to this is that the sky will resemble that of the End sky in the Nether, but ultimately it's the only way for this feature to work.
**`force-resource-packs`**: Force clients to load all resource packs if there are any. If set to false, it allows the user to disconnect from the server if they don't want to download the resource packs.
**`xbox-achievements-enabled`**: Allows Xbox achievements to be unlocked. **This disables certain commands so the Bedrock client can't "cheat" to get them; this cannot be worked around if you want to enable this**. Commands such as /gamemode and /give will not work from Bedrock with this enabled.
## Advanced Options
**`scoreboard-packet-threshold`**: Geyser updates the Scoreboard after every Scoreboard packet, but when Geyser tries to handle a lot of scoreboard packets per second can cause serious lag. This option allows you to specify after how many Scoreboard packets per seconds the Scoreboard updates will be then limited to four updates per second.
**`enable-proxy-connections`**: Allow connections from ProxyPass and Waterdog. See https://www.spigotmc.org/wiki/firewall-guide/ for assistance - use UDP instead of TCP. **This option does not need to be enabled in instances like BungeeCord or Velocity**.
**`mtu`**: https://en.wikipedia.org/wiki/Maximum_transmission_unit - The internet supports a maximum MTU of 1492 but could cause issues with packet fragmentation. 1400 is the default.
**`use-direct-connection`**: Whether to connect directly into the Java server without creating a TCP connection. This should only be disabled if a plugin that interfaces with packets or the network does not work correctly with Geyser. If enabled on plugin versions, the remote address and port sections are ignored. If disabled on plugin versions, expect performance decrease and latency increase.
Default Geyser Config:
```yml
# --------------------------------
# Geyser Configuration File
#
# A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition.
#
# GitHub: https://github.com/GeyserMC/Geyser
# Discord: https://discord.geysermc.org/
# --------------------------------
bedrock:
# The IP address that will listen for connections.
# There is no reason to change this unless you want to limit what IPs can connect to your server.
address: 0.0.0.0
# The port that will listen for connections
port: 19132
# Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock.
# This option makes the Bedrock port the same as the Java port every time you start the server.
# This option is for the plugin version only.
clone-remote-port: false
# The MOTD that will be broadcasted to Minecraft: Bedrock Edition clients. This is irrelevant if "passthrough-motd" is set to true
# If either of these are empty, the respective string will default to "Geyser"
motd1: "Geyser"
motd2: "Another Geyser server."
# The Server Name that will be sent to Minecraft: Bedrock Edition clients. This is visible in both the pause menu and the settings menu.
server-name: "Geyser"
# How much to compress network traffic to the Bedrock client. The higher the number, the more CPU usage used, but
# the smaller the bandwidth used. Does not have any effect below -1 or above 9. Set to -1 to disable.
compression-level: 6
# 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.
enable-proxy-protocol: false
# A list of allowed PROXY protocol speaking proxy IP addresses/subnets. Only effective when "enable-proxy-protocol" is enabled, and
# 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.
#proxy-protocol-whitelisted-ips: [ "127.0.0.1", "172.18.0.0/16" ]
remote:
# The IP address of the remote (Java Edition) server
# If it is "auto", for standalone version the remote address will be set to 127.0.0.1,
# for plugin versions, it is recommended to keep this as "auto" so Geyser will automatically configure address, port, and auth-type.
address: auto
# The port of the remote (Java Edition) server
# For plugin versions, if address has been set to "auto", the port will also follow the server's listening port.
port: 25565
# Authentication type. Can be offline, online, or floodgate (see https://github.com/GeyserMC/Geyser/wiki/Floodgate).
# For plugin versions, it's recommended to keep the `address` field to "auto" so Floodgate support is automatically configured.
auth-type: online
# Allow for password-based authentication methods through Geyser. Only useful in online mode.
# If this is false, users must authenticate to Microsoft using a code provided by Geyser on their desktop.
allow-password-authentication: true
# Whether to enable PROXY protocol or not while connecting to the server.
# This is useful only when:
# 1) Your server supports PROXY protocol (it probably doesn't)
# 2) You run Velocity or BungeeCord with the option enabled in the proxy's main config.
# IF YOU DON'T KNOW WHAT THIS IS, DON'T TOUCH IT!
use-proxy-protocol: false
# Forward the hostname that the Bedrock client used to connect over to the Java server
# This is designed to be used for forced hosts on proxies
forward-hostname: false
# Allows the overworld world height to be extended from 0 - 255 to -64 - 319. This option cannot be changed during a reload.
# 1.17.0-1.17.2 Bedrock clients cannot connect with this option enabled.
# Performance issues and/or additional bugs may occur for Bedrock clients as this is an experimental toggle on their end.
extended-world-height: false
# 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.
floodgate-key-file: key.pem
# The Xbox/Minecraft Bedrock username is the key for the Java server auth-info.
# This allows automatic configuration/login to the remote Java server.
# If you are brave enough to put your Mojang account info into a config file.
# Uncomment the lines below to enable this feature.
#userAuths:
# BedrockAccountUsername: # Your Minecraft: Bedrock Edition username
# email: javaccountemail@example.com # Your Minecraft: Java Edition email
# password: javaccountpassword123 # Your Minecraft: Java Edition password
# microsoft-account: true # Whether the account is a Mojang or Microsoft account.
#
# bluerkelp2:
# email: not_really_my_email_address_mr_minecrafter53267@gmail.com
# password: "this isn't really my password"
# microsoft-account: false
# Bedrock clients can freeze when opening up the command prompt for the first time if given a lot of commands.
# Disabling this will prevent command suggestions from being sent and solve freezing for Bedrock clients.
command-suggestions: true
# The following three options enable "ping passthrough" - the MOTD, player count and/or protocol name gets retrieved from the Java server.
# Relay the MOTD from the remote server to Bedrock players.
passthrough-motd: false
# Relay the protocol name (e.g. BungeeCord [X.X], Paper 1.X) - only really useful when using a custom protocol name!
# This will also show up on sites like MCSrvStatus. <mcsrvstat.us>
passthrough-protocol-name: false
# Relay the player count and max players from the remote server to Bedrock players.
passthrough-player-counts: false
# Enable LEGACY ping passthrough. There is no need to enable this unless your MOTD or player count does not appear properly.
# This option does nothing on standalone.
legacy-ping-passthrough: false
# How often to ping the remote server, in seconds. Only relevant for standalone or legacy ping passthrough.
# Increase if you are getting BrokenPipe errors.
ping-passthrough-interval: 3
# 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.
forward-player-ping: false
# Maximum amount of players that can connect. This is only visual at this time and does not actually limit player count.
max-players: 100
# If debug messages should be sent through console
debug-mode: false
# Thread pool size
general-thread-pool: 32
# Allow third party capes to be visible. Currently allowing:
# OptiFine capes, LabyMod capes, 5Zig capes and MinecraftCapes
allow-third-party-capes: true
# Allow third party deadmau5 ears to be visible. Currently allowing:
# MinecraftCapes
allow-third-party-ears: false
# Allow a fake cooldown indicator to be sent. Bedrock players do not see a cooldown as they still use 1.8 combat
# Can be title, actionbar or false
show-cooldown: title
# Controls if coordinates are shown to players.
show-coordinates: true
# If set, when a Bedrock player performs any emote, it will swap the offhand and mainhand items, just like the Java Edition keybind
# There are three options this can be set to:
# disabled - the default/fallback, which doesn't apply this workaround
# no-emotes - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen.
# emotes-and-offhand - emotes will be sent to Bedrock clients and offhand will be swapped
emote-offhand-workaround: "disabled"
# The default locale if we dont have the one the client requested. Uncomment to not use the default system language.
# default-locale: en_us
# 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)
cache-images: 0
# Allows custom skulls to be displayed. Keeping them enabled may cause a performance decrease on older/weaker devices.
allow-custom-skulls: true
# 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.
add-non-bedrock-items: true
# 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.
above-bedrock-nether-building: false
# Force clients to load all resource packs if there are any.
# If set to false, it allows the user to connect to the server even if they don't
# want to download the resource packs.
force-resource-packs: true
# Allows Xbox achievements to be unlocked.
# THIS DISABLES ALL COMMANDS FROM SUCCESSFULLY RUNNING FOR BEDROCK IN-GAME, as otherwise Bedrock thinks you are cheating.
xbox-achievements-enabled: false
# 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 here: https://bstats.org/.
# https://bstats.org/plugin/server-implementation/GeyserMC
metrics:
# If metrics should be enabled
enabled: true
# UUID of server, don't change!
uuid: generateduuid
# ADVANCED OPTIONS - DO NOT TOUCH UNLESS YOU KNOW WHAT YOU ARE DOING!
# 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 limited to four updates per second.
scoreboard-packet-threshold: 20
# Allow connections from ProxyPass and Waterdog.
# See https://www.spigotmc.org/wiki/firewall-guide/ for assistance - use UDP instead of TCP.
enable-proxy-connections: false
# The internet supports a maximum MTU of 1492 but could cause issues with packet fragmentation.
# 1400 is the default.
# mtu: 1400
# 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
use-direct-connection: true
config-version: 4
```
@@ -0,0 +1,66 @@
---
layout: page
title: Using geyser or floodgate as a dependency
permalink: /geyser/Using-Geyser-or-Floodgate-as-a-dependency/
---
To start, add the Open Collaboration repository to your project:
```xml
<repository>
<id>opencollab-snapshot-repo</id>
<url>https://repo.opencollab.dev/maven-snapshots/</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
```
## Using Geyser
*Please note: this information will be updated with a new API at a later point, but the old API structure will continue to work.*
Add Geyser's common codebase as a dependency:
```xml
<dependency>
<groupId>org.geysermc</groupId>
<artifactId>core</artifactId>
<version>2.0.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
To get a Geyser player, or check if a player is from Bedrock:
```java
GeyserSession session = GeyserConnector.getInstance().getPlayerByUuid(uuid);
```
`session` can be null if such a player does not exist on Geyser.
`GeyserConnector.getInstance()` will be null until after the Geyser plugin enables.
## Using Floodgate
This page has a very simple primer for the Floodgate API. For a full breakdown, see [here](https://github.com/GeyserMC/Floodgate/wiki/FloodgateApi).
Add Floodgate's API as a dependency:
```xml
<dependency>
<groupId>org.geysermc.floodgate</groupId>
<artifactId>api</artifactId>
<version>2.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
Get the Floodgate API using:
```java
FloodgateApi api = FloodgateApi.getInstance();
api.isFloodgatePlayer(uuid);
```
@@ -0,0 +1,52 @@
---
layout: page
title: Using Geyser with Consoles
permalink: /geyser/Using-Geyser-with-Consoles/
---
All consoles can join third-party servers - including Geyser servers - with workarounds. Xbox One, Nintendo Switch, and PS4 systems can join third-party servers using a third-party program called BedrockConnect. For technical information about the program, including how to run your own setup, see [their GitHub repository](https://github.com/Pugmatt/BedrockConnect) (*This program is not affiliated with GeyserMC*). Other methods are also available for use.
**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 [BedrockConnect Github Page](https://github.com/Pugmatt/BedrockConnect), or the [Public GeyserConnect](https://www.geyserconnect.net) which allows connecting to both Java and Bedrock servers.**
# Xbox One
(Video linked below)
[![Xbox One BedrockConnect](https://img.youtube.com/vi/g8mHvasVHMs/0.jpg)](https://www.youtube.com/watch?v=g8mHvasVHMs)
# Nintendo Switch
(Video linked below)
[![Nintendo Switch BedrockConnect](https://img.youtube.com/vi/zalT_oR1nPM/0.jpg)](https://www.youtube.com/watch?v=zalT_oR1nPM)
# PlayStation 4
1. Go to your PS4 Home screen.
2. Go to Settings.
3. Go to Network.
4. Select Set Up Internet connection.
5. If you are using wired internet, select "Use LAN Cable", otherwise choose "Use Wi-Fi".
6. Select the Custom network creation mode.
7. Select Automatic IP Address.
8. For DHCP Host Name, make sure you select Do Not Specify.
9. Under DNS Settings, select Manual.
10. Enter the BedrockConnect IP for the preferred Primary DNS (Multiple options depending on region can be found on the [BedrockConnect Github Page](https://github.com/Pugmatt/BedrockConnect)) and something like Google or Cloudfare's IP for the Secondary DNS (8.8.8.8 or 1.1.1.1).
## Alternative Methods
If you'd rather try emulating a LAN game on your network on another device, here's how you'd do that.
*Note that this method will not work with the Nintendo Switch.*
### Using a PC
If you have a PC, you can use [Phantom](https://github.com/jhead/phantom).
### Using an Android Device
If you have an Android device, you have several options:
- [Geyser Android app](https://github.com/GeyserMC/GeyserAndroid)
- [MC Lan Proxy (Trial)](https://discord.com/channels/613163671870242838/613194762249437245/770699493482037310)
- [MC Lan Proxy (Paid)](https://play.google.com/store/apps/details?id=com.luzenna.mineproxydroid)
- [MC Server Connector](https://play.google.com/store/apps/details?id=com.smokiem.mcserverconnector)
### Using an iOS device
If you have an iOS 14+ device, you can use [BedrockTogether](https://apps.apple.com/app/bedrocktogether/id1534593376).
+81 -36
View File
@@ -1,41 +1,86 @@
---
layout: page
title: Docsy Jekyll Theme
title: Docsy GeyserMC
permalink: /
---
# Welcome to Docsy Jekyll
This is a starter template for a docsy jekyll theme.
![assets/img/docsy-jekyll.png](assets/img/docsy-jekyll.png)
## Purpose
GitHub pages uses Jekyll natively, so when I make documentation, I typically
look for Jekyll templates. Why? Using Jekyll means that I can use markdown,
and allow for users to easily contribute, and build automatically just by
way of pushing to a master branch (or general GitHub pages).
I found Docsy, a beautiful Hugo template, but it requires hugo with GoLang
which doesn't render natively on GitHub pages. For this reason, I've spent
some time creating a custom Jekyll template that is (almost) as beautiful,
and includes all the features that I might want.
## Features
What are these features? You should see the {% include doc.html name="Getting Started" path="getting-started" %}
guide for a complete summary. Briefly:
- *User interaction* including consistent permalinks, links to ask questions via GitHub issues, and edit the file on GitHub directly.
- *Search* across posts, documentation, and other site pages, with an ability to exclude from search.
- *External Search* meaning an ability to link any page tag to trigger an external search.
- *Documentation* A documentation collection that was easy to organize on the filesystem, render with nested headings for the user, and refer to in markdown.
- *Pages* A separate folder for more traditional pages (e.g, about).
- *Navigation*: Control over the main navigation on the left of the page, and automatic generation of table of contents for each page on the right.
- *News* A posts feed for news and updates, along with an archive (organized by year).
- *Templates* or specifically, "includes" that make it easy to create an alert, documentation link, or other content.
- *Continuous Integration* recipes to preview the site
For features, getting started with development, see the {% include doc.html name="Getting Started" path="getting-started" %} page. Would you like to request a feature or contribute?
[Open an issue]({{ site.repo }}/issues)
<html lang="en">
<body>
<header>
<div id="header" class="section1 sections">
<div class="container h-100">
<div class="row h-100 align-items-center">
<div class="col-12 text-center">
<img class="logoimg" src="https://geysermc.org/img/geyser.png" alt="geyser logo"/>
<h1 class="text-center">Revolutionize Your Minecraft Server</h1>
<h4 class="text-center">Enable clients from Minecraft Bedrock Edition to join your Minecraft Java server.</h4>
</div>
</div>
</div>
</div>
</header>
<div id="whatisgeyser" class="section2 sections">
<div class="container">
<div class="row">
<div class="col">
<h1>What is Geyser?</h1>
<p>Geyser is a proxy, bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers. The ultimate goal of this project is to allow Minecraft: Bedrock Edition users to join Minecraft: Java Edition servers as seamlessly as possible to allow for true cross-platform.</p>
</div>
<div class="col">
<div><img src="https://geysermc.org/img/crossplat0.png" alt="image of bedrock client on java edition server"/></div>
</div>
</div>
</div>
</div>
<div id="howto" class="section3 sections">
<div class="container">
<div class="row">
<div class="col">
<iframe src="https://www.youtube.com/embed/U7dZZ8w7Gi4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
<div class="col">
<h1>How do I use it?</h1>
<p>Geyser can be downloaded from our Jenkins server <a href="http://ci.geysermc.org">here</a> and setup installations can be found on our <a href="https://github.com/GeyserMC/Geyser/wiki#Setup">wiki</a> or in the tutorial video. Geyser can be used to join any modern Java server and doesn't require anything extra to be done on their end.</p>
</div>
</div>
</div>
</div>
<div id="howitworks" class="section4 sections">
<div class="container">
<div class="row">
<div class="col">
<h1>How does it work?</h1>
<p>Geyser is a middleware, which translates all the incoming and outgoing packets. With this being said, Geyser works as a standalone proxy, meaning you can use it to join <i>any</i> modern Minecraft Java server. Geyser can also be installed on your server as a plugin, so you can easily make your server compatible with Minecraft: Bedrock Edition.</p>
</div>
<div class="col">
<div><img src="https://geysermc.org/img/crossplat1.png" alt="diagram of bedrock edition to geyser to java edition"/></div>
</div>
</div>
</div>
</div>
<div id="floodgate" class="section5 sections">
<div class="container">
<div class="row">
<div class="col">
<h1>Join from anywhere</h1>
<p>Geyser can be joined from Windows 10, iOS, Android, and even consoles
(see <a href="https://github.com/GeyserMC/Geyser/wiki/Using-Geyser-with-Consoles">here</a>
for how to set this up!) Geyser is tested working with a
<a href="https://github.com/GeyserMC/Geyser/wiki/Supported-Hosting-Providers">wide array of hosting providers</a>,
and, if you own the server, you aren't limited by a Java account with our <a href="https://github.com/GeyserMC/Floodgate/">Floodgate</a>
plugin!</p>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row py-4 d-flex align-items-center">
<div class="col text-center text-md-left mb-4 mb-md-0">
<h6 class="mb-0">© 2021 GeyserMC</h6>
</div>
</div>
</div>
</footer>
</body>
</html>
-26
View File
@@ -1,26 +0,0 @@
---
title: News
permalink: /news/
---
# News
<p>Subscribe with <a href="{{ site.baseurl }}/feed.xml">RSS</a> to keep up with the latest news.
For site changes, see the <a href="https://github.com/{{ site.github_user }}/{{ site.github_repo }}/blob/master/CHANGELOG.md">changelog</a> kept with the code base.</p>
<br>
{% for post in site.posts limit:10 %}
<div class="post-preview">
<h2><a href="{{ site.baseurl }}{{ post.url }}">{{ post.title }}</a></h2>
<span class="post-date">{{ post.date | date: "%B %d, %Y" }}</span><br>
{% if post.badges %}{% for badge in post.badges %}<span class="badge badge-{{ badge.type }}">{{ badge.tag }}</span>{% endfor %}{% endif %}
{{ post.content | split:'<!--more-->' | first }}
{% if post.content contains '<!--more-->' %}
<a href="{{ site.baseurl }}{{ post.url }}">read more</a>
{% endif %}
</div>
<hr>
{% endfor %}
Want to see more? See the <a href="{{ site.baseurl }}/archive/">News Archive</a>.
+109
View File
@@ -0,0 +1,109 @@
---
layout: page
title: Community Geyser Projects
permalink: /other/Community-Geyser-Projects/
---
Below is a list of community-compiled plugins, extensions and tools that work with Geyser.
Please note that, as these are unofficial, the main Geyser Discord will likely be unable to help with any bugs or issues you run into. Please check the linked pages for their support systems.
If you wish to add your own plugin to this list, please reach out in the #development channel of Geyser first!
## Awesome Geyser Resources
A list of other utilities that are useful with Geyser or for developing Geyser-like projects. Contains plugins, standalone resources, and Geyser Extensions.
* [GitHub](https://github.com/bundabrg/awesome-geyser-resources#geyser-extensions)
Maintainer: [bundabrg](https://github.com/bundabrg)
## BedrockSkinUtility
This is a Fabric mod that allows you to view Bedrock capes from Java.
* [GitHub](https://github.com/Camotoy/BedrockSkinUtility)
Creator: [Camotoy](https://github.com/Camotoy)
## Bedrock Player Manager for Floodgate
A Spigot plugin that is able to run certain commands when a Bedrock player joins, or have Bedrock players able to bypass the anticheat, etc.
* [Spigot page](https://www.spigotmc.org/resources/bedrock-player-managment-for-floodgate-geyser.82278/)
Creator: ofunny
## CustomCommandPrefix
A Spigot plugin that allows users to enter commands starting with `.`, to work around Xbox achievements being disabled.
* [Spigot page](https://www.spigotmc.org/resources/customcommandprefix.87224/)
* [GitHub](https://github.com/ChewMC/CustomCommandPrefix)
Creator: [Chew](https://github.com/Chew)
## FloodgatePlaceholders
Placeholders support for Floodgate.
* [GitHub](https://github.com/rtm516/FloodgatePlaceholders)
* [eCloud](https://api.extendedclip.com/expansions/floodgate/)
Creator: [rtm516](https://github.com/rtm516)
## Floodgate-Skript
Floodgate support for Skript.
* [GitHub](https://github.com/Camotoy/floodgate-skript)
Creator: [Camotoy](https://github.com/Camotoy)
## GeyserBlockJavaPlayers
Plugin that blocks Java players from joining your Geyser server, so you can have a Bedrock only server that can use Spigot plugins.
* [GitHub](https://github.com/Camotoy/GeyserBlockJavaPlayers)
Creator: [Camotoy](https://github.com/Camotoy)
## GeyserHub
A crossplay lobby plugin that provides server selector and command forms for both Bedrock Edition and Java Edition players.
* [Github](https://github.com/ProjectG-Plugins/GeyserHub)
Creators: [Jens](https://github.com/Jens-Co), [Konicai](https://github.com/Konicai)
## GeyserPlaceholders
Placeholders support for Geyser.
* [GitHub](https://github.com/ImDaBigBoss/GeyserPlaceholders)
Creator: [ImDaBigBoss](https://github.com/ImDaBigBoss)
## GeyserPreventServerSwitch
Prevent Bedrock players from joining specific sub-servers on a proxy
* [GitHub](https://github.com/Camotoy/GeyserPreventServerSwitch)
Creator: [Camotoy](https://github.com/Camotoy)
## TydiumCraft Skin API
An API makes it easier for your Bedrock skin to be rendered and outputted!
* [Website](https://tydiumcraft.net/docs/skinapi)
Creators: [Tydium](https://github.com/Tydium), [higbead](https://github.com/higbead), [gibbon27](https://github.com/gibbon27)
## GeyserSkinManager
Spigot and Bungee plugin to make Bedrock skins work; requires Geyser to be installed on the server.
* [GitHub](https://github.com/Camotoy/GeyserSkinManager)
Creator: [Camotoy](https://github.com/Camotoy)
## GeyserUpdater
This is a Spigot/BungeeCord/Velocity plugin that can be used to automatically update Geyser.
* [GitHub](https://github.com/ProjectG-Plugins/GeyserUpdater)
* [Spigot page](https://www.spigotmc.org/resources/geyserupdater.88555/)
Creators: [Jens](https://github.com/Jens-Co), [YHDiamond](https://github.com/YHDiamond), [Konicai](https://github.com/Konicai)
## SleepingServerStarter
Small application that waits for a player to connect before launching actual minecraft server.
* [GitHub](https://github.com/vincss/mcsleepingserverstarter)
Creator: [Vincss](https://github.com/vincss)
+54
View File
@@ -0,0 +1,54 @@
---
layout: page
title: Developer Guide
permalink: /other/DeveloperGuide/
---
## Compiling
1. Clone the repo to your computer (EG: `git clone https://github.com/GeyserMC/Geyser.git`)
2. [Install Maven](https://maven.apache.org/install.html)
3. Navigate to the Geyser root directory and run `git submodule update --init --recursive`. This downloads all the needed submodules for Geyser and is a crucial step in this process.
4. Run `mvn clean install` and locate to the `bootstrap`, then your desired Geyser version, then `target` folder.
## Project layout
* `bootstrap` is where we hold the specific platform code. So if you're porting Geyser to a new platform, or working with platform-specific code, you likely want to be in here.
* `connector` is where connections are handled and the data conversion is done. The majority of Geyser work is held here.
# Compiler Tools
## Lombok
*Note that the latest version of IntelliJ IDEA does not require additional setup in order to develop with Geyser.*
If you're using an IDE for editing any of the GeyserMC projects you will most likely need to install the Project Lombok plugin as it is used to generate a bunch of handy functions. You can edit without it but you may get missing functions and or other issues displayed in your IDE. Please see the IDE section on their site for the supported plugins and install methods [https://projectlombok.org/setup/overview](https://projectlombok.org/setup/overview).
# Protocol Information
## GopherTunnel
[GopherTunnel](https://github.com/Sandertv/gophertunnel/tree/master/minecraft/protocol/packet) is a library for Bedrock Edition written in Go. The source code is an excellent documentation for the Bedrock protocol.
## wiki.vg
For a full rundown of the Java Edition protocol, see [here](https://wiki.vg/Protocol).
## wiki.vg (Bedrock)
The Bedrock Edition protocol is documented [here](https://wiki.vg/Bedrock_Protocol), but it's currently incomplete so only use it as a reference.
# Programs
## debuginfo-be
[debuginfo-be](https://github.com/Heath123/debuginfo-be) is a Spigot plugin that displays an overlay to Geyser clients with useful debug information, similar to the F3 screen in Java Edition.
## pakkit
pakkit is a GUI-based tool for intercepting packets between a server and client developed by Geyser contributor [circuit10/Heath123](https://github.com/Heath123/) built using Electron. It works for both Java Edition (using node-minecraft-protocol) and Bedrock (as a GUI wrapper for ProxyPass adding extra features). It supports features such as viewing packet data in JSON format, Edit and Resend and a hex view for raw packet data. You can download it from [here](https://ci.rtm516.co.uk/job/pakkit/job/master/). It's currently WIP, so expect bugs.
## ProxyPass
ProxyPass is a tool for intercepting packets between a Bedrock server and client developed by the Cloudburst team. It can be found [here](https://github.com/NukkitX/ProxyPass) and the vanilla Bedrock server can be found [here](https://www.minecraft.net/en-us/download/server/bedrock/).
## MCC Toolchest
MCC Toolchest is a tool for viewing and editing NBT data for Bedrock edition, this allows you to see data as it is stored in Bedrock. You can download it from [here](http://mcctoolchest.com/).
## NBTExplorer
NBTExplorer is a tool for viewing and editing NBT data for Java edition, this allows you to see data as it is stored in Java edition. You can download it from [here](https://github.com/jaquadro/NBTExplorer/releases).
## Windows 10 Multi-Version Launcher
The Windows 10 Multi-Version launcher allows you to switch between release and beta versions of Minecraft Bedrock. Its GitHub repository can be viewed [here](https://github.com/MCMrARM/mc-w10-version-launcher/).
+25
View File
@@ -0,0 +1,25 @@
---
layout: page
title: Geyser-Fabric
permalink: /other/Geyser-Fabric/
---
# [Download here](https://ci.opencollab.dev/job/GeyserMC/job/Geyser-Fabric/job/java-1.18/lastSuccessfulBuild/artifact/build/libs/Geyser-Fabric-2.0.0-SNAPSHOT.jar)
For the most part, Geyser-Fabric operates the same as other Geyser platforms. There are a couple of exceptions:
- Geyser-Fabric is installed in the `mods` folder, and its config can be found in `config/Geyser-Fabric/config.yml` at the root of your server.
- Any mod that requires clientside installation in order to join the server will not permit Bedrock clients to join.
- Floodgate is currently not supported on Fabric.
- You must install the Fabric API mod from [here](https://www.curseforge.com/minecraft/mc-mods/fabric-api).
The source code can be found [here](https://github.com/GeyserMC/Geyser-Fabric).
### permissions.yml
This file located in `config/Geyser-Fabric` controls what commands non-opped players (both Bedrock and Java) are able to run. Uncomment the commands you want any player to run.
### Why a separate repository?
- By maintaining a separate repository, we can support multiple Minecraft versions easier.
- Fabric is built around the Gradle build tool, while Geyser is built around the Maven build tool.
+36
View File
@@ -0,0 +1,36 @@
---
layout: page
title: GeyserConnect
permalink: /other/GeyserConnect/
---
GeyserConnect is a version of Geyser that allows you to join multiple servers using a single GeyserMC proxy.
## Setup
(For GeyserConnect to work you need an open UDP port, by default it's `19132`.)
1. Download the latest build from [Jenkins](https://ci.opencollab.dev/job/GeyserMC/job/GeyserConnect/job/master/)
2. Edit the config as needed
3. Start the server as you do with a normal Geyser install. EG: `java -Xms1024M -jar GeyserConnect.jar` (More info on [Creating a Startup Script](Creating-a-Startup-Script))
4. Connect to it to make sure its all working.
## DNS and Docker
There are both [DNS](https://github.com/GeyserMC/GeyserConnect/tree/master/bind9) (using bind9) and [Docker](https://github.com/GeyserMC/GeyserConnect/tree/master/docker) configs in the repo if you would like to use them.
## Config
* `address` - The IP address that will listen for connections.
* `remote-address` - The IP address to forward players to, this needs to be accessible by the client. Set it to `auto` to grab your public IP automatically.
* `port` - The port that will listen for connections.
* `debug-mode` - If debug messages should be sent through console.
* `max-players` - Maximum amount of players that can connect.
* `motd` - MOTD to display.
* `geyser`
* `debug-mode` - If debug messages should be sent through the console, has to be enabled in both places to work.
* `shutdown-time` - The time to wait after the last player disconnects to shutdown the proxy, in seconds. Set to -1 to disable.
* `servers` - A list of servers to show for everyone build from `address`, `port`, `name`, `online` and `bedrock` all optional apart from address.
* `custom-servers`
* `enabled` - Should custom servers be enabled for users.
* `max` - Max amount of custom servers per user.
* `storage-type` - Storage engine for custom servers. Can be `json`, `sqlite`, `mysql`
* `mysql` - Connection information for the MySQL database if enabled
The default config can be found [here](https://github.com/GeyserMC/GeyserConnect/blob/master/src/main/resources/config.yml).
+23
View File
@@ -0,0 +1,23 @@
---
layout: page
title: GeyserOptionalPack
permalink: /other/GeyserOptionalPack/
---
**Download:** https://ci.opencollab.dev/job/GeyserMC/job/GeyserOptionalPack/job/master/lastSuccessfulBuild/artifact/GeyserOptionalPack.mcpack
GeyserOptionalPack is a Bedrock resource pack that adds more features to Geyser to bring Bedrock Edition in line with Java Edition. A resource pack allows various features and bug fixes to be implemented in Bedrock, including:
- Armor stand poses and arm/baseplate visibility
- Illusioner texture
- Iron golem cracked texture
- Missing particles, like sweep attack
- Spectral arrow entity texture
A more complete list can be found on the optional pack's [README](https://github.com/GeyserMC/GeyserOptionalPack/blob/master/README.md). Implementation details for those interested in how features are added can be found [here](https://github.com/GeyserMC/GeyserOptionalPack/blob/master/developer_documentation.md).
While recommended, it is not required to install the resource pack on the server - clients can install it themselves. Additionally, if you use a proxy like WaterdogPE, you can install the pack on the server without impacting gameplay on other Bedrock servers.
### Resource pack conflicts
If your current server resource pack contains any [entity definitions](https://github.com/GeyserMC/GeyserOptionalPack/tree/master/entity) that overlap with the optional pack, you will need to merge the definitions for these entities for the optional pack and your own pack to work correctly. Otherwise, the prevailing entity definition will be based on pack application order. This process is best performed manually due to the complexity of entity definition files, though it can also be [scripted](https://gist.github.com/Kas-tle/89c6adc3e7901fbabd1b9f71d902d0a6).
+25
View File
@@ -0,0 +1,25 @@
---
layout: page
title: Test Server
permalink: /other/TestServer/
---
### Details
- IP: `test.geysermc.org` (default ports on both Bedrock and Java)
- World size: 20k x 20k
### Infomation
Geyser has a test server for those who want to test how Java <-> Bedrock crossplay works on their device, and to see the limitations and restrictions. You can join from either Bedrock or Java, and the server has [Floodgate](Floodgate) installed so you don’t need a Java account to join from Bedrock.
If you can't build/destroy/interact with the world in the test server, run `/rtp` to get away from the protected spawn area.
If you have any questions or problems be sure to join our [Discord](https://discord.geysermc.org)!
### Commands:
|Command|Desc|
|--|--|
|`/rtp`|Teleport to a random location|
|`/ll`|LandLord base command for managing land claims|
|`/spawn`|Teleport to spawn|
|`/home`|Set/go-to a home|
|`/linkaccount`|Link your Java and Bedrock accounts|