/astroneer-server-deployment

A package that deploys ASTRONEER dedicated server and dependencies to your Windows Server.

Primary LanguagePowerShellMIT LicenseMIT

Astroneer Server Deployment Tools

Astroneer Logo

Build Status Supports Windows Server 2019 Supports Windows 10 Requires Powershell 5 Powershell 6+ Not Supported GitHub issues GitHub forks GitHub stars GitHub license GitHub All Releases GitHub contributors

This module lets you quickly deploy an Astroneer Dedicated Server

Did I save you some time? Buy me a ☕😄

How to use

Easy Method (5 minutes)

Watch the Video

  1. Download the install-astroneer-server.zip file from the latest release
  2. Extract the ZIP
  3. Run the install-astroneer-server.exe file as administrator
  4. Answer the prompts followed by ENTER
  • Owner Steam Name: This is how your steam name is publicly visible to the world.
  • Server Name: This will be the name of your server
  • Max FPS: Set to 30 if you're unsure.
  • Server Password: A server password if you wish, or just hit enter for no password.
  • Use AstroLauncher as GUI [y/n]: Recommended If you'd like to install AstroLauncher to manage the server.

Advanced Method

  1. Download or Clone the repository
  2. Execute the powershell script: powershell.exe -executionpolicy bypass -file "install-astroneer-server.ps1"

Supported command line switches and examples

  • -ownerName "The owner steam name"
  • -serverName "The server name"
  • -serverPassword "A Super Secure Password"
  • -maxFPS 60
  • -useGUI y or -useGUI n to install AstroLauncher
  • -autoReboot y Optional Default: n If set to y, the server will be rebooted automatically after installation if needed. Otherwise, if a reboot is needed, the script will exit and the server will not be able to start until the reboot is complete.
  • -installPath "C:\SteamServers" Optional Default: C:\SteamServers The path to install to without trailing slash

Unattended installation

By specifiying all required parameters you will be able to run the installation completely unattended.

  • powershell.exe -executionpolicy bypass -file "install-astroneer-server.ps1" -ownerName "Guy" -serverName "Guys Lair" -serverPassword "Guy123" -maxFPS 60 -useGUI y -autoReboot y

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Requirements

This script has been tested on Windows Server 2019 and Windows 10 1909, both using Powershell 5.

Powershell 6+ users will not be able to use this as it relies on the depricated Invoke-WmiMethod -Class Win32_Process class.

Credits

MScholtes - PS2EXE allows me to build this in a way that's easy to use by masses

hjorslev - Wrapper that helped in speeding up usage of SteamCMD

ricky-davis - Web based server management utility for Astroneer