K4ryuu/CS2-Egg
K4ryuu/CS2-Egg has 117 GitHub stars and 36 forks. GitHot measured 0 stars in 24 hours and 0 in 7 days. Last checked 2026-11-15 15:51 UTC. Last push 2026-11-03.
What you can do
- VPK Sync & Centralized Updates → 80% storage savings + auto-restart on CS2 updates
- Auto-Updaters → Plugin auto-updates (MetaMod, CSS, SwiftlyS2, ModSharp)
- Junk Cleaner → Automatic cleanup with customizable rules
Measured star growth
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- Update delayed
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
A fully custom CS2 Pterodactyl/Pelican egg with built-in updaters (CSS, Metamod, Swiftly, ModSharp), console message filter, junk cleaner with user settings, VPK sync for reduced storage, and auto-restart on game updates. Includes custom scripts and full documentation.
AIREADME.md
Original[!CAUTION] This egg is superseded by CS2-Egg-Go, a full rewrite in Go with significantly more features. New installs should use that instead.
CS2 Egg
Production-ready CS2 Pterodactyl & Pelican Egg with automated updates, intelligent cleanup, auto-restart on game updates, and advanced configuration management.
Download
·
Report Bug
·
Request Feature
·
Discord
·
Documentation
Support My Work
I create free, open-source projects for the community. If you'd like to support my work, consider becoming a sponsor!
💖 GitHub Sponsors
Support this project through GitHub Sponsors with flexible options:
- One-time or monthly contributions
- Custom amount - choose what works for you
- Multiple tiers available - from basic benefits to priority support or private project access
Every contribution helps me dedicate more time to development, support, and creating new features. Thank you! 🙏
⭐ Or support me for free by starring this repository!
Centralized Update & VPK Sync
Run CS2 on multiple servers without storing 55GB per server. One installation, shared across all containers.
A guided installation wizard handles everything - download, configuration, systemd daemon, and cron setup. Default options work for most setups.
curl -fsSL https://raw.githubusercontent.com/K4ryuu/CS2-Egg/main/misc/install-cs2-update.sh -o /tmp/install-cs2-update.sh && sudo bash /tmp/install-cs2-update.sh
Recommended: run with default options. Just press Enter through the wizard.
Once installed, the script doubles as the host-side maintenance tool:
| Flag | What it does |
|---|---|
--doctor |
Full health check (service, cron, dependencies, per-server status, orphaned locks) with safe auto-fixes |
--update |
Self-update the script right now, daemon restarts automatically |
--test |
Run the boot-handshake and soak window test suites |
--validate |
One-shot SteamCMD file check without changing your saved config |
System Requirements
Supported Panels
| Panel | Status |
|---|---|
| Pterodactyl | ✅ Supported & Tested |
| Pelican | ✅ Supported & Tested |
Supported Operating Systems (for VPK Sync & Centralized Updates)
| Operating System | Minimum Version | Supported Versions | Status |
|---|---|---|---|
| Ubuntu | 18.04 (Bionic) | 18.04, 20.04, 22.04, 24.04 | ✅ Tested |
| Debian | 10 (Buster) | 10, 11, 12, 13 | ✅ Tested |
The centralized update script automatically detects your OS version and installs appropriate dependencies.
Supported Modding Frameworks
Multi-Framework Support → Enable multiple frameworks simultaneously with independent boolean toggles. The egg automatically handles framework dependencies, load order, and gameinfo.gi configuration.
- MetaMod:Source → Core plugin framework (required for CSS)
- CounterStrikeSharp → C# plugin framework with .NET 8 runtime
- SwiftlyS2 → Standalone C# framework v2
- ModSharp → Standalone C# platform with .NET 9 runtime
Each framework can be enabled/disabled independently via Pterodactyl/Pelican panel. Auto-updates on server restart while enabled.
Features
Automation & Updates
- Auto-Updaters → MetaMod, CounterStrikeSharp, SwiftlyS2, ModSharp automatically update on server restart
- Centralized Update Script → Auto-restart on CS2 updates with version tracking (misc/update-cs2-centralized.sh)
- Boot Handshake → Servers read a daemon-written status file at boot, so a restart during a CS2 update waits it out instead of triggering a full SteamCMD redownload
- Update Soak Window → The self-updating script installs itself as root, so a new version waits 12 hours on the branch before any host applies it. A broken or tampered release can be pulled before it lands anywhere (
UPDATE_SOAK_SECONDS,--updatebypasses it)
Storage & Performance
- VPK Sync → 80% storage & bandwidth reduction via centralized file sharing
- Worker Pool → Parallel file pushes (
MAX_WORKERS, default 8) so mass-starting servers never stalls the daemon - Junk Cleaner → Automatic cleanup with customizable rules (backups, logs, demos, crash dumps)
Management & Configuration
- Console Filter → Block unwanted messages (inspired by Poggu's CleanerCS2)
- JSON Configs → FTP-editable configuration files
- Colored Logging → Enhanced console output
- Custom Parameters → Safe user-configurable startup options
- Tokenless Servers → Run servers without GSLT token requirement
Documentation
Comprehensive documentation is available:
Getting Started
- Installation Guide → Install and configure the egg
- Quick Start → Get running quickly
- Updating → Update guide
Features
- VPK Sync & Centralized Updates → 80% storage savings + auto-restart on CS2 updates
- Auto-Updaters → Plugin auto-updates (MetaMod, CSS, SwiftlyS2, ModSharp)
- Junk Cleaner → Automatic cleanup with customizable rules
Configuration
- Configuration Files → JSON configs, console filter, logging
Advanced
- Building from Source → Build your own image
- Troubleshooting → Common issues
- Error Codes → Every fatal error code with cause and fix
- Debugging → Diagnose a misbehaving server
Quick Build
Build your own Docker image using the included build script:
# Build with custom tag
./build.sh latest
# Build and publish to Docker Hub
./build.sh latest --dockerhub
# Build and publish to both Docker Hub and GHCR
./build.sh latest --all
Note: Edit build.sh to change the registry from sples1/k4ryuu-cs2 to your own.
Full Building Guide → - Customization, multi-arch builds, CI/CD integration
Credits
- CS2 Pterodactyl from 1zc: The base of the image is maximally based on this image and if you don't want to use the custom scripts, you can use this image instead. Appreciate the work of 1zc and give him a star.
Roadmap
Nothing planned right now - development continues through bug reports and feature requests. Have an idea? Open a request.
License
Distributed under the MIT License. See LICENSE.md for more information.