Thanks to visit codestin.com
Credit goes to github.com

Skip to content

A fully custom CS2 Pterodactyl 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.

License

Notifications You must be signed in to change notification settings

K4ryuu/CS2-Egg

Repository files navigation

GitHub Repo stars GitHub issues GitHub Docker Pulls GHCR Pulls Discord

⭐ Star this repo if you find it useful!

KitsuneLab©

CS2 Egg

Production-ready CS2 Pterodactyl Egg with automated updates, intelligent cleanup, auto-restart on game updates, and advanced configuration management.


Download · Report Bug · Request Feature · Discord · Documentation

System Requirements

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.

(back to top)

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.

Each framework can be enabled/disabled independently via Pterodactyl 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)

Storage & Performance

  • VPK Sync → 80% storage & bandwidth reduction via centralized file sharing
  • Junk Cleaner → Automatic cleanup (backups, logs, demos)

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

(back to top)

Documentation

Comprehensive documentation is available:

Getting Started

Features

Advanced

View Full Documentation →

(back to top)

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 --publish

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

(back to top)

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

  • Improve bad SFTP client compatibility against stating symbolic links
  • GDC optional connection to automatically detect unreliable gamedatas(?)
  • Optimize and add more automated tests for update scripts

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.md for more information.

(back to top)

About

A fully custom CS2 Pterodactyl 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.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages