Core Keeper Dedicated Server

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

Supported tags and respective Dockerfile links

• latest (Dockerfile)

How to run

Volumes

Create two directories where you want to run your server :

• server-data: mandatory if you want to keep configuration between each restart
• server-files: optional, contains all the files of the application

Using Docker CLI:

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

Using Docker Compose

Create a docker-compose.yml with the following content:

services:
  core-keeper:
    container_name: core-keeper-dedicated
    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:

PUID=1000
PGID=1000
WORLD_INDEX=0
WORLD_NAME="Core Keeper Server"
WORLD_SEED=0
WORLD_MODE=0
GAME_ID=""
DATA_PATH="${STEAMAPPDATADIR}"
MAX_PLAYERS=10
SEASON=""
SERVER_IP=""
SERVER_PORT=""
DISCORD_WEBHOOK_URL=""
# Player Join
DISCORD_PLAYER_JOIN_ENABLED=true
DISCORD_PLAYER_JOIN_MESSAGE="$${char_name} ($${steamid}) has joined the server."
DISCORD_PLAYER_JOIN_TITLE="Player Joined"
DISCORD_PLAYER_JOIN_COLOR="47456"
# Player Leave
DISCORD_PLAYER_LEAVE_ENABLED=true
DISCORD_PLAYER_LEAVE_MESSAGE="$${char_name} ($${steamid}) has disconnected. Reason: $${reason}."
DISCORD_PLAYER_LEAVE_TITLE="Player Left"
DISCORD_PLAYER_LEAVE_COLOR="11477760"
# Server Start
DISCORD_SERVER_START_ENABLED=true
DISCORD_SERVER_START_MESSAGE="**World:** $${world_name}\n**GameID:** $${gameid}"
DISCORD_SERVER_START_TITLE="Server Started"
DISCORD_SERVER_START_COLOR="2013440"
# Server Stop
DISCORD_SERVER_STOP_ENABLED=true
DISCORD_SERVER_STOP_MESSAGE=""
DISCORD_SERVER_STOP_TITLE="Server Stopped"
DISCORD_SERVER_STOP_COLOR="12779520"

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

Configuration

These are the arguments you can use to customize server behavior with default values.

Argument	Default	Description
PUID	1000	The user ID on the host that the container should use for file ownership and permissions.
PGID	1000	The group ID on the host that the container should use for file ownership and permissions.
WORLD_INDEX	0	Which world index to use.
WORLD_NAME	"Core Keeper Server"	The name to use for the server.
WORLD_SEED	0	The seed to use for a new world. Set to 0 to generate random seed.
WORLD_MODE	0	Sets the world mode for the world. Can be Normal (0), Hard (1), Creative (2), Casual (4).
SEASON	No Default	Overrides current season by setting to any of None (0), Easter (1), Halloween (2), Christmas (3), Valentine (4), Anniversary (5), CherryBlossom (6), LunarNewYear(7). Do not set this env var if you want real date season.
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.
MAX_PLAYERS	10	Maximum number of players that will be allowed to connect to server.
DATA_PATH	"/home/steam/core-keeper-data"	Save file location.
SERVER_IP	No Default	Only used if port is set. Sets the address that the server will bind to.
SERVER_PORT	No Default	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.
DISCORD_WEBHOOK_URL	""	Webhook url (Edit channel > Integrations > Create Webhook).
DISCORD_PLAYER_JOIN_ENABLED	true	Enable/Disable message on player join
DISCORD_PLAYER_JOIN_MESSAGE	"$${char_name} ($${steamid}) has joined the server."	Embed message
DISCORD_PLAYER_JOIN_TITLE	"Player Joined"	Embed title
DISCORD_PLAYER_JOIN_COLOR	"47456"	Embed color
DISCORD_PLAYER_LEAVE_ENABLED	true	Enable/Disable message on player leave
DISCORD_PLAYER_LEAVE_MESSAGE	"$${char_name} ($${steamid}) has disconnected. Reason: $${reason}."	Embed message
DISCORD_PLAYER_LEAVE_TITLE	"Player Left"	Embed title
DISCORD_PLAYER_LEAVE_COLOR	"11477760"	Embed color
DISCORD_SERVER_START_ENABLED	true	Enable/Disable message on server start
DISCORD_SERVER_START_MESSAGE	"**World:** $${world_name}\n**GameID:** $${gameid}"	Embed message
DISCORD_SERVER_START_TITLE	"Server Started"	Embed title
DISCORD_SERVER_START_COLOR	"2013440"	Embed color
DISCORD_SERVER_STOP_ENABLED	true	Enable/Disable message on server stop
DISCORD_SERVER_STOP_MESSAGE	""	Embed message
DISCORD_SERVER_STOP_TITLE	"Server Stopped"	Embed title
DISCORD_SERVER_STOP_COLOR	"12779520"	Embed color

Contributors

Made with contrib.rocks.