ankemp/AstroLauncher

AstroLauncher - Dedicated Server Launcher

Table of Contents
Overview
What does it do?
TODO
INI File options
Getting Started
- Prerequisites
- Installation
Usage
- Building an EXE
Contributing
License
Contact

Overview

This tool is perfect for you if you are hosting your own dedicated server for Astroneer. It has many features to make hosting a lot easier like automatic restarts, advanced logging and a webinterface.

What does it do?

Verifies your network settings to check for Port Forwarding/NAT Loopback
Automatically sets up the base Config files
Fixes the double server problem in the server list
Starts, and automatically restarts the server
Displays when users join/leave the server
Keeps a log of everything in the logs folder
Auto Restart every X hours
Backup Retention for X hours
Web Interface to monitor server data, force saves and restarts

TODO

Build out Web Interface to have more management functions, possibly log in functionality

INI File options

Below are the descriptions and defaults for the INI file options. Do not copy/paste this into the INI file, allow the INI file to be automatically generated. Every option must be present and set, and there must be no comments or extra options.

# Disables Auto Update -- Notifies but does not download
DisableAutoUpdate = False

# Specifies how often the launcher will check for players joining/leaving
ServerStatusFrequency = 2

# Specifies how often the launcher will check for server registration status
PlayfabAPIFrequency = 2

# Disable Backup Retention
DisableBackupRetention = False

# How many hours of saves should the launcher retain
BackupRetentionPeriodHours= 76

# Location to backup the save files to
BackupRetentionFolderLocation = Astro\Saved\Backup\LauncherBackups

# Enable auto restart
EnableAutoRestart = False

# Timestamp you want to synchronize with. 00:00 or "midnight" work for midnight. Disable with "False". No quotes.
# Example: If set to 03:35, with AutoRestartEveryHours set to 6, it will restart at 03:35, 09:35, 15:35, and 21:35 every day
AutoRestartSyncTimestamp = 00:00

# After the first restart specified above, how often do you want to restart?
AutoRestartEveryHours = 24

# Disable the Port Forward / NAT Loopback check on startup
DisableNetworkCheck = False

# Disable the Web Management Server
DisableWebServer=False

# Set the port you want the Web Management Server to run on
WebServerPort=5000

# Disable the server console popup window.
DisableServerConsolePopup=False

Getting Started

To get a local copy up and running follow these simple steps or check the Latest Release for a download of the executable.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Python 3.7
pip / pipenv

Installation

Clone the AstroLauncher repository

git clone https://github.com/ricky-davis/AstroLauncher.git

Install python modules using pip or pipenv

pip install requirements.txt

pipenv install

Usage

Run the server launcher using one of the following commands

python Run-Server.py

pipenv run python AstroLauncher.py

If not placed in the same directory as the server files, you can specify a server folder location like so

python AstroLauncher.py --path "steamapps\common\ASTRONEER Dedicated Server"

pipenv run python AstroLauncher.py -p "steamapps\common\ASTRONEER Dedicated Server"

Building an EXE

If you want to turn this project into an executable, make sure to install pyinstaller using one of the following methods

pip install pyinstaller

pipenv install -d

Run pyinstaller with the all-in-one flag

pyinstaller AstroLauncher.py -F --add-data "assets/*;." --icon=assets/astrolauncherlogo.ico

or just run the BuildEXE.py which automatically cleans up afterwards

python -OO BuildEXE.py

Move the executable (in the new dist folder) to the directory of your choice. (If you want you can now delete the dist and build folders, as well as the .spec file)
Run AstroLauncher.exe

AstroLauncher.exe -p "steamapps\common\ASTRONEER Dedicated Server"

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.

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ricky Davis - Discord: @Spyci#0001

Project Link: https://github.com/ricky-davis/AstroLauncher

ankemp / AstroLauncher