README
¶
Stationeers Dedicated Server Control
✨ Feature Showcase ✨
| 🚀 Easy Setup | Secure by Default | 🔄 Auto Updates | 🎮 Easy Control | 💾 Smart Backups | 🤖 Discord Bot |
|---|---|---|---|---|---|
| Just run and go | JWT auth, TLS | Gameserver updates at startup | One-click management | Automated system | Remote control |
🌟 Live UI Preview 🌟
Explore your fututre Stationeers Server UI in action—no setup required! (Demo, no actual Backend connected)
Manage your Stationeers server with style - Retro interface, modern capabilities.
TL;DR - Get Started Fast
- 📦 Download latest executable from here
- 📁 Place in empty folder and run it on Linux or Windows (chmod +x on linux)
- 🌐 Access UI at
https://<<server-ip>>:8443 - 📚 See First-Time Setup in the wiki
- 🔒 If you set this up too quickly and are in search of the Default Username/Password, see Security Considerations for more details!
What is This?
A sleek, retro-themed web UI to manage your Stationeers dedicated server. No more command line headaches or manual file editing!
Why You'll Love It
- 🚀 Zero Config Setup - Place in empty folder and run
- 🔄 Auto Updates - Server updates automatically at startup
- 🎮 One-Click Controls - Start/stop server with simple buttons
- 💾 Smart Backups - Automated backup system with easy restore
- 🤖 Discord Integration - Control your server through Discord
- 🔌 Auto SteamCMD Setup - No manual installation required
- 🔒 Secure by Default - JWT auth, TLS, and randomized JWT key
Detailed Documentation
For comprehensive instructions, examples, and more details, visit our GitHub Wiki.
| Documentation Section | Description |
|---|---|
| Features | Complete list of features and capabilities |
| Requirements | System requirements and prerequisites |
| Installation | Step-by-step installation guide |
| First-Time Setup | Getting your server up and running |
| Discord Integration | Setting up and using Discord features |
| Web Interface | Using the web UI effectively |
| Docker Guide | Running in Docker containers |
| Security Considerations | Important security best practices |
Web UI Preview
Click the images to expand them.
| UI Overview | Configuration | Backup Management |
|---|---|---|
 |
 |
 |
Discord Preview
Click the images to expand them.
| Connection Log | Save Log | Panel | Discord Commands |
|---|---|---|---|
 |
 |
 |
 |
Contributing
Love this project? I'd love your help making it better! See the Contributing Guidelines to get started.
- 🐛 Found a bug? Open an issue
- 💡 Have an idea? Suggest a feature
- 🤔 Questions? Check the Wiki or open a topic.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Documentation
¶
Overview ¶
Package main is the entry point for StationeersServerUI, a tool for managing Stationeers servers. It coordinates setup, configuration, logging, resource loading, and a web-based UI.
The server initializes by running the setup process, loading resources, and starting a web server. Key functionality is provided by the following subpackages:
- src/config: Manages server configuration.
- src/configchanger: Handles configuration changes.
- src/gamemgr: Manages process management.
- src/loader: Handles resource loading and detection initialization.
- src/logger: Provides logging utilities.
- src/setup: Performs initial server setup.
- src/web: Runs the web-based user interface.
- src/discordbot: Handles Discord bot functionality.
- src/backupmgr: Manages backups of the server's world.
- src/detectionmgr: Manages event detection and processing.
- src/setup: Performs initial server setup.
- src/ssestream: Handles Server-Sent Events (SSE) streaming.
- src/security: Handles security-related tasks.
For detailed documentation, see the subpackages or the project Wiki on GitHub.
Source Files
Directories