From 59902566f3299aa753103fee835ea00c4800d698 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sun, 1 Oct 2023 17:42:15 -0500 Subject: [PATCH] docs: added examples page, starting with Geyser (#2404) --- docs/misc/examples.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/misc/examples.md diff --git a/docs/misc/examples.md b/docs/misc/examples.md new file mode 100644 index 00000000..6c287ad1 --- /dev/null +++ b/docs/misc/examples.md @@ -0,0 +1,28 @@ +# Examples + +Various examples are [maintained in the repository](https://github.com/itzg/docker-minecraft-server/tree/master/examples). The sections below highlight a few particular ones. + +## Bedrock compatible server + +Using the [GeyserMC plugin](https://geysermc.org/) with a Paper server (or similar) "enables clients from Minecraft Bedrock Edition to join your Minecraft Java server". The example also includes [Floodgate](https://wiki.geysermc.org/floodgate/) which "allows Xbox Live authenticated Bedrock users to join without a Java Edition account". + +```yaml +version: "3.8" + +services: + mc: + image: itzg/minecraft-server + environment: + EULA: "true" + TYPE: "PAPER" + PLUGINS: | + https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot + https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot + ports: + - "25565:25565" + - "19132:19132/udp" + volumes: + - ./data:/data +``` + +[Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/geyser/docker-compose.yml) \ No newline at end of file