Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/getting-started/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ comments: true

Endstone is built around the official [Bedrock Dedicated Server (BDS)](https://www.minecraft.net/download/server/bedrock), which supports Windows and Ubuntu Linux.

Accordingly, Endstone only supports Windows and Ubuntu Linux. Other platforms may or may function.
Accordingly, Endstone only supports Windows and Ubuntu Linux. Other platforms may or may not function.

BDS only supports the `x86-64` CPU architecture. Systems with `arm` CPU architectures are not supported.
BDS natively supports the `x86-64` CPU architecture. Systems with `arm` CPU architectures are not officially supported.[^1]

[^1]: While BDS is natively built for `x86-64`, it can also run well on `arm` systems via [Docker emulation]. Using emulation can also allow Endstone to run on macOS.

[Docker emulation]: installation.md/#with-docker-latest-arm-with-emulation
18 changes: 15 additions & 3 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,16 +67,28 @@ from the last step. Open up a terminal and install Endstone with:
### with docker

The official [Docker image] is a great way to get the Endstone server up and running in a few
minutes. Open up a terminal and pull the image with:
minutes, and enables you to run Endstone on ARM through emulation. Open up a terminal and pull the image with:

=== "Latest"

```
```shell
docker pull endstone/endstone
```

=== "Latest / :fontawesome-brands-apple: macOS / :fontawesome-solid-microchip: with emulation"

```shell
docker pull --platform linux/amd64 endstone/endstone
Comment thread
niko-at-chalupa marked this conversation as resolved.
```

Note that if you are on an `x86-64` machine and you are not on macOS or Windows, emulation will not apply.

If you're new to Docker, check out the [Docker beginner's guide].

[Python package]: https://pypi.org/project/endstone/

[virtual environment]: https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment

[Docker image]: https://hub.docker.com/r/endstone/endstone/
[Docker image]: https://hub.docker.com/r/endstone/endstone/

[Docker beginner's guide]: https://docs.docker.com/get-started/
14 changes: 14 additions & 0 deletions docs/getting-started/start-your-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ Alternatively, if you're running Endstone from within Docker, use:
docker run --rm -it -v "%cd%":/home/endstone -p 19132:19132/udp endstone/endstone
```

=== ":fontawesome-brands-linux: Linux / :fontawesome-brands-apple: macOS / :fontawesome-solid-microchip: with emulation"

```
docker run \
--platform linux/amd64 \
-p 19132:19132 \
-it \
-v ${PWD}:/home/endstone \
--name endstone-server \
endstone/endstone
```

Note that if you are on an `x86-64` machine and you are not on macOS or Windows, emulation will not apply.

You should see this in your console:

![Start your server](start-your-server.png)
Expand Down