Brickadia

games
Report Issue

Brickadia is a next-generation sandbox game with immense flexibility. Every creative tool - building, scripting, and more - is used right in the game, in real-time multiplayer. Build massive worlds, intricate physics contraptions, and entirely new game modes together with your friends without ever leaving the action.

Contributors:
odie.identity@gmail.com danielb@purpleflaghosting.com
README

Brickadia

Brickadia is a next-generation sandbox game with immense flexibility. Every creative tool - building, scripting, and more - is used right in the game, in real-time multiplayer. Build massive worlds, intricate physics contraptions, and entirely new game modes together with your friends without ever leaving the action.

Configuration files

File Purpose Path
GameUserSettings.ini General server configuration /home/container/.config/Epic/Brickadia/Saved/Config/LinuxServer/GameUserSettings.ini
RoleSetup2.json Server user role permissions /home/container/.config/Epic/Brickadia/Saved/Server/RoleSetup2.json

Server Ports

Name Default
Game 7777
Docker Images (1)
Name Image
ghcr.io/ptero-eggs/yolks:mono_latest ghcr.io/ptero-eggs/yolks:mono_latest
Startup Command 
./Brickadia/Binaries/Linux/BrickadiaServer-Linux-Shipping -server -log -world="{{WORLD_NAME}}" -port={{SERVER_PORT}} -token={{SERVER_HOSTING_TOKEN}}
Variables (7)

SRCDS_APPID

Environment:
SRCDS_APPID
Default:
3017590
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:3017590

Auto Update

Auto update the server on restart

Environment:
AUTO_UPDATE
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
required|boolean

Dedicated Server Hosting Token

Your Brickadia Dedicated Server Hosting Token. This comes from https://brickadia.com/account -> "Create Server Hosting Token"

Environment:
SERVER_HOSTING_TOKEN
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:100

World

(Optional) Argument which will auto-load the world with the given name on server startup, as well as auto-saving to it. The world MUST exist in /home/container/.config/Epic/Brickadia/Saved/Worlds/ before this will work. The simplest way to add a new world to this directory is to run `br.world.saveas <world name>` in the console once the server is booted. You can then use `world name` for this variable.

Environment:
WORLD_NAME
Default:
world
User Viewable:
❌
User Editable:
❌
Rules:
string|max:100

Server Name

The name of your server on the public server list.

Environment:
SERVER_NAME
Default:
A Pterodactyl Server
User Viewable:
❌
User Editable:
❌
Rules:
string|max:255

Server Password

(Optional) Server password that players must enter to join. Leave blank for none.

Environment:
SERVER_PASSWORD
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
string|max:100

List Server Publicly

Whether or not to include the server in the public server listing.

Environment:
SERVER_LIST_PUBLIC
Default:
True
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:True,False
Installation Script
Container: ghcr.io/ptero-eggs/installers:debian
Entrypoint: bash
#!/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} $( [[ -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

## add below your custom commands if needed
mkdir -p $HOME/.config
## install end
echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"