Updated Core Keeper README

This commit is contained in:
Attackwave 2023-01-14 20:55:36 +01:00 committed by GitHub
parent 66ec53f559
commit c326efd209
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -17,9 +17,7 @@ Explore an endless cavern of creatures, relics and resources in a mining sandbox
| World Index | 0 | Which world index to use. Default: 0. |
| World Name | Core Keeper Server | The name to use for the server. Defaul: Core Keeper Server. |
| World Seed | 0 | The seed to use for a new world. Set to 0 to generate random seed. Default: 0. |
| Game ID | EMPTY | Game ID to use for the server. Needs to be at least 28 characters and alphanumeric, excluding Y,y,x,0,O. Empty or not valid means a new ID will be generated at start. Default: EMPTY. |
| Game Path | Dedicated Server | Save file location. Defaul: DedicatedServer. |
| Game Port | 27015 | What UDP game port to bind to. Note that the UDP Query Port is automaticaly game port + 1. The clients will connect to the server directly and the ports needs to be open. Default: 27015 (27016). |
| Game ID | | Game ID to use for the server. Needs to be at least 28 characters and alphanumeric, excluding Y,y,x,0,O. Empty or not valid means a new ID will be generated at start. Default: EMPTY. |
| Max Players | 100 | Maximum number of players that will be allowed to connect to server. Maximum is 100. Default: 100, |
| World Mode | 0 | Whether to use normal (0) or hard (1) mode for world. Default: 0. |
| Auto Update | 1 | Enable automatic updates on boot: Default: true |
@ -28,9 +26,26 @@ Explore an endless cavern of creatures, relics and resources in a mining sandbox
| Port | Default | Protocol | Description |
|---------|---------|----------|---------------------------------------------|
| Game | 27015 | UDP | |
| Server | 27015 | UDP | |
| Query | 27016 | UDP | Automaticaly bind by the game server (Game port + 1) |
Example:\
Game Port = 4711\
Server Port = 4711\
Make sure you open UDP ports 4711-4712 in your firewall and bind the allocations to the Core Keeper Server.
## Requirements of RAM and storage
| Req | Minimum | Recommend |
|---------|---------|---------|
| RAM | 1.0GB | 1.5GB |
| Storage | 1.0GB | 1.5GB |
## Important directories
| Directory | Description |
|---------|---------|
| World Saves | /home/container/.config/unity3d/Pugstorm/Core Keeper/DedicatedServer/worlds |
| Server Settings | /home/container/.config/unity3d/Pugstorm/Core Keeper/DedicatedServer |