Installation

1. Download egg from the GitHub repository.

2. Import into your Pterodactyl nest of choice. You can do this by navigating to the Admin section of your Pterodactyl panel, "Nests" under "Service Management", and clicking "Import Egg".

Applying the Egg to existing server

1. Navigate to the "Servers" page on the Admin section of pterodactyl.

2. Select the server that you want to apply the egg to.

3. Navigate to "Startup" tab.

4. Set the Nest to the one that contains the Egg.

5. Set the Egg to KitsuneLab CS2 Egg @ K4ryuu.

6. Check Skip Egg Install Script in order to keep your files safe.

7. Set the Image to the selected version of the Egg.

8. Save the modifications.

Installing new Server with the Egg

1. On the "New Server" page scroll down until you see Nest Configuration.

2. Set the Nest to the one that contains the Egg.

3. Set the Egg to KitsuneLab CS2 Egg @ K4ryuu.

4. Set the Docker Image to the selected version of the Egg.

5. Set the other values as you want and then create the server.

Welcome to the official documentation for Kitsune-Lab’s CS2-Egg project.

The system includes various features designed to simplify server management. Automation tools ensure that your server and key add-ons are always up-to-date, clear unnecessary files, filter console outputs, and automatically restart the server when a new game version is detected—eliminating the need to manually track game updates.

The CS2-Egg project was initially created for use with the Pterodactyl platform, which is why it includes an importable egg file. However, the system's versatile design ensures compatibility with any Docker-based environment, provided that the appropriate environment variables are configured within the Docker setup. This flexibility allows users to leverage the system's features across various platforms, enhancing ease of management and functionality beyond its original scope.

Features

• Automated Restart Scheduling: Automatically schedule a restart when a new game version is detected.

• Restart Countdown Notifications: Display information to players with timed commands during the restart countdown.

• Colored Logs: Enhanced readability for main scripts with colored logs.

• Junk Cleaner:

  • Round backups: Retain for 24 hours

  • Logs: Retain for 3 days

  • CSS logs: Retain for 3 days

  • Accelerator logs: Retain for 7 days

  • Demo files: Retain for 7 days

• GameInfo Updater: Automatically updates GameInfo file to maintain MetaMod reference.

• Auto-Updater: Automatically updates CounterStrikeSharp and MetaMod to the latest versions on restart, when necessary.

• Console Filter: Blocks your unwanted messages from appearing in the console.

• Premade variables to support custom parameters safely by user

The easiest way to report issues is by joining our Discord server. There, you'll find a publicly accessible room called "trackers," which functions as a forum where you can create threads for feature requests or issue reports. Be as detailed as possible in your report, and if applicable, attach logs or other relevant files to help us troubleshoot. Give your thread a clear title and assign appropriate labels to make it easier for us to identify the case.

If you prefer not to use Discord, you can also report issues on GitHub Issues. Please try to details your issue as much as possible to help us resolve the issue faster.

Steps to Setup Properly - Admin Side

1. Navigate to your Nests page of your Admin section.

2. Go to the nest where the egg is located at and open it.

3. Select the Variables page.

4. Set the default value for Auto Restart - Check Interval to the desired time frequency for server updates. A longer interval is recommended to avoid rate limiting.

5. Set the default value for Auto Restart - API URL to your Pterodactyl panel URL. Don't include any path at the end. Example: https://panel.your-domain.com

6. Configure any Auto Restart default setting according to your preferences, as these will apply to all new servers or servers where you change the egg to this.

7. You can also configure which settings are visible on client side.

Steps to Setup Properly - Client Side

1. Access the server where you wish to activate the feature.

2. Go to the Startup page.

3. Activate the AUTO RESTART - ENABLED setting.

4. To add your API key, navigate to the AUTO RESTART - USER API KEY section. You can generate this key by clicking your profile picture in the top right corner, selecting API Credentials, or visiting https://panel.your-domain.com/account/api. Create a new key and copy it immediately after generation, as it is only visible once. The key is typically 48 characters long.

5. Define a JSON structure containing commands and their corresponding timings to execute during the countdown to a restart to AUTO RESTART - COMMANDS. These commands can be used to notify players about the upcoming restart or to perform any other actions. Follow the default format, where the key represents the remaining seconds before the restart, and the value specifies the command to execute.

6. Set the AUTO RESTART - COUNTDOWN INTERVAL to the number of seconds to wait before restarting the server upon detecting a new version. It's recommended to set this value to a few minutes to allow players to be notified in advance.

7. Restart your server, and if everything is set up correctly, you should see a green message at startup indicating that it has successfully started.

Tips and Tricks

• If your server uses centralized and symlinked egg modifications, set the AUTO RESTART - COUNTDOWN INTERVAL to at least 5 minutes. This allows the main server time to detect and download updates.

• If you host only your own servers, you can configure the Auto Restart settings in the Nests for all servers. Ensure you apply these settings before switching to this egg.

• If plugins save database changes inefficiently, consider disconnecting players briefly before a restart to trigger the plugin's save logic and ensure data is saved in time. (Rare scenarios)

• Set the Auto Restart - Check Interval to a few minutes in order to avoid being rate limited by Steam.

Update

1. Download egg from the GitHub repository.

2. Navigate to Nests in your Admin section.

3. Locate the Egg and select it.

4. Upload the new file that you downloaded to the Egg File section.

5. Click on the red Update Egg button.

6. Simply restart your servers as they download always the latest scripts.