Skip to content

Commit

Permalink
clarified documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jammsen committed Jan 20, 2024
1 parent a783959 commit d901ed1
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This includes a Palworld Dedicated Server based on Linux and Docker.

## What you need to run this

- Basic understanding of Docker and Docker-Compose, Linux and Networking (Port-Forwarding/NAT)
- Basic understanding of Docker, Docker-Compose, Linux and Networking (Port-Forwarding/NAT)

## Getting started

Expand All @@ -32,17 +32,17 @@ This includes a Palworld Dedicated Server based on Linux and Docker.
4. After first start, stop the server, setup your config at `game/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` and start it again

## Environment-Variables
| Variable | Describe | Default Value | Allowed Value |
| ---------------------- | ---------------------------------------------------------------- | ------------- | ------------- |
| ALWAYS_UPDATE_ON_START | Updates the server on startup | true | false/true |
| GAME_PORT | Game port of the server | 8211 | 1024-65535 |
| MAX_PLAYERS | Maximum amout of players | 32 | 1-32 |
| MULTITHREAD_ENABLED | Sets options for "Improved multi-threaded CPU performance" | true | false/true |
| COMMUNITY_SERVER | Sets the server to a "Community-Server", will appear in the list | false | false/true |
| PUBLIC_IP | Public ip, auto-detect if not specified | false | ip address |
| PUBLIC_PORT | Public port, auto-detect if not specified | false | 1024-65535 |

Look at https://tech.palworldgame.com/optimize-game-balance for more information
| Variable | Describe | Default Value | Allowed Value |
| ---------------------- | ------------------------------------------------------------------------------------------------- | ------------- | ------------- |
| ALWAYS_UPDATE_ON_START | Updates the server on startup | true | false/true |
| GAME_PORT | Game port of the server | 8211 | 1024-65535 |
| MAX_PLAYERS | Maximum amout of players | 32 | 1-32 |
| MULTITHREAD_ENABLED | Sets options for "Improved multi-threaded CPU performance" | true | false/true |
| COMMUNITY_SERVER | Sets the server to a "Community-Server", will appear in the list. Needs PUBLIC_IP and PUBLIC_PORT | false | false/true |
| PUBLIC_IP | Public ip, auto-detect if not specified, see COMMUNITY_SERVER | false | ip address |
| PUBLIC_PORT | Public port, auto-detect if not specified, see COMMUNITY_SERVER | false | 1024-65535 |

Look at https://tech.palworldgame.com/optimize-game-balance for more information and config-settings in `game/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`

## Planned features in the future

Expand Down

0 comments on commit d901ed1

Please sign in to comment.