Skip to content

Portal Knights

The world of Elysia needs YOU! Join this cooperative, 3D sandbox action RPG to level up your character, craft epic weapons, conquer enemies in real-time, and build almost anything! Craft your adventure. Forge your hero. Become the ultimate Portal Knight!

egg-portal-knights.json

updated

Ports

Add an allocation on the node for each port.

  • Game 16365

Install

Installer image
ghcr.io/ptero-eggs/installers:debian
Steam app
374040
Steam login
required
Install script
56 lines

Image

  • Wine ghcr.io/ptero-eggs/yolks:wine_latest

Panel features

  • steam_disk_space

    The Panel tells the user when SteamCMD does not have enough disk space.

Startup

The Panel runs this command to start the server. It replaces each variable in the command with the value of that variable.

13 variables

Startup command

cd /home/container/dedicated_server; xvfb-run --auto-servernum wine pk_dedicated_server.exe -config server_config.json -log server.log
  • STEAM_USERUsers cannot see

    required|stringA value is required.

  • STEAM_PASSUsers cannot see

    required|stringA value is required.

  • WINDOWS_INSTALLUsers cannot see

    boolean

  • SRCDS_APPIDUsers cannot see

    required|string|in:374040

  • Auto update server on startup.

    AUTO_UPDATEUsers can edit

    boolean

  • WINEARCHUsers cannot see

    required|string|in:win32,win64

  • WINEDEBUGUsers cannot see

    required|string|max:64

  • The name off the server

    SERVER_NAMEUsers can edit

    required|string|max:32

  • ADMIN_PASSUsers can edit

    required|string|max:64

  • USER_PASSUsers can edit

    nullable|string|max:64

  • GUEST_PASSUsers can edit

    nullable|string|max:64

  • The game play mode for the dedicated server.

    GAMEMODEUsers can edit

    required|string|in:Adventure,Creative

  • The universe size for the dedicated server.

    UNIVERSE_SIZEUsers can edit

    required|string|in:Small,Normal,Large

Wings

Stop command
^^C
Running when the console shows
Listening on
ReadyToServe
has started

Files Wings edits

Wings sets these values in these files before each start.

dedicated_server/server_config.json json

basicServerData.name
{{server.build.env.SERVER_NAME}}
basicServerData.ipv4
0.0.0.0
basicServerData.port
{{server.build.default.port}}
basicServerData.saveFolderPath
./savedata
admins.credentials.password
{{server.build.env.ADMIN_PASS}}
users.credentials.password
{{server.build.env.USER_PASS}}
guests.credentials.password
{{server.build.env.GUEST_PASS}}
gameplayMode
{{server.build.env.GAMEMODE}}
universeSize
{{server.build.env.UNIVERSE_SIZE}}
hideConsoleWindow
true

Readme

Portal Knights

The world of Elysia needs YOU! Join this cooperative, 3D sandbox action RPG to level up your character, craft epic weapons, conquer enemies in real-time, and build almost anything! Craft your adventure. Forge your hero. Become the ultimate Portal Knight!

Server

Because the server files are not in a dedicated Steam app id this egg installs the whole game and then unpacks the .zip with the dedicated server files.

Because of this a steam account is required that own the game and has Steam guard off

WineHQ

The server is running with wine. So the console output can be a litte strange but it does work.

Storage

This server will at least needs 12GB of storage allocated to be able to start

Server Ports

Portal Knights requires 1 port

Port default
Game 16365

Changes

  1. Move several games to wine_latest

    · Daniel Barton · 7b08ba7

  2. Add steamcmd based eggs

    · Daniel Barton · 60ef9fb

All changes on GitHub

Problem with this egg?

Open an issue on GitHub. Include your Panel and Wings versions.

Install script 56 lines bash in ghcr.io/ptero-eggs/installers:debian Show
#!/bin/bash
# steamcmd Base Installation Script
#
# Server Files: /mnt/server
# Image to install with is 'ghcr.io/ptero-eggs/installers:debian'


## 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
dir=/mnt/server/dedicated_server
if [[ ! -e $dir ]]; then
    mkdir -p $dir
fi

cd /mnt/server/dedicated_server
unzip -o ../dedicated_server.zip
curl -sSL -o server_config.json https://pteropaste.com/f8p6yx0yj07d

## install end
echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"