Egg Repository

Pterodactyl Community Egg Repository

Veloren

Veloren is a multiplayer voxel RPG written in Rust. It is inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft.

Report an Issue!

Report an issue with this egg on GitHub using the buttons below

Read Me

Veloren

From their Site

Veloren is a multiplayer voxel RPG written in Rust. It is inspired by games such as Cube World, Legend of Zelda: Breath of the Wild, Dwarf Fortress and Minecraft.

Veloren is fully open-source, licensed under GPL 3. It uses original graphics, musics and other assets created by its community. Being contributor-driven, its development community and user community is one and the same: developers, players, artists and musicians come together to develop the game.

Server Ports

Due to there new config file you have to set the game port manual in the config file!!

/home/container/userdata/server/server_config/settings.ron

  • Line 4: address: "[::]:14004", -> address: "[::]:<port>",
  • Line 7: address: "0.0.0.0:14004",-> address: "0.0.0.0:<port>",

Ports required to run the server in a table format.

Portdefault
Game14004
Metrics14005

Mods/Plugins may require ports to be added to the server

Yolks
NameTag
Ubuntughcr.io/ptero-eggs/yolks:ubuntu_24.04
Variables and Startup

Startup Command

./veloren-server-cli

Variables

Version

weekly = download the latest weekly build. nightly = download the latest nightly build.

Environment Variable: VERSION
Default Value: weekly
User Viewable:✅
User Editable:✅
Server name

The name your server will be displaying

Environment Variable: SERVER_NAME
Default Value: A pterodactyl hosted server
User Viewable:✅
User Editable:✅
Metrics port

Game port +1

Environment Variable: METRICS_PORT
Default Value: 14005
User Viewable:✅
User Editable:❌
Install Script
#!/bin/bash

apt update
apt install -y curl wget unzip git jq

mkdir -p /mnt/server
cd /mnt/server

ARCH=$([[ "$(uname -m)" == "x86_64" ]] && echo "x86_64" || echo "aarch64")

if [ -z "${VERSION}" ] || [ "${VERSION}" == "weekly" ]; then
    echo -e "weekly"
    DOWNLOAD_URL=https://download.veloren.net/latest/linux/${ARCH}/weekly
elif [ "${VERSION}" == "nightly" ]; then
    echo -e "nightly"
    DOWNLOAD_URL=https://download.veloren.net/latest/linux/${ARCH}/nightly
else
    echo -e  "something went wrong"
fi

echo -e "download url: ${DOWNLOAD_URL}"
wget ${DOWNLOAD_URL} -O files.zip

unzip -o files.zip
rm files.zip

chmod +x veloren-server-cli

## generate config because there is no better way to get it.
mkdir -p /mnt/server/userdata/server/server_config/
if [ ! -f /mnt/server/userdata/server/server_config/settings.ron ]; then
    wget https://raw.githubusercontent.com/ptero-eggs/game-eggs/main/veloren/settings.ron -O /tmp/settings.ron
    sed "s/14004/${SERVER_PORT}/g" /tmp/settings.ron > /mnt/server/userdata/server/server_config/settings.ron
    rm /tmp/settings.ron
    echo "config file pulled"
fi

echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"
Installation Imageghcr.io/ptero-eggs/installers:debianInstallation Entrypointbash