Skip to content

Commit

Permalink
Merge pull request thijsvanloef#332 from thijsvanloef/update-readme
Browse files Browse the repository at this point in the history
Update readme to include ARM warning
  • Loading branch information
thijsvanloef authored Feb 8, 2024
2 parents b501e92 + b971d4e commit d88b12f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@
This is a Docker container to help you get started with hosting your own
[Palworld](https://store.steampowered.com/app/1623730/Palworld/) dedicated server.

This Docker container has been tested and will work on Linux (Ubuntu/Debian), Windows 10 and macOS (including Apple Silicon).
This Docker container has been tested and will work on the following OS:

* Linux (Ubuntu/Debian)
* Windows 10,11
* MacOS (including Apple Silicon M1/M2/M3).

This container has also been tested and will work on both `x64` and `ARM64` based CPU architecture.

> [!IMPORTANT]
> At the moment, Xbox GamePass/Xbox Console players will not be able to join a dedicated server.
Expand All @@ -47,6 +53,10 @@ Massive shoutout to the following sponsors!

Keep in mind that you'll need to change the [environment variables](#environment-variables).

> [!IMPORTANT]
> If you use an ARM64 based CPU (Raspberry pi, M1,M2,M3 Mac, Oracle Cloud Free tier, etc.)
> Please make sure you use the `:latest-arm64` image tag.
### Docker Compose

This repository includes an example [docker-compose.yml](/docker-compose.yml) file you can use to set up your server.
Expand Down

0 comments on commit d88b12f

Please sign in to comment.