StarRupture Wine

games
Report Issue

StarRupture is a first-person open world base-building game with advanced combat and tons of exploration. Play alone or in a group on this sublime and ever-changing planet, extract and manage resources, create your complex industrial system and fight off hordes of alien monsters.

Contributors:
brainshead
README

StarRupture

StarRupture is a first-person open-world base-building game with advanced combat and tons of exploration. Play alone or in a group on this sublime and ever-changing planet, extract and manage resources, create your complex industrial system, and fight off hordes of alien monsters.

⚠️ Note: Server software is still in an experimental phase. Expect some issues in future updates!

Contributors

Name GitHub Profile
brainshead https://github.com/brainshead
SavageCore https://github.com/SavageCore

Server Ports

StarRupture requires 1 port:

Port Default
Game 7777

This can be changed to any port.

System Requirements

Type Memory Storage
Bare Minimal 6 GB 25 GB
Recommended 12~16+ GB 40 GB+

Configuration Files

File Purpose Path
DSSettings.txt Server configuration for save management /home/container/DSSettings.txt
Password.json Admin password configuration /home/container/Password.json
PlayerPassword.json Server join password configuration /home/container/PlayerPassword.json
.pteroignore Files/folders to ignore during backups /home/container/.pteroignore

Unofficial documentation: https://wiki.starrupture-utilities.com/en/dedicated-server/configuration

Configuration

Setup Methods

There are two ways to configure your server: via the Panel (recommended) or In-Game. Choose one method and follow it consistently.

Method 1: Panel Configuration (Recommended)

This method uses the Pterodactyl Panel and DSSettings.txt for all configuration. It is the recommended approach because settings persist across server restarts, and the in-game management system has known vulnerabilities, such as wiping saves and changing admin passwords. Read more: https://wiki.starrupture-utilities.com/en/dedicated-server/Vulnerability-Announcement

⚠️ Important: Always stop the server before making configuration changes.

Password Setup

⚠️ Warning: Anyone who knows your IP and port can join your server if no password is set!

Automatic Setup (Recommended)

If you set the [SERVER] Admin Password and [SERVER] Player Password variables in the Startup tab before installing the server, the password files will be created automatically during installation.

Manual Setup

If you didn't set passwords during installation, you can create them manually:

  1. Visit https://starrupture-utilities.com/passwords
  2. Generate both an Admin password and a Player password
  3. Create Password.json in the root of the container (/home/container/) and paste the generated content
  4. Create PlayerPassword.json in the root of the container (/home/container/) and paste the generated content
  5. Start the server

Save Game Settings

The egg manages DSSettings.txt automatically via the Panel's Startup tab.

Panel Option DSSettings.txt Key Description
[SERVER] Session Name SessionName Name of the save game session (max 20 characters)
[SERVER] Save Interval SaveGameInterval Time between automatic saves in seconds (e.g., 300 = 5 mins)
[SERVER] Start new Savegame StartNewGame true to create a new world (use only once!)
[SERVER] Load saved Game LoadSavedGame true to load an existing save on startup
[SERVER] Savegame Name SaveGameName Filename of the save to load (e.g., AutoSave0.sav)

Creating a New World

⚠️ Important: Only enable Start new Savegame for initial world creation - disable it immediately after!

  1. Stop the server
  2. Go to the Startup tab in the Panel
  3. Set [SERVER] Load saved Game to false
  4. Set [SERVER] Start new Savegame to true
  5. Start the server and wait for it to finish loading
    1. Join using the server's WAN IP and port
    2. Press ESC to open the menu and then select Save. This will instruct the server to save the file to StarRupture\Saved\SaveGames\SessionName
    3. Disconnect from the server
  6. Stop the server
  7. Set [SERVER] Load saved Game to true
  8. Set [SERVER] Start new Savegame to false
  9. Start the server - your world will now load automatically on every startup

Loading an Existing Save

  1. Stop the server
  2. Go to the Startup tab in the Panel
  3. Set [SERVER] Load saved Game to true
  4. Set [SERVER] Start new Savegame to false
  5. Set [SERVER] Savegame Name to match your save file (e.g., AutoSave0.sav)
  6. Set [SERVER] Session Name to match your session folder name (e.g., StarRuptureServer)
  7. Start the server

Method 2: In-Game Configuration

This method uses the game's built-in Manage Server feature. Only use this method if you have issues with DSSettings.txt and are aware of the vulnerabilities mentioned above.

⚠️ Important: For this method to work, DSSettings.txt must not exist. Shutdown the server and delete it if present. You'll be stuck on a loading spinner when trying to connect if it exists. You must also remove -RCWebControlDisable and -RCWebInterfaceDisable from the startup parameters in the Startup tab.

Password Setup

  1. Start your server
  2. Open the StarRupture game client
  3. From the main menu, select Manage Server and connect to your server
  4. When prompted, configure an Admin Password
  5. Click Change Password to set the player join password

Save Game Management

  1. Start your server
  2. Open the StarRupture game client
  3. From the main menu, select Manage Server and connect to your server
  4. Use the in-game interface to create a new world or load an existing save

⚠️ Note: With this method, you will need to load your save via the in-game interface each time the server restarts.

Docker Images (1)
Name Image
Wine Latest ghcr.io/ptero-eggs/yolks:wine_latest
Startup Command 
wine /home/container/StarRupture/Binaries/Win64/StarRuptureServerEOS-Win64-Shipping.exe  -Log -Port=${SERVER_PORT} -RCWebControlDisable -RCWebInterfaceDisable  & SR_PID=$!; tail -c0 -F /home/container/StarRupture/Saved/Logs/StarRupture.log --pid=$SR_PID | grep -v -E "LogCore: Warning|LogUObjectBase: Error"
Variables (18)

[STEAM] Steam User

Steam User Account

Environment:
STEAM_USER
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|string

[STEAM] Steam Password

Steam User Password

Environment:
STEAM_PASS
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|string

[STEAM] Game ID

The ID corresponding to the game to download and run using SRCDS

Environment:
SRCDS_APPID
Default:
3809400
User Viewable:
❌
User Editable:
❌
Rules:
string

[STEAM] Steam Auth

Steam account auth code. Required if you have 2fa enabled

Environment:
STEAM_AUTH
Default:
None
User Viewable:
❌
User Editable:
❌
Rules:
nullable|string|max:5

[STEAM] Auto Update Server

This is to auto-update the game server

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

[SYSTEM] Winetricks

Environment:
WINETRICKS_RUN
Default:
vcrun2022
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

[SYSTEM] Wine Debug

Environment:
WINEDEBUG
Default:
-all
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

[SYSTEM] WINEARCH

Environment:
WINEARCH
Default:
win64
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

[SYSTEM] WINEPREFIX

Wine root directory for the container

Environment:
WINEPREFIX
Default:
/home/container/.wine
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:100

[STEAM] WINDOWS_INSTALL

Environment:
WINDOWS_INSTALL
Default:
1
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:1

[SYSTEM] WINEDLLOVERRIDES

Environment:
WINEDLLOVERRIDES
Default:
mscoree,mshtml=
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20

[SERVER] Start new Savegame

Setting this to `true` forces the creation of a new world. Be careful!

Environment:
START_NEW
Default:
false
User Viewable:
✅
User Editable:
✅
Rules:
required|string|in:true,false

[SERVER] Load saved Game

true -> Loads an existing save; false -> Skips loading saved data

Environment:
LOAD_SAVE
Default:
true
User Viewable:
✅
User Editable:
✅
Rules:
required|string|in:true,false

[SERVER] Save Interval

Time between automatic saves (in seconds) 300 = 5 minutes

Environment:
SAVE_INTERVAL
Default:
300
User Viewable:
✅
User Editable:
✅
Rules:
required|numeric

[SERVER] Savegame Name

Filename of the save to load; Must exist in the server save directory under `/StarRupture/Saved/SaveGames/{SESSION_NAME}`

Environment:
SAVEGAME_NAME
Default:
AutoSave0.sav
User Viewable:
✅
User Editable:
✅
Rules:
required|string

[SERVER] Session Name

Name of the save game sessionName of the save game session

Environment:
SESSION_NAME
Default:
StarRuptureServer
User Viewable:
✅
User Editable:
✅
Rules:
required|string

[SERVER] Admin Password

The admin password used for "Manage Server" In-Game

Environment:
ADMIN_PASSWORD
Default:
None
User Viewable:
✅
User Editable:
✅
Rules:
string|nullable

[SERVER] Player Password

The password used to join the server

Environment:
PLAYER_PASSWORD
Default:
None
User Viewable:
✅
User Editable:
✅
Rules:
string|nullable
Installation Script
Container: ghcr.io/ptero-eggs/installers:debian
Entrypoint: bash
#!/bin/bash
# steamcmd Base Installation Script


## just in case someone removed the defaults.
if [ "${STEAM_USER}" == "" ]; 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
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

#Custom Commands

## create DSSettings.txt
if [ ! -f /mnt/server/DSSettings.txt ]; then
    echo "Creating default DSSettings.txt"
    cat << EOF > /mnt/server/DSSettings.txt
    {
        "SessionName": "StarRuptureServer",
        "SaveGameInterval": "300",
        "StartNewGame": "false",
        "LoadSavedGame": "true",
        "SaveGameName": "AutoSave0.sav"
    }
EOF
fi

## create .pteroignore to only back up necessary files
if [ ! -f /mnt/server/.pteroignore ]; then
    echo "Creating default .pteroignore"
    cat << EOF > /mnt/server/.pteroignore
    *
    !Password.json
    !PlayerPassword.json
    !DSSettings.txt
    !StarRupture/Saved/SaveGames/*/AutoSave0.met
    !StarRupture/Saved/SaveGames/*/AutoSave0.sav
    !StarRupture/Saved/SaveGames/SaveData.dat
EOF
fi

## Generate password files if passwords are set
if [[ -n "${ADMIN_PASSWORD}" ]] || [[ -n "${PLAYER_PASSWORD}" ]]; then
    # Only generate if at least one password file is missing
    if [[ ! -f /mnt/server/Password.json ]] || [[ ! -f /mnt/server/PlayerPassword.json ]]; then
        echo "Generating password files..."

        RESPONSE=$(curl -s --request POST \
            --url https://starrupture-utilities.com/passwords/ \
            --header 'Content-Type: multipart/form-data' \
            --form "adminpassword=${ADMIN_PASSWORD}" \
            --form "playerpassword=${PLAYER_PASSWORD}")

        if [[ -n "${RESPONSE}" ]]; then
            # Extract and save admin password if set and file doesn't exist
            if [[ -n "${ADMIN_PASSWORD}" ]] && [[ ! -f /mnt/server/Password.json ]]; then
                echo "${RESPONSE}" | jq '{password: .adminpassword}' > /mnt/server/Password.json
                echo "Password.json created successfully"
            fi

            # Extract and save player password if set and file doesn't exist
            if [[ -n "${PLAYER_PASSWORD}" ]] && [[ ! -f /mnt/server/PlayerPassword.json ]]; then
                echo "${RESPONSE}" | jq '{password: .playerpassword}' > /mnt/server/PlayerPassword.json
                echo "PlayerPassword.json created successfully"
            fi
        else
            echo "Warning: Failed to generate password files"
        fi
    fi
fi

echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"