Standardized container images for game servers with KGSM compatibility

• Overview
• Features
• Supported Games
• Getting Started
• Image Design
• Contributing
• License

KGSM-Containers provides standardized Docker container images for game servers that work seamlessly with KGSM (Krystal Game Server Manager). While designed for KGSM integration, these containers can also be used independently.

• Standardized Structure: Consistent patterns across all game servers
• KGSM Integration: Seamless compatibility with KGSM's container system
• Independent Operation: Usable with or without KGSM
• Optimized Images: Minimal size with maximum functionality
• Security-Minded: Non-root execution with proper permissions
• Automated Startup: Servers launch automatically when containers start

• V Rising
• Enshrouded
• The Forest
• Empyrion: Galactic Survival
• Abiotic Factor

• Docker installed and running on your system
• Basic knowledge of Docker commands

For more information, check the KGSM repository

# Create a container-based game server
kgsm --create vrising --name myserver

docker run -it \
  --name vrising-server \
  -p 9876:9876/udp \
  -p 9877:9877/udp \
  -v vrising-backups:/opt/vrising/backups \
  -v vrising-instal:/opt/vrising/install \
  -v vrising-logs:/opt/vrising/logs \
  -v vrising-saves:/opt/vrising/saves \
  -v vrising-temp:/opt/vrising/temp \
  ghcr.io/thekrystalship/vrising:latest

All images share a common architecture:

• Base: steamcmd/steamcmd:debian
• User: Non-root kgsm user
• Entrypoint: Game-specific management script

Three standardized templates in the templates/ directory ensure consistency:

This is how the directory structure looks like inside the images

/opt/<game-name>/
├── backups/                # For automated or manual backups
├── install/                # Game server installation files
├── logs/                   # Server log files
├── saves/                  # Game save files
├── temp/                   # Temporary files
└── <game-name>.manage.sh   # Management script, entrypoint

The container management script:

• Serves as the container entrypoint
• Automatically starts the game server on container launch
• Handles initialization, updates, and runtime management
• Provides standardized command-line arguments

We welcome contributions of new game server images! See CONTRIBUTING.md for detailed guidelines.

1. Fork the repository
2. Copy the template files from templates/
3. Customize for your game server
4. Test thoroughly
5. Submit a pull request

All contributors receive proper credit for their work:

• Attribution headers in all files
• Recognition for both original and adapted work
• Transparency about code origins

This project is licensed under the GNU General Public License v3.0.