Skip to content

Necesse

Build, quest, and conquer across an infinite procedurally generated world. Play alone or with friends as you establish a settlement and explore deep dungeons, fight monsters and bosses, mine rare ores, craft magical equipment, recruit specialists for your colony, and more!

egg-necesse.json

updated

Ports

Add an allocation on the node for each port.

  • Game 14159

Install

Installer image
ghcr.io/ptero-eggs/installers:debian
Steam app
1169370
Steam login
not required
Install script
77 lines

Image

  • SteamCMD, Debian ghcr.io/ptero-eggs/steamcmd:debian

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.

6 variables

Startup command

./jre/bin/java -Xms128M -Xmx1024M -Dterminal.jline=false -Dterminal.ansi=true -jar Server.jar -localdir -nogui -world Save1

Dotted values come from the server settings. These values are examples.

  • Name of the save file.

    SAVE_NAMEUsers can edit

    required|string|max:20

  • Number of slots available for players to join the server.

    SERVER_SLOTSUsers can edit

    required|numeric|max:99

  • Password required to enter the server.

    SERVER_PASSWORDUsers can edit

    nullable|string|max:32

  • DO NOT EDIT

    SRCDS_APPIDUsers can see

    required|string|in:1169370

  • Enable or disable auto-update on startup. 0 to disable and 1 to enable.

    AUTO_UPDATEUsers can edit

    required|boolean

  • Steam Beta branch to install.

    SRCDS_BETAIDUsers can edit

    nullable|string|max:64

Wings

Stop command
stop
Running when the console shows
Type help for list of commands.

Files Wings edits

Wings sets these values in these files before each start.

cfg/server.cfg properties

port
{{server.build.default.port}},
slots
{{server.build.env.SERVER_SLOTS}},
password
{{server.build.env.SERVER_PASSWORD}},

Readme

Necesse

Build, quest, and conquer across an infinite procedurally generated world. Play alone or with friends as you establish a settlement and explore deep dungeons, fight monsters and bosses, mine rare ores, craft magical equipment, recruit specialists for your colony, and more!

Server Configuration

Steam page: link Official Wiki: link Server Wiki Page: link (Linux specifics can be found here)

Server Ports

Port default
Game 14159

Configuration files

File Path
server.cfg /home/container/cfg/server.cfg
worldSettings.cfg /home/container/saves/worlds/SAVE_NAME.zip/worldSettings.cfg

Changes

  1. SteamCMD + Other fixes

    · yesBad · edbf925

  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 77 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} $( [[ -z ${SRCDS_BETAID} ]] || printf %s "-beta ${SRCDS_BETAID}" ) $( [[ -z ${SRCDS_BETAPASS} ]] || printf %s "-betapassword ${SRCDS_BETAPASS}" ) ${INSTALL_FLAGS} validate +quit ## other flags may be needed depending on install. looking at you cs 1.6

## 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


# setup the default config file
export SERVER_CFG=/mnt/server/cfg/server.cfg

if [ ! -f "$SERVER_CFG" ]; then
    echo "Generating server config"
    mkdir "$(dirname "$SERVER_CFG")"
    cat > "$SERVER_CFG" <<EOF
SERVER = {
	port = $SERVER_PORT, // [0 - 65535] Server default port
	slots = $SERVER_SLOTS, // [1 - 250] Server default slots
	password = $SERVER_PASSWORD, // Leave blank for no password
	maxClientLatencySeconds = 30,
	pauseWhenEmpty = true,
	giveClientsPower = true, // If true, clients will have much more power over what hits them, their position etc
	logging = true, // If true, will create log files for each server start
	language = en,
	unloadLevelsCooldown = 30, // The number of seconds a level will stay loaded after the last player has left it
	worldBorderSize = -1, // The max distance from spawn players can travel. -1 for no border
	droppedItemsLifeMinutes = 0, // Minutes that dropped items will stay in the world. 0 or less for indefinite
	unloadSettlements = false, // If the server should unload player settlements or keep them loaded
	maxSettlementsPerPlayer = -1, // The maximum amount of settlements per player. -1 or less means infinite
	maxSettlersPerSettlement = -1, // The maximum amount of settlers per settlement. -1 or less means infinite
	jobSearchRange = 100, // The tile search range of settler jobs
	zipSaves = true, // If true, will create new saves uncompressed
	MOTD =  // Message of the day
}
EOF
fi

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