Explore an endless cavern of creatures, relics and resources in a mining sandbox adventure for 1-8 players. Mine, build, fight, craft and farm to unravel the mystery of the ancient Core. Get Core Keeper at the Steam Store
Create two directories where you want to run your server :
server-data
: mandatory if you want to keep configuration between each restartserver-files
: optional, contains all the files of the application
docker run -d -e WORLD_NAME="Core Keeper Server" -e MAX_PLAYERS=5 -v $(pwd)/server-data:/home/steam/core-keeper-data --name core-keeper-dedicated escaping/core-keeper-dedicated
Create a docker-compose.yml
with the following content:
version: "3"
services:
core-keeper:
image: escaping/core-keeper-dedicated
volumes:
- server-files:/home/steam/core-keeper-dedicated
- server-data:/home/steam/core-keeper-data
env_file:
- ./core.env
restart: always
stop_grace_period: 2m
volumes:
server-files:
server-data:
Create a core.env
file, it should contain the environment variables for the dedicated server, see configuration for reference. Example:
WORLD_INDEX=0
WORLD_NAME=Core Keeper Server
WORLD_SEED=0
WORLD_MODE=0
GAME_ID=
DATA_PATH=/home/steam/core-keeper-data
MAX_PLAYERS=10
DISCORD=1
DISCORD_HOOK=https://discord.com/api/webhooks/{id}/{token}
SEASON=-1
SERVER_IP=
SERVER_PORT=
On the folder which contains the files run docker-compose up -d
.
A GameID.txt
file will be created next to the executable containing the Game ID. If it doesn't appear you can check the log in the same location named core-keeper-dedicated/CoreKeeperServerLog.txt
for errors.
To query the game ID run:
docker exec -it core-keeper-dedicated cat core-keeper-dedicated/GameID.txt
These are the arguments you can use to customize server behavior with default values.
WORLD_INDEX Which world index to use.
WORLD_NAME The name to use for the server.
WORLD_SEED The seed to use for a new world. Set to 0 to generate random seed.
WORLD_MODE Sets the world mode for the world. Can be Normal (0), Hard (1), Creative (2), Casual (4). NOTE: Changing between Creative and non-Creative worlds not currently supported.
GAME_ID Game ID to use for the server. Need 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.
DATA_PATH Save file location. If not set it defaults to a sub-folder named "DedicatedServer" at the default Core Keeper save location.
MAX_PLAYERS Maximum number of players that will be allowed to connect to server.
DISCORD Enables discord webhook features which sends GameID to a channel.
DISCORD_HOOK Webhook url (Edit channel > Integrations > Create Webhook).
DISCORD_PRINTF_STR The format string used to generate the content of the Discord webook. Default is `%s`, simply sending the GameID.
SEASON Overrides current season by setting to any of None (0), Easter (1), Halloween (2), Christmas (3), Valentine (4), Anniversary (5), CherryBlossom (6), LunarNewYear(7). -1 is default setting where it is set depending on system date.
SERVER_IP Only used if port is set. Sets the address that the server will bind to.
SERVER_PORT What port to bind to. If not set, then the server will use the Steam relay network. If set the clients will connect to the server directly and the port needs to be open.
Made with contrib.rocks.