gameserverexpress/starrupture-server repository overview

(as seen on github https://github.com/gameserver-express/starrupture-server-docker⁠)

⁠Unofficial StarRupture Server Docker Container by Gameserver-Express.de

Unofficial: Not affiliated or endorsed by StarRupture / CreepyJar / Steam! Use at your own risk.

• Easy to handle docker container server (amd64) for StarRupture using wine for supporting the windows server under linux.
• Forked from the awesome steamcmd-minimal⁠ by Renegade-Master⁠.
• Licensed under GPLv3

⁠Read before usage!

• You need to accept Steam EULA by commenting out USER_ACCEPTS_STEAM_LICENSE comment below.
• The first start takes time and will download around 24GB. Check Known Issues below if needed.
• The second startup should download much less and be much faster.
• Make sure that (default) ports 7777 and 27015 udp are reachable from your clients (=the internet).
• After start you need to claim the server (setting the password) using the game client.
• To prevent user permission issues, create the bind mount folders with your preferred user PRIOR to starting the container the first time.
• By default, game files are verified before every start. Depending on your SSD/HDD speed, you might want to change this as commented in the docker-compose.yaml below.
• If needed, you can access your world in the game folder. If you want to backup things, this would be a good place to start.

⁠docker-compose.yaml

services:
  starrupture:
    image: gameserverexpress/starrupture-server:latest
    container_name: starrupture
    ports:
      - "7777:7777/udp"
      - "27015:27015/udp"
    environment:
      PORT: "7777"
      QUERY_PORT: "27015"
      SERVER_NAME: "gameserver-express StarRupture Docker"

      # you need to accept and set this to "TRUE"
      # https://store.steampowered.com/subscriber_agreement/
      # USER_ACCEPTS_STEAM_LICENSE: "TRUE"

      # disable steam server verify on every start (faster but not recommended)
      # DISABLE_STEAM_APP_VERIFY: "TRUE"

      # container expects id 1000 gid 1000 on HOST folders
      # override UID/GID if needed
      # USER_UID: 1000
      # GROUP_UID: 1000

      # This is NOT your hosts public ip and usually does not need changes!
      # BIND_IP: "0.0.0.0"
    volumes:
      # change this to your liking (e.g. use bind mount folders)
      - ./home-cache:/home/ubuntu/.cache
      - ./game:/home/ubuntu/serverfiles

      # change this only if you absolutely know what you are doing
      - apt-folder:/var/cache/apt

    restart: unless-stopped
    stop_grace_period: 30s
volumes:
  apt-folder:
  game:
  home-cache:

⁠Details

As of now StarRupture Server needs Wine Emulation and the StarRupture server itself is not exactly small. Given the fact that we did not want the container to be 2GB without even containing the game, this leads to a situation where lots of things will be downloaded during runtime. However this only impacts the first run.

⁠Podman (for advanced linux users)

Is out of scope for this project but (if you know what you are doing) should work with:

services:
  starrupture:
    privileged: true

However given the nature of podman, bind mount folders will NOT have "proper" permissions (as in: super easy to access). Not a serious issue for advanced linux podman users though.

⁠Known Issues

⁠Apt - Errors

Stopping / Restarting the container in init phase might corrupt apt-cache folder. In case of apt errors try reseting the volume:

# 0. stop + rm container
docker stop starrupture
docker rm starrupture

# 1. find correct apt volume
docker volume ls | grep apt-folder

# 2. remove volume
docker volume rm steamcmd-minimal_apt-folder

# 3. restart container as usual

⁠Enabling env variables at later stages

For podman at least, you might need to docker-compose stop starrupture and restart for changes to take effect.

⁠Problems / Feedback / Improvements

You read the readme and especially Known Issues or you just want to help? Please create an issue first. Do not invest your valuable time before getting in contact with us :)