Windrose

games
Report Issue

Embark on a PvE survival adventure in the Age of Piracy. Fight on land and sea, solo or with friends. Build, craft and explore vast open world filled with dark secrets. Master soulslite combat and take on challenging bosses, command your ship and plunder unspoken treasures!

Contributors:
Red-Banana-Official danielb@purpleflaghosting.com
README

Windrose

Embark on a PvE survival adventure in the Age of Piracy. Fight on land and sea, solo or with friends. Build, craft and explore vast open world filled with dark secrets. Master soulslite combat and take on challenging bosses, command your ship and plunder unspoken treasures!

Warning

  • If running in a VM, set the CPU type to host/passthrough (or equivalent) to expose full CPU features and avoid crashes such as: Unhandled illegal instruction at address 000000014147C7F8 (thread 0154), starting debugger...

Server Requirements

Players RAM Storage
2 8GB 32GB SSD
4 12GB 32GB SSD
10 16GB 32GB SSD

Connecting to the server

Players can connect by:

  • Using the Direct Connect feature, allowing you to connect to the server using your servers allocated ip:port
  • Using the Invite Code set by the Invite Code variable (and password if set) the Invite Code does not work when Direct Connect is enabled.
  • The Invite Code can be found in /home/container/R5/ServerDescription.json and changed in your Invite Code variable.

Server Ports

  • With the Invite Code, ports are dynamically assigned via NAT punch-through. Ensure your router supports UPnP. Disable proxy/VPN temporarily if connections fail.
  • With Direct Connect it will use your servers allocated Game Port instead.
Docker Images (1)
Name Image
ghcr.io/ptero-eggs/yolks:wine_latest ghcr.io/ptero-eggs/yolks:wine_latest
Startup Command 
wine /home/container/R5/Binaries/Win64/WindroseServer-Win64-Shipping.exe -log & WINDROSE_PID=$!; tail -c0 -F /home/container/R5/Saved/Logs/R5.log --pid=$WINDROSE_PID
Variables (14)

Server Name

The server name

Environment:
SERVER_NAME
Default:
Pterodactyl Windrose Server
User Viewable:
✅
User Editable:
✅
Rules:
required|string|max:40

Use Direct Connection

Enable direct connection instead of invite codes, when set to 1 (enabled) it will disable the use of the Invite Code.

Environment:
USE_DIRECT_CONNECTION
Default:
0
User Viewable:
✅
User Editable:
✅
Rules:
required|boolean

Server Password

The server password

Environment:
SERVER_PASSWORD
Default:
None
User Viewable:
✅
User Editable:
✅
Rules:
nullable|string|max:30

Max players

Maximum allowed players

Environment:
MAX_PLAYERS
Default:
8
User Viewable:
✅
User Editable:
✅
Rules:
required|string|max:20

Auto Update

Decide if you want to update your server

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

Invite code

Invite code (0-9, a-z, A-Z). Min 6 chars, case sensitive. Leave empty to generate a random code on each server start. Ignored when Direct Connection is enabled.

Environment:
INVITE_CODE
Default:
None
User Viewable:
✅
User Editable:
❌
Rules:
nullable|string|min:6|max:32|regex:/^[a-zA-Z0-9]+$/

Password Protected

Off by default, enable this when using a server password

Environment:
SERVER_PASSWORD_PROTECTED
Default:
0
User Viewable:
✅
User Editable:
✅
Rules:
required|boolean

P2P PROXY

Don't change this

Environment:
P2P_PROXY
Default:
127.0.0.1
User Viewable:
❌
User Editable:
❌
Rules:
required|string|in:127.0.0.1

App id

The ID corresponding to the game to download.

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

WINEDEBUG

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

WINEPATH

Environment:
WINEPATH
Default:
/home/container
User Viewable:
❌
User Editable:
❌
Rules:
required|string|

WINETRICKS_RUN

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

Windows

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

Winearch

Environment:
WINEARCH
Default:
win64
User Viewable:
❌
User Editable:
❌
Rules:
required|string|max:20
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

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