README.md

KitsuneLab CS2 Egg Documentation

Welcome to the official documentation for the KitsuneLab CS2 Pterodactyl Egg! This comprehensive guide will help you install, configure, and use all features.

Quick Start

New to this egg? Start here:

1. Installation Guide - Install the egg in Pterodactyl

2. Quick Start - Get your server running

3. Updating Guide - Keep everything up to date

Table of Contents

Getting Started

• Installation - How to install and apply the egg

• Quick Start - Get your server running quickly

• Updating - Update the egg, Docker image, and server

Features

• VPK Sync & Centralized Updates - 80% storage savings + automatic CS2 updates

• Auto-Updaters - Multi-framework support with independent toggles

Configuration

• Configuration Files - JSON-based configuration system

Advanced

• Building from Source - Build your own Docker image

• GDB Debugging - Remote debugging with GDB and IDA Pro

• Troubleshooting - Common issues and solutions

Key Features

This egg includes many powerful features:

• Auto-Restart - Detect CS2 updates and restart automatically

• Auto-Updaters - Keep MetaMod, CounterStrikeSharp, Swiftly, and ModSharp updated

• VPK Sync - Save ~52GB per server with centralized files

• Junk Cleaner - Automatic cleanup configured via JSON

• Colored Logs - Enhanced console output with rotation

• Console Filter - Pattern-based message filtering

• Tokenless Servers - Run servers without GSLT token requirement

• Flexible - Works with Pterodactyl or standalone Docker

Common Tasks

Install a New Server

1. Download the egg

2. Import into Pterodactyl

3. Create a new server with the egg

4. Start and enjoy!

Full Installation Guide →

Enable Auto-Restart

1. Set up VPK Sync for centralized CS2 files

2. Configure the centralized update script

3. Add to cron for automatic checks

4. Servers restart automatically on CS2 updates!

VPK Sync & Centralized Updates Guide →

Build Custom Image

git clone https://github.com/K4ryuu/CS2-Egg.git
cd CS2-Egg
./build.sh my-tag
docker push your-registry/your-image:my-tag

Building Guide →

Quick Links

• Download Egg

• Report Bug

• Request Feature

• View Changelog

Need Help?

If you need assistance:

1. Check the Troubleshooting Guide

2. Search existing GitHub Issues

3. Ask in GitHub Discussions

4. Create a new issue if needed

Contributing

Want to help improve this project?

• Report bugs and suggest features

• Improve documentation

• Submit pull requests

• Share your experience

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details.

Credits

• 1zc - Original CS2-Pterodactyl base image

• Poggu - Console filter inspiration from CleanerCS2

• All contributors who help improve this project

---

Made with ♥ by K4ryuu @ KitsuneLab

⭐ Star on GitHub