Add an "overview" landing page to Geyser, add detailed supported versions page (#5)

This commit is contained in:
chris authored and GitHub committed 2024-07-21 19:15:13 +02:00
1 parent 80f6447d0c
commit 1695f80bff
4 files changed
+63 -13

No files matched your search

+1
View File
@@ -85,6 +85,7 @@ const sidebars: SidebarsConfig = {
id: 'geyser/faq'
},
items: [
'geyser/supported-versions',
'geyser/anticheat-compatibility',
'geyser/current-limitations'
]
+1 -8
View File
@@ -53,14 +53,7 @@ Here you can find answers to frequently asked questions about Geyser - if you ha
<Q>
What server versions does Geyser support?
<A>
The Geyser-Spigot plugin supports any Minecraft server version 1.16.5 or later. Any earlier version is not supported by the plugin - use a proxy version or the standalone build instead.
Since Geyser emulates a <Versions platform="java"/> Java Edition client, you need to [install ViaVersion](https://viaversion.com/) on your server
if it is not running the latest version of Minecraft.
In order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the [chat signing page](/wiki/geyser/secure-chat/).
You will also need to run at least Java 17 or later to use Geyser. See [here](https://docs.papermc.io/misc/java-install) for more info on updating Java.
Paper versions not supporting Java 17 can add `-DPaper.IgnoreJavaVersion=true` flag to the Java startup arguments to allow Paper to run on Java 17.
Please see [this page](/wiki/geyser/supported-versions) for detailed information.
</A>
</Q>
<Q>
+22 -5
View File
@@ -1,12 +1,14 @@
---
title: Geyser
title: Overview
permalink: /geyser/
description: 'Geyser is a bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition, closing the gap from those wanting to play true cross-platform.'
---
import { Versions } from '@site/src/components/Versions'
import { useDocById } from '@docusaurus/theme-common/internal'
import DocCardList from '@theme/DocCardList'
# Geyser
# Overview
[//]: # ([![License: MIT]&#40;https://img.shields.io/badge/license-MIT-blue.svg?label=License&#41;]&#40;LICENSE&#41;)
[![Build Status](https://github.com/GeyserMC/Geyser/actions/workflows/build.yml/badge.svg)](https://github.com/GeyserMC/Geyser/actions/workflows/build.yml)
@@ -14,8 +16,23 @@ import { Versions } from '@site/src/components/Versions'
_A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition._
[//]: # (TODO: MEOW)
**Currently, supporting Minecraft Bedrock <Versions platform="bedrock"/> and Minecraft Java <Versions platform="java"/>**
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.
Here are a few selected guides that will help you get started with Geyser!
<DocCardList items={[
'setup',
'supported-versions',
'understanding-the-config',
'faq',
'common-issues',
'extensions'
].map((id) => {
const metadata = useDocById("geyser/" + id)
return {
type: 'link',
label: metadata.title,
href: id,
docId: 'geyser/' + id
}
})} />
+39
View File
@@ -0,0 +1,39 @@
---
title: Supported versions
description: Information on the versions Geyser supports.
---
import { Versions } from '@site/src/components/Versions'
import DocCardList from '@theme/DocCardList';
# Currently supported versions
:::info
**Geyser currently supports Minecraft Bedrock <Versions platform="bedrock"/> and Minecraft Java <Versions platform="java"/>**.
:::
## Using Geyser with older Minecraft: Bedrock edition versions
Older Bedrock versions are not supported. Minecraft: Bedrock Edition updates automatically on all platforms, so there are few users who would
want to use older versions. Further, older Bedrock versions do not have all features which Geyser support, which would lead to a sub-par experience.
## Using Geyser on older Minecraft: Java edition servers
Geyser emulates a <Versions platform="java"/> client, so a Java server must accept users using that version in order for Geyser to work.
This is possible thanks to [ViaVersion](https://viaversion.com/), which allows Java edition players with newer versions to join servers
that run older versions of the game.
### Using Geyser-Spigot on a Spigot/Paper server running on 1.16.5 or above
You can use Geyser-Spigot on servers that run on 1.16.5 or above. Do note that Geyser requires Java 17 to run! You will also need to run at least Java 17 or later to use Geyser. See [here](https://docs.papermc.io/misc/java-install) for more info on updating Java. Paper versions not supporting Java 17 can add `-DPaper.IgnoreJavaVersion=true` flag to the Java startup arguments to allow Paper to run on Java 17.
In order for Bedrock players to chat (1.19.3+) or join (1.19.1/1.19.2), you need to disable chat signing. More information about that can be read on the [chat signing page](/wiki/geyser/secure-chat).
### Using Geyser-Spigot on a Spigot/Paper server running on a version below 1.16.5
This is unfortunately not possible. You'll need to use a proxy such as Velocity or BungeeCord, or set up Geyser-Standalone separately with the [ViaVersion](https://github.com/ViaVersion/ViaVersion) plugin. Another alternative would be to install [ViaProxy](https://github.com/ViaVersion/ViaProxy), which is a standalone ViaVersion proxy that
translates between different Minecraft: Java edition versions, and to install Geyser-ViaProxy on it.
### Using Geyser-Fabric or Geyser-NeoForge on servers that do not run <Versions platform="java"/>
Unfortunately, Geyser-Fabric and Geyser-NeoForge only support the latest version of Minecraft: Java edition. The recommended way to still use
Geyser with older versions would be to install [ViaProxy](https://github.com/ViaVersion/ViaProxy), which is a standalone ViaVersion proxy that
translates between different Minecraft: Java edition versions, and to install Geyser-ViaProxy on it. This will also work with Floodgate auth.
### Using Geyser-Velocity or Geyser-BungeeCord on a proxy
Make sure you update your proxy software to the latest available version, and, if the backend servers are not on <Versions platform="java"/>, also install the [ViaVersion](https://github.com/ViaVersion/ViaVersion) plugin on the backend servers. Velocity/BungeeCord support most Minecraft versions, so you can update them regardless of the backend server versions.