Core Keeper
GamesCore Keeper is a survival sandbox game for single or multiplayers. --- Drawn towards a mysterious relic, you are an explorer who awakens in an ancient cavern of creatures, resources and trinkets. Trapped deep underground will your survival skills be up to the task? Mine relics and resources to build your base, craft new equipment, survive, and power up the Core. ---
README
Core Keeper
Game Info
Core Keeper is a sandbox survival game.
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.
Dedicated Server
Parameters
| Parameter | Default | Description |
|---|---|---|
| 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 | 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 |
Game Ports
| Port | Default | Protocol | Description |
|---|---|---|---|
| Server | 27015 | UDP | |
| Query | 27016 | UDP | Automaticaly bind by the game server (Game port + 1) |
Example:
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 |
Docker Images (1)
| Name | Image |
|---|---|
ghcr.io/ptero-eggs/steamcmd:debian | ghcr.io/ptero-eggs/steamcmd:debian |
Startup Command
export DISPLAY=:0; rm ./GameID.txt ./CoreKeeperServerLog.txt; touch ./CoreKeeperServerLog.txt; xvfb-run -s "-screen 0 {{DISPLAY_WIDTH}}x{{DISPLAY_HEIGHT}}x{{DISPLAY_DEPTH}} -ac -nolisten tcp -nolisten unix" ./CoreKeeperServer -batchmode -logfile CoreKeeperServerLog.txt -world {{WORLD_INDEX}} -worldname "{{WORLD_NAME}}" -worldseed {{WORLD_SEED}} $([[ "{{GAME_ID}}" != "" ]] && echo -n " -gameid {{GAME_ID}}") -maxplayers {{MAX_PLAYERS}} -worldmode {{WORLD_MODE}} -port {{SERVER_PORT}} & CKPID=$!; tail -f CoreKeeperServerLog.txt | grep -e '^\[userid:[0-9]*\] player' -e '^[^\[]' & LOGPID=$!; trap "kill ${CKPID}; wait ${CKPID}; kill ${LOGPID}; wait ${LOGPID}" 15; wait $! Variables (11)
World Index
Which world index to use. Default: 0.
- Environment:
WORLD_INDEX- Default:
0- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|integer|min:0
World Name
The name to use for the server. Defaul: Core Keeper Server.
- Environment:
WORLD_NAME- Default:
Core Keeper Server- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|string|max:100|min:3
World Seed
The seed to use for a new world. Set to 0 to generate random seed. Default: 0.
- Environment:
WORLD_SEED- Default:
0- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|integer|min:0
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.
- Environment:
GAME_ID- Default:
None- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
nullable|string|min:28
Max Players
Maximum number of players that will be allowed to connect to server. Maximum is 100. Default: 100,
- Environment:
MAX_PLAYERS- Default:
100- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|integer|min:1|max:100
World Mode
Whether to use normal (0) or hard (1) mode for world.
- Environment:
WORLD_MODE- Default:
0- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|boolean
Steam App ID
Steam App ID of Core Keeper Dedicated Server
- Environment:
SRCDS_APPID- Default:
1963720- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|string|in:1963720
Auto Update
Enable automatic updates on boot
- Environment:
AUTO_UPDATE- Default:
1- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|boolean
DISPLAY_WIDTH
Virtual display width. Fix:1.
- Environment:
DISPLAY_WIDTH- Default:
1- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|integer
DISPLAY_HEIGHT
Virtual display height. Fix:1.
- Environment:
DISPLAY_HEIGHT- Default:
1- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|integer
DISPLAY_DEPTH
Virtual display color depth. Fix: 24.
- Environment:
DISPLAY_DEPTH- Default:
24- User Viewable:
- ❌
- User Editable:
- ❌
- Rules:
required|integer
Installation Script
ghcr.io/ptero-eggs/installers:debianbash#!/bin/bash
# steamcmd Base Installation Script
#
# Server Files: /mnt/server
# Image to install with is 'ghcr.io/ptero-eggs/installers:debian'
##
#
# Variables
# STEAM_USER, STEAM_PASS, STEAM_AUTH - Steam user setup. If a user has 2fa enabled it will most likely fail due to timeout. Leave blank for anon install.
# WINDOWS_INSTALL - if it's a windows server you want to install set to 1
# SRCDS_APPID - steam app id found here - https://developer.valvesoftware.com/wiki/Dedicated_Servers_List
# SRCDS_BETAID - beta branch of a steam app. Leave blank to install normal branch
# SRCDS_BETAPASS - password for a beta branch should one be required during private or closed testing phases.. Leave blank for no password.
# INSTALL_FLAGS - Any additional SteamCMD flags to pass during install.. Keep in mind that steamcmd auto update process in the docker image might overwrite or ignore these when it performs update on server boot.
# AUTO_UPDATE - Adding this variable to the egg allows disabling or enabling automated updates on boot. Boolean value. 0 to disable and 1 to enable.
#
##
# Install packages. Default packages below are not required if using our existing install image thus speeding up the install process.
#apt -y update
#apt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates
## just in case someone removed the defaults.
if [[ "${STEAM_USER}" == "" ]] || [[ "${STEAM_PASS}" == "" ]]; then
echo -e "steam user is not set.\n"
echo -e "Using anonymous user.\n"
STEAM_USER=anonymous
STEAM_PASS=""
STEAM_AUTH=""
else
echo -e "user set to ${STEAM_USER}"
fi
## download and install steamcmd
cd /tmp
mkdir -p /mnt/server/steamcmd
curl -sSL -o steamcmd.tar.gz https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz
tar -xzvf steamcmd.tar.gz -C /mnt/server/steamcmd
mkdir -p /mnt/server/steamapps # Fix steamcmd disk write error when this folder is missing
cd /mnt/server/steamcmd
# SteamCMD fails otherwise for some reason, even running as root.
# This is changed at the end of the install process anyways.
chown -R root:root /mnt
export HOME=/mnt/server
## install game using steamcmd
./steamcmd.sh +force_install_dir /mnt/server +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} $( [[ "${WINDOWS_INSTALL}" == "1" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} validate +quit
## set up 32 bit libraries
mkdir -p /mnt/server/.steam/sdk32
cp -v linux32/steamclient.so ../.steam/sdk32/steamclient.so
## set up 64 bit libraries
mkdir -p /mnt/server/.steam/sdk64
cp -v linux64/steamclient.so ../.steam/sdk64/steamclient.so
## add below your custom commands if needed
## install end
echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"