Skip to content

Commit 019a7ca

Browse files
niko-at-chalupaAevarkanwu-vincent
authored
docs: enhance faq (#387)
* docs: fix grammatical error in faq * docs: add tip for arm architecture with emulation in faq * Update docs/getting-started/faq.md Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> * docs: enhance Docker installation instructions for emulation on ARM architecture * docs: update anchor link for Docker emulation Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> * docs: move docker run instructions for emulation into start your server * docs: fix x86-64 naming and macOS naming Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> * docs: fix naming in start-your-server.md Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> * docs: fix naming in a tab within start-your-server.md Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> * docs: fix naming in installation.md Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> * Update docs/getting-started/faq.md Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> --------- Co-authored-by: Aevarkan <141498060+Aevarkan@users.noreply.github.com> Co-authored-by: Vincent <magicdroidx@gmail.com>
1 parent 7a07a52 commit 019a7ca

3 files changed

Lines changed: 35 additions & 5 deletions

File tree

docs/getting-started/faq.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ comments: true
88

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

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

13-
BDS only supports the `x86-64` CPU architecture. Systems with `arm` CPU architectures are not supported.
13+
BDS natively supports the `x86-64` CPU architecture. Systems with `arm` CPU architectures are not officially supported.[^1]
14+
15+
[^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.
16+
17+
[Docker emulation]: installation.md/#with-docker-latest-arm-with-emulation

docs/getting-started/installation.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,28 @@ from the last step. Open up a terminal and install Endstone with:
6767
### with docker
6868
6969
The official [Docker image] is a great way to get the Endstone server up and running in a few
70-
minutes. Open up a terminal and pull the image with:
70+
minutes, and enables you to run Endstone on ARM through emulation. Open up a terminal and pull the image with:
7171
7272
=== "Latest"
7373
74-
```
74+
```shell
7575
docker pull endstone/endstone
7676
```
7777
78+
=== "Latest / :fontawesome-brands-apple: macOS / :fontawesome-solid-microchip: with emulation"
79+
80+
```shell
81+
docker pull --platform linux/amd64 endstone/endstone
82+
```
83+
84+
Note that if you are on an `x86-64` machine and you are not on macOS or Windows, emulation will not apply.
85+
86+
If you're new to Docker, check out the [Docker beginner's guide].
87+
7888
[Python package]: https://pypi.org/project/endstone/
7989
8090
[virtual environment]: https://realpython.com/what-is-pip/#using-pip-in-a-python-virtual-environment
8191
82-
[Docker image]: https://hub.docker.com/r/endstone/endstone/
92+
[Docker image]: https://hub.docker.com/r/endstone/endstone/
93+
94+
[Docker beginner's guide]: https://docs.docker.com/get-started/

docs/getting-started/start-your-server.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ Alternatively, if you're running Endstone from within Docker, use:
2525
docker run --rm -it -v "%cd%":/home/endstone -p 19132:19132/udp endstone/endstone
2626
```
2727

28+
=== ":fontawesome-brands-linux: Linux / :fontawesome-brands-apple: macOS / :fontawesome-solid-microchip: with emulation"
29+
30+
```
31+
docker run \
32+
--platform linux/amd64 \
33+
-p 19132:19132 \
34+
-it \
35+
-v ${PWD}:/home/endstone \
36+
--name endstone-server \
37+
endstone/endstone
38+
```
39+
40+
Note that if you are on an `x86-64` machine and you are not on macOS or Windows, emulation will not apply.
41+
2842
You should see this in your console:
2943

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

0 commit comments

Comments
 (0)