OpenStarbound Server Manager

A cross-platform graphical server manager for both OpenStarbound and Starbound, built with Python and PySide6.

OpenStarbound Server Manager provides an easy-to-use interface for starting, stopping, and monitoring your OpenStarbound and Starbound dedicated server. It features real-time console output, player monitoring, resource usage tracking, a built-in server configuration editor, and optional ngrok integration.

---

Contents

• Features
• Getting Started
• Configuration
• Usage
• Roadmap
• Acknowledgements
• License

---

Features

• Cross-Platform: Supports both Windows and Linux.
• Server Control: Start, Stop, and Restart your OpenStarbound server with dedicated buttons.
• Live Console: View the server console output in real time.
• Player Monitoring: See connected players and the current player count.
• Resource Monitoring: Track CPU and RAM usage for both the server process and your entire system.
• Server Information: View server status, uptime, public IP address, and player count at a glance.
• Ngrok Integration: Optional one-click ngrok support for easy public hosting without manual port forwarding.
• Server Configuration Editor: Edit starbound_server.config directly inside the application.
• Simple Settings Interface: Configure server and ngrok paths without manually editing configuration files.
• Session Logging: Automatically saves timestamped server logs for every server session.
• Crash Handling: Detect server crashes and optionally restart the server automatically.
• Automatic Updates: Check for and install new releases directly from within the application.

---

Getting Started

Prerequisites

• Windows or Linux
• A local copy of either the OpenStarbound dedicated server or the original Starbound Dedicated Server.

Installation

Option 1: Download the latest release (Recommended)

Windows

1. Download OpenStarbound-Server-Manager-Windows.exe from the latest release.
2. Run the executable.

Linux

1. Download OpenStarbound-Server-Manager-Linux from the latest release.

2. Make it executable:

   chmod +x OpenStarbound-Server-Manager-Linux

3. Run it:

   ./OpenStarbound-Server-Manager-Linux

Option 2: Run from source

Clone the repository:

git clone https://github.com/assasin34/OpenStarbound-Server-Manager.git
cd OpenStarbound-Server-Manager

Install the required packages:

pip install -r requirements.txt

Run the application:

python main.py

---

Configuration

The first time you launch the application, a settings.json file will be created with default values.

Open Settings from the top-right corner and configure the following paths:

• Server Executable: Path to your OpenStarbound server executable (starbound_server.exe on Windows or starbound_server on Linux).
• Server Directory: Directory containing the server executable.

If you want to use ngrok:

• Enable Use Ngrok.
• Select the ngrok executable.
• Select the directory containing the executable.

Click Save to apply your changes.

Alternatively, you can edit settings.json manually:

{
    "server_executable": "C:/path/to/your/starbound_server.exe",
    "server_directory": "C:/path/to/your/server_folder",
    "ngrok_executable": "C:/path/to/your/ngrok.exe",
    "ngrok_directory": "C:/path/to/your/ngrok_folder",
    "storage_path": "...",
    "assets_path": "...",
    "use_ngrok": false,
    "restart_after_crash": false
}

---

Usage

1. Launch OpenStarbound Server Manager.
2. Open Settings and configure your server paths.
3. (Optional) Configure ngrok.
4. Click Start to launch your server.
5. Monitor server activity through the console, player list, status panel, and resource usage displays.
6. Use Stop or Restart whenever needed.

Interface Overview

• Server Controls: Start, Stop, and Restart your server.
• Players & Console: View connected players alongside the live server console.
• Server Information: Displays server status, uptime, public IP (or ngrok URL), and current player count.
• Resource Usage: Displays real-time CPU and RAM usage for both your server and your system.

---

Roadmap

Completed

• Cross-platform Windows/Linux support
• Server management
• Live console
• Player monitoring
• Resource monitoring
• Ngrok integration
• Server configuration editor
• Session Logging
• Crash handling
• Automatic Updates

Planned

• Automatic backups
• Mod manager
• Player location tracking
• Native dark mode
• Modernized user interface

---

Acknowledgements

• OpenStarbound – The open-source reimplementation and enhancement of the Starbound engine.
• Starbound Server GUI (PenGUIn) – Inspiration for the overall concept and several server management features.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.